Document and install psendfile.
authorFredrik Tolf <fredrik@dolda2000.com>
Sun, 3 Mar 2013 17:24:02 +0000 (18:24 +0100)
committerFredrik Tolf <fredrik@dolda2000.com>
Sun, 3 Mar 2013 17:24:02 +0000 (18:24 +0100)
doc/Makefile.am
doc/psendfile.doc [new file with mode: 0644]
doc/sendfile.doc
src/Makefile.am

index dc88692..3c4fe3d 100644 (file)
@@ -1,6 +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
+                       callfcgi.1 multifscgi.1 errlogger.1 httimed.1 \
+                       psendfile.1
 
 dist_man7_MANS = ashd.7
 
diff --git a/doc/psendfile.doc b/doc/psendfile.doc
new file mode 100644 (file)
index 0000000..91af60c
--- /dev/null
@@ -0,0 +1,43 @@
+psendfile(1)
+============
+
+NAME
+----
+psendfile - Persistent static file handler for ashd(7)
+
+SYNOPSIS
+--------
+*psendfile* [*-h*]
+
+DESCRIPTION
+-----------
+
+*psendfile* is a variant of *sendfile*(1) that runs as a persistent
+handler. Except those actions of *sendfile* explicitly triggered by
+command-line options, *psendfile* does the exact same things as
+*sendfile*, the only difference being that it runs persistently and
+handles all requests in the same process, instead of spawning a
+process per request. In doing so, it uses more persistent resources in
+order to use less resources per request. As such, *psendfile* is more
+suitable for a system under heavier load, while *sendfile* is more
+suitable for a system under light load.
+
+Accordingly, *psendfile* is a persistent handler, as defined in
+*ashd*(7). See the *sendfile*(1) manpage for all the details of it
+operations, as it mirrors that program exactly except in the special
+options it accepts.
+
+OPTIONS
+-------
+
+*-h*::
+
+       Print a brief help message to standard output and exit.
+
+AUTHOR
+------
+Fredrik Tolf <fredrik@dolda2000.com>
+
+SEE ALSO
+--------
+*sendfile*(1), *dirplex*(1), *ashd*(7)
index a958030..51356bf 100644 (file)
@@ -66,4 +66,4 @@ Fredrik Tolf <fredrik@dolda2000.com>
 
 SEE ALSO
 --------
-*dirplex*(1), *ashd*(7)
+*dirplex*(1), *psendfile*(1), *ashd*(7)
index 8a08744..5c4f895 100644 (file)
@@ -2,9 +2,7 @@ SUBDIRS = dirplex
 
 bin_PROGRAMS = htparser sendfile callcgi patplex userplex htls \
                callscgi accesslog htextauth callfcgi multifscgi \
-               errlogger httimed
-
-noinst_PROGRAMS=psendfile
+               errlogger httimed psendfile
 
 htparser_SOURCES = htparser.c htparser.h plaintcp.c ssl-gnutls.c