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