ipif: fix for make breakage
[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
28newsrc-lg X B X Acquire list of subscribed groups from .newsrcs
f9b4e3fe 29
30Key to the Status:
4ef650d5 31 First letter is completeness:
32 Y Complete.
33 P Partially complete, some glue or modification needed.
34 X Incomplete. Much extra stuff is required.
35 Second letter is general status:
f9b4e3fe 36 Y Released; hopefully of production quality.
5edd1887 37 B Beta. Not fully released, but hopefully useful with care.
4ef650d5 38 A Alpha. Probably buggy. Not well tested or widely used.
f9b4e3fe 39 X Example/experimental - for documentation purposes only,
40 not recommended for use.
4ef650d5 41 S Too small for this question to be relevant.
f9b4e3fe 42 Third letter is documentation:
4ef650d5 43 Y Full installation and use instructions included.
44 A Documentation is believed largely adequate, but a bit rough.
f9b4e3fe 45 P Partial documentation or hints. Good sysadmins should cope.
46 X No documentation. Good luck !
4ef650d5 47 S Too small to need any significant documentation.
f9b4e3fe 48
49userv-utils are
711a0748 50Copyright (C)1996-2000,2003 Ian Jackson <ian@davenant.greenend.org.uk>.
4ef650d5 51Copyright (C)1998 David Damerell <damerell@chiark.greenend.org.uk>
711a0748 52Copyright (C)1999,2003
53 Chancellor Masters and Scholars of the University of Cambridge
f9b4e3fe 54
55All the utilities here are free software. You can redistribute it
56and/or modify them under the terms of the GNU General Public License
57as published by the Free Software Foundation; either version 2 of the
58License, or (at your option) any later version.
59
60These programs are distributed in the hope that they will be useful,
61but WITHOUT ANY WARRANTY; without even the implied warranty of
62MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
63General Public License for more details.
64
65You should have received a copy of the GNU General Public License
66along with userv-utils as the file COPYING; if not, email me at the
67address above or write to the Free Software Foundation, 59 Temple
68Place - Suite 330, Boston, MA 02111-1307, USA.
69
4ef650d5 70
5124214b 71$Id$
72
f9b4e3fe 73Local variables:
74mode: text
75fill-column: 77
76End: