ipif: "include" looks for the file in the directory where "include" appears
[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
5d439336 15ijackson@chiark.greenend.org.uk, or to the userv-discuss mailing
f9b4e3fe 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)
a04d96bc 25www-cgi Y Y A UC provide CGIs which run as themselves
be995f34 26misc/mailq* Y S S UC list mail queue even if sendmail forbids
4ef650d5 27misc/ndc-reload Y S S UC reload named after editing own zone files
5e5500ed 28misc/checkpass* Y Y S UC check own password; some can check any passwd
ef974b1a 29git-daemon Y Y Y UC safely publish git repositories on port 9418
4ef650d5 30newsrc-lg X B X Acquire list of subscribed groups from .newsrcs
40ad9f41 31dyndns Y Y Y UC edit simple DNS entries for certian domains
f9b4e3fe 32
33Key to the Status:
4ef650d5 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:
f9b4e3fe 39 Y Released; hopefully of production quality.
5edd1887 40 B Beta. Not fully released, but hopefully useful with care.
4ef650d5 41 A Alpha. Probably buggy. Not well tested or widely used.
f9b4e3fe 42 X Example/experimental - for documentation purposes only,
43 not recommended for use.
4ef650d5 44 S Too small for this question to be relevant.
f9b4e3fe 45 Third letter is documentation:
4ef650d5 46 Y Full installation and use instructions included.
47 A Documentation is believed largely adequate, but a bit rough.
f9b4e3fe 48 P Partial documentation or hints. Good sysadmins should cope.
49 X No documentation. Good luck !
4ef650d5 50 S Too small to need any significant documentation.
f9b4e3fe 51
52userv-utils are
be9d5573 53Copyright 1996-2013,2016 Ian Jackson <ijackson@chiark.greenend.org.uk>
9028e234
IJ
54Copyright 1998 David Damerell <damerell@chiark.greenend.org.uk>
55Copyright 1999,2003
711a0748 56 Chancellor Masters and Scholars of the University of Cambridge
9028e234 57Copyright 2010 Tony Finch <fanf@dotat.at>
93733bee 58Copyright 2013,2016 Mark Wooding <mdw@distorted.org.uk>
f9b4e3fe 59
9028e234
IJ
60All the utilities here are free software; you can redistribute it and/or
61modify it under the terms of the GNU General Public License as published by
62the Free Software Foundation; either version 3 of the License, or (at your
63option) any later version.
f9b4e3fe 64
9028e234
IJ
65This program is distributed in the hope that it will be useful, but
66WITHOUT ANY WARRANTY; without even the implied warranty of
f9b4e3fe 67MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
68General Public License for more details.
69
70You should have received a copy of the GNU General Public License
9028e234 71along with userv-utils; if not, see http://www.gnu.org/licenses/.
f9b4e3fe 72
4ef650d5 73
f9b4e3fe 74Local variables:
75mode: text
76fill-column: 77
77End: