doc: Added manpage for multifscgi.
authorFredrik Tolf <fredrik@dolda2000.com>
Sat, 30 Oct 2010 09:46:00 +0000 (11:46 +0200)
committerFredrik Tolf <fredrik@dolda2000.com>
Sat, 30 Oct 2010 09:46:00 +0000 (11:46 +0200)
doc/Makefile.am
doc/callfcgi.doc
doc/multifscgi.doc [new file with mode: 0644]

index f453b18..47e0dad 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
+                       callfcgi.1 multifscgi.1
+
 dist_man7_MANS = ashd.7
 
 %.7 %.1: %.doc
index cd07126..7326ab8 100644 (file)
@@ -21,7 +21,9 @@ protocol, so see the manpage for *callscgi* for all the details.
 
 In relation to the FastCGI protocol, it should be noted that
 *callfcgi* does not multiplex several requests over one opened FastCGI
-connection, but rather opens one connection for each request.
+connection, but rather opens one connection for each request. For
+running multiple instances of the FastCGI server program, please see
+the *multifscgi*(1) program.
 
 AUTHOR
 ------
@@ -29,4 +31,4 @@ Fredrik Tolf <fredrik@dolda2000.com>
 
 SEE ALSO
 --------
-*callscgi*(1), *ashd*(7)
+*callscgi*(1), *multifscgi*(1), *ashd*(7)
diff --git a/doc/multifscgi.doc b/doc/multifscgi.doc
new file mode 100644 (file)
index 0000000..da72323
--- /dev/null
@@ -0,0 +1,52 @@
+multifscgi(1)
+=============
+
+NAME
+----
+multifscgi - Manage multiple instances of a FastCGI or SCGI server
+
+SYNOPSIS
+--------
+*multifscgi* [*-h*] 'NUM' 'PROGRAM' ['ARGS'...]
+
+DESCRIPTION
+-----------
+
+*multifscgi* is a simple program intended to manage multiple running
+instances of a FastCGI or SCGI server. It is distributed as part of
+*ashd*(7).
+
+The utility of multifscgi lies in the fact some FastCGI or SCGI server
+programs, such as PHP, process at most one request at a time. As such,
+multiple such server processes must run simultaneously in order to
+process requests concurrently.
+
+The *multifscgi* program works simply by forking 'NUM' instances of
+whatever program it is given on its command line. As long as the SCGI
+or FastCGI listen socket is passed on standard input, it will be
+naturally inherited by those child processes, and whichever one of
+them is currently idle will be able to accept a request. If any of the
+children terminate, a new one will be started in its place.
+
+OPTIONS
+-------
+
+*-h*::
+
+       Print a brief help message to standard output and exit.
+
+SIGNALS
+-------
+
+SIGTERM, SIGINT::
+
+       Terminate cleanly be killing off any remaining child
+       processes.
+
+AUTHOR
+------
+Fredrik Tolf <fredrik@dolda2000.com>
+
+SEE ALSO
+--------
+*callscgi*(1), *callfcgi*(1), *ashd*(7)