finalise 0.4.2
[userv-utils] / README
CommitLineData
4ef650d5 1This is userv-utils. It is a collection of utilities, scripts and example
2configuration files that serve both as examples for how to use userv, and in
3some cases, hopefully as useful programs and services.
f9b4e3fe 4
4ef650d5 5Please see each individual directory for any details, installation
6instructions, documentation, invididual copyright statements, and anything
7else, that is available.
f9b4e3fe 8
9If you do not know what userv is, see its WWW page at
10http://www.chiark.greenend.org.uk/~ian/userv/. For now at least, the
11userv mailing lists should be used to discuss these and other
12userv-using programs.
13
14Please send bug reports and suggestions to
15userv-maint@chiark.greenend.org.uk, or to the userv-discuss mailing
16list if you are subscribed to it.
17
18
19Here is a quick summary of the currently available utilities
20
21Directory Status Description (UC=`users can ...')
22--------------- ----- ------------------------------------------------
4ef650d5 23groupmanage Y Y A UC create groups, add/remove members, &c
5124214b 24ipif Y Y A UC create IP interfaces/VPNs (Linux-specific)
4ef650d5 25www-cgi Y B A UC provide CGIs which run as themselves
4ef650d5 26misc/mailq Y S S UC list mail queue even if sendmail forbids
27misc/ndc-reload Y S S UC reload named after editing own zone files
ef974b1a 28git-daemon Y Y Y UC safely publish git repositories on port 9418
4ef650d5 29newsrc-lg X B X Acquire list of subscribed groups from .newsrcs
f9b4e3fe 30
31Key to the Status:
4ef650d5 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:
f9b4e3fe 37 Y Released; hopefully of production quality.
5edd1887 38 B Beta. Not fully released, but hopefully useful with care.
4ef650d5 39 A Alpha. Probably buggy. Not well tested or widely used.
f9b4e3fe 40 X Example/experimental - for documentation purposes only,
41 not recommended for use.
4ef650d5 42 S Too small for this question to be relevant.
f9b4e3fe 43 Third letter is documentation:
4ef650d5 44 Y Full installation and use instructions included.
45 A Documentation is believed largely adequate, but a bit rough.
f9b4e3fe 46 P Partial documentation or hints. Good sysadmins should cope.
47 X No documentation. Good luck !
4ef650d5 48 S Too small to need any significant documentation.
f9b4e3fe 49
50userv-utils are
ef974b1a 51Copyright (C)1996-2010 Ian Jackson <ian@davenant.greenend.org.uk>.
4ef650d5 52Copyright (C)1998 David Damerell <damerell@chiark.greenend.org.uk>
711a0748 53Copyright (C)1999,2003
54 Chancellor Masters and Scholars of the University of Cambridge
ef974b1a 55Copyright (C)2010 Tony Finch <fanf@dotat.at>
f9b4e3fe 56
57All the utilities here are free software. You can redistribute it
58and/or modify them under the terms of the GNU General Public License
59as published by the Free Software Foundation; either version 2 of the
60License, or (at your option) any later version.
61
62These programs are distributed in the hope that they will be useful,
63but WITHOUT ANY WARRANTY; without even the implied warranty of
64MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
65General Public License for more details.
66
67You should have received a copy of the GNU General Public License
68along with userv-utils as the file COPYING; if not, email me at the
69address above or write to the Free Software Foundation, 59 Temple
70Place - Suite 330, Boston, MA 02111-1307, USA.
71
4ef650d5 72
5124214b 73$Id$
74
f9b4e3fe 75Local variables:
76mode: text
77fill-column: 77
78End: