doc: Documented httrcall.
authorFredrik Tolf <fredrik@dolda2000.com>
Thu, 13 Feb 2014 02:37:10 +0000 (03:37 +0100)
committerFredrik Tolf <fredrik@dolda2000.com>
Thu, 13 Feb 2014 02:37:10 +0000 (03:37 +0100)
doc/Makefile.am
doc/httrcall.doc [new file with mode: 0644]

index 3c4fe3d..28c3d2c 100644 (file)
@@ -1,7 +1,7 @@
 dist_man1_MANS =       callcgi.1 dirplex.1 htparser.1 patplex.1 sendfile.1 \
                        userplex.1 htls.1 callscgi.1 accesslog.1 htextauth.1 \
                        callfcgi.1 multifscgi.1 errlogger.1 httimed.1 \
-                       psendfile.1
+                       psendfile.1 httrcall.1
 
 dist_man7_MANS = ashd.7
 
diff --git a/doc/httrcall.doc b/doc/httrcall.doc
new file mode 100644 (file)
index 0000000..c4fa48e
--- /dev/null
@@ -0,0 +1,38 @@
+httrcall(1)
+==========
+
+NAME
+----
+httrcall - Call transient ashd handlers
+
+SYNOPSIS
+--------
+*httrcall* [*-h*] 'PROGRAM' ['ARGS'...]
+
+DESCRIPTION
+-----------
+
+*httrcall* is a persistent handler, as defined in *ashd*(7), but works
+by starting a specified transient handler for every incoming
+request. Thus, it can be used to run transient handlers where normally
+only persistent handlers are accepted, such as for the program
+specified to *accesslog*(1), *htextauth*(1) or even *htparser*(1).
+
+The transient handler to call is specified by the 'PROGRAM'
+argument. Any 'ARGS' given are prepended to the usual arguments for
+transient handlers, as described in *ashd*(7).
+
+OPTIONS
+-------
+
+*-h*::
+
+       Print a brief help message to standard output and exit.
+
+AUTHOR
+------
+Fredrik Tolf <fredrik@dolda2000.com>
+
+SEE ALSO
+--------
+*ashd*(7)