diff options
Diffstat (limited to 'usr.sbin/httpd/htdocs/manual/mod/mod_cgi.html')
| -rw-r--r-- | usr.sbin/httpd/htdocs/manual/mod/mod_cgi.html | 193 |
1 files changed, 118 insertions, 75 deletions
diff --git a/usr.sbin/httpd/htdocs/manual/mod/mod_cgi.html b/usr.sbin/httpd/htdocs/manual/mod/mod_cgi.html index d1cfa745a5b..dd6e29277e5 100644 --- a/usr.sbin/httpd/htdocs/manual/mod/mod_cgi.html +++ b/usr.sbin/httpd/htdocs/manual/mod/mod_cgi.html @@ -1,8 +1,8 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -<title>Apache module mod_cgi</title> -</head> +<HTML> +<HEAD> +<TITLE>Apache module mod_cgi</TITLE> +</HEAD> <!-- Background white, links blue (unvisited), navy (visited), red (active) --> <BODY @@ -15,52 +15,58 @@ <DIV ALIGN="CENTER"> <IMG SRC="../images/sub.gif" ALT="[APACHE DOCUMENTATION]"> <H3> - Apache HTTP Server Version 1.2 + Apache HTTP Server Version 1.3 </H3> </DIV> -<h1 ALIGN="CENTER">Module mod_cgi</h1> +<H1 ALIGN="CENTER">Module mod_cgi</H1> -This module is contained in the <code>mod_cgi.c</code> file, and +This module is contained in the <CODE>mod_cgi.c</CODE> file, and is compiled in by default. It provides for execution of CGI scripts. -Any file with mime type <code>application/x-httpd-cgi</code> will be +Any file with mime type <CODE>application/x-httpd-cgi</CODE> will be processed by this module. <!--%plaintext <?INDEX {\tt application/x-httpd-cgi} mime type> --> <!--%plaintext <?INDEX CGI scripts> --> -<h2>Summary</h2> -Any file that has the mime type <code>application/x-httpd-cgi</code> -or handler <code>cgi-script</code> (Apache 1.1 or later) +<H2>Summary</H2> +Any file that has the mime type <CODE>application/x-httpd-cgi</CODE> +or handler <CODE>cgi-script</CODE> (Apache 1.1 or later) will be treated as a CGI script, and run by the server, with its output being returned to the client. Files acquire this type either by -having a name ending in an extension defined by the +having a name containing an extension defined by the <A HREF="mod_mime.html#addtype">AddType</A> directive, or by being in -a <A HREF="mod_alias.html#scriptalias">ScriptAlias</A> directory. <p> +a <A HREF="mod_alias.html#scriptalias">ScriptAlias</A> directory. <P> When the server invokes a CGI script, it will add a variable called -<code>DOCUMENT_ROOT</code> to the environment. This variable will contain the +<CODE>DOCUMENT_ROOT</CODE> to the environment. This variable will contain the value of the <A HREF="core.html#documentroot">DocumentRoot</A> configuration variable. -<h2>CGI Environment variables</h2> -The server will set the CGI environment variables as described in the CGI -specification, with the following provisions: -<dl> -<dt>REMOTE_HOST -<dd>This will only be set if the server has not been compiled with -<code>MINIMAL_DNS</code>. -<dt>REMOTE_IDENT -<dd>This will only be set if -<A HREF="core.html#identitycheck">IdentityCheck</A> is set to <code>on</code>. -<dt>REMOTE_USER -<dd>This will only be set if the CGI script is subject to authentication. -</dl> +<H2>CGI Environment variables</H2> +The server will set the CGI environment variables as described in the +<A HREF="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI specification</A>, with the +following provisions: +<DL> +<DT>REMOTE_HOST +<DD>This will only be set if <A HREF="core.html#hostnamelookups"><CODE>HostnameLookups</CODE></A> +is set to <CODE>on</CODE> (it is off by default), and if a reverse DNS +lookup of the accessing host's address indeed finds a host name. +<DT>REMOTE_IDENT +<DD>This will only be set if +<A HREF="core.html#identitycheck">IdentityCheck</A> is set to <CODE>on</CODE> +and the accessing host supports the ident protocol. Note that the contents +of this variable cannot be relied upon because it can easily be faked, and if +there is a proxy between the client and the server, it is usually +totally useless. +<DT>REMOTE_USER +<DD>This will only be set if the CGI script is subject to authentication. +</DL> <P> -<hr> +<HR> -<h2><a name="cgi_debug">CGI Debugging</a></h2> +<H2><A NAME="cgi_debug">CGI Debugging</A></H2> Debugging CGI scripts has traditionally been difficult, mainly because it has @@ -71,62 +77,74 @@ which are failing to run properly. These directives, included in Apache 1.2 and later, provide more detailed logging of errors when they occur. -<hr> +<HR> -<h2>CGI Logfile Format</h2> +<H2>CGI Logfile Format</H2> When configured, the CGI error log logs any CGI which does not execute properly. Each CGI script which fails to operate causes several lines of information to be logged. The first two lines are always of the format: -<pre> - %% [<i>time</i>] <i>request-line</i> - %% <i>HTTP-status</i> <i>CGI-script-filename</i> -</pre> +<PRE> + %% [<EM>time</EM>] <EM>request-line</EM> + %% <EM>HTTP-status</EM> <EM>CGI-script-filename</EM> +</PRE> If the error is that CGI script cannot be run, the log file will contain an extra two lines: -<pre> +<PRE> %%error - <i>error-message</i> -</pre> + <EM>error-message</EM> +</PRE> Alternatively, if the error is the result of the script returning incorrect header information (often due to a bug in the script), the following information is logged: -<pre> +<PRE> %request - <i>All HTTP request headers received</i> - <i>POST or PUT entity (if any)</i> + <EM>All HTTP request headers received</EM> + <EM>POST or PUT entity (if any)</EM> %response - <i>All headers output by the CGI script</i> + <EM>All headers output by the CGI script</EM> %stdout - <i>CGI standard output</i> + <EM>CGI standard output</EM> %stderr - <i>CGI standard error</i> -</pre> + <EM>CGI standard error</EM> +</PRE> (The %stdout and %stderr parts may be missing if the script did not output anything on standard output or standard error). -<hr> - -<h2>Directives</h2> - -<h3><a name="scriptlog">ScriptLog</a></h3> +<HR> -<b>Syntax:</b> ScriptLog <i>filename</i><br> -<b>Default:</b> none<br> -<b>Context:</b> resource config<br> -<b>Status:</b> mod_cgi -<p> +<H2>Directives</H2> + +<H3><A NAME="scriptlog">ScriptLog</A></H3> + +<A + HREF="directive-dict.html#Syntax" + REL="Help" +><STRONG>Syntax:</STRONG></A> ScriptLog <EM>filename</EM><BR> +<A + HREF="directive-dict.html#Default" + REL="Help" +><STRONG>Default:</STRONG></A> none<BR> +<A + HREF="directive-dict.html#Context" + REL="Help" +><STRONG>Context:</STRONG></A> server config<BR> +<A + HREF="directive-dict.html#Status" + REL="Help" +><STRONG>Status:</STRONG></A> mod_cgi +<P> -The <tt>ScriptLog</tt> directive sets the CGI script error logfile. +The <TT>ScriptLog</TT> directive sets the CGI script error logfile. If no ScriptLog is given, no error log is created. If given, any CGI errors are logged into the filename given as argument. If this is a relative file or path it is taken relative to the server root. @@ -140,34 +158,58 @@ script log in your main logs directory, do <STRONG>NOT</STRONG> change the directory permissions to make it writable by the user the child processes run as.</P> -<p>Note that script logging is meant to be a debugging feature when +<P>Note that script logging is meant to be a debugging feature when writing CGI scripts, and is not meant to be activated continuously on running servers. It is not optimized for speed or efficiency, and may have security problems if used in a manner other than that for which -it was designed.</p> - -<h3><a name="scriptloglength">ScriptLogLength</a></h3> - -<b>Syntax:</b> ScriptLogLength <i>size</i><br> -<b>Default:</b> 10385760<br> -<b>Context:</b> resource config<br> -<b>Status:</b> mod_cgi -<p> +it was designed.</P> + +<H3><A NAME="scriptloglength">ScriptLogLength</A></H3> + +<A + HREF="directive-dict.html#Syntax" + REL="Help" +><STRONG>Syntax:</STRONG></A> ScriptLogLength <EM>size</EM><BR> +<A + HREF="directive-dict.html#Default" + REL="Help" +><STRONG>Default:</STRONG></A> 10385760<BR> +<A + HREF="directive-dict.html#Context" + REL="Help" +><STRONG>Context:</STRONG></A> server config<BR> +<A + HREF="directive-dict.html#Status" + REL="Help" +><STRONG>Status:</STRONG></A> mod_cgi +<P> -<tt>ScriptLogLength</tt> can be used to limit the size of the CGI +<TT>ScriptLogLength</TT> can be used to limit the size of the CGI script logfile. Since the logfile logs a lot of information per CGI error (all request headers, all script output) it can grow to be a big file. To prevent problems due to unbounded growth, this directive can be used to set an maximum file-size for the CGI logfile. If the file exceeds this size, no more information will be written to it. -<h3><a name="scriptlogbuffer">ScriptLogBuffer</a></h3> - -<b>Syntax:</b> ScriptLogBuffer <i>size</i><br> -<b>Default:</b> 1024<br> -<b>Context:</b> resource config<br> -<b>Status:</b> mod_cgi -<p> +<H3><A NAME="scriptlogbuffer">ScriptLogBuffer</A></H3> + +<A + HREF="directive-dict.html#Syntax" + REL="Help" +><STRONG>Syntax:</STRONG></A> ScriptLogBuffer <EM>size</EM><BR> +<A + HREF="directive-dict.html#Default" + REL="Help" +><STRONG>Default:</STRONG></A> 1024<BR> +<A + HREF="directive-dict.html#Context" + REL="Help" +><STRONG>Context:</STRONG></A> server config<BR> +<A + HREF="directive-dict.html#Status" + REL="Help" +><STRONG>Status:</STRONG></A> mod_cgi +<P> The size of any PUT or POST entity body that is logged to the file is limited, to prevent the log file growing too big too quickly if large @@ -175,8 +217,9 @@ bodies are being received. By default, up to 1024 bytes are logged, but this can be changed with this directive. <HR> + <H3 ALIGN="CENTER"> - Apache HTTP Server Version 1.2 + Apache HTTP Server Version 1.3 </H3> <A HREF="./"><IMG SRC="../images/index.gif" ALT="Index"></A> |