1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4<html xmlns="http://www.w3.org/1999/xhtml">
5  <head>
6    <meta name="generator" content="HTML Tidy, see www.w3.org" />
7
8    <title>Apache module mod_log_referer</title>
9  </head>
10  <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
11
12  <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
13  vlink="#000080" alink="#FF0000">
14        <div align="CENTER">
15      <img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]" />
16
17      <h3>Apache HTTP Server Version 1.3</h3>
18    </div>
19
20
21    <h1 align="CENTER">Module mod_log_referer</h1>
22
23    <p>This module provides for logging of the documents which
24    reference documents on the server.</p>
25
26    <p><a href="module-dict.html#Status"
27    rel="Help"><strong>Status:</strong></a> Extension<br />
28     <a href="module-dict.html#SourceFile"
29    rel="Help"><strong>Source File:</strong></a>
30    mod_log_referer.c<br />
31     <a href="module-dict.html#ModuleIdentifier"
32    rel="Help"><strong>Module Identifier:</strong></a>
33    referer_log_module</p>
34
35    <h2>Summary</h2>
36
37    <p>This module is provided strictly for compatibility with NCSA
38    httpd, and is deprecated. We recommend you use <a
39    href="mod_log_config.html">mod_log_config</a> instead.</p>
40
41    <h2>Directives</h2>
42
43    <ul>
44      <li><a href="#refererignore">RefererIgnore</a></li>
45
46      <li><a href="#refererlog">RefererLog</a></li>
47    </ul>
48
49    <p>See also: <a
50    href="mod_log_config.html#customlog">CustomLog</a> and <a
51    href="mod_log_config.html#logformat">LogFormat</a>.</p>
52
53    <h2>Log file format</h2>
54    The log file contains a separate line for each refer. Each line
55    has the format
56
57    <blockquote>
58      <em>uri</em> <code>-&gt;</code> <em>document</em>
59    </blockquote>
60    where <em>uri</em> is the (%-escaped) URI for the document that
61    references the one requested by the client, and
62    <em>document</em> is the (%-decoded) local URL to the document
63    being referred to.
64    <hr />
65
66    <h2><a id="refererignore"
67    name="refererignore">RefererIgnore</a> directive</h2>
68
69    <a href="directive-dict.html#Syntax"
70    rel="Help"><strong>Syntax:</strong></a> RefererIgnore
71    <em>string</em> [<em>string</em>] ...<br />
72     <a href="directive-dict.html#Context"
73    rel="Help"><strong>Context:</strong></a> server config, virtual
74    host<br />
75     <a href="directive-dict.html#Status"
76    rel="Help"><strong>Status:</strong></a> Extension<br />
77     <a href="directive-dict.html#Module"
78    rel="Help"><strong>Module:</strong></a> mod_log_referer
79
80    <p>The RefererIgnore directive adds to the list of strings to
81    ignore in Referer headers. If any of the strings in the list is
82    contained in the Referer header, then no referrer information
83    will be logged for the request. Example:</p>
84
85    <blockquote>
86      <code>RefererIgnore www.ncsa.uiuc.edu</code>
87    </blockquote>
88    This avoids logging references from www.ncsa.uiuc.edu.
89    <hr />
90
91    <h2><a id="refererlog" name="refererlog">RefererLog</a>
92    directive</h2>
93
94    <a href="directive-dict.html#Syntax"
95    rel="Help"><strong>Syntax:</strong></a> RefererLog
96    <em>file-pipe</em><br />
97     <a href="directive-dict.html#Default"
98    rel="Help"><strong>Default:</strong></a> <code>RefererLog
99    logs/referer_log</code><br />
100     <a href="directive-dict.html#Context"
101    rel="Help"><strong>Context:</strong></a> server config, virtual
102    host<br />
103     <a href="directive-dict.html#Status"
104    rel="Help"><strong>Status:</strong></a> Extension<br />
105     <a href="directive-dict.html#Module"
106    rel="Help"><strong>Module:</strong></a> mod_log_referer
107
108    <p>The RefererLog directive sets the name of the file to which
109    the server will log the Referer header of incoming requests.
110    <em>File-pipe</em> is one of</p>
111
112    <dl>
113      <dt>A filename</dt>
114
115      <dd>A filename relative to the <a
116      href="core.html#serverroot">ServerRoot</a>.</dd>
117
118      <dt>`|' followed by a command</dt>
119
120      <dd>A program to receive the referrer log information on its
121      standard input. Note that a new program will not be started
122      for a VirtualHost if it inherits the RefererLog from the main
123      server.</dd>
124    </dl>
125    <strong>Security:</strong> if a program is used, then it will
126    be run under the user who started httpd. This will be root if
127    the server was started by root; be sure that the program is
128    secure.
129
130    <p><strong>Security:</strong> See the <a
131    href="../misc/security_tips.html">security tips</a> document
132    for details on why your security could be compromised if the
133    directory where logfiles are stored is writable by anyone other
134    than the user that starts the server.</p>
135
136    <p>This directive is provided for compatibility with NCSA
137    1.4.</p>
138
139    <p>    <hr />
140
141    <h3 align="CENTER">Apache HTTP Server Version 1.3</h3>
142    <a href="./"><img src="../images/index.gif" alt="Index" /></a>
143    <a href="../"><img src="../images/home.gif" alt="Home" /></a>
144
145    </p>
146  </body>
147</html>
148
149