X-Git-Url: http://www.dolda2000.com/gitweb/?a=blobdiff_plain;f=doc%2Fhtparser.doc;h=928e642c9a241c87376820f98c81588dea4262e4;hb=295f91786e8606bed03ca004157adbeb84565094;hp=698e559173f74e02c29c84a79d6ddf002cf5c2f3;hpb=16c2bec346ae486bd09d0b18ab276b4c89005cad;p=ashd.git diff --git a/doc/htparser.doc b/doc/htparser.doc index 698e559..928e642 100644 --- a/doc/htparser.doc +++ b/doc/htparser.doc @@ -24,7 +24,8 @@ all the 'ARGS' as command-line arguments. Only after that will *htparser* do any daemonizing or chrooting as specified by options. The root handler must be a persistent program as specified in -*ashd*(7). If the handler program exits, *htparser* will exit too. +*ashd*(7). If the handler program exits, *htparser* will exit too, +following the procedure described below under SIGNALS. PORT SPECIFICATION ------------------ @@ -37,9 +38,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. @@ -63,23 +64,34 @@ OPTIONS 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'. +SIGNALS +------- + +SIGTERM, SIGINT:: + + Upon first reception, `htparser` closes all listening ports + and the socket to the root handler, but continues to serve all + currently ongoing requests until none remain, not keeping the + connections open for keep-alive. Upon second reception, + `htparser` shuts down completely. + EXAMPLES -------- @@ -92,7 +104,7 @@ EXAMPLES `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`::