From f9b4e3fecc797d721aedd03c713c32c11dc3db3c Mon Sep 17 00:00:00 2001 From: ian Date: Tue, 9 Nov 1999 21:38:21 +0000 Subject: Some documentation. --- README | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..3c18d1b --- /dev/null +++ b/README @@ -0,0 +1,69 @@ +This is userv-utils. It is a collection of utilities and scripts that +serve both as examples for how to use userv, and in some cases, +hopefully as useful programs. + +Please see each individual directory for details, installation +instructions, documentation, invididual copyright statements, and +anything else that might be available. + +If you do not know what userv is, see its WWW page at +http://www.chiark.greenend.org.uk/~ian/userv/. For now at least, the +userv mailing lists should be used to discuss these and other +userv-using programs. + +Please send bug reports and suggestions to +userv-maint@chiark.greenend.org.uk, or to the userv-discuss mailing +list if you are subscribed to it. + + +Here is a quick summary of the currently available utilities + +Directory Status Description (UC=`users can ...') +--------------- ----- ------------------------------------------------ +groupmanage Y Y P UC create groups, add/remove members, &c +www-cgi B Y Y UC provide CGIs which run as themselves +ipif B Y X UC create IP interfaces/tunnels (Linux only) +newsrc-lg B P X Acquire list of subscribed groups from .newsrcs +misc/mailq S C X UC list mail queue even if sendmail forbids +misc/ndc-reload S C X UC reload named after editing own zone files + + +Key to the Status: + First letter is general status: + Y Released; hopefully of production quality. + B Beta. Not released, but hopefully useful with care. + A Alpha. Probably buggy. Not widely tested or debugged. + X Example/experimental - for documentation purposes only, + not recommended for use. + S Too small to be relevant + Second letter is completeness: + Y Complete. + P Partially complete, some glue or modification needed. + X Incomplete. Much extra stuff is required. + Third letter is documentation: + Y Supplied documentation is believed adequate. + P Partial documentation or hints. Good sysadmins should cope. + X No documentation. Good luck ! + +userv-utils are +Copyright (C)1996-9 Ian Jackson . + +All the utilities here are free software. You can redistribute it +and/or modify them under the terms of the GNU General Public License +as published by the Free Software Foundation; either version 2 of the +License, or (at your option) any later version. + +These programs are distributed in the hope that they will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with userv-utils as the file COPYING; if not, email me at the +address above or write to the Free Software Foundation, 59 Temple +Place - Suite 330, Boston, MA 02111-1307, USA. + +Local variables: +mode: text +fill-column: 77 +End: -- cgit v1.2.3