X-Git-Url: http://www.dolda2000.com/gitweb/?a=blobdiff_plain;f=doc%2Fhtparser.doc;h=9bace5b1c4f7f92725064e0712cec39fa78e7533;hb=58ee5c4ab4ce9be692277b520de72735494bd9f7;hp=72cc5b512fbd74a3e267224cf016159694e94029;hpb=36ee223092e3578c9b65c474793293356ddc67ad;p=ashd.git diff --git a/doc/htparser.doc b/doc/htparser.doc index 72cc5b5..9bace5b 100644 --- a/doc/htparser.doc +++ b/doc/htparser.doc @@ -3,7 +3,7 @@ htparser(1) NAME ---- -htparser - Root HTTP server for use with *ashd*(7) +htparser - Root HTTP server for use with ashd(7) SYNOPSIS -------- @@ -37,9 +37,9 @@ PORT SPECIFICATION Currently, the available 'HANDLERs' are *plain* and *ssl*, for handling plain TCP connections and SSL/TLS-protected connections, respectively. For details regarding the arguments that each handler -accept, simply run *htparser* with 'HANDLER':*help*. For example, the -command "`htparser ssl:help`" will display help for the *ssl* handler to -standard output and then exit. +accepts, simply run *htparser* with 'HANDLER'*:help*. For example, the +command "`htparser ssl:help`" will display help for the *ssl* handler +to standard output and then exit. The port specifications must be followed by the `--` argument to distinguish them from the root handler specification. @@ -53,26 +53,29 @@ OPTIONS *-S*:: - Log messages to *syslog*(3) instead of standard error. + Log messages to *syslog*(3) instead of standard error. Also + sets the ASHD_USESYSLOG environment variable in the root + handler process, which indicates to the standard ashd programs + to do the same thing. *-f*:: Daemonize after all specified ports have been successfully bound and the root handler has been started. -*-u*:: +*-u* 'USER':: Change UID to 'USER' once all specified ports have been successfully bound and the root handler has been started. 'USER' must be specified symbolically (i.e. not as a numeric UID). -*-r*:: +*-r* 'ROOT':: Change root directory to 'ROOT' once all specified ports have been successfully bound and the root handler has been started. -*-p*:: +*-p* 'PIDFILE':: After having daemonized, write the PID of the new process to 'PIDFILE'. @@ -82,19 +85,19 @@ EXAMPLES `htparser plain -- dirplex /srv/www`:: - This simple invocation will simply listen for HTTP requests on - port 80 and use *dirplex*(1) to serve files from the /srv/www + This simple invocation will listen for HTTP requests on port + 80 and use *dirplex*(1) to serve files from the /srv/www directory. `htparser plain:port=8080 -- dirplex /srv/www`:: The same as the previous example, but uses port 8080 instead, - so that it can be started without root privileges.] + so that it can be started without root privileges. `htparser plain ssl:cert=/etc/ssl/private/web.pem -- dirplex /srv/www`:: The same as above, but will listen on port 443 for SSL - connections as well. The file `/etc/ssl/privte/web.pem` needs + connections as well. The file `/etc/ssl/private/web.pem` needs to contain both the server certificate and its private key. `htparser plain -- sudo -u www-user dirplex /srv/www`:: @@ -113,6 +116,13 @@ EXAMPLES file system, so that it can start other handler programs as needed. +`htparser -f plain -- errlogger -n ashd dirplex /srv/www`:: + + The same as the first example, but will daemonize and use the + *errlogger*(1) program to ensure that any errors or other + messages written by any handler program to its stderr are + recorded in the *syslog*(3). + X-ASH HEADERS -------------