etc: Add environment option to run init.d/ashd silently.

[ashd.git] / doc / userplex.doc

diff --git a/doc/userplex.doc b/doc/userplex.doc
index e6406f4..db59dd9 100644 (file)
--- a/doc/userplex.doc
+++ b/doc/userplex.doc
@@ -7,7 +7,7 @@ userplex - User directory multiplexer for ashd(7)
 
 SYNOPSIS
 --------
-*userplex* [*-hI*] [*-g* 'GROUP'] [*-m* 'MIN-UID'] [*-d* 'PUBDIR'] ['PROGRAM' ['ARGS'...]]
+*userplex* [*-hIs*] [*-g* 'GROUP'] [*-m* 'MIN-UID'] [*-d* 'PUBDIR'] ['PROGRAM' ['ARGS'...]]
 
 DESCRIPTION
 -----------
@@ -41,8 +41,8 @@ argument. 'PUBDIR' defaults to `htpub` if no 'PROGRAM' was specified.
 
 If 'PUBDIR' was given (either by being specified explicitly, or
 implicitly if no 'PROGRAM' argument was given), it is checked for
-existence. If it does not exist, *userplex* should return a 404
-response to the client (but see BUGS below).
+existence. If it does not exist, *userplex* returns a 404 response to
+the client.
 
 If there exists a file named `~/.ashd/error` in the user's home
 directory, it will be opened in append mode and connected to the
@@ -63,6 +63,15 @@ OPTIONS
        If given, ignore any `~/.ashd/handler` file in a user's home
        directory and use only the default handler.
 
+*-s*::
+
+       If given, set the ASHD_USESYSLOG environment variable in all
+       started children. If not given, *userplex* will actively clear
+       the variable from its children instead. The presence of the
+       variable indicates to the standard ashd programs to log
+       messages to *syslog*(3) instead of printing them on standard
+       error.
+
 *-g* 'GROUP'::
 
        If given, only users that are members of the named 'GROUP'
@@ -90,6 +99,8 @@ LOGIN
 
 As part of the login procedure, *userplex* does the following:
 
+ * A new session is entered (with *setsid*(2)).
+
  * The UID, GID and auxiliary groups of the new process are changed
    accordingly. For testing purposes, *userplex* may be running as a
    user other than root, and the child process will, then, simply exit
@@ -117,12 +128,6 @@ its normal login procedure, and then *exec*(2) the *dirplex*(1)
 handler to serve files normally. Of course, the second line can be
 replaced by whatever other handler one might wish to use.
 
-BUGS
-----
-
-Currently, *userplex* does not, in fact, return a 404 response to the
-client if the 'PUBDIR' directory does not exist.
-
 AUTHOR
 ------
 Fredrik Tolf <fredrik@dolda2000.com>