6 htparser - Root HTTP server for use with *ashd*(7)
10 *htparser* [*-hSf*] [*-u* 'USER'] [*-r* 'ROOT'] [*-p* 'PIDFILE'] 'PORTSPEC'... `--` 'ROOT' ['ARGS'...]
15 The *htparser* program is the root HTTP server of *ashd*(7). It
16 listens to specified TCP ports, speaks HTTP with connecting clients,
17 and passes requests on to the root handler program.
19 When *htparser* starts, it will first begin listening to all ports
20 specified by 'PORTSPEC'. Once all ports have been bound successfully,
21 it will fork off and start the root handler specified by 'ROOT',
22 searching the *PATH* environment variable if necessary, and passing it
23 all the 'ARGS' as command-line arguments. Only after that will
24 *htparser* do any daemonizing or chrooting as specified by options.
26 The root handler must be a persistent program as specified in
27 *ashd*(7). If the handler program exits, *htparser* will exit too.
32 'PORTSPEC' is given in the form
33 'HANDLER'[*:*'PAR'[*=*'VAL'][(*,*'PAR'[*=*'VAL'])...]]. The
34 'PAR'='VAL' pairs are used for specifying key-value arguments to the
35 'HANDLER'. An example of a valid 'PORTSPEC' is `plain:port=8080`.
37 Currently, the available 'HANDLERs' are *plain* and *ssl*, for
38 handling plain TCP connections and SSL/TLS-protected connections,
39 respectively. For details regarding the arguments that each handler
40 accept, simply run *htparser* with 'HANDLER':*help*. For example, the
41 command "`htparser ssl:help`" will display help for the *ssl* handler to
42 standard output and then exit.
44 The port specifications must be followed by the `--` argument to
45 distinguish them from the root handler specification.
52 Print a brief usage message on standard output and exit.
56 Log messages to *syslog*(3) instead of standard error.
60 Daemonize after all specified ports have been successfully
61 bound and the root handler has been started.
65 Change UID to 'USER' once all specified ports have been
66 successfully bound and the root handler has been
67 started. 'USER' must be specified symbolically (i.e. not as a
72 Change root directory to 'ROOT' once all specified ports have
73 been successfully bound and the root handler has been started.
77 After having daemonized, write the PID of the new process to
83 *htparser* strips away all headers from incoming requests that begin
84 with the `X-Ash-` prefix, and adds the following headers to requests:
88 The IP address that the client connected from. May be an IPv6
93 The client-side port number of the TCP connection.
95 *X-Ash-Server-Address*::
97 The IP address of the server where the connection was
98 accepted. May be an IPv6 address.
100 *X-Ash-Server-Port*::
102 The server-side port number of the TCP connection.
106 Either *http* or *https*, depending on whether the request was
107 received by the *plain* or the *ssl* handler.
111 Fredrik Tolf <fredrik@dolda2000.com>