From d74d0e6b4e0a58d7b0a2f2ae26c8f3919c41a0af Mon Sep 17 00:00:00 2001 From: =?utf8?q?Andr=C3=A9=20Malo?= Date: Wed, 6 Nov 2002 03:37:59 +0000 Subject: [PATCH] - -> - add s to AcceptPathInfo and the CGI spec - little markup improvements - whitespace reformatting -> update transformations git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97421 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_cgi.html.en | 111 +++++++++++----------- docs/manual/mod/mod_cgi.xml | 122 +++++++++++++------------ docs/manual/mod/quickreference.html.en | 6 +- 3 files changed, 126 insertions(+), 113 deletions(-) diff --git a/docs/manual/mod/mod_cgi.html.en b/docs/manual/mod/mod_cgi.html.en index 567f812725..904ce40438 100644 --- a/docs/manual/mod/mod_cgi.html.en +++ b/docs/manual/mod/mod_cgi.html.en @@ -10,8 +10,6 @@ cgi_moduleSource File: mod_cgi.c

Summary

- -

Any file that has the mime type application/x-httpd-cgi or handler @@ -40,7 +38,7 @@

Directives

Topics

See also

top

CGI Environment variables

+

Topics

See also

top

CGI Environment variables

The server will set the CGI environment variables as described in the CGI specification, with the following provisions:

@@ -49,13 +47,11 @@
PATH_INFO
This will not be available if the AcceptPathInfo directive is explicitly set to - off. The default behavior, if AcceptPathInfo is - not given, is that mod_cgi will accept path info (trailing - /more/path/info following the script filename in the URI), while - the core server will return a 404 NOT FOUND error for requests - with additional path info. Omitting the AcceptPathInfo - directive has the same effect as setting it on for - mod_cgi requests.
+ off. The default behavior, if AcceptPathInfo is not given, is that mod_cgi will accept path info (trailing + /more/path/info following the script filename in the URI), + while the core server will return a 404 NOT FOUND error for requests + with additional path info. Omitting the AcceptPathInfo directive has the same effect as setting + it On for mod_cgi requests.
REMOTE_HOST
@@ -77,63 +73,70 @@
This will only be set if the CGI script is subject to authentication.
-
top

CGI Debugging

+
top

CGI Debugging

Debugging CGI scripts has traditionally been difficult, mainly because it has not been possible to study the output (standard output and error) for scripts which are failing to run properly. These directives, included in Apache 1.2 and later, - provide more detailed logging of errors when they occur.

- -

CGI Logfile Format

-

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:

-

- %% [time] request-line
- %% HTTP-status CGI-script-filename -

-

If the error is that CGI script cannot be run, the log file - will contain an extra two lines:

-

- %%error
- error-message -

-

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:

-

- %request
- All HTTP request headers received
- POST or PUT entity (if any)
- %response
- All headers output by the CGI script
- %stdout
- CGI standard output
- %stderr
- CGI standard error
-

-

(The %stdout and %stderr parts may be missing if the script did - not output anything on standard output or standard error).

- + provide more detailed logging of errors when they occur.

+ +

CGI Logfile Format

+

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:

+ +

+ %% [time] request-line
+ %% HTTP-status CGI-script-filename +

+ +

If the error is that CGI script cannot be run, the log file + will contain an extra two lines:

+ +

+ %%error
+ error-message +

+ +

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:

+ +

+ %request
+ All HTTP request headers received
+ POST or PUT entity (if any)
+ %response
+ All headers output by the CGI script
+ %stdout
+ CGI standard output
+ %stderr
+ CGI standard error
+

+ +

(The %stdout and %stderr parts may be missing if the script did + not output anything on standard output or standard error).

+
top

ScriptLog Directive

Description: Location of the CGI script error logfile
Syntax: - ScriptLog file-path
Context: + ScriptLog file-path
Context: server config, virtual host
Status: Base
Module: mod_cgi, mod_cgid

The ScriptLog 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 ServerRoot.

+ 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 ServerRoot. +

Example

- ScriptLog logs/cgi_log + ScriptLog logs/cgi_log

This log will be opened as the user the child processes run - as, ie. the user specified in the main User directive. This means that + as, i.e. the user specified in the main User directive. This means that either the directory the script log is in needs to be writable by that user or the file needs to be manually created and set to be writable by that user. If you place the script log in @@ -149,7 +152,7 @@

top

ScriptLogBuffer Directive

Description: Maximum amount of PUT or POST requests that will be recorded in the scriptlog
Syntax: - ScriptLogBuffer bytes
Default: + ScriptLogBuffer bytes
Default: ScriptLogBuffer 1024
Context: server config, virtual host
Status: Base
Module: @@ -161,7 +164,7 @@ in the scriptlog
Syntax: directive.

top

ScriptLogLength Directive

