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 ijackson@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 Y 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 misc/checkpass* Y Y S   UC check own password; some can check any passwd
  29 git-daemon      Y Y Y   UC safely publish git repositories on port 9418
  30 newsrc-lg       X B X   Acquire list of subscribed groups from .newsrcs
  31 dyndns          Y Y Y   UC edit simple DNS entries for certian domains
  32
  33 Key to the Status:
  34  First letter is completeness:
  35    Y    Complete.
  36    P    Partially complete, some glue or modification needed.
  37    X    Incomplete.  Much extra stuff is required.
  38  Second letter is general status:
  39    Y    Released; hopefully of production quality.
  40    B    Beta.  Not fully released, but hopefully useful with care.
  41    A    Alpha.  Probably buggy.  Not well tested or widely used.
  42    X    Example/experimental - for documentation purposes only,
  43         not recommended for use.
  44    S    Too small for this question to be relevant.
  45  Third letter is documentation:
  46    Y    Full installation and use instructions included.
  47    A    Documentation is believed largely adequate, but a bit rough.
  48    P    Partial documentation or hints.  Good sysadmins should cope.
  49    X    No documentation.  Good luck !
  50    S    Too small to need any significant documentation.
  51
  52 userv-utils are
  53 Copyright 1996-2013 Ian Jackson <ijackson@chiark.greenend.org.uk>
  54 Copyright 1998 David Damerell <damerell@chiark.greenend.org.uk>
  55 Copyright 1999,2003
  56    Chancellor Masters and Scholars of the University of Cambridge
  57 Copyright 2010 Tony Finch <fanf@dotat.at>
  58
  59 All the utilities here are free software; you can redistribute it and/or
  60 modify it under the terms of the GNU General Public License as published by
  61 the Free Software Foundation; either version 3 of the License, or (at your
  62 option) any later version.
  63
  64 This program is distributed in the hope that it will be useful, but
  65 WITHOUT ANY WARRANTY; without even the implied warranty of
  66 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  67 General Public License for more details.
  68
  69 You should have received a copy of the GNU General Public License
  70 along with userv-utils; if not, see http://www.gnu.org/licenses/.
  71
  72
  73 Local variables:
  74 mode: text
  75 fill-column: 77
  76 End: