You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by nd...@apache.org on 2002/11/18 01:29:45 UTC
cvs commit: httpd-2.0/docs/manual/mod mod_log_config.html.en quickreference.html.en
nd 2002/11/17 16:29:45
Modified: docs/manual/mod mod_log_config.html.en
quickreference.html.en
Log:
update transformation
Revision Changes Path
1.20 +185 -223 httpd-2.0/docs/manual/mod/mod_log_config.html.en
Index: mod_log_config.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_log_config.html.en,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- mod_log_config.html.en 5 Nov 2002 19:05:22 -0000 1.19
+++ mod_log_config.html.en 18 Nov 2002 00:29:45 -0000 1.20
@@ -9,7 +9,6 @@
</a></th><td>Base</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:
</a></th><td>log_config_module</td></tr><tr><th><a href="module-dict.html#SourceFile">Source�File:
</a></th><td>mod_log_config.c</td></tr></table><h3>Summary</h3>
-
<p>This module provides for flexible logging of client
requests. Logs are written in a customizable format, and may be
written directly to a file, or to an external program.
@@ -18,21 +17,18 @@
of the request.</p>
<p>Three directives are provided by this module:
- <code>TransferLog</code> to create a log file,
- <code>LogFormat</code> to set a custom format, and
- <code>CustomLog</code> to define a log file and format in one
- step. The <code>TransferLog</code> and <code>CustomLog</code>
- directives can be used multiple times in each server to cause
- each request to be logged to multiple files.</p>
+ <code class="directive"><a href="#transferlog">TransferLog</a></code> to create
+ a log file, <code class="directive"><a href="#logformat">LogFormat</a></code>
+ to set a custom format, and <code class="directive"><a href="#customlog">CustomLog</a></code> to define a log file and format in one
+ step. The <code class="directive">TransferLog</code> and <code class="directive">CustomLog</code> directives can be used multiple times in each
+ server to cause each request to be logged to multiple files.</p>
</div><div id="quickview"><h3 class="directives">Directives</h3><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#cookielog">CookieLog</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#customlog">CustomLog</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#logformat">LogFormat</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#transferlog">TransferLog</a></li>
</ul><h3>Topics</h3><ul id="topics"><li><img alt="" src="../images/down.gif" /> <a href="#formats">Custom Log Formats</a></li><li><img alt="" src="../images/down.gif" /> <a href="#security">Security Considerations</a></li></ul><h3>See also</h3><ul class="seealso"><li><a href="../logs.html">Apache Log Files</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="formats" id="formats">Custom Log Formats</a></h2>
-
- <p>The format argument to the <code>LogFormat</code> and
- <code>CustomLog</code> directives is a string. This string is
+ <p>The format argument to the <code class="directive"><a href="#logformat">LogFormat</a></code> and <code class="directive"><a href="#customlog">CustomLog</a></code> directives is a string. This string is
logged to the log file for each request. It can contain literal
characters copied into the log files and the c-type control
characters "\n" and "\t" to represent new-lines and tabs.
@@ -40,197 +36,170 @@
back-slashes.</p>
<p>The characteristics of the request itself are logged by
- placing "%" directives in the format string, which are replaced
- in the log file by the values as follows:</p>
-
-<table>
-
-<tr><td>%...a:</td>
-<td>Remote IP-address</td></tr>
-
-<tr><td>%...A:</td>
-<td>Local IP-address</td></tr>
-
-<tr><td>%...B:</td>
-<td>Bytes sent, excluding HTTP headers.</td></tr>
-
-<tr><td>%...b:</td>
-<td>Bytes sent, excluding HTTP headers. In CLF format
-i.e. a '-' rather than a 0 when no bytes are sent.</td></tr>
-
-<tr><td>%...{Foobar}C:</td>
-<td>The contents of cookie "Foobar" in the request sent to the server.</td></tr>
-
-<tr><td>%...D:</td>
-<td>The time taken to serve the request, in microseconds.</td></tr>
-
-<tr><td>%...{FOOBAR}e:</td>
-<td>The contents of the environment variable FOOBAR</td></tr>
-
-<tr><td>%...f:</td>
-<td>Filename</td></tr>
-
-<tr><td>%...h:</td>
-<td>Remote host</td></tr>
-
-<tr><td>%...H</td>
-<td>The request protocol</td></tr>
-
-<tr><td>%...{Foobar}i:</td>
-<td>The contents of Foobar: header line(s) in the request
-sent to the server.</td></tr>
-
-<tr><td>%...l:</td>
-<td>Remote logname (from identd, if supplied)</td></tr>
-
-<tr><td>%...m:</td>
-<td>The request method</td></tr>
-
-<tr><td>%...{Foobar}n:</td>
-<td>The contents of note "Foobar" from another module.</td></tr>
-
-<tr><td>%...{Foobar}o:</td>
-<td>The contents of Foobar: header line(s) in the reply.</td></tr>
-
-<tr><td>%...p:</td>
-<td>The canonical Port of the server serving the request</td></tr>
-
-<tr><td>%...P:</td>
-<td>The process ID of the child that serviced the request.</td></tr>
-
-<tr><td>%...q:</td>
-<td>The query string (prepended with a ? if a query string exists,
-otherwise an empty string)</td></tr>
-
-<tr><td>%...r:</td>
-<td>First line of request</td></tr>
-
-<tr><td>%...s:</td>
-<td>Status. For requests that got internally redirected, this is
-the status of the *original* request --- %...>s for the last.</td></tr>
-
-<tr><td>%...t:</td>
-<td>Time, in common log format time format (standard english format)</td></tr>
-
-<tr><td>%...{format}t:</td>
-<td>The time, in the form given by format, which should
-be in strftime(3) format. (potentially localized)</td></tr>
-
-<tr><td>%...T:</td>
-<td>The time taken to serve the request, in seconds.</td></tr>
-
-<tr><td>%...u:</td>
-<td>Remote user (from auth; may be bogus if return status (%s) is 401)</td></tr>
-
-<tr><td>%...U:</td>
-<td>The URL path requested, not including any query string.</td></tr>
-
-<tr><td>%...v:</td>
-<td>The canonical ServerName of the server serving the request.</td></tr>
-
-<tr><td>%...V:</td>
-<td>The server name according to the UseCanonicalName setting.</td></tr>
-
-<tr><td>%...X:</td>
-<td>Connection status when response is completed.
-<div class="example"><p><code>
-'X' = connection aborted before the response completed.<br />
-'+' = connection may be kept alive after the response is sent.<br />
-'-' = connection will be closed after the response is sent.
-</code></p></div>
-<div class="note">(This directive was %...c in late versions of Apache 1.3, but
-this conflicted with the historical ssl %...{var}c syntax.)</div>
-</td></tr>
-
-<tr><td>%...I:</td>
-<td>Bytes received, including request and headers, cannot be zero. You need to
-enable <code class="module"><a href="../mod/mod_logio.html">mod_logio</a></code> to use this.</td></tr>
-
-<tr><td>%...O:</td>
-<td>Bytes sent, including headers, cannot be zero. You need to enable
-<code class="module"><a href="../mod/mod_logio.html">mod_logio</a></code> to use this.</td></tr>
+ placing "<code>%</code>" directives in the format string, which are
+ replaced in the log file by the values as follows:</p>
+ <table class="bordered"><tr class="header"><th>Format�String</th>
+ <th>Description</th></tr>
+<tr><td><code>%...a</code></td>
+ <td>Remote IP-address</td></tr>
+<tr class="odd"><td><code>%...A</code></td>
+ <td>Local IP-address</td></tr>
+<tr><td><code>%...B</code></td>
+ <td>Bytes sent, excluding HTTP headers.</td></tr>
+<tr class="odd"><td><code>%...b</code></td>
+ <td>Bytes sent, excluding HTTP headers. In CLF format, <em>i.e.</em>
+ a '<code>-</code>' rather than a 0 when no bytes are sent.</td></tr>
+<tr><td><code>%...{<var>Foobar</var>}C</code></td>
+ <td>The contents of cookie <var>Foobar</var> in the request sent
+ to the server.</td></tr>
+<tr class="odd"><td><code>%...D</code></td>
+ <td>The time taken to serve the request, in microseconds.</td></tr>
+<tr><td><code>%...{<var>FOOBAR</var>}e</code></td>
+ <td>The contents of the environment variable
+ <var>FOOBAR</var></td></tr>
+<tr class="odd"><td><code>%...f</code></td>
+ <td>Filename</td></tr>
+<tr><td><code>%...h</code></td>
+ <td>Remote host</td></tr>
+<tr class="odd"><td><code>%...H</code></td>
+ <td>The request protocol</td></tr>
+<tr><td><code>%...{<var>Foobar</var>}i</code></td>
+ <td>The contents of <code><var>Foobar</var>:</code> header line(s)
+ in the request sent to the server.</td></tr>
+<tr class="odd"><td><code>%...l</code></td>
+ <td>Remote logname (from identd, if supplied)</td></tr>
+<tr><td><code>%...m</code></td>
+ <td>The request method</td></tr>
+<tr class="odd"><td><code>%...{<var>Foobar</var>}n</code></td>
+ <td>The contents of note <var>Foobar</var> from another
+ module.</td></tr>
+<tr><td><code>%...{<var>Foobar</var>}o</code></td>
+ <td>The contents of <code><var>Foobar</var>:</code> header line(s)
+ in the reply.</td></tr>
+<tr class="odd"><td><code>%...p</code></td>
+ <td>The canonical port of the server serving the request</td></tr>
+<tr><td><code>%...P</code></td>
+ <td>The process ID of the child that serviced the request.</td></tr>
+<tr class="odd"><td><code>%...q</code></td>
+ <td>The query string (prepended with a <code>?</code> if a query
+ string exists, otherwise an empty string)</td></tr>
+<tr><td><code>%...r</code></td>
+ <td>First line of request</td></tr>
+<tr class="odd"><td><code>%...s</code></td>
+ <td>Status. For requests that got internally redirected, this is
+ the status of the *original* request --- <code>%...>s</code>
+ for the last.</td></tr>
+<tr><td><code>%...t</code></td>
+ <td>Time, in common log format time format (standard english
+ format)</td></tr>
+<tr class="odd"><td><code>%...{<var>format</var>}t</code></td>
+ <td>The time, in the form given by format, which should be in
+ <code>strftime(3)</code> format. (potentially localized)</td></tr>
+<tr><td><code>%...T</code></td>
+ <td>The time taken to serve the request, in seconds.</td></tr>
+<tr class="odd"><td><code>%...u</code></td>
+ <td>Remote user (from auth; may be bogus if return status
+ (<code>%s</code>) is 401)</td></tr>
+<tr><td><code>%...U</code></td>
+ <td>The URL path requested, not including any query string.</td></tr>
+<tr class="odd"><td><code>%...v</code></td>
+ <td>The canonical <code class="directive"><a href="../mod/core.html#servername">ServerName</a></code>
+ of the server serving the request.</td></tr>
+<tr><td><code>%...V</code></td>
+ <td>The server name according to the <code class="directive"><a href="../mod/core.html#usecanonicalname">UseCanonicalName</a></code> setting.</td></tr>
+<tr class="odd"><td><code>%...X</code></td>
+ <td>Connection status when response is completed:
+
+ <table>
+ <tr><td><code>X</code> =</td>
+ <td>connection aborted before the response completed.</td></tr>
+ <tr><td><code>+</code> =</td>
+ <td>connection may be kept alive after the response is
+ sent.</td></tr>
+ <tr><td><code>-</code> = </td>
+ <td>connection will be closed after the response is
+ sent.</td></tr>
+ </table>
+
+ <p>(This directive was <code>%...c</code> in late versions of Apache
+ 1.3, but this conflicted with the historical ssl
+ <code>%...{<var>var</var>}c</code> syntax.)</p></td></tr>
+<tr><td><code>%...I</code></td>
+ <td>Bytes received, including request and headers, cannot be zero.
+ You need to enable <code class="module"><a href="../mod/mod_logio.html">mod_logio</a></code> to use this.</td></tr>
+<tr class="odd"><td><code>%...O</code></td>
+ <td>Bytes sent, including headers, cannot be zero. You need to
+ enable <code class="module"><a href="../mod/mod_logio.html">mod_logio</a></code> to use this.</td></tr>
</table>
- <p>The "..." can be nothing at all (<em>e.g.</em>, <code>"%h %u
- %r %s %b"</code>), or it can indicate conditions for inclusion
- of the item (which will cause it to be replaced with "-" if the
- condition is not met). The forms of condition are a list of
+ <p>The "<var>...</var>" can be nothing at all (<em>e.g.</em>,
+ <code>"%h %u %r %s %b"</code>), or it can indicate conditions for
+ inclusion of the item (which will cause it to be replaced with "-" if
+ the condition is not met). The forms of condition are a list of
HTTP status codes, which may or may not be preceded by "!".
- Thus, "%400,501{User-agent}i" logs User-agent: on 400 errors
- and 501 errors (Bad Request, Not Implemented) only;
- "%!200,304,302{Referer}i" logs Referer: on all requests which
- did <strong>not</strong> return some sort of normal status.</p>
+ Thus, "%400,501{User-agent}i" logs <code>User-agent:</code> on 400
+ errors and 501 errors (Bad Request, Not Implemented) only;
+ "%!200,304,302{Referer}i" logs <code>Referer:</code> on all requests
+ which did <em>not</em> return some sort of normal status.</p>
<p>Note that there is no escaping performed on the strings from
- %...r, %...i and %...o. This is mainly to comply with the
- requirements of the Common Log Format. This implies that
- clients can insert control characters into the log, so care
- should be taken when dealing with raw log files.</p>
+ <code>%...r</code>, <code>%...i</code> and <code>%...o</code>. This
+ is mainly to comply with the requirements of the Common Log Format.
+ This implies that clients can insert control characters into the log,
+ so care should be taken when dealing with raw log files.</p>
<p>Some commonly used log format strings are:</p>
<dl>
<dt>Common Log Format (CLF)</dt>
-
<dd><code>"%h %l %u %t \"%r\" %>s %b"</code></dd>
<dt>Common Log Format with Virtual Host</dt>
-
<dd><code>"%v %h %l %u %t \"%r\" %>s %b"</code></dd>
<dt>NCSA extended/combined log format</dt>
-
<dd><code>"%h %l %u %t \"%r\" %>s %b \"%{Referer}i\"
\"%{User-agent}i\""</code></dd>
<dt>Referer log format</dt>
-
<dd><code>"%{Referer}i -> %U"</code></dd>
<dt>Agent (Browser) log format</dt>
-
<dd><code>"%{User-agent}i"</code></dd>
</dl>
- <p>Note that the canonical <a href="core.html#servername">ServerName</a> and <a href="mpm_common.html#listen">Listen</a> of the server serving the
+ <p>Note that the canonical <code class="directive"><a href="../mod/core.html#servername">ServerName</a></code> and <code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code> of the server serving the
request are used for <code>%v</code> and <code>%p</code>
- respectively. This happens regardless of the <a href="core.html#usecanonicalname">UseCanonicalName</a> setting
+ respectively. This happens regardless of the <code class="directive"><a href="../mod/core.html#usecanonicalname">UseCanonicalName</a></code> setting
because otherwise log analysis programs would have to duplicate
the entire vhost matching algorithm in order to decide what
host really served the request.</p>
- </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="security" id="security">Security Considerations</a></h2>
-
-
-
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="security" id="security">Security Considerations</a></h2>
<p>See the <a href="../misc/security_tips.html#serverroot">security tips</a>
document for details on why your security could be compromised
if the directory where logfiles are stored is writable by
anyone other than the user that starts the server.</p>
-
- </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CookieLog" id="CookieLog">CookieLog</a> <a name="cookielog" id="cookielog">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CookieLog" id="CookieLog">CookieLog</a> <a name="cookielog" id="cookielog">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Sets filename for the logging of cookies</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><code>CookieLog <em>filename</em></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td><code>CookieLog <var>filename</var></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
</a></th><td>mod_log_config</td></tr><tr><th><a href="directive-dict.html#Compatibility">Compatibility:
- </a></th><td>Only available in Apache 1.2 and above</td></tr></table>
-
+ </a></th><td>This directive is deprecated.</td></tr></table>
<p>The <code class="directive">CookieLog</code> directive sets the
filename for logging of cookies. The filename is relative to the
- <code class="directive"><a href="../mod/core.html#serverroot">serverroot</a></code>. This directive is
+ <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>. This directive is
included only for compatibility with <code>mod_cookies</code>,
and is deprecated.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="CustomLog" id="CustomLog">CustomLog</a> <a name="customlog" id="customlog">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Sets filename and format of log file</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><code>CustomLog
- <em>file</em>|<em>pipe</em> <em>format</em>|<em>nickname</em>
- [env=[!]<em>environment-variable</em>]</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td><code>CustomLog <var>file</var>|<var>pipe</var>
+<var>format</var>|<var>nickname</var>
+[env=[!]<var>environment-variable</var>]</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
- </a></th><td>mod_log_config</td></tr><tr><th><a href="directive-dict.html#Compatibility">Compatibility:
- </a></th><td>Nickname only available in Apache 1.3 or later.
-Conditional logging available in 1.3.5 or later.</td></tr></table>
+ </a></th><td>mod_log_config</td></tr></table>
<p>The <code class="directive">CustomLog</code> directive is used to
log requests to the server. A log format is specified, and the
logging can optionally be made conditional on request
@@ -241,68 +210,67 @@
types of values:</p>
<dl>
- <dt><em>file</em></dt>
-
- <dd>A filename, relative to the <a href="core.html#serverroot">ServerRoot</a>.</dd>
-
- <dt><em>pipe</em></dt>
+ <dt><var>file</var></dt>
+ <dd>A filename, relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</dd>
+ <dt><var>pipe</var></dt>
<dd>The pipe character "<code>|</code>", followed by the path
to a program to receive the log information on its standard
- input. <strong>Security:</strong> if a program is used, then
- it will be run under the user who started httpd. This will be
- root if the server was started by root; be sure that the
- program is secure.</dd>
+ input.
+
+ <div class="warning"><h3>Security:</h3>
+ <p>If a program is used, then it will be run under the user who
+ started httpd. This will be root if the server was started by root;
+ be sure that the program is secure.</p>
+ </div></dd>
</dl>
<p>The second argument specifies what will be written to the
- log file. It can specify either a <em>nickname</em> defined by
- a previous <a href="#logformat">LogFormat</a> directive, or it
- can be an explicit <em>format</em> string as described in the
- <a href="#formats">log formats</a> section.</p>
+ log file. It can specify either a <var>nickname</var> defined by
+ a previous <code class="directive"><a href="#logformat">LogFormat</a></code>
+ directive, or it can be an explicit <var>format</var> string as
+ described in the <a href="#formats">log formats</a> section.</p>
<p>For example, the following two sets of directives have
exactly the same effect:</p>
-<div class="example"><p><code>
- # CustomLog with format nickname<br />
- LogFormat "%h %l %u %t \"%r\" %>s %b" common<br />
- CustomLog logs/access_log common<br />
-<br />
- # CustomLog with explicit format string<br />
- CustomLog logs/access_log "%h %l %u %t \"%r\" %>s %b"<br />
-</code></p></div>
+ <div class="example"><p><code>
+ # CustomLog with format nickname<br />
+ LogFormat "%h %l %u %t \"%r\" %>s %b" common<br />
+ CustomLog logs/access_log common<br />
+ <br />
+ # CustomLog with explicit format string<br />
+ CustomLog logs/access_log "%h %l %u %t \"%r\" %>s %b"
+ </code></p></div>
<p>The third argument is optional and allows the decision on
whether or not to log a particular request to be based on the
presence or absence of a particular variable in the server
environment. If the specified <a href="../env.html">environment
variable</a> is set for the request (or is not set, in the case
- of a '<code>env=!<em>name</em></code>' clause), then the
+ of a '<code>env=!<var>name</var></code>' clause), then the
request will be logged.</p>
- <p>Environment variables can be set on a <em>per</em>-request
+ <p>Environment variables can be set on a per-request
basis using the <code class="module"><a href="../mod/mod_setenvif.html">mod_setenvif</a></code>
and/or <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> modules. For
example, if you want to record requests for all GIF
images on your server in a separate logfile but not in your main
log, you can use:</p>
-<div class="example"><p><code>
- SetEnvIf Request_URI \.gif$ gif-image<br />
- CustomLog gif-requests.log common env=gif-image<br />
- CustomLog nongif-requests.log common env=!gif-image
-</code></p></div>
+ <div class="example"><p><code>
+ SetEnvIf Request_URI \.gif$ gif-image<br />
+ CustomLog gif-requests.log common env=gif-image<br />
+ CustomLog nongif-requests.log common env=!gif-image
+ </code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="LogFormat" id="LogFormat">LogFormat</a> <a name="logformat" id="logformat">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Describes a format for use in a log file</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><code>LogFormat
- <em>format</em>|<em>nickname</em> [<em>nickname</em>]</code></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td><code>LogFormat <var>format</var>|<var>nickname</var>
+[<var>nickname</var>]</code></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>LogFormat "%h %l %u %t \"%r\" %>s %b"</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
- </a></th><td>mod_log_config</td></tr><tr><th><a href="directive-dict.html#Compatibility">Compatibility:
- </a></th><td>Nickname only available in Apache 1.3 or later.
-</td></tr></table>
+ </a></th><td>mod_log_config</td></tr></table>
<p>This directive specifies the format of the access log
file.</p>
@@ -311,53 +279,47 @@
this directive sets the log format which will be used by logs
specified in subsequent <code class="directive">TransferLog</code>
directives. The single argument can specify an explicit
- <em>format</em> as discussed in <a href="#formats">custom log
+ <var>format</var> as discussed in <a href="#formats">custom log
formats</a> section above. Alternatively, it can use a
- <em>nickname</em> to refer to a log format defined in a
+ <var>nickname</var> to refer to a log format defined in a
previous <code class="directive">LogFormat</code> directive as described
below.</p>
<p>The second form of the <code class="directive">LogFormat</code>
- directive associates an explicit <em>format</em> with a
- <em>nickname</em>. This <em>nickname</em> can then be used in
+ directive associates an explicit <var>format</var> with a
+ <var>nickname</var>. This <var>nickname</var> can then be used in
subsequent <code class="directive">LogFormat</code> or
- <code class="directive">CustomLog</code> directives rather than
- repeating the entire format string. A
- <code class="directive">LogFormat</code>
- directive that defines a nickname <strong>does nothing
- else</strong> -- that is, it <em>only</em> defines the
- nickname, it doesn't actually apply the format and make it the
- default. Therefore, it will not affect subsequent
- <code class="directive">TransferLog</code> directives. In addition,
- <code class="directive">LogFormat</code> cannot use one nickname
- to define another nickname.</p>
-
- <p>For example:</p>
-
- <div class="example"><p><code>LogFormat "%v %h %l %u %t \"%r\" %>s %b"
- vhost_common</code></p></div>
-
+ <code class="directive"><a href="#customlog">CustomLog</a></code> directives
+ rather than repeating the entire format string. A
+ <code class="directive">LogFormat</code> directive that defines a nickname
+ <strong>does nothing else</strong> -- that is, it <em>only</em>
+ defines the nickname, it doesn't actually apply the format and make
+ it the default. Therefore, it will not affect subsequent
+ <code class="directive"><a href="#transferlog">TransferLog</a></code> directives.
+ In addition, <code class="directive">LogFormat</code> cannot use one nickname
+ to define another nickname. Note, that the nickname should not contain
+ percent signs (<code>%</code>).</p>
+
+ <div class="example"><h3>Example</h3><p><code>
+ LogFormat "%v %h %l %u %t \"%r\" %>s %b" vhost_common
+ </code></p></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="TransferLog" id="TransferLog">TransferLog</a> <a name="transferlog" id="transferlog">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Specifly location of a log file</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><code>TransferLog <em>file</em>|<em>pipe</em></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td><code>TransferLog <var>file</var>|<var>pipe</var></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
- </a></th><td>mod_log_config</td></tr><tr><th><a href="directive-dict.html#Compatibility">Compatibility:
- </a></th><td /></tr></table>
-
+ </a></th><td>mod_log_config</td></tr></table>
<p>This directive has exactly the same arguments and effect as
- the <code class="directive">CustomLog</code> directive, with the
- exception that it does not allow the log format to be specified
- explicitly or for conditional logging of requests. Instead, the
- log format is determined by the most recently specified
- <code class="directive">LogFormat</code> directive (which
- does not define a nickname). Common Log Format is used if no
+ the <code class="directive"><a href="#customlog">CustomLog</a></code>
+ directive, with the exception that it does not allow the log format
+ to be specified explicitly or for conditional logging of requests.
+ Instead, the log format is determined by the most recently specified
+ <code class="directive"><a href="#logformat">LogFormat</a></code> directive
+ (which does not define a nickname). Common Log Format is used if no
other format has been specified.</p>
- <p>Example:</p>
-<div class="example"><p><code>
- LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""<br />
- TransferLog logs/access_log
-</code></p></div>
-
+ <div class="example"><h3>Example</h3><p><code>
+ LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""<br />
+ TransferLog logs/access_log
+ </code></p></div>
</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><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></body></html>
1.47 +7 -7 httpd-2.0/docs/manual/mod/quickreference.html.en
Index: quickreference.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/quickreference.html.en,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -r1.46 -r1.47
--- quickreference.html.en 17 Nov 2002 01:43:20 -0000 1.46
+++ quickreference.html.en 18 Nov 2002 00:29:45 -0000 1.47
@@ -219,16 +219,16 @@
headers</td></tr>
<tr><td><a href="mod_usertrack.html#cookiedomain">CookieDomain <em>domain</em></a></td><td /><td>svdh</td><td>E</td></tr><tr><td class="descr" colspan="4">The domain to which the tracking cookie applies</td></tr>
<tr class="odd"><td><a href="mod_usertrack.html#cookieexpires">CookieExpires <em>expiry-period</em></a></td><td /><td>svdh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Expiry time for the tracking cookie</td></tr>
-<tr><td><a href="mod_log_config.html#cookielog">CookieLog <em>filename</em></a></td><td /><td>sv</td><td>B</td></tr><tr><td class="descr" colspan="4">Sets filename for the logging of cookies</td></tr>
+<tr><td><a href="mod_log_config.html#cookielog">CookieLog <var>filename</var></a></td><td /><td>sv</td><td>B</td></tr><tr><td class="descr" colspan="4">Sets filename for the logging of cookies</td></tr>
<tr class="odd"><td><a href="mod_usertrack.html#cookiename">CookieName <em>token</em></a></td><td> Apache </td><td>svdh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Name of the tracking cookie</td></tr>
<tr><td><a href="mod_usertrack.html#cookiestyle">CookieStyle
<em>Netscape|Cookie|Cookie2|RFC2109|RFC2965</em></a></td><td> Netscape </td><td>svdh</td><td>E</td></tr><tr><td class="descr" colspan="4">Format of the cookie header field</td></tr>
<tr class="odd"><td><a href="mod_usertrack.html#cookietracking">CookieTracking on|off</a></td><td> off </td><td>svdh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Enables tracking cookie</td></tr>
<tr><td><a href="mpm_common.html#coredumpdirectory">CoreDumpDirectory <var>directory</var></a></td><td /><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">Directory where Apache attempts to
switch before dumping core</td></tr>
-<tr class="odd"><td><a href="mod_log_config.html#customlog">CustomLog
- <em>file</em>|<em>pipe</em> <em>format</em>|<em>nickname</em>
- [env=[!]<em>environment-variable</em>]</a></td><td /><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sets filename and format of log file</td></tr>
+<tr class="odd"><td><a href="mod_log_config.html#customlog">CustomLog <var>file</var>|<var>pipe</var>
+<var>format</var>|<var>nickname</var>
+[env=[!]<var>environment-variable</var>]</a></td><td /><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sets filename and format of log file</td></tr>
<tr><td><a href="mod_dav.html#dav" id="D" name="D">Dav On|Off|<var>provider-name</var></a></td><td> Off </td><td>d</td><td>E</td></tr><tr><td class="descr" colspan="4">Enable WebDAV HTTP methods</td></tr>
<tr class="odd"><td><a href="mod_dav.html#davdepthinfinity">DavDepthInfinity on|off</a></td><td> off </td><td>svd</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Allow PROPFIND, Depth: Infinity requests</td></tr>
<tr><td><a href="mod_dav_fs.html#davlockdb">DavLockDB <var>file-path</var></a></td><td /><td>sv</td><td>E</td></tr><tr><td class="descr" colspan="4">Location of the DAV lock database</td></tr>
@@ -369,8 +369,8 @@
<var>regex</var>> ... </LocationMatch></a></td><td /><td>sv</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Applies the enclosed directives only to regular-expression
matching URLs</td></tr>
<tr><td><a href="mpm_common.html#lockfile">LockFile <var>filename</var></a></td><td> logs/accept.lock </td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">Location of the accept serialization lock file</td></tr>
-<tr class="odd"><td><a href="mod_log_config.html#logformat">LogFormat
- <em>format</em>|<em>nickname</em> [<em>nickname</em>]</a></td><td> "%h %l %u %t \"%r\" +</td><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Describes a format for use in a log file</td></tr>
+<tr class="odd"><td><a href="mod_log_config.html#logformat">LogFormat <var>format</var>|<var>nickname</var>
+[<var>nickname</var>]</a></td><td> "%h %l %u %t \"%r\" +</td><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Describes a format for use in a log file</td></tr>
<tr><td><a href="core.html#loglevel">LogLevel <var>level</var></a></td><td> warn </td><td>sv</td><td>C</td></tr><tr><td class="descr" colspan="4">Controls the verbosity of the ErrorLog</td></tr>
<tr class="odd"><td><a href="mpm_common.html#maxclients" id="M" name="M">MaxClients <var>number</var></a></td><td /><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Maximum number of child processes that will be created
to serve requests</td></tr>
@@ -625,7 +625,7 @@
<tr class="odd"><td><a href="mpm_netware.html#threadstacksize">ThreadStackSize <var>number</var></a></td><td> 65536 </td><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">-</td></tr>
<tr><td><a href="core.html#timeout">TimeOut <var>number</var></a></td><td> 300 </td><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Amount of time the server will wait for
certain events before failing a request</td></tr>
-<tr class="odd"><td><a href="mod_log_config.html#transferlog">TransferLog <em>file</em>|<em>pipe</em></a></td><td /><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Specifly location of a log file</td></tr>
+<tr class="odd"><td><a href="mod_log_config.html#transferlog">TransferLog <var>file</var>|<var>pipe</var></a></td><td /><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Specifly location of a log file</td></tr>
<tr><td><a href="mod_mime.html#typesconfig">TypesConfig <em>file-path</em></a></td><td> conf/mime.types </td><td>s</td><td>B</td></tr><tr><td class="descr" colspan="4">The location of the mime.types file</td></tr>
<tr class="odd"><td><a href="mod_env.html#unsetenv" id="U" name="U">UnsetEnv <var>env-variable</var> [<var>env-variable</var>]
...</a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Removes variables from the environment</td></tr>