1aab621d3c5c5157ca1525885c8ea18755e259cb
[ashd.git] / python / doc / scgi-wsgi.doc
1 scgi-wsgi(1)
2 ============
3
4 NAME
5 ----
6 scgi-wsgi - WSGI adapter for SCGI
7
8 SYNOPSIS
9 --------
10 *scgi-wsgi* [*-hA*] [*-p* 'MODPATH'] [*-T* \[HOST:]'PORT'] 'HANDLER-MODULE' ['ARGS'...]
11
12 DESCRIPTION
13 -----------
14
15 The *scgi-wsgi* program translates SCGI requests to WSGI requests, and
16 passes them to a specified Python module. It is mainly written to
17 emulate the behavior of *ashd-wsgi*(1), but over SCGI instead of the
18 native *ashd*(7) protocol, so please see its documentation for details
19 of Python interoperation. Unlike *ashd-wsgi* which requires CPython,
20 however, *scgi-wsgi* is written in pure Python using only the standard
21 library, and so should be usable by any Python implementation. If
22 using it under *ashd*(7), please see the documentation for
23 *callscgi*(1) as well.
24
25 Following *callscgi*(1) conventions, *scgi-wsgi* will, by default,
26 accept connections on a socket passed on its standard input (a
27 behavior which is, obviously, not available on all Python
28 implementations). Use the *-T* option to listen to a TCP address
29 instead.
30
31 OPTIONS
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
44 *-p* 'MODPATH'::
45
46         Prepend 'MODPATH' to Python's `sys.path`; can be given multiple
47         times.
48
49 *-T* \[HOST:]'PORT'::
50
51         Instead of using a listening socket passed on standard input
52         to accept SCGI connections, bind a TCP socket to the 'HOST'
53         address listening for connections on 'PORT' instead. If 'HOST'
54         is not given, `localhost` is used by default.
55
56 AUTHOR
57 ------
58 Fredrik Tolf <fredrik@dolda2000.com>
59
60 SEE ALSO
61 --------
62 *ashd-wsgi*(1), *callscgi*(1), <http://wsgi.org/>,
63 <http://www.python.ca/scgi/>