README

   1 This is userv-utils.  It is a collection of utilities and scripts that
   2 serve both as examples for how to use userv, and in some cases,
   3 hopefully as useful programs.
   4
   5 Please see each individual directory for details, installation
   6 instructions, documentation, invididual copyright statements, and
   7 anything else that might be available.
   8
   9 If you do not know what userv is, see its WWW page at
  10 http://www.chiark.greenend.org.uk/~ian/userv/.  For now at least, the
  11 userv mailing lists should be used to discuss these and other
  12 userv-using programs.
  13
  14 Please send bug reports and suggestions to
  15 userv-maint@chiark.greenend.org.uk, or to the userv-discuss mailing
  16 list if you are subscribed to it.
  17
  18
  19 Here is a quick summary of the currently available utilities
  20
  21 Directory       Status  Description (UC=`users can ...')
  22 --------------- -----   ------------------------------------------------
  23 groupmanage     Y Y P   UC create groups, add/remove members, &c
  24 www-cgi         B Y Y   UC provide CGIs which run as themselves
  25 ipif            B Y X   UC create IP interfaces/tunnels (Linux only)
  26 newsrc-lg       B P X   Acquire list of subscribed groups from .newsrcs
  27 misc/mailq      S C X   UC list mail queue even if sendmail forbids
  28 misc/ndc-reload S C X   UC reload named after editing own zone files
  29
  30
  31 Key to the Status:
  32  First letter is general status:
  33    Y    Released; hopefully of production quality.
  34    B    Beta.  Not released, but hopefully useful with care.
  35    A    Alpha.  Probably buggy.  Not widely tested or debugged.
  36    X    Example/experimental - for documentation purposes only,
  37         not recommended for use.
  38    S    Too small to be relevant
  39  Second letter is completeness:
  40    Y    Complete.
  41    P    Partially complete, some glue or modification needed.
  42    X    Incomplete.  Much extra stuff is required.
  43  Third letter is documentation:
  44    Y    Supplied documentation is believed adequate.
  45    P    Partial documentation or hints.  Good sysadmins should cope.
  46    X    No documentation.  Good luck !
  47
  48 userv-utils are
  49 Copyright (C)1996-9 Ian Jackson <ian@davenant.greenend.org.uk>.
  50
  51 All the utilities here are free software.  You can redistribute it
  52 and/or modify them under the terms of the GNU General Public License
  53 as published by the Free Software Foundation; either version 2 of the
  54 License, or (at your option) any later version.
  55
  56 These programs are distributed in the hope that they will be useful,
  57 but WITHOUT ANY WARRANTY; without even the implied warranty of
  58 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  59 General Public License for more details.
  60
  61 You should have received a copy of the GNU General Public License
  62 along with userv-utils as the file COPYING; if not, email me at the
  63 address above or write to the Free Software Foundation, 59 Temple
  64 Place - Suite 330, Boston, MA 02111-1307, USA.
  65
  66 Local variables:
  67 mode: text
  68 fill-column: 77
  69 End: