home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278255_mod_cgi.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  10KB  |  239 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.8.2.4 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_cgi.xml.meta">
  23.  
  24. <name>mod_cgi</name>
  25. <description>Execution of CGI scripts</description>
  26. <status>Base</status>
  27. <sourcefile>mod_cgi.c</sourcefile>
  28. <identifier>cgi_module</identifier>
  29.  
  30. <summary>
  31.     <!-- XXX: Should mention Options ExecCGI
  32.           is the link to howto/cgi not sufficient? -nd
  33.     -->
  34.  
  35.     <p>Any file that has the mime type
  36.     <code>application/x-httpd-cgi</code> or handler
  37.     <code>cgi-script</code> (Apache 1.1 or later) will be treated
  38.     as a CGI script, and run by the server, with its output being
  39.     returned to the client. Files acquire this type either by
  40.     having a name containing an extension defined by the
  41.     <directive module="mod_mime">AddType</directive> directive, or by being
  42.     in a <directive module="mod_alias">ScriptAlias</directive>
  43.     directory.</p>
  44.  
  45.     <p>When the server invokes a CGI script, it will add a variable
  46.     called <code>DOCUMENT_ROOT</code> to the environment. This
  47.     variable will contain the value of the
  48.     <directive module="core">DocumentRoot</directive> configuration
  49.     variable.</p>
  50.  
  51.     <p>For an introduction to using CGI scripts with Apache, see
  52.     our tutorial on <a href="../howto/cgi.html">Dynamic Content
  53.     With CGI</a>.</p>
  54.  
  55.     <p>When using a multi-threaded MPM under unix, the module
  56.     <module>mod_cgid</module> should be used in place of
  57.     this module. At the user level, the two modules are essentially
  58.     identical.</p>
  59. </summary>
  60.  
  61. <seealso><directive module="core">AcceptPathInfo</directive></seealso>
  62. <seealso><directive module="core">Options</directive></seealso>
  63. <seealso><directive module="mod_alias">ScriptAlias</directive></seealso>
  64. <seealso><directive module="mod_mime">AddHandler</directive></seealso>
  65. <seealso><a href="../suexec.html">Running CGI programs under different user IDs</a></seealso>
  66. <seealso><a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI Specification</a></seealso>
  67.  
  68. <section id="env"><title>CGI Environment variables</title>
  69.     <p>The server will set the CGI environment variables as described
  70.     in the <a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI
  71.     specification</a>, with the following provisions:</p>
  72.  
  73.     <dl>
  74.       <dt>PATH_INFO</dt>
  75.  
  76.       <dd>This will not be available if the <directive module="core"
  77.       >AcceptPathInfo</directive> directive is explicitly set to
  78.       <code>off</code>.  The default behavior, if <directive
  79.       >AcceptPathInfo</directive> is not given, is that <module
  80.       >mod_cgi</module> will accept path info (trailing <code>
  81.       /more/path/info</code> following the script filename in the URI),
  82.       while the core server will return a 404 NOT FOUND error for requests
  83.       with additional path info. Omitting the <directive
  84.       >AcceptPathInfo</directive> directive has the same effect as setting
  85.       it <code>On</code> for <module>mod_cgi</module> requests.</dd>
  86.  
  87.       <dt>REMOTE_HOST</dt>
  88.  
  89.       <dd>This will only be set if <directive module="core"
  90.       >HostnameLookups</directive> is set to <code>on</code> (it
  91.       is off by default), and if a reverse DNS lookup of the accessing
  92.       host's address indeed finds a host name.</dd>
  93.  
  94.       <dt>REMOTE_IDENT</dt>
  95.  
  96.       <dd>This will only be set if <directive module="core"
  97.       >IdentityCheck</directive> is set to
  98.       <code>on</code> and the accessing host supports the ident
  99.       protocol. Note that the contents of this variable cannot be
  100.       relied upon because it can easily be faked, and if there is a
  101.       proxy between the client and the server, it is usually
  102.       totally useless.</dd>
  103.  
  104.       <dt>REMOTE_USER</dt>
  105.  
  106.       <dd>This will only be set if the CGI script is subject to
  107.       authentication.</dd>
  108.     </dl>
  109. </section>
  110.  
  111. <section id="cgi-debug"><title>CGI Debugging</title>
  112.     <p>Debugging CGI scripts has traditionally been difficult, mainly
  113.     because it has not been possible to study the output (standard
  114.     output and error) for scripts which are failing to run
  115.     properly. These directives, included in Apache 1.2 and later,
  116.     provide more detailed logging of errors when they occur.</p>
  117.  
  118.     <section><title>CGI Logfile Format</title>
  119.       <p>When configured, the CGI error log logs any CGI which does not
  120.       execute properly. Each CGI script which fails to operate causes
  121.       several lines of information to be logged. The first two lines
  122.       are always of the format:</p>
  123.  
  124.       <example>
  125.         %% [<var>time</var>] <var>request-line</var><br />
  126.         %% <var>HTTP-status</var> <var>CGI-script-filename</var>
  127.       </example>
  128.  
  129.       <p>If the error is that CGI script cannot be run, the log file
  130.       will contain an extra two lines:</p>
  131.  
  132.       <example>
  133.         %%error<br />
  134.         <var>error-message</var>
  135.       </example>
  136.  
  137.       <p>Alternatively, if the error is the result of the script
  138.       returning incorrect header information (often due to a bug in
  139.       the script), the following information is logged:</p>
  140.  
  141.       <example>
  142.         %request<br />
  143.         <var>All HTTP request headers received</var><br />
  144.         <var>POST or PUT entity (if any)</var><br />
  145.         %response<br />
  146.         <var>All headers output by the CGI script</var><br />
  147.         %stdout<br />
  148.         <var>CGI standard output</var><br />
  149.         %stderr<br />
  150.         <var>CGI standard error</var><br />
  151.       </example>
  152.  
  153.       <p>(The %stdout and %stderr parts may be missing if the script did
  154.       not output anything on standard output or standard error).</p>
  155.     </section>
  156. </section>
  157.  
  158. <directivesynopsis>
  159. <name>ScriptLog</name>
  160. <description>Location of the CGI script error logfile</description>
  161. <syntax>ScriptLog <var>file-path</var></syntax>
  162. <contextlist><context>server config</context>
  163. <context>virtual host</context></contextlist>
  164. <modulelist><module>mod_cgi</module><module>mod_cgid</module>
  165. </modulelist>
  166.  
  167. <usage>
  168.     <p>The <directive>ScriptLog</directive> directive sets the CGI
  169.     script error logfile. If no <directive>ScriptLog</directive> is given,
  170.     no error log is created. If given, any CGI errors are logged into the
  171.     filename given as argument. If this is a relative file or path it is
  172.     taken relative to the <directive module="core">ServerRoot</directive>.
  173.     </p>
  174.  
  175.     <example><title>Example</title>
  176.       ScriptLog logs/cgi_log
  177.     </example>
  178.  
  179.     <p>This log will be opened as the user the child processes run
  180.     as, <em>i.e.</em> the user specified in the main <directive
  181.     module="mpm_common">User</directive> directive. This means that
  182.     either the directory the script log is in needs to be writable
  183.     by that user or the file needs to be manually created and set
  184.     to be writable by that user. If you place the script log in
  185.     your main logs directory, do <strong>NOT</strong> change the
  186.     directory permissions to make it writable by the user the child
  187.     processes run as.</p>
  188.  
  189.     <p>Note that script logging is meant to be a debugging feature
  190.     when writing CGI scripts, and is not meant to be activated
  191.     continuously on running servers. It is not optimized for speed
  192.     or efficiency, and may have security problems if used in a
  193.     manner other than that for which it was designed.</p>
  194. </usage>
  195. </directivesynopsis>
  196.  
  197. <directivesynopsis>
  198. <name>ScriptLogLength</name>
  199. <description>Size limit of the CGI script logfile</description>
  200. <syntax>ScriptLogLength <var>bytes</var></syntax>
  201. <default>ScriptLogLength 10385760</default>
  202. <contextlist><context>server config</context>
  203. <context>virtual host</context></contextlist>
  204. <modulelist><module>mod_cgi</module><module>mod_cgid</module>
  205. </modulelist>
  206.  
  207. <usage>
  208.     <p><directive>ScriptLogLength</directive> can be used to limit the
  209.     size of the CGI script logfile. Since the logfile logs a lot of
  210.     information per CGI error (all request headers, all script output)
  211.     it can grow to be a big file. To prevent problems due to unbounded
  212.     growth, this directive can be used to set an maximum file-size for
  213.     the CGI logfile. If the file exceeds this size, no more
  214.     information will be written to it.</p>
  215. </usage>
  216. </directivesynopsis>
  217.  
  218. <directivesynopsis>
  219. <name>ScriptLogBuffer</name>
  220. <description>Maximum amount of PUT or POST requests that will be recorded
  221. in the scriptlog</description>
  222. <syntax>ScriptLogBuffer <var>bytes</var></syntax>
  223. <default>ScriptLogBuffer 1024</default>
  224. <contextlist><context>server config</context>
  225. <context>virtual host</context></contextlist>
  226. <modulelist><module>mod_cgi</module><module>mod_cgid</module>
  227. </modulelist>
  228.  
  229. <usage>
  230.     <p>The size of any PUT or POST entity body that is logged to
  231.     the file is limited, to prevent the log file growing too big
  232.     too quickly if large bodies are being received. By default, up
  233.     to 1024 bytes are logged, but this can be changed with this
  234.     directive.</p>
  235. </usage>
  236. </directivesynopsis>
  237.  
  238. </modulesynopsis>
  239.