README

   1 This is userv-utils.  It is a collection of utilities, scripts and example
   2 configuration files that serve both as examples for how to use userv, and in
   3 some cases, hopefully as useful programs and services.
   4
   5 Please see each individual directory for any details, installation
   6 instructions, documentation, invididual copyright statements, and anything
   7 else, that is 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 A   UC create groups, add/remove members, &c
  24 ipif            Y Y A   UC create IP interfaces/VPNs (Linux-specific)
  25 www-cgi         Y B A   UC provide CGIs which run as themselves
  26 misc/mailq      Y S S   UC list mail queue even if sendmail forbids
  27 misc/ndc-reload Y S S   UC reload named after editing own zone files
  28 git-daemon      Y Y Y   UC safely publish git repositories on port 9418
  29 newsrc-lg       X B X   Acquire list of subscribed groups from .newsrcs
  30
  31 Key to the Status:
  32  First letter is completeness:
  33    Y    Complete.
  34    P    Partially complete, some glue or modification needed.
  35    X    Incomplete.  Much extra stuff is required.
  36  Second letter is general status:
  37    Y    Released; hopefully of production quality.
  38    B    Beta.  Not fully released, but hopefully useful with care.
  39    A    Alpha.  Probably buggy.  Not well tested or widely used.
  40    X    Example/experimental - for documentation purposes only,
  41         not recommended for use.
  42    S    Too small for this question to be relevant.
  43  Third letter is documentation:
  44    Y    Full installation and use instructions included.
  45    A    Documentation is believed largely adequate, but a bit rough.
  46    P    Partial documentation or hints.  Good sysadmins should cope.
  47    X    No documentation.  Good luck !
  48    S    Too small to need any significant documentation.
  49
  50 userv-utils are
  51 Copyright (C)1996-2010 Ian Jackson <ian@davenant.greenend.org.uk>.
  52 Copyright (C)1998 David Damerell <damerell@chiark.greenend.org.uk>
  53 Copyright (C)1999,2003
  54    Chancellor Masters and Scholars of the University of Cambridge
  55 Copyright (C)2010 Tony Finch <fanf@dotat.at>
  56
  57 All the utilities here are free software.  You can redistribute it
  58 and/or modify them under the terms of the GNU General Public License
  59 as published by the Free Software Foundation; either version 2 of the
  60 License, or (at your option) any later version.
  61
  62 These programs are distributed in the hope that they will be useful,
  63 but WITHOUT ANY WARRANTY; without even the implied warranty of
  64 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  65 General Public License for more details.
  66
  67 You should have received a copy of the GNU General Public License
  68 along with userv-utils as the file COPYING; if not, email me at the
  69 address above or write to the Free Software Foundation, 59 Temple
  70 Place - Suite 330, Boston, MA 02111-1307, USA.
  71
  72
  73 $Id$
  74
  75 Local variables:
  76 mode: text
  77 fill-column: 77
  78 End: