python: Changed some messages and docstrings to reflect then Python 3 changes.
[ashd.git] / python3 / doc / ashd-wsgi3.doc
similarity index 75%
rename from python3/doc/ashd-wsgi.doc
rename to python3/doc/ashd-wsgi3.doc
index 9b950b8..0af0882 100644 (file)
@@ -1,35 +1,35 @@
-ashd-wsgi(1)
-============
+ashd-wsgi3(1)
+=============
 
 NAME
 ----
 
 NAME
 ----
-ashd-wsgi - WSGI adapter for ashd(7)
+ashd-wsgi3 - WSGI adapter for ashd(7)
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
-*ashd-wsgi* [*-hA*] [*-p* 'MODPATH'] [*-l* 'LIMIT'] 'HANDLER-MODULE' ['ARGS'...]
+*ashd-wsgi3* [*-hA*] [*-p* 'MODPATH'] [*-l* 'LIMIT'] 'HANDLER-MODULE' ['ARGS'...]
 
 DESCRIPTION
 -----------
 
 
 DESCRIPTION
 -----------
 
-The *ashd-wsgi* handler translates *ashd*(7) requests to WSGI
+The *ashd-wsgi3* handler translates *ashd*(7) requests to WSGI
 requests, and passes them to a specified Python handler module. The
 precise Python convention for doing so is described in the PROTOCOL
 section, below.
 
 requests, and passes them to a specified Python handler module. The
 precise Python convention for doing so is described in the PROTOCOL
 section, below.
 
-*ashd-wsgi* is a persistent handler, as defined in *ashd*(7). It uses
+*ashd-wsgi3* is a persistent handler, as defined in *ashd*(7). It uses
 multithreaded dispatching in a single Python interpreter, which means
 that WSGI applications that use it need to be thread-safe, but that
 they can also share all Python data structures and global variables
 between requests.
 
 multithreaded dispatching in a single Python interpreter, which means
 that WSGI applications that use it need to be thread-safe, but that
 they can also share all Python data structures and global variables
 between requests.
 
-The Python module that *ashd-wsgi* comes with also contains a standard
-handler module, `ashd.wsgidir`, which serves individual WSGI
+The Python module that *ashd-wsgi3* comes with also contains a
+standard handler module, `ashd.wsgidir`, which serves individual WSGI
 applications directly from the files in which they reside and as such
 makes this program useful as a *dirplex*(1) handler. Please see its
 Python documentation for further details.
 
 applications directly from the files in which they reside and as such
 makes this program useful as a *dirplex*(1) handler. Please see its
 Python documentation for further details.
 
-*ashd-wsgi* requires the `ashd.proto` and `ashd.util` modules, which
+*ashd-wsgi3* requires the `ashd.proto` and `ashd.util` modules, which
 are only available for CPython. If you want to use some other Python
 implementation instead, you may want to use the *scgi-wsgi*(1) program
 instead, along with *callscgi*(1).
 are only available for CPython. If you want to use some other Python
 implementation instead, you may want to use the *scgi-wsgi*(1) program
 instead, along with *callscgi*(1).
@@ -50,7 +50,7 @@ OPTIONS
 *-p* 'MODPATH'::
 
        Prepend 'MODPATH' to Python's `sys.path`; can be given multiple
 *-p* 'MODPATH'::
 
        Prepend 'MODPATH' to Python's `sys.path`; can be given multiple
-       times. Note that the working directory of *ashd-wsgi* is not
+       times. Note that the working directory of *ashd-wsgi3* is not
        on Python's module path by default, so if you want to use a
        module in that directory, you will need to specify "`-p .`".
 
        on Python's module path by default, so if you want to use a
        module in that directory, you will need to specify "`-p .`".
 
@@ -59,13 +59,13 @@ OPTIONS
        Allow at most 'LIMIT' requests to run concurrently. If a new
        request is made when 'LIMIT' requests are executing, the new
        request will wait up to ten seconds for one of them to
        Allow at most 'LIMIT' requests to run concurrently. If a new
        request is made when 'LIMIT' requests are executing, the new
        request will wait up to ten seconds for one of them to
-       complete; if none does, *ashd-wsgi* will assume that the
+       complete; if none does, *ashd-wsgi3* will assume that the
        process is foobar and *abort*(3).
 
 PROTOCOL
 --------
 
        process is foobar and *abort*(3).
 
 PROTOCOL
 --------
 
-When starting, *ashd-wsgi* will attempt to import the module named by
+When starting, *ashd-wsgi3* will attempt to import the module named by
 'HANDLER-MODULE', look for an object named `wmain` in that module,
 call that object passing the 'ARGS' (as Python strings) as positional
 parameters, and use the returned object as the WSGI application
 'HANDLER-MODULE', look for an object named `wmain` in that module,
 call that object passing the 'ARGS' (as Python strings) as positional
 parameters, and use the returned object as the WSGI application
@@ -90,20 +90,20 @@ modules directly from the filesystem.
 
 --------
 child wsgidir
 
 --------
 child wsgidir
-  exec ashd-wsgi ashd.wsgidir
+  exec ashd-wsgi3 ashd.wsgidir
 match
   filename *.wsgi
   handler wsgidir
 --------
 
 match
   filename *.wsgi
   handler wsgidir
 --------
 
-Since *ashd-wsgi* is a persistent handler, it can be used directly as
+Since *ashd-wsgi3* is a persistent handler, it can be used directly as
 a root handler for *htparser*(1). For instance, if the directory
 `/srv/www/foo` contains a `wsgi.py` file, which declares a standard
 WSGI `application` object, it can be served with the following
 command:
 
 --------
 a root handler for *htparser*(1). For instance, if the directory
 `/srv/www/foo` contains a `wsgi.py` file, which declares a standard
 WSGI `application` object, it can be served with the following
 command:
 
 --------
-htparser plain:port=8080 -- ashd-wsgi -Ap /srv/www/foo wsgi
+htparser plain:port=8080 -- ashd-wsgi3 -Ap /srv/www/foo wsgi
 --------
 
 AUTHOR
 --------
 
 AUTHOR
@@ -112,4 +112,4 @@ Fredrik Tolf <fredrik@dolda2000.com>
 
 SEE ALSO
 --------
 
 SEE ALSO
 --------
-*scgi-wsgi*(1), *ashd*(7), <http://wsgi.org/>
+*scgi-wsgi3*(1), *ashd*(7), <http://wsgi.org/>