From 351f358af43706d8c824315649fb6903095a1ebe Mon Sep 17 00:00:00 2001
From: Astrid Malo
Date: Wed, 8 Jan 2003 20:58:32 +0000
Subject: [PATCH] - further markup improvements - use a more realistic values
for some examples - use better parameter names - correct a seealso title
thanks to nd for his suggestions
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@98210 13f79535-47bb-0310-9956-ffa450edef68
---
docs/manual/mod/core.html.en | 104 ++++++++++++-------------
docs/manual/mod/core.xml | 78 +++++++++----------
docs/manual/mod/quickreference.html.en | 9 ++-
3 files changed, 92 insertions(+), 99 deletions(-)
diff --git a/docs/manual/mod/core.html.en b/docs/manual/mod/core.html.en
index 5a79aeb35f..e9b7b50a8a 100644
--- a/docs/manual/mod/core.html.en
+++ b/docs/manual/mod/core.html.en
@@ -99,7 +99,7 @@ available
Override: | FileInfo |
Status: | Core |
Module: | core |
-Compatibility: | Available in Apache 2.0.30 and later |
+Compatibility: | Available in Apache 2.0.30 and later |
This directive controls whether requests that contain trailing
@@ -151,7 +151,7 @@ available
Options +Includes
SetOutputFilter INCLUDES
- AcceptPathInfo on
+ AcceptPathInfo On
</Files>
@@ -237,7 +237,7 @@ response without an explicit character set
Override: | FileInfo |
Status: | Core |
Module: | core |
-Compatibility: | Available in Apache 2.0.33 and later |
+Compatibility: | Available in Apache 2.0.33 and later |
This directive activates a particular output filter for a request depending on the
response MIME-type.
@@ -454,7 +454,7 @@ scripts
Override: | FileInfo |
Status: | Core |
Module: | core |
-Compatibility: | NetWare only |
+Compatibility: | NetWare only |
This directive is used to control how Apache finds the
interpreter used to run CGI scripts. For example, setting
@@ -800,7 +800,7 @@ Location
Override: | FileInfo |
Status: | Core |
Module: | core |
-Compatibility: | Available in version 2.0.44 and later |
+Compatibility: | Available in version 2.0.44 and later |
This directive controls whether httpd
may use the sendfile
support from the kernel to transmit file contents to the client.
@@ -853,8 +853,8 @@ in case of an error
Override: | FileInfo |
Status: | Core |
Module: | core |
-Compatibility: | Quoting syntax for text messages is different in Apache
-2.0 |
+Compatibility: | Quoting syntax for text messages is different in Apache
+2.0 |
In the event of a problem or error, Apache can be configured
to do one of four things,
@@ -934,8 +934,8 @@ ErrorLog logs/error.log (Windows and OS/2)
The ErrorLog
directive sets the name of
the file to which the server will log any errors it encounters. If
- the file-path does not begin with a slash (/) then it is
- assumed to be relative to the ServerRoot
.
+ the file-path is not absolute (in general: does not begin
+ with a slash (/)) then it is assumed to be relative to the ServerRoot
.
Example
ErrorLog /var/log/httpd/error_log
@@ -1037,9 +1037,9 @@ filenames
The <Files>
directive
provides for access control by filename. It is comparable to the
- Directory
- directive and Location
directives. It should be
- matched with a </Files>
directive. The
+ <Directory>
+ directive and <Location>
directives. It should be
+ matched with a <Files>
directive. The
directives given within this section will be applied to any object
with a basename (last component of filename) matching the
specified filename. <Files>
@@ -1113,7 +1113,7 @@ MIME content-type
Override: | FileInfo |
Status: | Core |
Module: | core |
-Compatibility: | Moved to the core in Apache 2.0 |
+Compatibility: | Moved to the core in Apache 2.0 |
When placed into an .htaccess
file or a
<Directory>
, or
@@ -1333,12 +1333,12 @@ the server configuration files
Context: | server config, virtual host, directory |
Status: | Core |
Module: | core |
-Compatibility: | Wildcard matching available in 2.0.41 and later |
+Compatibility: | Wildcard matching available in 2.0.41 and later |
This directive allows inclusion of other configuration files
from within the server configuration files.
- Shell-style (fnmatch) wildcard characters can be used to
+
Shell-style (fnmatch()
) wildcard characters can be used to
include several files at once, in alphabetical order. In
addition, if Include
points to a directory,
rather than a file, Apache will read all files in that directory
@@ -1637,7 +1637,7 @@ client
For example:
- LimitRequestFieldSize 16380
+ LimitRequestFieldSize 4094
Under normal conditions, the value should not be changed from
@@ -1679,7 +1679,7 @@ from the client
For example:
- LimitRequestLine 16380
+ LimitRequestLine 4094
Under normal conditions, the value should not be changed from
@@ -2194,27 +2194,18 @@ a resource
This directive selects which authenticated users can access
a directory. The allowed syntaxes are:
-
- -
- Require user userid [userid] ...
-
-
Only the named users can access the resource.
-
-
- -
- Require group group-name [group-name] ...
-
-
-
Only users in the named groups can access the
- resource.
-
+
+ Require user userid [userid]
+ ...
+ - Only the named users can access the resource.
-
-
- Require valid-user
+
Require group group-name [group-name]
+ ...
+ - Only users in the named groups can access the resource.
- All valid users can access the resource.
-
-
+
Require valid-user
+
All valid users can access the resource.
+
Require
must be accompanied by
AuthName
and AuthType
directives, and directives such
@@ -2249,7 +2240,7 @@ a resource
Description: | Limits the CPU consumption of processes launched
by Apache children |
-Syntax: | RLimitCPU number|max [number|max] |
+Syntax: | RLimitCPU seconds|max [seconds|max] |
Default: | Unset; uses operating system defaults |
Context: | server config, virtual host, directory, .htaccess |
Override: | All |
@@ -2262,7 +2253,7 @@ by Apache children
or max
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
+ the server is running as root
, or in the initial startup
phase.
This applies to processes forked off from Apache children
@@ -2285,7 +2276,7 @@ by Apache children
Description: | Limits the memory consumption of processes launched
by Apache children |
-Syntax: | RLimitMEM number|max [number|max] |
+Syntax: | RLimitMEM bytes|max [bytes|max] |
Default: | Unset; uses operating system defaults |
Context: | server config, virtual host, directory, .htaccess |
Override: | All |
@@ -2298,7 +2289,7 @@ by Apache children
or max
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
+ the server is running as root
, or in the initial startup
phase.
This applies to processes forked off from Apache children
@@ -2334,7 +2325,7 @@ processes launched by Apache children
or max
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
+ the server is running as root
, or in the initial startup
phase.
This applies to processes forked off from Apache children
@@ -2413,8 +2404,9 @@ scripts
Override: | FileInfo |
Status: | Core |
Module: | core |
-Compatibility: | Win32 only
-option Registry-Strict is available in Apache 2.0 and later |
+Compatibility: | Win32 only
+option Registry-Strict is available in Apache 2.0 and
+later |
This directive is used to control how Apache finds the
interpreter used to run CGI scripts. The default technique is to
@@ -2488,9 +2480,9 @@ itself
Context: | server config, virtual host |
Status: | Core |
Module: | core |
-Compatibility: | In version 2.0, this
- directive supersedes the functionality of the Port
- directive from version 1.3. |
+Compatibility: | In version 2.0, this
+ directive supersedes the functionality of the Port
+ directive from version 1.3. |
The ServerName
directive sets the hostname and
port that the server uses to identify itself. This is used when
@@ -2527,7 +2519,8 @@ itself
See also
![top](../images/up.gif)
@@ -2600,7 +2593,9 @@ is accessed by an incompatible browser
listings,
mod_info
output, ...). The reason why you
would want to enable such a footer line is that in a chain of proxies,
the user often has no possibility to tell which of the chained servers
- actually produced a returned error message.
The
Off
+ actually produced a returned error message.
+
+
The Off
setting, which is the default, suppresses the footer line (and is
therefore compatible with the behavior of Apache-1.2 and
below). The On
setting simply adds a line with the
@@ -2620,7 +2615,8 @@ is accessed by an incompatible browser
![top](../images/up.gif)
When placed into an .htaccess
file or a
<Directory>
or
@@ -2790,7 +2786,7 @@ server
Description: | Amount of time the server will wait for
certain events before failing a request |
-Syntax: | TimeOut number |
+Syntax: | TimeOut second |
Default: | TimeOut 300 |
Context: | server config |
Status: | Core |
@@ -2988,8 +2984,8 @@ hostname or IP address
See also
- Apache Virtual Host documentation
-- Warnings about DNS and
- Apache
+- Issues Regarding DNS and
+ Apache
- Setting
which addresses and ports Apache uses
- How <Directory>, <Location>
diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml
index 1705f4478d..5003c43ae4 100644
--- a/docs/manual/mod/core.xml
+++ b/docs/manual/mod/core.xml
@@ -73,7 +73,7 @@ available
Options +Includes
SetOutputFilter INCLUDES
- AcceptPathInfo on
+ AcceptPathInfo On
</Files>
@@ -882,8 +882,8 @@ ErrorLog logs/error.log (Windows and OS/2)
The ErrorLog directive sets the name of
the file to which the server will log any errors it encounters. If
- the file-path does not begin with a slash (/) then it is
- assumed to be relative to the file-path is not absolute (in general: does not begin
+ with a slash (/)) then it is assumed to be relative to the ServerRoot.
Example
@@ -986,10 +986,10 @@ filenames
The Files directive
provides for access control by filename. It is comparable to the
- Directory
+ Directory
directive and Location directives. It should be
- matched with a </Files>
directive. The
+ type="section">Location directives. It should be
+ matched with a Files directive. The
directives given within this section will be applied to any object
with a basename (last component of filename) matching the
specified filename. Files
@@ -1298,7 +1298,7 @@ the server configuration files
This directive allows inclusion of other configuration files
from within the server configuration files.
- Shell-style (fnmatch) wildcard characters can be used to
+
Shell-style (fnmatch()
) wildcard characters can be used to
include several files at once, in alphabetical order. In
addition, if Include points to a directory,
rather than a file, Apache will read all files in that directory
@@ -1598,7 +1598,7 @@ client
For example:
- LimitRequestFieldSize 16380
+ LimitRequestFieldSize 4094
Under normal conditions, the value should not be changed from
@@ -1639,7 +1639,7 @@ from the client
For example:
- LimitRequestLine 16380
+ LimitRequestLine 4094
Under normal conditions, the value should not be changed from
@@ -2163,27 +2163,18 @@ a resource
This directive selects which authenticated users can access
a directory. The allowed syntaxes are:
-
- -
- Require user userid [userid] ...
-
-
Only the named users can access the resource.
-
-
- -
- Require group group-name [group-name] ...
-
-
-
Only users in the named groups can access the
- resource.
-
+
+ Require user userid [userid]
+ ...
+ - Only the named users can access the resource.
-
-
- Require valid-user
+
Require group group-name [group-name]
+ ...
+ - Only users in the named groups can access the resource.
- All valid users can access the resource.
-
-
+ Require valid-user
+ - All valid users can access the resource.
+
Require must be accompanied by
AuthName and
RLimitCPU
Limits the CPU consumption of processes launched
by Apache children
-RLimitCPU number|max [number|max]
+RLimitCPU seconds|max [seconds|max]
Unset; uses operating system defaults
server configvirtual host
directory.htaccess
@@ -2229,7 +2220,7 @@ by Apache children
or max
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
+ the server is running as root
, or in the initial startup
phase.
This applies to processes forked off from Apache children
@@ -2249,7 +2240,7 @@ by Apache children
RLimitMEM
Limits the memory consumption of processes launched
by Apache children
-RLimitMEM number|max [number|max]
+RLimitMEM bytes|max [bytes|max]
Unset; uses operating system defaults
server configvirtual host
directory.htaccess
@@ -2262,7 +2253,7 @@ by Apache children
or max
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
+ the server is running as root
, or in the initial startup
phase.
This applies to processes forked off from Apache children
@@ -2295,7 +2286,7 @@ processes launched by Apache children
or max
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
+ the server is running as root
, or in the initial startup
phase.
This applies to processes forked off from Apache children
@@ -2370,7 +2361,8 @@ scripts
directory.htaccess
FileInfo
Win32 only
-option Registry-Strict is available in Apache 2.0 and later
+option Registry-Strict
is available in Apache 2.0 and
+later
This directive is used to control how Apache finds the
@@ -2481,7 +2473,8 @@ itself
-DNS Issues
+Issues Regarding DNS and
+ Apache
Apache virtual host
documentation
UseCanonicalName
@@ -2527,7 +2520,7 @@ is accessed by an incompatible browser
option to httpd
the
security tips for information on how to properly set
- permissions on the ServerRoot
+ permissions on the ServerRoot
@@ -2547,7 +2540,9 @@ is accessed by an incompatible browser
listings, mod_info output, ...). The reason why you
would want to enable such a footer line is that in a chain of proxies,
the user often has no possibility to tell which of the chained servers
- actually produced a returned error message.
The Off
+ actually produced a returned error message.
+
+ The Off
setting, which is the default, suppresses the footer line (and is
therefore compatible with the behavior of Apache-1.2 and
below). The On
setting simply adds a line with the
@@ -2567,7 +2562,8 @@ is accessed by an incompatible browser
ServerTokens
-Configures the Server HTTP response header
+Configures the Server
HTTP response
+header
ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full
ServerTokens Full
server config
@@ -2730,7 +2726,7 @@ server
TimeOut
Amount of time the server will wait for
certain events before failing a request
-TimeOut number
+TimeOut second
TimeOut 300
server config
@@ -2924,8 +2920,8 @@ hostname or IP address
Apache Virtual Host documentation
-Warnings about DNS and
- Apache
+Issues Regarding DNS and
+ Apache
Setting
which addresses and ports Apache uses
How <Directory>, <Location>
diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en
index e9527345ff..c8282edb6f 100644
--- a/docs/manual/mod/quickreference.html.en
+++ b/docs/manual/mod/quickreference.html.en
@@ -533,9 +533,9 @@ engine
RewriteOptions Options | | svdh | E |
Sets some special options for the rewrite engine |
RewriteRule
Pattern Substitution | | svdh | E |
Defines rules for the rewriting engine |
-RLimitCPU number|max [number|max] | | svdh | C |
Limits the CPU consumption of processes launched
+ |
RLimitCPU seconds|max [seconds|max] | | svdh | C |
Limits the CPU consumption of processes launched
by Apache children |
-RLimitMEM number|max [number|max] | | svdh | C |
Limits the memory consumption of processes launched
+ |
RLimitMEM bytes|max [bytes|max] | | svdh | C |
Limits the memory consumption of processes launched
by Apache children |
RLimitNPROC number|max [number|max] | | svdh | C |
Limits the number of processes that can be launched by
processes launched by Apache children |
@@ -571,7 +571,8 @@ itself
is accessed by an incompatible browser
ServerRoot directory-path | /usr/local/apache | s | C |
Base directory for the server installation |
ServerSignature On|Off|EMail | Off | svdh | C |
Configures the footer on server-generated documents |
-ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full | Full | s | C |
Configures the Server HTTP response header |
+ServerTokens Major|Minor|Min[imal]|Prod[uctOnly]|OS|Full | Full | s | C |
Configures the Server HTTP response
+header |
SetEnv env-variable value | | svdh | B |
Sets environment variables |
SetEnvIf attribute
regex [!]env-variable[=value]
@@ -652,7 +653,7 @@ Certificate verification |
per child process
ThreadsPerChild number | | s | M |
Number of threads created by each child process |
ThreadStackSize number | 65536 | s | M |
Determine the stack size for each thread |
-TimeOut number | 300 | s | C |
Amount of time the server will wait for
+ |
TimeOut second | 300 | s | C |
Amount of time the server will wait for
certain events before failing a request |
TransferLog file|pipe | | sv | B |
Specifly location of a log file |
TypesConfig file-path | conf/mime.types | s | B |
The location of the mime.types file |
--
2.40.0