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