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...@locus.apache.org on 2000/12/06 06:12:13 UTC
cvs commit: httpd-docs-1.3/htdocs/manual/mod core.html directive-dict.html
slive 00/12/05 21:12:13
Modified: htdocs/manual/mod core.html directive-dict.html
Log:
Normalize the "syntax" entries in core and update the
directive-dict for the new format.
Revision Changes Path
1.182 +87 -78 httpd-docs-1.3/htdocs/manual/mod/core.html
Index: core.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/core.html,v
retrieving revision 1.181
retrieving revision 1.182
diff -u -d -b -u -r1.181 -r1.182
--- core.html 2000/12/03 03:13:06 1.181
+++ core.html 2000/12/06 05:12:11 1.182
@@ -139,7 +139,8 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> AccessFileName <EM>filename filename ...</EM><BR>
+><STRONG>Syntax:</STRONG></A> AccessFileName <EM>filename</em>
+[<em>filename</em>] ...<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -174,7 +175,7 @@
<H2><A NAME="adddefaultcharset">AddDefaultCharset directive</A></H2>
<A HREF="directive-dict.html#Syntax" REL="Help"><STRONG>Syntax:</STRONG></A>
-AddDefaultCharset <EM>Off / On / charset</EM><BR>
+AddDefaultCharset On|Off|<em>charset</em><BR>
<A HREF="directive-dict.html#Context" REL="Help" ><STRONG>Context:</STRONG></A>
all<BR>
<A HREF="directive-dict.html#Status" REL="Help" ><STRONG>Status:</STRONG></A>
@@ -191,7 +192,7 @@
of <CODE>AddDefaultCharset Off</CODE> disables this functionality.
<CODE>AddDefaultCharset On</CODE> enables Apache's internal
default charset of <code>iso-8859-1</code> as required by the
-directive. You can also specify an alternate charset to be used;
+directive. You can also specify an alternate <em>charset</em> to be used;
e.g. <code>AddDefaultCharset utf-8</code>.
<P><HR>
@@ -200,7 +201,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> AddModule <EM>module module ...</EM><BR>
+><STRONG>Syntax:</STRONG></A> AddModule <EM>module</em> [<em>module</em>] ...<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -226,7 +227,8 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> AllowOverride <EM>override override ...</EM><BR>
+><STRONG>Syntax:</STRONG></A> AllowOverride All|None|<EM>directive-type</em>
+[<em>directive-type</em>] ...<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -240,13 +242,21 @@
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
-When the server finds an .htaccess file (as specified by
+<p>When the server finds an .htaccess file (as specified by
<A HREF="#accessfilename">AccessFileName</A>) it needs to know which
-directives declared in that file can override earlier access information.<P>
+directives declared in that file can override earlier access information.</p>
-<EM>Override</EM> can be set to <CODE>None</CODE>, in which case the server
-will not read the file, <CODE>All</CODE> in which case the server will
-allow all the directives, or one or more of the following:
+<p>When this directive is set to <code>None</code>, then
+.htaccess files are completely ignored. In this case, the server
+will not even attempt to read .htaccess files in the filesystem.</p>
+
+<p>When this directive is set to <code>All</code>, then any directive
+which has the .htaccess <a
+href="directive-dict.html#Context">Context</a> is allowed in .htaccess
+files.</p>
+
+<p>The <em>directive-type</em> can be one of the following groupings
+of directives.</p>
<DL>
<DT>AuthConfig
<DD>
@@ -328,7 +338,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> AuthType <EM>type</EM><BR>
+><STRONG>Syntax:</STRONG></A> AuthType Basic|Digest<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -355,7 +365,8 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> BindAddress <EM>saddr</EM><BR>
+><STRONG>Syntax:</STRONG></A> BindAddress
+*|<em>IP-address</em>|<EM>domain-name</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -369,28 +380,22 @@
REL="Help"
><STRONG>Status:</STRONG></A> core<P>
-A Unix® http server can either listen for connections to every
+<p>A Unix® http server can either listen for connections to every
IP address of the server machine, or just one IP address of the server
-machine. <EM>Saddr</EM> can be
-
-<MENU>
-<LI>*
-<LI>An IP address
-<LI>A fully-qualified Internet domain name
-</MENU>
-If the value is *, then the server will listen for connections on
-every IP address, otherwise it will only listen on the IP address
-specified. <P>
+machine. If the argument to this directive is *, then the
+server will listen for connections on every IP address. Otherwise,
+the server can listen to only a specific <em>IP-address</em>
+or a fully-qualified Internet <em>domain-name</em>.</p>
-Only one <CODE>BindAddress</CODE> directive can be used. For more
+<p>Only one <CODE>BindAddress</CODE> directive can be used. For more
control over which address and ports Apache listens to, use the
<CODE><A HREF="#listen">Listen</A></CODE> directive instead of
-<CODE>BindAddress</CODE>.<P>
+<CODE>BindAddress</CODE>.</P>
-<CODE>BindAddress</CODE> can be used as an alternative method for
+<p><CODE>BindAddress</CODE> can be used as an alternative method for
supporting <A HREF="../vhosts/">virtual hosts</A> using
multiple independent servers, instead of using <CODE><A
-HREF="#virtualhost"><VirtualHost></A></CODE> sections.
+HREF="#virtualhost"><VirtualHost></A></CODE> sections.</p>
<P><STRONG>See Also:</STRONG>
<A HREF="../dns-caveats.html">DNS Issues</A><BR>
@@ -467,7 +472,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ContentDigest <EM>on|off</EM><BR>
+><STRONG>Syntax:</STRONG></A> ContentDigest on|off<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -854,7 +859,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ErrorLog <EM>filename</EM>|<CODE>syslog[:facility]</CODE>
+><STRONG>Syntax:</STRONG></A> ErrorLog <EM>filename</EM>|syslog[:<em>facility</em>]
<BR>
<A
HREF="directive-dict.html#Default"
@@ -1049,7 +1054,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> HostNameLookups <EM>on | off | double</EM><BR>
+><STRONG>Syntax:</STRONG></A> HostNameLookups on|off|double<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -1108,7 +1113,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> IdentityCheck <EM>boolean</EM><BR>
+><STRONG>Syntax:</STRONG></A> IdentityCheck on|off<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -1289,7 +1294,7 @@
<H2><A NAME="keepalive">KeepAlive directive</A></H2>
<STRONG>Syntax: (Apache 1.1)</STRONG> KeepAlive <EM>max-requests</EM><BR>
<STRONG>Default: (Apache 1.1)</STRONG> <CODE>KeepAlive 5</CODE><BR>
-<STRONG>Syntax: (Apache 1.2)</STRONG> KeepAlive <EM>on/off</EM><BR>
+<STRONG>Syntax: (Apache 1.2)</STRONG> KeepAlive on|off<BR>
<STRONG>Default: (Apache 1.2)</STRONG> <CODE>KeepAlive On</CODE><BR>
<A
HREF="directive-dict.html#Context"
@@ -1378,7 +1383,7 @@
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A>
- <Limit <EM>method method</EM> ... > ... </Limit><BR>
+ <Limit <EM>method</em> [<em>method</EM>] ... > ... </Limit><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -1419,7 +1424,7 @@
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A>
- <LimitExcept <EM>method method</EM> ... > ... </LimitExcept><BR>
+ <LimitExcept <EM>method</em> [<em>method</EM>] ... > ... </LimitExcept><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -1447,7 +1452,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> LimitRequestBody <EM>number</EM><BR>
+><STRONG>Syntax:</STRONG></A> LimitRequestBody <EM>bytes</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -1468,8 +1473,9 @@
Apache 1.3.2 and later.
<P>
-<EM>Number</EM> is a long integer from 0 (meaning unlimited) to 2147483647
-(2GB). The default value is defined by the compile-time constant
+<p>This directive specifies the number of <em>bytes</em> from 0
+(meaning unlimited) to 2147483647 (2GB) that are allowed in a request
+body. The default value is defined by the compile-time constant
<CODE>DEFAULT_LIMIT_REQUEST_BODY</CODE> (0 as distributed).
<P>
@@ -1518,7 +1524,7 @@
Apache 1.3.2 and later.
<P>
-<EM>Number</EM> is an integer from 0 (meaning unlimited) to 32767.
+<p><em>Number</em> is an integer from 0 (meaning unlimited) to 32767.
The default value is defined by the compile-time constant
<CODE>DEFAULT_LIMIT_REQUEST_FIELDS</CODE> (100 as distributed).
<P>
@@ -1546,7 +1552,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> LimitRequestFieldsize <EM>number</EM><BR>
+><STRONG>Syntax:</STRONG></A> LimitRequestFieldsize <EM>bytes</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -1566,9 +1572,10 @@
Apache 1.3.2 and later.
<P>
-<EM>Number</EM> is an integer size in bytes from 0 to the value of the
-compile-time constant <CODE>DEFAULT_LIMIT_REQUEST_FIELDSIZE</CODE>
-(8190 as distributed).
+This directive specifies the number of <em>bytes</em> from 0 to the
+value of the compile-time constant
+<CODE>DEFAULT_LIMIT_REQUEST_FIELDSIZE</CODE> (8190 as distributed)
+that will be allowed in an HTTP request header.
<P>
The LimitRequestFieldsize directive allows the server administrator to reduce
@@ -1593,7 +1600,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> LimitRequestLine <EM>number</EM><BR>
+><STRONG>Syntax:</STRONG></A> LimitRequestLine <EM>bytes</EM><BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -1613,9 +1620,9 @@
Apache 1.3.2 and later.
<P>
-<EM>Number</EM> is an integer size in bytes from 0 to the value of the
-compile-time constant <CODE>DEFAULT_LIMIT_REQUEST_LINE</CODE>
-(8190 as distributed).
+This directive sets the number of <em>bytes</em> from 0 to the value
+of the compile-time constant <CODE>DEFAULT_LIMIT_REQUEST_LINE</CODE>
+(8190 as distributed) that will be allowed on the HTTP request-line.
<P>
The LimitRequestLine directive allows the server administrator to reduce
@@ -1640,7 +1647,7 @@
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A>
-Listen [<EM>IP address</EM>:]<EM>port number</EM><BR>
+Listen [<EM>IP-address</EM>:]<EM>port</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -2215,7 +2222,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> Options <EM>[+|-]option [+|-]option ...</EM><BR>
+><STRONG>Syntax:</STRONG></A> Options [+|-]<em>option</em> [[+|-]<em>option</em>] ...</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -2438,7 +2445,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> Require <EM>entity-name entity entity...</EM><BR>
+><STRONG>Syntax:</STRONG></A> Require <EM>entity-name</em> [<em>entity-name</em>] ...</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -2455,9 +2462,9 @@
This directive selects which authenticated users can access a directory.
The allowed syntaxes are:
<UL>
-<LI>Require user <EM>userid userid ...</EM><P>
+<LI>Require user <EM>userid</em> [<em>userid</em>] ...<P>
Only the named users can access the directory.<P>
-<LI>Require group <EM>group-name group-name ...</EM><P>
+<LI>Require group <EM>group-name</em> [<em>group-name</em>] ...<P>
Only users in the named groups can access the directory.<P>
<LI>Require valid-user<P>
All valid users can access the directory.
@@ -2528,8 +2535,8 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> RLimitCPU <EM># or 'max'</EM>
- <EM>[# or 'max']</EM>
+><STRONG>Syntax:</STRONG></A> RLimitCPU <EM>number</EM>|max
+ [<em>number</em>|max]
<BR>
<A
HREF="directive-dict.html#Default"
@@ -2552,7 +2559,7 @@
Takes 1 or 2 parameters. The first parameter sets the soft resource limit
for all processes and the second parameter sets the maximum resource limit.
-Either parameter can be a number, or <EM>max</EM> to indicate to the server
+Either parameter can be a number, or <code>max</code> to indicate to the server
that the limit should be set to the maximum allowed by the operating system
configuration. Raising the maximum resource limit requires that the server
is running as root, or in the initial startup phase.<P>
@@ -2572,8 +2579,8 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> RLimitMEM <EM># or 'max'</EM>
- <EM>[# or 'max']</EM><BR>
+><STRONG>Syntax:</STRONG></A> RLimitMEM <EM>number</em>|max
+ [<em>number</em>|max]<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -2593,12 +2600,13 @@
><STRONG>Compatibility:</STRONG></A> RLimitMEM is only available in Apache 1.2
and later<P>
-Takes 1 or 2 parameters. The first parameter sets the soft resource limit for
-all processes and the second parameter sets the maximum resource limit. Either
-parameter can be a number, or <EM>max</EM> to indicate to the server that the
-limit should be set to the maximum allowed by the operating system
-configuration. Raising the maximum resource limit requires that the
-server is running as root, or in the initial startup phase.<P>
+Takes 1 or 2 parameters. The first parameter sets the soft resource
+limit for all processes and the second parameter sets the maximum
+resource limit. Either parameter can be a number, or <code>max</code>
+to indicate to the server that the limit should be set to the maximum
+allowed by the operating system configuration. Raising the maximum
+resource limit requires that the server is running as root, or in the
+initial startup phase.<P>
This applies to processes forked off from Apache children servicing requests,
not the Apache children themselves. This includes CGI scripts and SSI
@@ -2615,8 +2623,8 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> RLimitNPROC <EM># or 'max'</EM>
- <EM>[# or 'max']</EM><BR>
+><STRONG>Syntax:</STRONG></A> RLimitNPROC <EM>number</em>|max
+ [<em>number</EM>|max]<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -2636,12 +2644,13 @@
><STRONG>Compatibility:</STRONG></A> RLimitNPROC is only available in Apache
1.2 and later<P>
-Takes 1 or 2 parameters. The first parameter sets the soft resource limit
-for all processes and the second parameter sets the maximum resource limit.
-Either parameter can be a number, or <EM>max</EM> to indicate to the server
-that the limit should be set to the maximum allowed by the operating system
-configuration. Raising the maximum resource limit requires that the server
-is running as root, or in the initial startup phase.<P>
+Takes 1 or 2 parameters. The first parameter sets the soft resource
+limit for all processes and the second parameter sets the maximum
+resource limit. Either parameter can be a number, or <code>max</code>
+to indicate to the server that the limit should be set to the maximum
+allowed by the operating system configuration. Raising the maximum
+resource limit requires that the server is running as root, or in the
+initial startup phase.<P>
This applies to processes forked off from Apache children servicing requests,
not the Apache children themselves. This includes CGI scripts and SSI
@@ -2666,7 +2675,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> Satisfy <EM>'any' or 'all'</EM><BR>
+><STRONG>Syntax:</STRONG></A> Satisfy any|all<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -2759,7 +2768,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ScriptInterpreterSource <EM>'registry' or 'script'</EM><BR>
+><STRONG>Syntax:</STRONG></A> ScriptInterpreterSource registry|script<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -2828,7 +2837,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ServerAlias <EM>host1 host2 ...</EM><BR>
+><STRONG>Syntax:</STRONG></A> ServerAlias <EM>hostname</em> [<em>hostname</em>] ...<BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
@@ -2857,7 +2866,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ServerName <EM>fully-qualified domain name</EM>
+><STRONG>Syntax:</STRONG></A> ServerName <EM>fully-qualified-domain-name</EM>
<BR>
<A
HREF="directive-dict.html#Context"
@@ -2954,7 +2963,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ServerSignature <EM>Off | On | EMail</EM><BR>
+><STRONG>Syntax:</STRONG></A> ServerSignature On|Off|EMail<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -2997,7 +3006,7 @@
<A
HREF="directive-dict.html#Syntax"
REL="Help"
-><STRONG>Syntax:</STRONG></A> ServerTokens <EM>Minimal|ProductOnly|OS|Full</EM><BR>
+><STRONG>Syntax:</STRONG></A> ServerTokens Minimal|ProductOnly|OS|Full<BR>
<A
HREF="directive-dict.html#Default"
REL="Help"
@@ -3233,7 +3242,7 @@
<H2><A NAME="usecanonicalname">UseCanonicalName directive</A></H2>
<!--%plaintext <?INDEX {\tt UseCanonicalName} directive> -->
<A HREF="directive-dict.html#Syntax" REL="Help">
-<STRONG>Syntax:</STRONG></A> UseCanonicalName <EM>on|off|dns</EM><BR>
+<STRONG>Syntax:</STRONG></A> UseCanonicalName on|off|dns<BR>
<A HREF="directive-dict.html#Default" REL="Help">
<STRONG>Default:</STRONG></A> <CODE>UseCanonicalName on</CODE><BR>
<A HREF="directive-dict.html#Context" REL="Help">
@@ -3350,7 +3359,7 @@
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> <VirtualHost <EM>addr</EM>[:<EM>port</EM>]
- ...> ...
+[<EM>addr</EM>[:<EM>port</EM>]] ...> ...
</VirtualHost> <BR>
<A
HREF="directive-dict.html#Context"
1.4 +10 -2 httpd-docs-1.3/htdocs/manual/mod/directive-dict.html
Index: directive-dict.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/directive-dict.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -b -u -r1.3 -r1.4
--- directive-dict.html 1999/08/05 10:33:36 1.3
+++ directive-dict.html 2000/12/06 05:12:12 1.4
@@ -84,8 +84,16 @@
<H2><A NAME="Syntax">Syntax</A></H2>
<P>
This indicates the format of the directive as it would appear in a
- configuration file. This syntax is extremely directive-specific, so
- refer to the text of the directive's description for details.
+ 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.
</P>
<HR>