and designates the target as a CGI script - - + - +
Description: Size limit of the CGI script logfile
Syntax: - ScriptLogLength bytes
Default: + ScriptLogLength bytes
Default: ScriptLogLength 10385760
Context: server config, virtual host
Status: Base
Module: diff --git a/docs/manual/mod/mod_cgi.xml b/docs/manual/mod/mod_cgi.xml index a2ad952e05..be37294211 100644 --- a/docs/manual/mod/mod_cgi.xml +++ b/docs/manual/mod/mod_cgi.xml @@ -10,9 +10,9 @@ cgi_module - - - +

Any file that has the mime type application/x-httpd-cgi or handler @@ -40,11 +40,13 @@ identical.

 +AcceptPathInfo Options ScriptAlias AddHandler +CGI Specification -
CGI Environment variables +
CGI Environment variables

The server will set the CGI environment variables as described in the CGI specification, with the following provisions:

@@ -54,13 +56,14 @@
This will not be available if the AcceptPathInfo directive is explicitly set to - off. The default behavior, if AcceptPathInfo is - not given, is that mod_cgi will accept path info (trailing - /more/path/info following the script filename in the URI), while - the core server will return a 404 NOT FOUND error for requests - with additional path info. Omitting the AcceptPathInfo - directive has the same effect as setting it on for - mod_cgi requests.
+ off. The default behavior, if AcceptPathInfo is not given, is that mod_cgi will accept path info (trailing + /more/path/info following the script filename in the URI), + while the core server will return a 404 NOT FOUND error for requests + with additional path info. Omitting the AcceptPathInfo directive has the same effect as setting + it On for mod_cgi requests.
REMOTE_HOST
@@ -86,51 +89,57 @@
-
CGI Debugging +
CGI Debugging

Debugging CGI scripts has traditionally been difficult, mainly because it has not been possible to study the output (standard output and error) for scripts which are failing to run properly. These directives, included in Apache 1.2 and later, - provide more detailed logging of errors when they occur.

- -
CGI Logfile Format -

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:

- - %% [time] request-line
- %% HTTP-status CGI-script-filename - -

If the error is that CGI script cannot be run, the log file - will contain an extra two lines:

- - %%error
- error-message - -

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:

- - %request
- All HTTP request headers received
- POST or PUT entity (if any)
- %response
- All headers output by the CGI script
- %stdout
- CGI standard output
- %stderr
- CGI standard error
- -

(The %stdout and %stderr parts may be missing if the script did - not output anything on standard output or standard error).

-
+ provide more detailed logging of errors when they occur.

+ +
CGI Logfile Format +

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:

+ + + %% [time] request-line
+ %% HTTP-status CGI-script-filename + + +

If the error is that CGI script cannot be run, the log file + will contain an extra two lines:

+ + + %%error
+ error-message + + +

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:

+ + + %request
+ All HTTP request headers received
+ POST or PUT entity (if any)
+ %response
+ All headers output by the CGI script
+ %stdout
+ CGI standard output
+ %stderr
+ CGI standard error
+ + +

(The %stdout and %stderr parts may be missing if the script did + not output anything on standard output or standard error).

+
ScriptLog Location of the CGI script error logfile -ScriptLog file-path +ScriptLog file-path server config virtual host mod_cgimod_cgid @@ -138,18 +147,19 @@

The ScriptLog 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 ServerRoot.

+ 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 ServerRoot. +

Example - ScriptLog logs/cgi_log + ScriptLog logs/cgi_log

This log will be opened as the user the child processes run - as, ie. the user specified in the main User directive. This means that + as, i.e. the user specified in the main User directive. This means that either the directory the script log is in needs to be writable by that user or the file needs to be manually created and set to be writable by that user. If you place the script log in @@ -168,7 +178,7 @@ ScriptLogLength Size limit of the CGI script logfile -ScriptLogLength bytes +ScriptLogLength bytes ScriptLogLength 10385760 server config virtual host @@ -190,7 +200,7 @@ ScriptLogBuffer Maximum amount of PUT or POST requests that will be recorded in the scriptlog -ScriptLogBuffer bytes +ScriptLogBuffer bytes ScriptLogBuffer 1024 server config virtual host diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 482a1c8593..1ff066ecd2 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -496,10 +496,10 @@ target as a CGI script

ScriptInterpreterSource registry|script script svdhC
Technique for locating the interpreter for CGI scripts
ScriptLog file-pathsvB
Location of the CGI script error logfile
ScriptLogBuffer bytes 1024 svB
Maximum amount of PUT or POST requests that will be recorded +
ScriptLog file-pathsvB
Location of the CGI script error logfile
ScriptLogBuffer bytes 1024 svB
Maximum amount of PUT or POST requests that will be recorded in the scriptlog
ScriptLogLength bytes 10385760 svB
Size limit of the CGI script logfile
ScriptLogLength bytes 10385760 svB
Size limit of the CGI script logfile
ScriptSock file-path logs/cgisock svB
-
SendBufferSize bytessM
TCP buffer size
ServerAdmin email-addresssvC
Email address that the server includes in error -- 2.40.0