mailq: Clarify set of relevant files in README.

[userv-utils] / README

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 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
userv mailing lists should be used to discuss these and other
userv-using programs.

Please send bug reports and suggestions to
userv-maint@chiark.greenend.org.uk, or to the userv-discuss mailing
list if you are subscribed to it.


Here is a quick summary of the currently available utilities

Directory	Status	Description (UC=`users can ...')
--------------- -----	------------------------------------------------
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 Y 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 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	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-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
as published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.

These programs are distributed in the hope that they will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
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
End: