You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by sl...@apache.org on 2001/07/17 22:20:22 UTC
cvs commit: httpd-2.0/docs/manual/mod core.html directive-dict.html
slive 01/07/17 13:20:22
Modified: docs/manual/mod core.html directive-dict.html
Log:
Bringing forward from 1.3: Changes to standardize the "argument types"
in the syntax entires.
Revision Changes Path
1.190 +25 -25 httpd-2.0/docs/manual/mod/core.html
Index: core.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/core.html,v
retrieving revision 1.189
retrieving revision 1.190
diff -u -d -b -u -r1.189 -r1.190
--- core.html 2001/02/27 12:28:17 1.189
+++ core.html 2001/07/17 20:20:20 1.190
@@ -432,7 +432,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> <Directory <EM>directory</EM>>
+><STRONG>Syntax:</STRONG></A> <Directory <EM>directory-path</EM>>
... </Directory> <BR>
<A
HREF="directive-dict.html#Context"
@@ -443,17 +443,16 @@
REL="Help"
><STRONG>Status:</STRONG></A> Core. <P>
-<Directory> and </Directory> are used to enclose a group of
-directives which will apply only to the named directory and sub-directories
-of that directory. Any directive which is allowed in a directory
-context may be used. <EM>Directory</EM> is either the full path to a directory,
-or a wild-card string. In a wild-card string, `?' matches any single character,
-and `*' matches any sequences of characters. As of Apache 1.3, you
-may also use `[]' character ranges like in the shell. Also as of Apache 1.3
-none of the wildcards match a `/' character, which more closely mimics the
-behaviour of Unix shells.
-Example:
-<PRE>
+<Directory> and </Directory> are used to enclose a group
+of directives which will apply only to the named directory and
+sub-directories of that directory. Any directive which is allowed in a
+directory context may be used. <EM>Directory-path</EM> is either the
+full path to a directory, or a wild-card string. In a wild-card
+string, `?' matches any single character, and `*' matches any
+sequences of characters. As of Apache 1.3, you may also use `[]'
+character ranges like in the shell. Also as of Apache 1.3 none of the
+wildcards match a `/' character, which more closely mimics the
+behaviour of Unix shells. Example: <PRE>
<Directory /usr/local/httpd/htdocs>
Options Indexes FollowSymLinks
</Directory>
@@ -601,7 +600,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> DocumentRoot <EM>directory-filename</EM><BR>
+><STRONG>Syntax:</STRONG></A> DocumentRoot <EM>directory-path</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -662,8 +661,8 @@
<OL>
<LI>output a simple hardcoded error message
<LI>output a customized message
-<LI>redirect to a local URL to handle the problem/error
-<LI>redirect to an external URL to handle the problem/error
+<LI>redirect to a local <em>URL-path</em> to handle the problem/error
+<LI>redirect to an external <em>URL</em> to handle the problem/error
</OL>
<P>The first option is the default, while options 2-4 are configured
@@ -707,7 +706,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ErrorLog <EM>filename</EM>|syslog[:<em>facility</em>]
+><STRONG>Syntax:</STRONG></A> ErrorLog <EM>file-path</EM>|syslog[:<em>facility</em>]
<BR>
<A
HREF="directive-dict.html#Default"
@@ -727,11 +726,12 @@
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
-The error log directive sets the name of the file to which the server will log
-any errors it encounters. If the filename does not begin with a slash (/)
-then it is assumed to be relative to the <A HREF="#serverroot">ServerRoot</A>.
-If the filename begins with a pipe (|) then it is assumed to be a command to
-spawn to handle the error log.
+The error log directive sets the name of the file to which the server
+will log any errors it encounters. If the <em>file-path</em> does not
+begin with a slash (/) then it is assumed to be relative to the <A
+HREF="#serverroot">ServerRoot</A>. If the <em>file-path</em> begins
+with a pipe (|) then it is assumed to be a command to spawn to handle
+the error log.
<P><STRONG>Apache 1.3 and above:</STRONG>
Using <CODE>syslog</CODE> instead of a filename enables logging via syslogd(8)
@@ -1069,7 +1069,7 @@
<P> <HR>
<H2><A NAME="include">Include directive</A></H2>
-<STRONG>Syntax:</STRONG> Include <EM>filename</EM><BR>
+<STRONG>Syntax:</STRONG> Include <EM>file-path</EM>|<em>directory-path</em><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -1463,7 +1463,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> <Location <EM>URL</EM>>
+><STRONG>Syntax:</STRONG></A> <Location <EM>URL-path</EM>|<em>URL</em>>
... </Location><BR>
<A
HREF="directive-dict.html#Context"
@@ -2288,7 +2288,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ServerPath <EM>pathname</EM><BR>
+><STRONG>Syntax:</STRONG></A> ServerPath <EM>directory-path</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -2316,7 +2316,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ServerRoot <EM>directory-filename</EM><BR>
+><STRONG>Syntax:</STRONG></A> ServerRoot <EM>directory-path</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
1.6 +86 -8 httpd-2.0/docs/manual/mod/directive-dict.html
Index: directive-dict.html
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/directive-dict.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -b -u -r1.5 -r1.6
--- directive-dict.html 2000/12/09 19:50:01 1.5
+++ directive-dict.html 2001/07/17 20:20:21 1.6
@@ -87,15 +87,91 @@
configuration file. This syntax is extremely directive-specific,
and is described in detail in the directive's definition.
Generally, the directive name is followed by a series of one or
- more arguments. Optional arguments are enclosed in square brackets.
- Where an argument can take on more than one possible value, possible
- values are separated by a vertical bar. Literal text is presented
- in the default font, while argument-types for which substitution
- is necessary are emphasized. Directives which can take a variable
- number of arguments will end in "..." indicating that the last
- argument is repeated.
+ more space-separated arguments. If an argument contains a space,
+ the argument must be enclosed in double quotes. Optional arguments
+ are enclosed in square brackets. Where an argument can take on more
+ than one possible value, the possible values are separated by
+ vertical bars "|". Literal text is presented in the default font,
+ while argument-types for which substitution is necessary are
+ <em>emphasized</em>. Directives which can take a variable number of
+ arguments will end in "..." indicating that the last argument is
+ repeated.
</P>
+ <P>
+ Directives use a great number of different argument types.
+ A few common ones are defined below.</p>
+
+<dl>
+
+<dt><em>URL</em></dt>
+
+<dd>A complete Uniform Resource Locator including a scheme, hostname,
+and optional pathname as in
+<code>http://www.example.com/path/to/file.html</code></dd>
+
+<dt><em>URL-path</em><dt>
+
+<dd>The part of a <em>url</em> which follows the scheme and hostname
+as in <code>/path/to/file.html</code>. The <em>url-path</em>
+represents a web-view of a resource, as opposed to a file-system
+view.</dd>
+
+<dt><em>file-path</em></dt>
+
+<dd>The path to a file in the local file-system beginning with the
+root directory as in
+<code>/usr/local/apache/htdocs/path/to/file.html</code>. Unless
+otherwise specified, a <em>file-path</em> which does not begin with a
+slash will be treated as relative to the <a
+href="core.html#serverroot">ServerRoot</a>.</dd>
+
+<dt><em>directory-path</em></dt>
+
+<dd>The path to a directory in the local file-system beginning with
+the root directory as in
+<code>/usr/local/apache/htdocs/path/to/</code>.
+
+<dt><em>filename</em></dt>
+
+<dd>The name of a file with no accompanying path information as in
+<code>file.html</code>.</dd>
+
+<dt><em>regex</em></dt>
+
+<dd>A <a href="../misc/FAQ.html#regex">regular expression</a>, which
+is a way of describing a pattern to match in text. The directive
+definition will specify what the <em>regex</em> is matching
+against.</dd>
+
+<dt><em>extension</em></dt>
+
+<dd>In general, this is the part of the <em>filename</em> which
+follows the last dot. However, Apache recognizes multiple filename
+extensions, so if a <em>filename</em> contains more than one dot, each
+dot-separated part of the filename following the first dot is an
+<em>extension</em>. For example, the <em>filename</em>
+<code>file.html.en</code> contains two extensions: <code>.html</code>
+and <code>.en</code>. For Apache directives, you may specify
+<em>extension</em>s with or without the leading dot. In addition,
+<em>extension</em>s are not case sensitive.</dd>
+
+<dt><em>MIME-type</em></dt>
+
+<dd>A method of describing the format of a file which consists of a
+major format type and a minor format type, separated by a slash
+as in <code>text/html</code>.
+
+<dt><em>env-variable</em></dt>
+
+<dd>The name of an <a href="../env.html">environment variable</a>
+defined in the Apache configuration process. Note this is not
+necessarily the same as an operating system environment variable. See
+the <a href="../env.html">environment variable documentation</a> for
+more details.</dd>
+
+</dl>
+
<HR>
<H2><A NAME="Default">Default</A></H2>
<P>
@@ -103,7 +179,9 @@
from your configuration entirely, the Apache Web server will behave as
though you set it to a particular value), it is described here. If
there is no default value, this section should say
- "<EM>None</EM>".
+ "<EM>None</EM>". Note that the default listed here is not
+ necessarily the same as the value the directive takes in the
+ default httpd.conf distributed with the server.
</P>
<HR>