Added the `ratequeue' program.
[ashd.git] / python / doc / scgi-wsgi.doc
CommitLineData
338bee9d
FT
1scgi-wsgi(1)
2============
3
4NAME
5----
6scgi-wsgi - WSGI adapter for SCGI
7
8SYNOPSIS
9--------
0690bcf6 10*scgi-wsgi* [*-hAL*] [*-m* 'PDM-SPEC'] [*-p* 'MODPATH'] [*-t* 'HANDLING-MODEL'] [*-T* \[HOST:]'PORT'] 'HANDLER-MODULE' ['ARGS'...]
338bee9d
FT
11
12DESCRIPTION
13-----------
14
15The *scgi-wsgi* program translates SCGI requests to WSGI requests, and
16passes them to a specified Python module. It is mainly written to
17emulate the behavior of *ashd-wsgi*(1), but over SCGI instead of the
18native *ashd*(7) protocol, so please see its documentation for details
19of Python interoperation. Unlike *ashd-wsgi* which requires CPython,
20however, *scgi-wsgi* is written in pure Python using only the standard
21library, and so should be usable by any Python implementation. If
22using it under *ashd*(7), please see the documentation for
23*callscgi*(1) as well.
24
25Following *callscgi*(1) conventions, *scgi-wsgi* will, by default,
26accept connections on a socket passed on its standard input (a
27behavior which is, obviously, not available on all Python
28implementations). Use the *-T* option to listen to a TCP address
29instead.
30
31OPTIONS
32-------
33
34*-h*::
35
36 Print a brief help message to standard output and exit.
37
38*-A*::
39
40 Use the convention used by Apache's mod_wsgi module to find
41 the WSGI application object. See the PROTOCOL section of
42 *ashd-wsgi*(1) for details.
43
0690bcf6
FT
44*-L*::
45 By default, *scgi-wsgi* sets up the Python logging with a
46 logging format and for logging to standard error. The *-L*
47 option suppresses that behavior, so that any handler module
48 may set up logging itself.
49
338bee9d
FT
50*-p* 'MODPATH'::
51
52 Prepend 'MODPATH' to Python's `sys.path`; can be given multiple
53 times.
54
0690bcf6
FT
55*-t* 'HANDLING-MODEL'::
56
57 Specify the way *scgi-wsgi* handles requests. See the REQUEST
58 HANDLING section of *ashd-wsgi*(1) for details.
59
338bee9d
FT
60*-T* \[HOST:]'PORT'::
61
62 Instead of using a listening socket passed on standard input
63 to accept SCGI connections, bind a TCP socket to the 'HOST'
64 address listening for connections on 'PORT' instead. If 'HOST'
65 is not given, `localhost` is used by default.
66
62705f8e
FT
67*-m* 'PDM-SPEC'::
68
69 If the PDM library is installed on the system, create a
983f5a41 70 listening socket for connecting PDM clients according to
62705f8e
FT
71 'PDM-SPEC'.
72
338bee9d
FT
73AUTHOR
74------
75Fredrik Tolf <fredrik@dolda2000.com>
76
77SEE ALSO
78--------
79*ashd-wsgi*(1), *callscgi*(1), <http://wsgi.org/>,
80<http://www.python.ca/scgi/>