chiark / gitweb /
debian/control: Add missing build-dependency on flex. Fixes FTBFS. Report from Aurel...
[userv.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 1399ae8af0e4c4a204432cfd468c13023a0807fe..dafa9db3892b9cb1f7deff38e6a029a6550544d9 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -14,9 +14,7 @@ Programs:
 
 * md5sum (GNU textutils; alternatively, Colin Plumb's, as shipped with
           Debian in the `dpkg' package) - used during build only
 
 * md5sum (GNU textutils; alternatively, Colin Plumb's, as shipped with
           Debian in the `dpkg' package) - used during build only
-* GNU m4 [fixme: should ship the output]
 * GNU make
 * GNU make
-* GNU flex [fixme: should ship the output]
 * GCC is preferred but other compilers ought to work (though
   no portability testing has yet been done).  ANSI C only.
   ints must be at least 32 bits.
 * GCC is preferred but other compilers ought to work (though
   no portability testing has yet been done).  ANSI C only.
   ints must be at least 32 bits.
@@ -24,6 +22,8 @@ Programs:
   or many others.  GNU textutils has one.  NB that this `cat' is used
   at runtime and must be first on the system default PATH, so probably
   in /bin.)
   or many others.  GNU textutils has one.  NB that this `cat' is used
   at runtime and must be first on the system default PATH, so probably
   in /bin.)
+* GNU m4   } if you don't want to change those bits of source
+* GNU flex }  you can do without these
 
 C Library:
 
 
 C Library:
 
@@ -65,75 +65,16 @@ System interfaces:
 To format the documentation:
 
 * debiandoc-sgml, and hence sp (aka nsgmls) and sgmlspm.
 To format the documentation:
 
 * debiandoc-sgml, and hence sp (aka nsgmls) and sgmlspm.
-* For PostScript output, Lout and possibly psutils.
+* For PostScript output, dblatex and XeTeX.
 
 For debugging version (./configure --enable-debug):
 
 * initgroups(3) must use setgroups(2) and dynamic
   linking must allow overriding setgroups(2) for initgroups(3);
 
 
 For debugging version (./configure --enable-debug):
 
 * initgroups(3) must use setgroups(2) and dynamic
   linking must allow overriding setgroups(2) for initgroups(3);
 
-DAEMON INVOCATION:
-
-The daemon can be invoked with no arguments, in which case it will not
-fork or detach itself.  This is suitable for running from init and
-similar arrangements.
-
-With -daemon it will attempt to detach itself from the controlling
-terminal and fork/exit so that control returns at startup.
-
-In both cases diagnostics which prevent correct startup will appear on
-stderr.
-
-SYSLOG MESSAGES:
-
-The daemon issues diagnostics of various kinds to syslog, usually with
-facility LOG_DAEMON (though this can be changed in daemon.h if you want).
-The syslog levels used are:
- debug - verbose messages about the activity of the userv daemon.
- info - two log message about the nature and outcome of each request.
- notice - messages about the status of the daemon, including the
-          startup message and the hourly socket check messages.
- warning - if the uservd exits because it believes that it no longer
-          controls the rendezvous socket (ie, its socket has become
-          orphaned), this level will receive messages indicating why
-          the daemon believes this and notifying of its shutdown.
- err - a believed-recoverable error condition was detected by the
-       userv server in itself, the client or the operating system
-       (this includes resource shortages). The uservd will try to
-       continue.
- crit - the uservd detected a non-recoverable error condition
-        after startup and will exit.
- alert - not used.
- emerg - not used.
-
-The service configuration language has the facility to direct error
-and warning messages to syslog.  The default facility and level is
-user.err, but the author of the configuration file(s) can override
-this.
-
-DAEMON EXIT STATUS:
-
-The daemon's exit code will reflect how well things went:
-
- 0 - The daemon was asked to detach itself from the controlling
-     terminal and this appears to have been done successfully.
- 1* - The daemon got a SIGTERM or SIGINT and shut itself down.
- 2* - The daemon believes that it was no longer the uservd and so has
-      exited to clean itself up.
- 3 - uservd was started with incorrect arguments.
- 4 - A system call failure or other environmental problem occurred
-     during startup.
- 5* - There was a non-recoverable error after startup; the uservd had
-      to exit.
- 6 - The daemon was asked to detach itself, but its detaching child
-     died for some unexpected reason.
-
- SIGABRT/SIGIOT* - an unexpected internal error, usually caused by a
-   bug in uservd.  This can also occur if an attempt to block signals
-   using sigprocmask fails.
-
-Outcomes marked * are not possible if the daemon is asked to detach
-itself - these exit statuses will be reaped by init instead.
+EXIT STATUS CODES
+
+For information about uservd's exit status, see uservd(8).
 
 The daemon's per-request children will note the success level of its
 request in its exit status.  This will not usually be logged unless it
 
 The daemon's per-request children will note the success level of its
 request in its exit status.  This will not usually be logged unless it
@@ -231,11 +172,12 @@ COPYRIGHT
 This file, INSTALL, contains installation instructions and other
 details for userv.
 
 This file, INSTALL, contains installation instructions and other
 details for userv.
 
-userv is Copyright (C)1996-9 Ian Jackson <ian@davenant.greenend.org.uk>.
+userv is copyright Ian Jackson and other contributors.
+See README for full authorship information.
 
 userv is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
 
 userv is free software; you can redistribute it and/or modify it 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
+Software Foundation; either version 3 of the License, or (at your
 option) any later version.
 
 This program is distributed in the hope that it will be useful, but
 option) any later version.
 
 This program is distributed in the hope that it will be useful, but
@@ -244,6 +186,4 @@ 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
 General Public License for more details.
 
 You should have received a copy of the GNU General Public License
-along with userv 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.
+along with this program.  If not, see <http://www.gnu.org/licenses/>.