chiark / gitweb /
www-cgi: Introduce `?DEFAULTS' pattern to match the default set.
[userv-utils.git] / README
diff --git a/README b/README
index 3c18d1bafd37be050ef66d88358ddce135d0bce2..38e1b4605686ac08e072eb8c3bb56093595d9176 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
-This is userv-utils.  It is a collection of utilities and scripts that
-serve both as examples for how to use userv, and in some cases,
-hopefully as useful programs.
+This is userv-utils.  It is a collection of utilities, scripts and example
+configuration files that serve both as examples for how to use userv, and in
+some cases, hopefully as useful programs and services.
 
-Please see each individual directory for details, installation
-instructions, documentation, invididual copyright statements, and
-anything else that might be available.
+Please see each individual directory for any details, installation
+instructions, documentation, invididual copyright statements, and anything
+else, that is available.
 
 If you do not know what userv is, see its WWW page at
 http://www.chiark.greenend.org.uk/~ian/userv/.  For now at least, the
@@ -20,33 +20,40 @@ Here is a quick summary of the currently available utilities
 
 Directory      Status  Description (UC=`users can ...')
 --------------- -----  ------------------------------------------------
-groupmanage    Y Y P   UC create groups, add/remove members, &c
-www-cgi                B Y Y   UC provide CGIs which run as themselves
-ipif           B Y X   UC create IP interfaces/tunnels (Linux only)
-newsrc-lg      B P X   Acquire list of subscribed groups from .newsrcs
-misc/mailq     S C X   UC list mail queue even if sendmail forbids
-misc/ndc-reload        S C X   UC reload named after editing own zone files
-
+groupmanage    Y Y A   UC create groups, add/remove members, &c
+ipif           Y Y A   UC create IP interfaces/VPNs (Linux-specific)
+www-cgi                Y B A   UC provide CGIs which run as themselves
+misc/mailq     Y S S   UC list mail queue even if sendmail forbids
+misc/ndc-reload        Y S S   UC reload named after editing own zone files
+misc/checkpass* Y Y S   UC check own password; some can check any passwd
+git-daemon     Y Y Y   UC safely publish git repositories on port 9418
+newsrc-lg      X B X   Acquire list of subscribed groups from .newsrcs
 
 Key to the Status:
- First letter is general status:
-   Y   Released; hopefully of production quality.
-   B   Beta.  Not released, but hopefully useful with care.
-   A   Alpha.  Probably buggy.  Not widely tested or debugged.
-   X   Example/experimental - for documentation purposes only,
-        not recommended for use.
-   S   Too small to be relevant
- Second letter is completeness:
+ First letter is completeness:
    Y   Complete.
    P   Partially complete, some glue or modification needed.
    X   Incomplete.  Much extra stuff is required.
+ Second letter is general status:
+   Y   Released; hopefully of production quality.
+   B   Beta.  Not fully released, but hopefully useful with care.
+   A   Alpha.  Probably buggy.  Not well tested or widely used.
+   X   Example/experimental - for documentation purposes only,
+        not recommended for use.
+   S   Too small for this question to be relevant.
  Third letter is documentation:
-   Y   Supplied documentation is believed adequate.
+   Y   Full installation and use instructions included.
+   A   Documentation is believed largely adequate, but a bit rough.
    P    Partial documentation or hints.  Good sysadmins should cope.
    X    No documentation.  Good luck !
+   S   Too small to need any significant documentation.
 
 userv-utils are
-Copyright (C)1996-9 Ian Jackson <ian@davenant.greenend.org.uk>.
+Copyright (C)1996-2013 Ian Jackson <ian@davenant.greenend.org.uk>.
+Copyright (C)1998 David Damerell <damerell@chiark.greenend.org.uk>
+Copyright (C)1999,2003
+   Chancellor Masters and Scholars of the University of Cambridge
+Copyright (C)2010 Tony Finch <fanf@dotat.at>
 
 All the utilities here are free software.  You can redistribute it
 and/or modify them under the terms of the GNU General Public License
@@ -63,6 +70,9 @@ along with userv-utils as the file COPYING; if not, email me at the
 address above or write to the Free Software Foundation, 59 Temple
 Place - Suite 330, Boston, MA 02111-1307, USA.
 
+
+$Id$
+
 Local variables:
 mode: text
 fill-column: 77