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 / F278009_mod_cgi.html.en < prev    next >
Extensible Markup Language  |  2004-02-20  |  15KB  |  246 lines

  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>mod_cgi - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_cgi</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English"> en </a> |
  25. <a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
  26. <a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
  27. </div>
  28. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Execution of CGI scripts</td></tr>
  29. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  30. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>cgi_module</td></tr>
  31. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>mod_cgi.c</td></tr></table>
  32. <h3>Summary</h3>
  33.  
  34.     
  35.  
  36.     <p>Any file that has the mime type
  37.     <code>application/x-httpd-cgi</code> or handler
  38.     <code>cgi-script</code> (Apache 1.1 or later) will be treated
  39.     as a CGI script, and run by the server, with its output being
  40.     returned to the client. Files acquire this type either by
  41.     having a name containing an extension defined by the
  42.     <code class="directive"><a href="../mod/mod_mime.html#addtype">AddType</a></code> directive, or by being
  43.     in a <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>
  44.     directory.</p>
  45.  
  46.     <p>When the server invokes a CGI script, it will add a variable
  47.     called <code>DOCUMENT_ROOT</code> to the environment. This
  48.     variable will contain the value of the
  49.     <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code> configuration
  50.     variable.</p>
  51.  
  52.     <p>For an introduction to using CGI scripts with Apache, see
  53.     our tutorial on <a href="../howto/cgi.html">Dynamic Content
  54.     With CGI</a>.</p>
  55.  
  56.     <p>When using a multi-threaded MPM under unix, the module
  57.     <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code> should be used in place of
  58.     this module. At the user level, the two modules are essentially
  59.     identical.</p>
  60. </div>
  61. <div id="quickview"><h3 class="directives">Directives</h3>
  62. <ul id="toc">
  63. <li><img alt="" src="../images/down.gif" /> <a href="#scriptlog">ScriptLog</a></li>
  64. <li><img alt="" src="../images/down.gif" /> <a href="#scriptlogbuffer">ScriptLogBuffer</a></li>
  65. <li><img alt="" src="../images/down.gif" /> <a href="#scriptloglength">ScriptLogLength</a></li>
  66. </ul>
  67. <h3>Topics</h3>
  68. <ul id="topics">
  69. <li><img alt="" src="../images/down.gif" /> <a href="#env">CGI Environment variables</a></li>
  70. <li><img alt="" src="../images/down.gif" /> <a href="#cgi-debug">CGI Debugging</a></li>
  71. </ul><h3>See also</h3>
  72. <ul class="seealso">
  73. <li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li>
  74. <li><code class="directive"><a href="../mod/core.html#options">Options</a></code></li>
  75. <li><code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li>
  76. <li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
  77. <li><a href="../suexec.html">Running CGI programs under different user IDs</a></li>
  78. <li><a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI Specification</a></li>
  79. </ul></div>
  80. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  81. <div class="section">
  82. <h2><a name="env" id="env">CGI Environment variables</a></h2>
  83.     <p>The server will set the CGI environment variables as described
  84.     in the <a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI
  85.     specification</a>, with the following provisions:</p>
  86.  
  87.     <dl>
  88.       <dt>PATH_INFO</dt>
  89.  
  90.       <dd>This will not be available if the <code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code> directive is explicitly set to
  91.       <code>off</code>.  The default behavior, if <code class="directive">AcceptPathInfo</code> is not given, is that <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> will accept path info (trailing <code>
  92.       /more/path/info</code> following the script filename in the URI),
  93.       while the core server will return a 404 NOT FOUND error for requests
  94.       with additional path info. Omitting the <code class="directive">AcceptPathInfo</code> directive has the same effect as setting
  95.       it <code>On</code> for <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> requests.</dd>
  96.  
  97.       <dt>REMOTE_HOST</dt>
  98.  
  99.       <dd>This will only be set if <code class="directive"><a href="../mod/core.html#hostnamelookups">HostnameLookups</a></code> is set to <code>on</code> (it
  100.       is off by default), and if a reverse DNS lookup of the accessing
  101.       host's address indeed finds a host name.</dd>
  102.  
  103.       <dt>REMOTE_IDENT</dt>
  104.  
  105.       <dd>This will only be set if <code class="directive"><a href="../mod/core.html#identitycheck">IdentityCheck</a></code> is set to
  106.       <code>on</code> and the accessing host supports the ident
  107.       protocol. Note that the contents of this variable cannot be
  108.       relied upon because it can easily be faked, and if there is a
  109.       proxy between the client and the server, it is usually
  110.       totally useless.</dd>
  111.  
  112.       <dt>REMOTE_USER</dt>
  113.  
  114.       <dd>This will only be set if the CGI script is subject to
  115.       authentication.</dd>
  116.     </dl>
  117. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  118. <div class="section">
  119. <h2><a name="cgi-debug" id="cgi-debug">CGI Debugging</a></h2>
  120.     <p>Debugging CGI scripts has traditionally been difficult, mainly
  121.     because it has not been possible to study the output (standard
  122.     output and error) for scripts which are failing to run
  123.     properly. These directives, included in Apache 1.2 and later,
  124.     provide more detailed logging of errors when they occur.</p>
  125.  
  126.     <h3>CGI Logfile Format</h3>
  127.       <p>When configured, the CGI error log logs any CGI which does not
  128.       execute properly. Each CGI script which fails to operate causes
  129.       several lines of information to be logged. The first two lines
  130.       are always of the format:</p>
  131.  
  132.       <div class="example"><p><code>
  133.         %% [<var>time</var>] <var>request-line</var><br />
  134.         %% <var>HTTP-status</var> <var>CGI-script-filename</var>
  135.       </code></p></div>
  136.  
  137.       <p>If the error is that CGI script cannot be run, the log file
  138.       will contain an extra two lines:</p>
  139.  
  140.       <div class="example"><p><code>
  141.         %%error<br />
  142.         <var>error-message</var>
  143.       </code></p></div>
  144.  
  145.       <p>Alternatively, if the error is the result of the script
  146.       returning incorrect header information (often due to a bug in
  147.       the script), the following information is logged:</p>
  148.  
  149.       <div class="example"><p><code>
  150.         %request<br />
  151.         <var>All HTTP request headers received</var><br />
  152.         <var>POST or PUT entity (if any)</var><br />
  153.         %response<br />
  154.         <var>All headers output by the CGI script</var><br />
  155.         %stdout<br />
  156.         <var>CGI standard output</var><br />
  157.         %stderr<br />
  158.         <var>CGI standard error</var><br />
  159.       </code></p></div>
  160.  
  161.       <p>(The %stdout and %stderr parts may be missing if the script did
  162.       not output anything on standard output or standard error).</p>
  163.     
  164. </div>
  165. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  166. <div class="directive-section"><h2><a name="ScriptLog" id="ScriptLog">ScriptLog</a> <a name="scriptlog" id="scriptlog">Directive</a></h2>
  167. <table class="directive">
  168. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the CGI script error logfile</td></tr>
  169. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLog <var>file-path</var></code></td></tr>
  170. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  171. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  172. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code></td></tr>
  173. </table>
  174.     <p>The <code class="directive">ScriptLog</code> directive sets the CGI
  175.     script error logfile. If no <code class="directive">ScriptLog</code> is given,
  176.     no error log is created. If given, any CGI errors are logged into the
  177.     filename given as argument. If this is a relative file or path it is
  178.     taken relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.
  179.     </p>
  180.  
  181.     <div class="example"><h3>Example</h3><p><code>
  182.       ScriptLog logs/cgi_log
  183.     </code></p></div>
  184.  
  185.     <p>This log will be opened as the user the child processes run
  186.     as, <em>i.e.</em> the user specified in the main <code class="directive"><a href="../mod/mpm_common.html#user">User</a></code> directive. This means that
  187.     either the directory the script log is in needs to be writable
  188.     by that user or the file needs to be manually created and set
  189.     to be writable by that user. If you place the script log in
  190.     your main logs directory, do <strong>NOT</strong> change the
  191.     directory permissions to make it writable by the user the child
  192.     processes run as.</p>
  193.  
  194.     <p>Note that script logging is meant to be a debugging feature
  195.     when writing CGI scripts, and is not meant to be activated
  196.     continuously on running servers. It is not optimized for speed
  197.     or efficiency, and may have security problems if used in a
  198.     manner other than that for which it was designed.</p>
  199.  
  200. </div>
  201. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  202. <div class="directive-section"><h2><a name="ScriptLogBuffer" id="ScriptLogBuffer">ScriptLogBuffer</a> <a name="scriptlogbuffer" id="scriptlogbuffer">Directive</a></h2>
  203. <table class="directive">
  204. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum amount of PUT or POST requests that will be recorded
  205. in the scriptlog</td></tr>
  206. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogBuffer <var>bytes</var></code></td></tr>
  207. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogBuffer 1024</code></td></tr>
  208. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  209. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  210. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code></td></tr>
  211. </table>
  212.     <p>The size of any PUT or POST entity body that is logged to
  213.     the file is limited, to prevent the log file growing too big
  214.     too quickly if large bodies are being received. By default, up
  215.     to 1024 bytes are logged, but this can be changed with this
  216.     directive.</p>
  217.  
  218. </div>
  219. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  220. <div class="directive-section"><h2><a name="ScriptLogLength" id="ScriptLogLength">ScriptLogLength</a> <a name="scriptloglength" id="scriptloglength">Directive</a></h2>
  221. <table class="directive">
  222. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size limit of the CGI script logfile</td></tr>
  223. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogLength <var>bytes</var></code></td></tr>
  224. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogLength 10385760</code></td></tr>
  225. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  226. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  227. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code></td></tr>
  228. </table>
  229.     <p><code class="directive">ScriptLogLength</code> can be used to limit the
  230.     size of the CGI script logfile. Since the logfile logs a lot of
  231.     information per CGI error (all request headers, all script output)
  232.     it can grow to be a big file. To prevent problems due to unbounded
  233.     growth, this directive can be used to set an maximum file-size for
  234.     the CGI logfile. If the file exceeds this size, no more
  235.     information will be written to it.</p>
  236.  
  237. </div>
  238. </div>
  239. <div class="bottomlang">
  240. <p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English"> en </a> |
  241. <a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
  242. <a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
  243. </div><div id="footer">
  244. <p class="apache">Copyright 1999-2004 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
  245. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  246. </body></html>