home *** CD-ROM | disk | FTP | other *** search
/ Cricao de Sites - 650 Layouts Prontos / WebMasters.iso / Servidores / apache_2.2.8-win32-x86-no_ssl.msi / Data1.cab / _59D42F8601B865854D26E5AD17D7AA8A < prev    next >
Extensible Markup Language  |  2007-09-01  |  15KB  |  244 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.2</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/">Documentation</a> > <a href="../">Version 2.2</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 handler
  37.     <code>cgi-script</code> 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 handler either by
  40.     having a name containing an extension defined by the
  41.     <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> directive, or by being
  42.     in a <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code>
  43.     directory.</p>
  44.  
  45.     <p>For an introduction to using CGI scripts with Apache, see
  46.     our tutorial on <a href="../howto/cgi.html">Dynamic Content
  47.     With CGI</a>.</p>
  48.  
  49.     <p>When using a multi-threaded MPM under unix, the module
  50.     <code class="module"><a href="../mod/mod_cgid.html">mod_cgid</a></code> should be used in place of
  51.     this module. At the user level, the two modules are essentially
  52.     identical.</p>
  53.     
  54.     <p>For backward-compatibility, the cgi-script handler will also be activated
  55.     for any file with the mime-type <code>application/x-httpd-cgi</code>. The
  56.     use of the magic mime-type is deprecated.</p>
  57. </div>
  58. <div id="quickview"><h3 class="directives">Directives</h3>
  59. <ul id="toc">
  60. <li><img alt="" src="../images/down.gif" /> <a href="#scriptlog">ScriptLog</a></li>
  61. <li><img alt="" src="../images/down.gif" /> <a href="#scriptlogbuffer">ScriptLogBuffer</a></li>
  62. <li><img alt="" src="../images/down.gif" /> <a href="#scriptloglength">ScriptLogLength</a></li>
  63. </ul>
  64. <h3>Topics</h3>
  65. <ul id="topics">
  66. <li><img alt="" src="../images/down.gif" /> <a href="#env">CGI Environment variables</a></li>
  67. <li><img alt="" src="../images/down.gif" /> <a href="#cgi-debug">CGI Debugging</a></li>
  68. </ul><h3>See also</h3>
  69. <ul class="seealso">
  70. <li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li>
  71. <li><code class="directive"><a href="../mod/core.html#options">Options</a></code></li>
  72. <li><code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li>
  73. <li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
  74. <li><a href="../suexec.html">Running CGI programs under different
  75.     user IDs</a></li>
  76. <li><a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI Specification</a></li>
  77. </ul></div>
  78. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  79. <div class="section">
  80. <h2><a name="env" id="env">CGI Environment variables</a></h2>
  81.     <p>The server will set the CGI environment variables as described
  82.     in the <a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI
  83.     specification</a>, with the following provisions:</p>
  84.  
  85.     <dl>
  86.       <dt>PATH_INFO</dt>
  87.  
  88.       <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
  89.       <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>
  90.       /more/path/info</code> following the script filename in the URI),
  91.       while the core server will return a 404 NOT FOUND error for requests
  92.       with additional path info. Omitting the <code class="directive">AcceptPathInfo</code> directive has the same effect as setting
  93.       it <code>On</code> for <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code> requests.</dd>
  94.  
  95.       <dt>REMOTE_HOST</dt>
  96.  
  97.       <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
  98.       is off by default), and if a reverse DNS lookup of the accessing
  99.       host's address indeed finds a host name.</dd>
  100.  
  101.       <dt>REMOTE_IDENT</dt>
  102.  
  103.       <dd>This will only be set if <code class="directive"><a href="../mod/core.html#identitycheck">IdentityCheck</a></code> is set to
  104.       <code>on</code> and the accessing host supports the ident
  105.       protocol. Note that the contents of this variable cannot be
  106.       relied upon because it can easily be faked, and if there is a
  107.       proxy between the client and the server, it is usually
  108.       totally useless.</dd>
  109.  
  110.       <dt>REMOTE_USER</dt>
  111.  
  112.       <dd>This will only be set if the CGI script is subject to
  113.       authentication.</dd>
  114.     </dl>
  115. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  116. <div class="section">
  117. <h2><a name="cgi-debug" id="cgi-debug">CGI Debugging</a></h2>
  118.     <p>Debugging CGI scripts has traditionally been difficult, mainly
  119.     because it has not been possible to study the output (standard
  120.     output and error) for scripts which are failing to run
  121.     properly. These directives, included in Apache 1.2 and later,
  122.     provide more detailed logging of errors when they occur.</p>
  123.  
  124.     <h3>CGI Logfile Format</h3>
  125.       <p>When configured, the CGI error log logs any CGI which does not
  126.       execute properly. Each CGI script which fails to operate causes
  127.       several lines of information to be logged. The first two lines
  128.       are always of the format:</p>
  129.  
  130.       <div class="example"><p><code>
  131.         %% [<var>time</var>] <var>request-line</var><br />
  132.         %% <var>HTTP-status</var> <var>CGI-script-filename</var>
  133.       </code></p></div>
  134.  
  135.       <p>If the error is that CGI script cannot be run, the log file
  136.       will contain an extra two lines:</p>
  137.  
  138.       <div class="example"><p><code>
  139.         %%error<br />
  140.         <var>error-message</var>
  141.       </code></p></div>
  142.  
  143.       <p>Alternatively, if the error is the result of the script
  144.       returning incorrect header information (often due to a bug in
  145.       the script), the following information is logged:</p>
  146.  
  147.       <div class="example"><p><code>
  148.         %request<br />
  149.         <var>All HTTP request headers received</var><br />
  150.         <var>POST or PUT entity (if any)</var><br />
  151.         %response<br />
  152.         <var>All headers output by the CGI script</var><br />
  153.         %stdout<br />
  154.         <var>CGI standard output</var><br />
  155.         %stderr<br />
  156.         <var>CGI standard error</var><br />
  157.       </code></p></div>
  158.  
  159.       <p>(The %stdout and %stderr parts may be missing if the script did
  160.       not output anything on standard output or standard error).</p>
  161.     
  162. </div>
  163. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  164. <div class="directive-section"><h2><a name="ScriptLog" id="ScriptLog">ScriptLog</a> <a name="scriptlog" id="scriptlog">Directive</a></h2>
  165. <table class="directive">
  166. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Location of the CGI script error logfile</td></tr>
  167. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLog <var>file-path</var></code></td></tr>
  168. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  169. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  170. <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>
  171. </table>
  172.     <p>The <code class="directive">ScriptLog</code> directive sets the CGI
  173.     script error logfile. If no <code class="directive">ScriptLog</code> is given,
  174.     no error log is created. If given, any CGI errors are logged into the
  175.     filename given as argument. If this is a relative file or path it is
  176.     taken relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.
  177.     </p>
  178.  
  179.     <div class="example"><h3>Example</h3><p><code>
  180.       ScriptLog logs/cgi_log
  181.     </code></p></div>
  182.  
  183.     <p>This log will be opened as the user the child processes run
  184.     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
  185.     either the directory the script log is in needs to be writable
  186.     by that user or the file needs to be manually created and set
  187.     to be writable by that user. If you place the script log in
  188.     your main logs directory, do <strong>NOT</strong> change the
  189.     directory permissions to make it writable by the user the child
  190.     processes run as.</p>
  191.  
  192.     <p>Note that script logging is meant to be a debugging feature
  193.     when writing CGI scripts, and is not meant to be activated
  194.     continuously on running servers. It is not optimized for speed
  195.     or efficiency, and may have security problems if used in a
  196.     manner other than that for which it was designed.</p>
  197.  
  198. </div>
  199. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  200. <div class="directive-section"><h2><a name="ScriptLogBuffer" id="ScriptLogBuffer">ScriptLogBuffer</a> <a name="scriptlogbuffer" id="scriptlogbuffer">Directive</a></h2>
  201. <table class="directive">
  202. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum amount of PUT or POST requests that will be recorded
  203. in the scriptlog</td></tr>
  204. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogBuffer <var>bytes</var></code></td></tr>
  205. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogBuffer 1024</code></td></tr>
  206. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  207. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  208. <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>
  209. </table>
  210.     <p>The size of any PUT or POST entity body that is logged to
  211.     the file is limited, to prevent the log file growing too big
  212.     too quickly if large bodies are being received. By default, up
  213.     to 1024 bytes are logged, but this can be changed with this
  214.     directive.</p>
  215.  
  216. </div>
  217. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  218. <div class="directive-section"><h2><a name="ScriptLogLength" id="ScriptLogLength">ScriptLogLength</a> <a name="scriptloglength" id="scriptloglength">Directive</a></h2>
  219. <table class="directive">
  220. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Size limit of the CGI script logfile</td></tr>
  221. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ScriptLogLength <var>bytes</var></code></td></tr>
  222. <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ScriptLogLength 10385760</code></td></tr>
  223. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  224. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  225. <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>
  226. </table>
  227.     <p><code class="directive">ScriptLogLength</code> can be used to limit the
  228.     size of the CGI script logfile. Since the logfile logs a lot of
  229.     information per CGI error (all request headers, all script output)
  230.     it can grow to be a big file. To prevent problems due to unbounded
  231.     growth, this directive can be used to set an maximum file-size for
  232.     the CGI logfile. If the file exceeds this size, no more
  233.     information will be written to it.</p>
  234.  
  235. </div>
  236. </div>
  237. <div class="bottomlang">
  238. <p><span>Available Languages: </span><a href="../en/mod/mod_cgi.html" title="English"> en </a> |
  239. <a href="../ja/mod/mod_cgi.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
  240. <a href="../ko/mod/mod_cgi.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
  241. </div><div id="footer">
  242. <p class="apache">Copyright 2007 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>
  243. <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>
  244. </body></html>