From 4ad18bdbda9ca91f56e351ffdfa0029a56c8598d Mon Sep 17 00:00:00 2001 From: Andre Malo Date: Thu, 3 Oct 2002 00:53:48 +0000 Subject: [PATCH] ok, starting this: turn bogus to also: - several markup improvements (I hope) - remove   from c&p examples, because: - if you want preformatted text, use
   - they may lead to invisible
 errors (\xA0 =       is not recognized by the config parser as
 whitespace)

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97069 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/manual/mod/core.html.en           | 865 ++++++++++++------------
 docs/manual/mod/core.xml               | 894 +++++++++++++------------
 docs/manual/mod/quickreference.html.en |  90 +--
 docs/manual/style/common.dtd           |   2 +
 4 files changed, 960 insertions(+), 891 deletions(-)

diff --git a/docs/manual/mod/core.html.en b/docs/manual/mod/core.html.en
index 0b65efa66c..f02469c7a8 100644
--- a/docs/manual/mod/core.html.en
+++ b/docs/manual/mod/core.html.en
@@ -59,16 +59,17 @@ availableStatus:
     based on PATH_INFO.  The core handler would usually reject the
     request, so you can use the following configuration to enable
     such a script:

-

-<Files "mypaths.shtml">
- Options +Includes
- SetOutputFilter INCLUDES
- AcceptPathInfo on
-</Files> -

+ +
+<Files "mypaths.shtml">
+  Options +Includes
+  SetOutputFilter INCLUDES
+  AcceptPathInfo on
+</Files>
+
top

AccessFileName Directive

Description: Name of the distributed configuration file
Syntax: - AccessFileName filename [filename] ...
Default: + AccessFileName filename [filename] ...
Default: AccessFileName .htaccess
Context: server config, virtual host
Status: Core
Module: @@ -79,9 +80,9 @@ available
Status: configuration files are enabled for that directory. For example:

-

-AccessFileName .acl -

+

+ AccessFileName .acl +

before returning the document /usr/local/web/index.html, the server will read @@ -89,21 +90,19 @@ AccessFileName .acl /usr/local/.acl and /usr/local/web/.acl for directives, unless they have been disabled with

-

-<Directory />
-  AllowOverride None
-</Directory> -

+
+<Directory />
+  AllowOverride None
+</Directory>

See also

top

AddDefaultCharset Directive

Description: Default character set to be added for a response without an explicit character set
Syntax: - AddDefaultCharset On|Off|charset
Default: + AddDefaultCharset On|Off|charset
Default: AddDefaultCharset Off
Context: server config, virtual host, directory, .htaccess
Override: FileInfo
Status: Core
Module: core
-

This directive specifies the name of the character set that will be added to any response that does not have any parameter on the content type in the HTTP headers. This will override any @@ -113,16 +112,16 @@ response without an explicit character set

- AddDefaultCharset utf-8 -

+

+ AddDefaultCharset utf-8 +

top

AllowOverride Directive

Description: Types of directives that are allowed in .htaccess files
Syntax: - AllowOverride All|None|directive-type -[directive-type] ...
Default: + AllowOverride All|None|directive-type +[directive-type] ...
Default: AllowOverride All
Context: directory
Status: Core
Module: @@ -140,7 +139,7 @@ response without an explicit character set
Context is allowed in .htaccess files.

-

The directive-type can be one of the following +

The directive-type can be one of the following groupings of directives.

@@ -187,11 +186,13 @@ response without an explicit character set

AllowOverride AuthConfig Indexes

+

+ AllowOverride AuthConfig Indexes +

See also

top

AuthName Directive

Description: Authorization realm for use in HTTP authentication
Syntax: - AuthName auth-domain
Context: + AuthName auth-domain
Context: directory, .htaccess
Override: AuthConfig
Status: Core
Module: @@ -208,7 +209,9 @@ authentication
Syntax:

For example:

-

AuthName "Top Secret"

+

+ AuthName "Top Secret" +

The string provided for the AuthName is what will appear in the password dialog provided by most browsers.

@@ -264,9 +267,10 @@ headers
Syntax: message integrity check (MIC) of the entity-body. A proxy or client may check this header for detecting accidental modification of the entity-body in transit. Example header:

-

- Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA== -

+ +

+ Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA== +

Note that this can cause performance problems on your server since the message digest is computed on every request (the @@ -279,7 +283,7 @@ headers

Syntax:
top

DefaultType Directive

Description: MIME content-type that will be sent if the server cannot determine a type in any other way
Syntax: - DefaultType MIME-type
Default: + DefaultType MIME-type
Default: DefaultType text/plain
Context: server config, virtual host, directory, .htaccess
Override: FileInfo
Status: @@ -293,9 +297,10 @@ server cannot determine a type in any other way

- DefaultType image/gif -

+

+ DefaultType image/gif +

+

would be appropriate for a directory which contained many gif images with filenames missing the .gif extension.

@@ -306,7 +311,7 @@ server cannot determine a type in any other way
top

<Directory> Directive

Description: Enclose a group of directives that apply only to the named file-system directory and sub-directories
Syntax: - <Directory directory-path> + <Directory directory-path> ... </Directory>
Context: server config, virtual host
Status: Core
Module: @@ -315,7 +320,7 @@ named file-system directory and sub-directories
will not match /home/user/public_html, but <Directory /home/*/public_html> will match. Example:

-

- <Directory /usr/local/httpd/htdocs>
-  Options Indexes FollowSymLinks
- </Directory>
-

- -
-

Be careful with the directory-path arguments: They have -to literally match the filesystem path which Apache uses to access the -files. Directives applied to a particular <Directory> will not -apply to files accessed from that same directory via a different path, -such as via different symbolic links.

-
+ +
+<Directory /usr/local/httpd/htdocs>
+  Options Indexes FollowSymLinks
+</Directory>
+ +
+

Be careful with the directory-path arguments: + They have to literally match the filesystem path which Apache uses + to access the files. Directives applied to a particular + <Directory> will not apply to files accessed from that same + directory via a different path, such as via different symbolic + links.

+

Extended regular expressions can also be used, with the addition of the ~ character. For example:

-

- <Directory ~ "^/www/.*/[0-9]{3}"> -

+ +

+ <Directory ~ "^/www/.*/[0-9]{3}"> +

+

would match directories in /www/ that consisted of three numbers.

@@ -353,15 +361,15 @@ such as via different symbolic links.

first, interspersed with the directives from the
.htaccess files. For example, with

-

- <Directory />
-   AllowOverride None
- </Directory>
-
- <Directory /home/>
-   AllowOverride FileInfo
- </Directory> -

+
+<Directory />
+  AllowOverride None
+</Directory>
+
+<Directory /home/>
+  AllowOverride FileInfo
+</Directory>
+

for access to the document /home/web/dir/doc.html the steps are:

@@ -381,10 +389,10 @@ such as via different symbolic links.

expressions are tested in the order they appeared in the configuration file. For example, with

-

<Directory ~ abc$>
- ... directives here ...
- </Directory>
-

+
+<Directory ~ abc$>
+  # ... directives here ...
+</Directory>

The regular expression section won't be considered until after all normal <Directory>s and .htaccess files @@ -397,12 +405,11 @@ such as via different symbolic links.

recommended that you change this with a block such as

-

- <Directory />
-   Order Deny,Allow
-   Deny from All
- </Directory> -

+
+<Directory />
+  Order Deny,Allow
+  Deny from All
+</Directory>

and then override this for directories you want accessible. See the Security Tips page for more @@ -419,7 +426,7 @@ such as via different symbolic links.

Enclose directives that apply to file-system directories matching a regular expression and their subdirectories
Syntax: - <DirectoryMatch regex> + <DirectoryMatch regex> ... </Directory>
Context: server config, virtual host
Status: Core
Module: @@ -429,9 +436,10 @@ subdirectories
Syntax: of directives which will apply only to the named directory and sub-directories of that directory, the same as <Directory>. However, it takes as an argument a regular expression. For example:

-

- <DirectoryMatch "^/www/.*/[0-9]{3}"> -

+ +

+ <DirectoryMatch "^/www/.*/[0-9]{3}"> +

would match directories in /www/ that consisted of three numbers.

@@ -442,7 +450,7 @@ work for an explanation of how these different sections are combined when a request is received
top

DocumentRoot Directive

Description: Directory that forms the main document tree visible from the web
Syntax: - DocumentRoot directory-path
Default: + DocumentRoot directory-path
Default: DocumentRoot /usr/local/apache/htdocs
Context: server config, virtual host
Status: Core
Module: @@ -451,9 +459,11 @@ from the web
Syntax: serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document. Example:

-

- DocumentRoot /usr/web -

+ +

+ DocumentRoot /usr/web +

+

then an access to http://www.my.host.com/index.html refers to /usr/web/index.html.

@@ -474,13 +484,12 @@ Location
to
     delivery.  By default, when the handling of a request requires
     access to the data within a file-- for example, when delivering a
     server-parsed file using <code class=mod_include-- Apache - memory-maps the file if the OS supports it. -

-

- This memory-mapping sometimes yields a performance improvement. + memory-maps the file if the OS supports it.

+ +

This memory-mapping sometimes yields a performance improvement. But in some environments, it is better to disable the memory-mapping - to prevent operational problems: -

+ to prevent operational problems:

+
  • On some multiprocessor systems, memory-mapping can reduce the performance of the httpd.
  • @@ -488,17 +497,17 @@ Location
+ +

For server configurations that are vulnerable to these problems, + you should disable memory-mapping of delivered files by specifying:

+ +

+ EnableMMAP off +

top

ErrorDocument Directive

Description: What the server will return to the client in case of an error
Syntax: - ErrorDocument error-code document
Context: + ErrorDocument error-code document
Context: server config, virtual host, directory, .htaccess
Override: FileInfo
Status: Core
Module: @@ -513,10 +522,10 @@ in case of an error
Syntax
  • output a customized message
  • -
  • redirect to a local URL-path to handle the +
  • redirect to a local URL-path to handle the problem/error
  • -
  • redirect to an external URL to handle the +
  • redirect to an external URL to handle the problem/error
  • @@ -530,14 +539,12 @@ in case of an error
    Syntax URL which the client can resolve. Alternatively, a message can be provided to be displayed by the browser. Examples:

    -

    - ErrorDocument 500 - http://foo.example.com/cgi-bin/tester
    - ErrorDocument 404 /cgi-bin/bad_urls.pl
    - ErrorDocument 401 /subscription_info.html
    - ErrorDocument 403 "Sorry can't allow you access - today" -

    +

    + ErrorDocument 500 http://foo.example.com/cgi-bin/tester
    + ErrorDocument 404 /cgi-bin/bad_urls.pl
    + ErrorDocument 401 /subscription_info.html
    + ErrorDocument 403 "Sorry can't allow you access today" +

    Note that when you specify an ErrorDocument that points to a remote URL (ie. anything with a method such as @@ -568,7 +575,7 @@ in case of an error

    Syntax

    See also

    top

    ErrorLog Directive

    Description: Location where the server will log errors
    Syntax: - ErrorLog file-path|syslog[:facility]
    Default: + ErrorLog file-path|syslog[:facility]
    Default: ErrorLog logs/error_log (Unix) ErrorLog logs/error.log (Windows and OS/2)
    Context: server config, virtual host
    Status: @@ -576,16 +583,16 @@ ErrorLog logs/error.log (Windows and OS/2)
    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. If the file-path + the file-path does not begin with a slash (/) then it is + assumed to be relative to the ServerRoot. If the file-path begins with a pipe (|) then it is assumed to be a command to spawn to handle the error log.

    Using syslog instead of a filename enables logging via syslogd(8) if the system supports it. The default is to use syslog facility local7, but you can override this by - using the syslog:facility syntax where - facility can be one of the names usually documented in + using the syslog:facility syntax where + facility can be one of the names usually documented in syslog(1).

    SECURITY: See the security tips @@ -595,7 +602,7 @@ ErrorLog logs/error.log (Windows and OS/2)

    LogLevel
  • Apache Log Files
  • top

    FileETag Directive

    Description: File attributes used to create the ETag HTTP response header
    Syntax: - FileETag component ...
    Default: + FileETag component ...
    Default: FileETag INode MTime Size
    Context: server config, virtual host, directory, .htaccess
    Override: FileInfo
    Status: @@ -611,6 +618,7 @@ HTTP response header
    Synta FileETag directive allows you to choose which of these -- if any -- should be used. The recognized keywords are:

    +
    INode
    The file's i-node number will be included in the calculation
    @@ -619,31 +627,29 @@ HTTP response header
    Synta
    Size
    The number of bytes in the file will be included
    All
    -
    All available fields will be used (equivalent to - 'FileETag INode MTime Size')
    +
    All available fields will be used. This is equivalent to: +

    FileETag INode MTime Size

    None
    If a document is file-based, no ETag field will be included in the response
    -

    - The INode, MTime, and Size keywords may be prefixed with either '+' - or '-', which allow changes to be made to the default setting - inherited from a broader scope. Any keyword appearing without - such a prefix immediately and completely cancels the inherited - setting. -

    -

    - If a directory's configuration includes - 'FileETag INode MTime Size', and a - subdirectory's includes 'FileETag -INode', + +

    The INode, MTime, and Size + keywords may be prefixed with either + or -, + which allow changes to be made to the default setting inherited + from a broader scope. Any keyword appearing without such a prefix + immediately and completely cancels the inherited setting.

    + +

    If a directory's configuration includes + FileETag INode MTime Size, and a + subdirectory's includes FileETag -INode, the setting for that subdirectory (which will be inherited by any sub-subdirectories that don't override it) will be equivalent to - 'FileETag MTime Size'. -

    + FileETag MTime Size.

    top

    <Files> Directive

    Description: Contains directives that apply to matched filenames
    Syntax: - <Files filename> ... </Files>
    Context: + <Files filename> ... </Files>
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: Core
    Module: @@ -663,14 +669,16 @@ filenames
    Syntax: inside <Directory> sections to restrict the portion of the filesystem they apply to.

    -

    The filename argument should include a filename, or +

    The filename argument should include a filename, or a wild-card string, where `?' matches any single character, and `*' matches any sequences of characters. Extended regular expressions can also be used, with the addition of the ~ character. For example:

    -

    - <Files ~ "\.(gif|jpe?g|png)$"> -

    + +

    + <Files ~ "\.(gif|jpe?g|png)$"> +

    +

    would match most common Internet graphics formats. In Apache 1.3 and later, <FilesMatch> is preferred, however.

    @@ -684,7 +692,7 @@ filenames
    Syntax: request is received
    top

    <FilesMatch> Directive

    Description: Contains directives that apply to regular-expression matched filenames
    Syntax: - <FilesMatch regex> ... </FilesMatch>
    Context: + <FilesMatch regex> ... </FilesMatch>
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: Core
    Module: @@ -692,9 +700,10 @@ filenames
    Syntax:

    The <FilesMatch> directive provides for access control by filename, just as the <Files> directive does. However, it accepts a regular expression. For example:

    -

    - <FilesMatch "\.(gif|jpe?g|png)$"> -

    + +

    + <FilesMatch "\.(gif|jpe?g|png)$"> +

    would match most common Internet graphics formats.

    See also

    Syntax: request is received
    top

    ForceType Directive

    Description: Forces all matching files to be served with the specified MIME content-type
    Syntax: - ForceType mime-type
    Context: + ForceType MIME-type
    Context: directory, .htaccess
    Override: FileInfo
    Status: Core
    Module: @@ -715,12 +724,13 @@ MIME content-type
    Syntax: <Files> section, this directive forces all matching files to be served with the content type identification given by - mime-type. For example, if you had a directory full of + MIME-type. For example, if you had a directory full of GIF files, but did not want to label them all with ".gif", you might want to use:

    -

    - ForceType image/gif -

    + +

    + ForceType image/gif +

    Note that unlike DefaultType, this directive overrides all mime-type associations, including @@ -758,7 +768,7 @@ MIME content-type

    Syntax: Heavily loaded sites should leave this directive off, since DNS lookups can take considerable amounts of time. The utility logresolve, provided in - the /support directory, can be used to look up host + the /support directory, can be used to look up host names from logged IP addresses offline.

    top

    IdentityCheck Directive

    Description: Enables logging of the RFC1413 identity of the remote @@ -785,86 +795,80 @@ user
    Syntax:
    top

    <IfDefine> Directive

    Description: Encloses directives that will be processed only if a test is true at startup
    Syntax: - <IfDefine [!]parameter-name> ... + <IfDefine [!]parameter-name> ... </IfDefine>
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: Core
    Module: core
    -

    The <IfDefine - test>...</IfDefine> section is used to - mark directives that are conditional. The directives within an - <IfDefine> section are only - processed if the test is true. If test is false, - everything between the start and end markers is ignored.

    +

    The <IfDefine test>...</IfDefine> + section is used to mark directives that are conditional. The + directives within an <IfDefine> + section are only processed if the test is true. If + test is false, everything between the start and end markers is + ignored.

    -

    The test in the <IfDefine> section directive can be one - of two forms:

    +

    The test in the <IfDefine> section directive can be one of two forms:

      -
    • parameter-name
    • +
    • parameter-name
    • -
    • !parameter-name
    • +
    • !parameter-name

    In the former case, the directives between the start and end markers are only processed if the parameter named - parameter-name is defined. The second format reverses + parameter-name is defined. The second format reverses the test, and only processes the directives if - parameter-name is not defined.

    + parameter-name is not defined.

    -

    The parameter-name argument is a define as given on - the httpd command line via - -Dparameter-, at the time the server was - started.

    +

    The parameter-name argument is a define as given on + the httpd command line via -Dparameter- + , at the time the server was started.

    <IfDefine> sections are nest-able, which can be used to implement simple multiple-parameter tests. Example:

    -
    -  $ httpd -DReverseProxy ...
     
    -  # httpd.conf
    -  <IfDefine ReverseProxy>
    +    
    +$ httpd -DReverseProxy ...
    +
    +# httpd.conf
    +<IfDefine ReverseProxy>
       LoadModule rewrite_module modules/mod_rewrite.so
       LoadModule proxy_module   modules/libproxy.so
    -  </IfDefine>
    -
    - +</IfDefine>
    top

    <IfModule> Directive

    Description: Encloses directives that are processed conditional on the presence of absence of a specific module
    Syntax: - <IfModule [!]module-name> ... + <IfModule [!]module-name> ... </IfModule>
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: Core
    Module: core
    -

    The <IfModule - test>...</IfModule> section is used to - mark directives that are conditional on the presence of a - specific module. The directives within an - <IfModule> section are only - processed if the test is true. If test is false, - everything between the start and end markers is ignored.

    +

    The <IfModule test>...</IfModule> + section is used to mark directives that are conditional on the presence of a + specific module. The directives within an <IfModule> section are only processed if the test + is true. If test is false, everything between the start and + end markers is ignored.

    -

    The test in the <IfModule> section directive can be one - of two forms:

    +

    The test in the <IfModule> section directive can be one of two forms:

      -
    • module name
    • +
    • module name
    • -
    • !module name
    • +
    • !module name

    In the former case, the directives between the start and end - markers are only processed if the module named module - name is included in Apache -- either compiled in or - dynamically loaded using LoadModule. The second format - reverses the test, and only processes the directives if module - name is not included.

    + markers are only processed if the module named module + name is included in Apache -- either compiled in or + dynamically loaded using LoadModule. The second format reverses the test, + and only processes the directives if module name is + not included.

    -

    The module name argument is the file name of the +

    The module name argument is the file name of the module, at the time it was compiled. For example, mod_rewrite.c. If a module consists of several source files, use the name of the file containing the string @@ -882,7 +886,7 @@ presence of absence of a specific module

    top

    Include Directive

    Description: Includes other configuration files from within the server configuration files
    Syntax: - Include file-path|directory-path
    Context: + Include file-path|directory-path
    Context: server config, virtual host, directory
    Status: Core
    Module: core
    @@ -900,37 +904,37 @@ the server configuration files

    - Include /usr/local/apache/conf/ssl.conf
    - Include /usr/local/apache/conf/vhosts/ -

    - -

    Or, providing paths relative to your ServerRoot - directory:

    - -

    - Include conf/ssl.conf
    - Include conf/vhosts/ -

    - -

    Make sure that an included directory does not contain any stray - files, such as editor temporary files, for example, as Apache will - attempt to read them in and use the contents as configuration - directives, which may cause the server to fail on start up. - Running apachectl configtest will give you a list of - the files that are being processed during the configuration - check:

    - -
    - root@host# apachectl configtest
    -  Processing config directory: /usr/local/apache/conf/vhosts
    -  Processing config file: /usr/local/apache/conf/vhosts/vhost1
    -  Processing config file: /usr/local/apache/conf/vhosts/vhost2
    - Syntax OK
    -
    - -

    This will help in verifying that you are getting only the files - that you intended as part of your configuration.

    +

    + Include /usr/local/apache/conf/ssl.conf
    + Include /usr/local/apache/conf/vhosts/ +

    + +

    Or, providing paths relative to your ServerRoot + directory:

    + +

    + Include conf/ssl.conf
    + Include conf/vhosts/ +

    + +

    Make sure that an included directory does not contain any stray + files, such as editor temporary files, for example, as Apache will + attempt to read them in and use the contents as configuration + directives, which may cause the server to fail on start up. + Running apachectl configtest will give you a list of + the files that are being processed during the configuration + check:

    + +

    + root@host# apachectl configtest
    + Processing config directory: /usr/local/apache/conf/vhosts
    + Processing config file: /usr/local/apache/conf/vhosts/vhost1
    + Processing config file: /usr/local/apache/conf/vhosts/vhost2
    + Syntax OK +

    + +

    This will help in verifying that you are getting only the files + that you intended as part of your configuration.

    See also

    top

    KeepAlive Directive

    Description: Enables HTTP persistent connections
    Syntax: KeepAlive on|off
    Default: @@ -960,7 +964,7 @@ the server configuration files
    MaxKeepAliveRequests
    top

    KeepAliveTimeout Directive

    Description: Amount of time the server will wait for subsequent requests on a persistent connection
    Syntax: - KeepAliveTimeout seconds
    Default: + KeepAliveTimeout seconds
    Default: KeepAliveTimeout 15
    Context: server config, virtual host
    Status: Core
    Module: @@ -977,7 +981,7 @@ requests on a persistent connection
    top

    <Limit> Directive

    Description: Restrict enclosed access controls to only certain HTTP methods
    Syntax: - <Limit method [method] ... > ... + <Limit method [method] ... > ... </Limit>
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: @@ -997,20 +1001,23 @@ methods
    Syntax: example applies the access control only to the methods POST, PUT, and DELETE, leaving all other methods unprotected:

    -

    - <Limit POST PUT DELETE>
    -   Require valid-user
    - </Limit>
    -

    -

    The method names listed can be one or more of: GET, POST, PUT, - DELETE, CONNECT, OPTIONS, TRACE, PATCH, PROPFIND, PROPPATCH, - MKCOL, COPY, MOVE, LOCK, and UNLOCK. The method name is - case-sensitive. If GET is used it will also restrict - HEAD requests.

    +
    +<Limit POST PUT DELETE>
    +  Require valid-user
    +</Limit>
    + +

    The method names listed can be one or more of: GET, + POST, PUT, DELETE, + CONNECT, OPTIONS, TRACE, + PATCH, PROPFIND, PROPPATCH, + MKCOL, COPY, MOVE, + LOCK, and UNLOCK. The method name is + case-sensitive. If GET is used it will also + restrict HEAD requests.

    top

    <LimitExcept> Directive

    Description: Restrict access controls to all HTTP methods except the named ones
    Syntax: - <LimitExcept method [method] ... > ... + <LimitExcept method [method] ... > ... </LimitExcept>
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: @@ -1026,22 +1033,21 @@ except the named ones
    Synt

    For example:

    -

    - <LimitExcept POST GET>
    - Require valid-user
    - <LimitExcept> -

    +
    +<LimitExcept POST GET>
    +  Require valid-user
    +<LimitExcept>
    top

    LimitRequestBody Directive

    Description: Restricts the total size of the HTTP request body sent from the client
    Syntax: - LimitRequestBody bytes
    Default: + LimitRequestBody bytes
    Default: LimitRequestBody 0
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: Core
    Module: core
    -

    This directive specifies the number of bytes from 0 +

    This directive specifies the number of bytes from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in a request body. The default value is defined by the compile-time constant DEFAULT_LIMIT_REQUEST_BODY (0 as @@ -1070,18 +1076,18 @@ from the client

    Syntax: you might use the following directive:

    - LimitRequestBody 102400 + LimitRequestBody 102400

    top

    LimitRequestFields Directive

    Description: Limits the number of HTTP request header fields that will be accepted from the client
    Syntax: - LimitRequestFields number
    Default: + LimitRequestFields number
    Default: LimitRequestFields 100
    Context: server config
    Status: Core
    Module: core
    -

    Number is an integer from 0 (meaning unlimited) to +

    Number is an integer from 0 (meaning unlimited) to 32767. The default value is defined by the compile-time constant DEFAULT_LIMIT_REQUEST_FIELDS (100 as distributed).

    @@ -1107,18 +1113,18 @@ will be accepted from the client

    - LimitRequestFields 50 + LimitRequestFields 50

    top

    LimitRequestFieldSize Directive

    Description: Limits the size of the HTTP request header allowed from the client
    Syntax: - LimitRequestFieldsize bytes
    Default: + LimitRequestFieldsize bytes
    Default: LimitRequestFieldsize 8190
    Context: server config
    Status: Core
    Module: core
    -

    This directive specifies the number of bytes from 0 +

    This directive specifies the number of bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_FIELDSIZE (8190 as distributed) that will be allowed in an HTTP request @@ -1141,7 +1147,7 @@ client

    Syntax:

    For example:

    - LimitRequestFieldSize 16380 + LimitRequestFieldSize 16380

    Under normal conditions, the value should not be changed from @@ -1150,12 +1156,12 @@ client
    Syntax:
    top

    LimitRequestLine Directive

    Description: Limit the size of the HTTP request line that will be accepted from the client
    Syntax: - LimitRequestLine bytes
    Default: + LimitRequestLine bytes
    Default: LimitRequestLine 8190
    Context: server config
    Status: Core
    Module: core
    -

    This directive sets the number of bytes from 0 to +

    This directive sets the number of bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_LINE (8190 as distributed) that will be allowed on the HTTP request-line.

    @@ -1178,14 +1184,14 @@ from the client
    Syntax:

    For example:

    - LimitRequestLine 16380 + LimitRequestLine 16380

    Under normal conditions, the value should not be changed from the default.
    top

    LimitXMLRequestBody Directive

    Description: Limits the size of an XML-based request body
    Syntax: - LimitXMLRequestBody number
    Default: + LimitXMLRequestBody number
    Default: LimitXMLRequestBody 1000000
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: @@ -1197,7 +1203,7 @@ from the client
    Syntax:

    Example:

    - LimitXMLRequestBody 0 + LimitXMLRequestBody 0

    top

    <Location> Directive

    Description: @@ -1234,9 +1240,10 @@ URLs
    Syntax:

    Extended regular expressions can also be used, with the addition of the ~ character. For example:

    -

    - <Location ~ "/(extra|special)/data"> -

    + +

    + <Location ~ "/(extra|special)/data"> +

    would match URLs that contained the substring "/extra/data" or "/special/data". In Apache 1.3 and above, a new directive @@ -1249,31 +1256,33 @@ URLs

    Syntax: SetHandler directive. For example, to enable status requests, but allow them only from browsers at foo.com, you might use:

    -

    - <Location /status>
    - SetHandler server-status
    - Order Deny,Allow
    - Deny from all
    - Allow from .foo.com
    - </Location> -

    - -

    Note about / (slash)

    The slash character has -special meaning depending on where in a URL it appears. People may be -used to its behavior in the filesystem where multiple adjacent slashes -are frequently collapsed to a single slash (i.e., -/home///foo is the same as /home/foo). In -URL-space this is not necessarily true. The <LocationMatch> directive and the regex -version of <Location> require you -to explicitly specify multiple slashes if that is your intention. For -example, <LocationMatch ^/abc> would match the -request URL /abc but not the request URL -//abc. The (non-regex) <Location> directive behaves similarly when -used for proxy requests. But when (non-regex) <Location> is used for non-proxy requests it -will implicitly match multiple slashes with a single slash. For -example, if you specify <Location /abc/def> and the -request is to /abc//def then it will match.

    -
    + +
    +<Location /status>
    +  SetHandler server-status
    +  Order Deny,Allow
    +  Deny from all
    +  Allow from .foo.com
    +</Location>
    + +

    Note about / (slash)

    +

    The slash character has special meaning depending on where in a + URL it appears. People may be used to its behavior in the filesystem + where multiple adjacent slashes are frequently collapsed to a single + slash (i.e., /home///foo is the same as + /home/foo). In URL-space this is not necessarily true. + The <LocationMatch> + directive and the regex version of <Location> require you to explicitly specify multiple + slashes if that is your intention.

    + +

    For example, <LocationMatch ^/abc> would match + the request URL /abc but not the request URL + //abc. The (non-regex) <Location> directive behaves similarly when used for + proxy requests. But when (non-regex) <Location> is used for non-proxy requests it will + implicitly match multiple slashes with a single slash. For example, + if you specify <Location /abc/def> and the + request is to /abc//def then it will match.

    +

    See also

    Applies the enclosed directives only to regular-expression matching URLs
    Syntax: <LocationMatch - regex> ... </Location>
    Context: + regex> ... </Location>
    Context: server config, virtual host
    Status: Core
    Module: core

    The <LocationMatch> directive provides for access control by URL, in an identical manner to - <Location>. However, it takes a regular - expression as an argument instead of a simple string. For - example:

    -

    - <LocationMatch "/(extra|special)/data"> -

    + <Location>. However, + it takes a regular expression as an argument instead of a simple + string. For example:

    + +

    + <LocationMatch "/(extra|special)/data"> +

    -

    would match URLs that contained the substring "/extra/data" - or "/special/data".

    +

    would match URLs that contained the substring /extra/data + or /special/data.

    See also

    top

    LogLevel Directive

    Description: Controls the verbosity of the ErrorLog
    Syntax: - LogLevel level
    Default: + LogLevel level
    Default: LogLevel warn
    Context: server config, virtual host
    Status: Core
    Module: core

    LogLevel adjusts the verbosity of the messages recorded in the error logs (see ErrorLog directive). The following - levels are available, in order of decreasing + levels are available, in order of decreasing significance:

    @@ -1399,12 +1409,13 @@ matching URLs
    Syntax:

    For example:

    -

    LogLevel notice

    - +

    + LogLevel notice +

    top

    MaxKeepAliveRequests Directive

    Description: Number of requests allowed on a persistent connection
    Syntax: - MaxKeepAliveRequests number
    Default: + MaxKeepAliveRequests number
    Default: MaxKeepAliveRequests 100
    Context: server config, virtual host
    Status: Core
    Module: @@ -1418,21 +1429,25 @@ connection
    Syntax:

    For example:

    -

    MaxKeepAliveRequests 500

    +

    + MaxKeepAliveRequests 500 +

    top

    NameVirtualHost Directive

    Description: Designates an IP address for name-virtual hosting
    Syntax: - NameVirtualHost addr[:port]
    Context: + NameVirtualHost addr[:port]
    Context: server config
    Status: Core
    Module: core

    The NameVirtualHost directive is a required directive if you want to configure name-based virtual hosts.

    -

    Although addr can be hostname it is recommended - that you always use an IP address, e.g.

    +

    Although addr can be hostname it is recommended + that you always use an IP address, e.g.

    -

    NameVirtualHost 111.22.33.44

    +

    + NameVirtualHost 111.22.33.44 +

    With the NameVirtualHost directive you specify the IP address on which the server will receive requests @@ -1451,38 +1466,43 @@ hosting

    Syntax: don't define any VirtualHosts for that address).

    Optionally you can specify a port number on which the - name-based virtual hosts should be used, e.g.

    + name-based virtual hosts should be used, e.g.

    -

    NameVirtualHost 111.22.33.44:8080

    +

    + NameVirtualHost 111.22.33.44:8080 +

    -

    IPv6 addresses must be enclosed in square brackets, as shown - in the following example:

    +

    IPv6 addresses must be enclosed in square brackets, as shown + in the following example:

    -

    NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080

    +

    + NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080 +

    To receive requests on all interfaces, you can use an argument of *

    -

    NameVirtualHost *

    - -

    Argument to <VirtualHost> directive

    -

    Note that the argument to the <VirtualHost> directive must exactly -match the argument to the NameVirtualHost -directive.

    -

    -NameVirtualHost 1.2.3.4
    -<VirtualHost 1.2.3.4>
    -...
    -</VirtualHost>
    -

    -
    +

    + NameVirtualHost * +

    +

    Argument to <VirtualHost> directive

    +

    Note that the argument to the <VirtualHost> directive must + exactly match the argument to the NameVirtualHost directive.

    + +

    + NameVirtualHost 1.2.3.4
    + <VirtualHost 1.2.3.4>
    + # ...
    + </VirtualHost>
    +

    +

    See also

    top

    Options Directive

    Description: Configures what features are available in a particular directory
    Syntax: Options - [+|-]option [[+|-]option] ...
    Default: + [+|-]option [[+|-]option] ...
    Default: Options All
    Context: server config, virtual host, directory, .htaccess
    Override: Options
    Status: @@ -1491,7 +1511,7 @@ directory
    Syntax:

    The Options directive controls which server features are available in a particular directory.

    -

    option can be set to None, in which +

    option can be set to None, in which case none of the extra features are enabled, or one or more of the following:

    @@ -1510,13 +1530,14 @@ directory
    Syntax:
    - The server will follow symbolic links in this directory.
    - Note: even though the server follows the - symlink it does not change the pathname used to match - against
    <Directory> sections.
    - Note: this option gets ignored if set inside a - <Location> - section.
    + The server will follow symbolic links in this directory. +
    +

    Even though the server follows the symlink it does not + change the pathname used to match against <Directory> sections.

    +

    Note also, that this option gets ignored if set + inside a <Location> + section.

    +
    Includes
    @@ -1565,26 +1586,28 @@ directory
    Syntax:

    For example, without any + and - symbols:

    +
    +<Directory /web/docs>
    +  Options Indexes FollowSymLinks
    +</Directory>
    +
    +<Directory /web/docs/spec>
    +  Options Includes
    +</Directory>
    -

    <Directory /web/docs>
    - Options Indexes FollowSymLinks
    - </Directory>
    - <Directory /web/docs/spec>
    - Options Includes
    - </Directory> -

    then only Includes will be set for the /web/docs/spec directory. However if the second Options directive uses the + and - symbols:

    -

    - <Directory /web/docs>
    - Options Indexes FollowSymLinks
    - </Directory>
    - <Directory /web/docs/spec>
    - Options +Includes -Indexes
    - </Directory> -

    +
    +<Directory /web/docs>
    +  Options Indexes FollowSymLinks
    +</Directory>
    +
    +<Directory /web/docs/spec>
    +  Options +Includes -Indexes
    +</Directory>
    +

    then the options FollowSymLinks and Includes are set for the /web/docs/spec directory.

    @@ -1598,7 +1621,7 @@ directory
    Syntax:
    top

    Require Directive

    Description: Selects which authenticated users can access a resource
    Syntax: - Require entity-name [entity-name] ...
    Context: + Require entity-name [entity-name] ...
    Context: directory, .htaccess
    Override: AuthConfig
    Status: Core
    Module: @@ -1608,13 +1631,13 @@ a resource
    Syntax:
    • - Require user userid [userid] ... + Require user userid [userid] ...

      Only the named users can access the directory.

    • - Require group group-name [group-name] ... + Require group group-name [group-name] ...

      Only users in the named groups can access the @@ -1634,13 +1657,13 @@ a resource

    Syntax: and AuthGroupFile (to define users and groups) in order to work correctly. Example:

    -

    +

    AuthType Basic
    AuthName "Restricted Directory"
    AuthUserFile /web/users
    AuthGroupFile /web/groups
    - Require group admin
    -

    + Require group admin +

    Access controls which are applied in this way are effective for all methods. This is what is normally @@ -1652,7 +1675,7 @@ a resource

    Syntax:

    See also

    top

    RLimitCPU Directive

    Description: Limits the CPU consumption of processes launched by Apache children
    Syntax: - RLimitCPU number|max [number|max]
    Default: + RLimitCPU number|max [number|max]
    Default: Unset; uses operating system defaults
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: @@ -1661,7 +1684,7 @@ by Apache children
    Syntax:

    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 max to indicate to the server that the limit should + 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 @@ -1678,7 +1701,7 @@ by Apache children

    Syntax:

    See also

    top

    RLimitMEM Directive

    Description: Limits the memory consumption of processes launched by Apache children
    Syntax: - RLimitMEM number|max [number|max]
    Default: + RLimitMEM number|max [number|max]
    Default: Unset; uses operating system defaults
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: @@ -1687,7 +1710,7 @@ by Apache children
    Syntax:

    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 max to indicate to the server that the limit should + 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 @@ -1704,7 +1727,7 @@ by Apache children

    Syntax:

    See also

    top

    RLimitNPROC Directive

    Description: Limits the number of processes that can be launched by processes launched by Apache children
    Syntax: - RLimitNPROC number|max [number|max]
    Default: + RLimitNPROC number|max [number|max]
    Default: Unset; uses operating system defaults
    Context: server config, virtual host, directory, .htaccess
    Override: All
    Status: @@ -1731,7 +1754,7 @@ processes launched by Apache children
    RLimitMEM
  • RLimitCPU
  • top

    Satisfy Directive

    Description: Interaction between host-level access control and @@ -1743,10 +1766,10 @@ user authentication
    Syntax Core
    Module: core

    Access policy if both Allow and Require used. The parameter can be - either 'all' or 'any'. This directive is only + either all or any. This directive is only useful if access to a particular area is being restricted by both username/password and client host address. In this case - the default behavior ("all") is to require that the client passes + the default behavior (all) is to require that the client passes the address access restriction and enters a valid username and password. With the "any" option the client will be granted access if they either pass the host restriction or enter a @@ -1760,9 +1783,9 @@ user authentication

    Syntax configuration similar to the following:

    - Require valid-user
    - Allow from 192.168.1
    - Satisfy any + Require valid-user
    + Allow from 192.168.1
    + Satisfy any

    See also

    top

    ScriptInterpreterSource Directive

    Description: @@ -1784,7 +1807,7 @@ scripts
    Syntax:
    top

    ServerAdmin Directive

    Description: Email address that the server includes in error messages sent to the client
    Syntax: - ServerAdmin email-address
    Context: + ServerAdmin email-address
    Context: server config, virtual host
    Status: Core
    Module: core
    @@ -1792,32 +1815,34 @@ messages sent to the client

    ServerAdmin www-admin@foo.bar.com

    +

    It may be worth setting up a dedicated address for this, e.g.

    + +

    + ServerAdmin www-admin@foo.example.com +

    as users do not always mention that they are talking about the server!

    top

    ServerAlias Directive

    Description: Alternate names for a host used when matching requests to name-virtual hosts
    Syntax: - ServerAlias hostname [hostname] ...
    Context: + ServerAlias hostname [hostname] ...
    Context: virtual host
    Status: Core
    Module: core

    The ServerAlias directive sets the alternate names for a host, for use with name-based virtual hosts.

    -

    - <VirtualHost *>
    - ServerName server.domain.com
    - ServerAlias server server2.domain.com server2
    - ...
    - </VirtualHost> -

    +

    + <VirtualHost *>
    + ServerName server.domain.com
    + ServerAlias server server2.domain.com server2
    + # ...
    + </VirtualHost> +

    See also

    top

    ServerName Directive

    Description: Hostname and port that the server uses to identify itself
    Syntax: - ServerName fully-qualified-domain-name[:port]
    Context: + ServerName fully-qualified-domain-name[:port]
    Context: server config, virtual host
    Status: Core
    Module: core
    Compatibility: @@ -1832,7 +1857,9 @@ itself
    Syntax: and you wish the webserver to be so identified, the following directive should be used:

    -

    ServerName www.example.com:80

    +

    + ServerName www.example.com:80 +

    If no ServerName is specified, then the server attempts to deduce the hostname by performing a reverse @@ -1858,7 +1885,7 @@ itself

    Syntax: documentation
  • UseCanonicalName
  • NameVirtualHost
  • ServerAlias
  • top

    ServerPath Directive

    Description: Legacy URL pathname for a name-virtual host that is accessed by an incompatible browser
    Syntax: - ServerPath URL-path
    Context: + ServerPath URL-path
    Context: virtual host
    Status: Core
    Module: core
    @@ -1866,7 +1893,7 @@ is accessed by an incompatible browser
    name-based virtual hosts.

    See also

    top

    ServerRoot Directive

    Description: Base directory for the server installation
    Syntax: - ServerRoot directory-path
    Default: + ServerRoot directory-path
    Default: ServerRoot /usr/local/apache
    Context: server config
    Status: Core
    Module: @@ -1878,7 +1905,7 @@ is accessed by an incompatible browser

    Example

    - ServerRoot /home/httpd + ServerRoot /home/httpd

    See also

    ServerSignature
    top

    SetHandler Directive

    Description: Forces all matching files to be processed by a handler
    Syntax: - SetHandler handler-name
    Context: + SetHandler handler-name
    Context: server config, virtual host, directory, .htaccess
    Override: FileInfo
    Status: Core
    Module: @@ -1966,28 +1993,29 @@ handler
    Syntax: <Location> section, this directive forces all matching files to be parsed through the handler given by - handler-name. For example, if you had a directory you + handler-name. For example, if you had a directory you wanted to be parsed entirely as imagemap rule files, regardless of extension, you might put the following into an .htaccess file in that directory:

    -

    - SetHandler imap-file -

    + +

    + SetHandler imap-file +

    Another example: if you wanted to have the server display a status report whenever a URL of http://servername/status was called, you might put the following into httpd.conf:

    -

    - <Location /status>
    - SetHandler server-status
    - </Location> -

    +

    + <Location /status>
    + SetHandler server-status
    + </Location> +

    See also

    top

    SetInputFilter Directive

    Description: Sets the filters that will process client requests and POST input
    Syntax: - SetInputFilter filter[;filter...]
    Context: + SetInputFilter filter[;filter...]
    Context: server config, virtual host, directory, .htaccess
    Override: FileInfo
    Status: Core
    Module: @@ -2005,7 +2033,7 @@ input
    Syntax:

    See also

    top

    SetOutputFilter Directive

    Description: Sets the filters that will process responses from the server
    Syntax: - SetOutputFilter filter[;filter...]
    Context: + SetOutputFilter filter[;filter...]
    Context: server config, virtual host, directory, .htaccess
    Override: FileInfo
    Status: Core
    Module: @@ -2020,11 +2048,11 @@ server
    Syntax:

    For example, the following configuration will process all files in the /www/data/ directory for server-side includes.

    -

    -<Directory /www/data/>
    -  SetOutputFilter INCLUDES
    -</Directory> -

    + +
    +<Directory /www/data/>
    +  SetOutputFilter INCLUDES
    +</Directory>

    If more than one filter is specified, they must be separated by semicolons in the order in which they should process the @@ -2032,7 +2060,7 @@ server

    Syntax:

    See also

    top

    TimeOut Directive

    Description: Amount of time the server will wait for certain events before failing a request
    Syntax: - TimeOut number
    Default: + TimeOut number
    Default: TimeOut 300
    Context: server config
    Status: Core
    Module: @@ -2065,13 +2093,13 @@ port
    Syntax: server config, virtual host, directory
    Status: Core
    Module: core
    -

    In many situations Apache must construct a - self-referential URL -- that is, a URL that refers back to - the same server. With UseCanonicalName on Apache will - use the hostname and port specified in the ServerName directive to construct the canonical - name for the server. This name is used in all self-referential - URLs, and for the values of SERVER_NAME and - SERVER_PORT in CGIs.

    +

    In many situations Apache must construct a self-referential + URL -- that is, a URL that refers back to the same server. With + UseCanonicalName on Apache will use the hostname and port + specified in the ServerName + directive to construct the canonical name for the server. This name + is used in all self-referential URLs, and for the values of + SERVER_NAME and SERVER_PORT in CGIs.

    With UseCanonicalName off Apache will form self-referential URLs using the hostname and port supplied by @@ -2113,7 +2141,7 @@ port

    Syntax: Contains directives that apply only to a specific hostname or IP address
    Syntax: <VirtualHost - addr[:port] [addr[:port]] + addr[:port] [addr[:port]] ...> ... </VirtualHost>
    Context: server config
    Status: Core
    Module: @@ -2125,7 +2153,7 @@ hostname or IP address
    Syn used. When the server receives a request for a document on a particular virtual host, it uses the configuration directives enclosed in the <VirtualHost> - section. Addr can be

    + section. Addr can be:

    • The IP address of the virtual host;
    • @@ -2140,31 +2168,30 @@ hostname or IP address
    Syn with IP virtual hosting to catch unmatched IP addresses. - -

    Example

    - <VirtualHost 10.1.2.3>
    - ServerAdmin webmaster@host.foo.com
    - DocumentRoot /www/docs/host.foo.com
    - ServerName host.foo.com
    - ErrorLog logs/host.foo.com-error_log
    - TransferLog logs/host.foo.com-access_log
    - </VirtualHost> -

    +

    Example

    + <VirtualHost 10.1.2.3>
    + ServerAdmin webmaster@host.foo.com
    + DocumentRoot /www/docs/host.foo.com
    + ServerName host.foo.com
    + ErrorLog logs/host.foo.com-error_log
    + TransferLog logs/host.foo.com-access_log
    + </VirtualHost> +

    -

    IPv6 addresses must be specified in square brackets because - the optional port number could not be determined otherwise. An - IPv6 example is shown below:

    - -

    -<VirtualHost [fe80::a00:20ff:fea7:ccea]>
    - ServerAdmin webmaster@host.foo.com
    - DocumentRoot /www/docs/host.foo.com
    - ServerName host.foo.com
    - ErrorLog logs/host.foo.com-error_log
    - TransferLog logs/host.foo.com-access_log
    - </VirtualHost> -

    +

    IPv6 addresses must be specified in square brackets because + the optional port number could not be determined otherwise. An + IPv6 example is shown below:

    + +

    + <VirtualHost [fe80::a00:20ff:fea7:ccea]>
    + ServerAdmin webmaster@host.example.com
    + DocumentRoot /www/docs/host.example.com
    + ServerName host.example.com
    + ErrorLog logs/host.example.com-error_log
    + TransferLog logs/host.example.com-access_log
    + </VirtualHost> +

    Each Virtual Host must correspond to a different IP address, different port number or a different host name for the server, diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml index 42d0166c0b..641c373298 100644 --- a/docs/manual/mod/core.xml +++ b/docs/manual/mod/core.xml @@ -66,20 +66,22 @@ available based on PATH_INFO. The core handler would usually reject the request, so you can use the following configuration to enable such a script:

    - -<Files "mypaths.shtml">
    - Options +Includes
    - SetOutputFilter INCLUDES
    - AcceptPathInfo on
    -</Files> -
    + +
    +<Files "mypaths.shtml">
    +  Options +Includes
    +  SetOutputFilter INCLUDES
    +  AcceptPathInfo on
    +</Files>
    +
    + AccessFileName Name of the distributed configuration file -AccessFileName filename [filename] ... +AccessFileName filename [filename] ... AccessFileName .htaccess server configvirtual host @@ -91,9 +93,9 @@ available configuration files are enabled for that directory. For example:

    - -AccessFileName .acl - + + AccessFileName .acl +

    before returning the document /usr/local/web/index.html, the server will read @@ -101,11 +103,11 @@ AccessFileName .acl /usr/local/.acl and /usr/local/web/.acl for directives, unless they have been disabled with

    - -<Directory />
    -  AllowOverride None
    -</Directory> -
    +
    +<Directory />
    +  AllowOverride None
    +</Directory>
    +
    AllowOverride
    Configuration Files @@ -116,7 +118,7 @@ AccessFileName .acl AddDefaultCharset Default character set to be added for a response without an explicit character set -AddDefaultCharset On|Off|charset +AddDefaultCharset On|Off|charset AddDefaultCharset Off server config virtual hostdirectory @@ -124,7 +126,6 @@ response without an explicit character set FileInfo -

    This directive specifies the name of the character set that will be added to any response that does not have any parameter on the content type in the HTTP headers. This will override any @@ -134,11 +135,11 @@ response without an explicit character set functionality. AddDefaultCharset On enables Apache's internal default charset of iso-8859-1 as required by the directive. You can also specify an alternate - charset to be used. For example:

    + charset to be used. For example:

    - - AddDefaultCharset utf-8 - + + AddDefaultCharset utf-8 +
    @@ -146,8 +147,8 @@ response without an explicit character set AllowOverride Types of directives that are allowed in .htaccess files -AllowOverride All|None|directive-type -[directive-type] ... +AllowOverride All|None|directive-type +[directive-type] ... AllowOverride All directory @@ -167,7 +168,7 @@ response without an explicit character set href="directive-dict.html#Context">Context is allowed in .htaccess files.

    -

    The directive-type can be one of the following +

    The directive-type can be one of the following groupings of directives.

    @@ -234,7 +235,9 @@ response without an explicit character set

    Example:

    - AllowOverride AuthConfig Indexes + + AllowOverride AuthConfig Indexes + AccessFileName @@ -246,7 +249,7 @@ response without an explicit character set AuthName Authorization realm for use in HTTP authentication -AuthName auth-domain +AuthName auth-domain directory.htaccess AuthConfig @@ -266,7 +269,9 @@ authentication

    For example:

    - AuthName "Top Secret" + + AuthName "Top Secret" +

    The string provided for the AuthName is what will appear in the password dialog provided by most browsers.

    @@ -344,9 +349,10 @@ headers message integrity check (MIC) of the entity-body. A proxy or client may check this header for detecting accidental modification of the entity-body in transit. Example header:

    - - Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA== - + + + Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA== +

    Note that this can cause performance problems on your server since the message digest is computed on every request (the @@ -363,7 +369,7 @@ headers DefaultType MIME content-type that will be sent if the server cannot determine a type in any other way -DefaultType MIME-type +DefaultType MIME-type DefaultType text/plain server configvirtual host directory.htaccess @@ -379,9 +385,10 @@ server cannot determine a type in any other way document, so in the event of an unknown type it uses the DefaultType. For example:

    - - DefaultType image/gif - + + DefaultType image/gif + +

    would be appropriate for a directory which contained many gif images with filenames missing the .gif extension.

    @@ -397,7 +404,7 @@ server cannot determine a type in any other way Directory Enclose a group of directives that apply only to the named file-system directory and sub-directories -<Directory directory-path> +<Directory directory-path> ... </Directory> server configvirtual host @@ -407,7 +414,7 @@ named file-system directory and sub-directories </Directory> are used to enclose a group of directives that will apply only to the named directory and sub-directories of that directory. Any directive that is allowed - in a directory context may be used. Directory-path is + in a directory context may be used. Directory-path is either the full path to a directory, or a wild-card string using Unix shell-style matching. In a wild-card string, `?' matches any single character, and `*' matches any sequences of characters. @@ -416,26 +423,30 @@ named file-system directory and sub-directories /*/public_html> will not match /home/user/public_html, but <Directory /home/*/public_html> will match. Example:

    - - <Directory /usr/local/httpd/htdocs>
    -  Options Indexes FollowSymLinks
    - </Directory>
    -
    - - -

    Be careful with the directory-path arguments: They have -to literally match the filesystem path which Apache uses to access the -files. Directives applied to a particular <Directory> will not -apply to files accessed from that same directory via a different path, -such as via different symbolic links.

    -
    + +
    +<Directory /usr/local/httpd/htdocs>
    +  Options Indexes FollowSymLinks
    +</Directory>
    +
    + + +

    Be careful with the directory-path arguments: + They have to literally match the filesystem path which Apache uses + to access the files. Directives applied to a particular + <Directory> will not apply to files accessed from that same + directory via a different path, such as via different symbolic + links.

    +

    Extended regular expressions can also be used, with the addition of the ~ character. For example:

    - - <Directory ~ "^/www/.*/[0-9]{3}"> - + + + <Directory ~ "^/www/.*/[0-9]{3}"> + +

    would match directories in /www/ that consisted of three numbers.

    @@ -446,15 +457,16 @@ such as via different symbolic links.

    href="#accessfilename">.htaccess files. For example, with

    - - <Directory />
    -   AllowOverride None
    - </Directory>
    -
    - <Directory /home/>
    -   AllowOverride FileInfo
    - </Directory> -
    +
    +<Directory />
    +  AllowOverride None
    +</Directory>
    +
    +<Directory /home/>
    +  AllowOverride FileInfo
    +</Directory>
    +
    +

    for access to the document /home/web/dir/doc.html the steps are:

    @@ -474,10 +486,11 @@ such as via different symbolic links.

    expressions are tested in the order they appeared in the configuration file. For example, with

    -<Directory ~ abc$>
    - ... directives here ...
    - </Directory>
    -
    +
    +<Directory ~ abc$>
    +  # ... directives here ...
    +</Directory>
    +

    The regular expression section won't be considered until after all normal <Directory>s and .htaccess files @@ -490,12 +503,12 @@ such as via different symbolic links.

    recommended that you change this with a block such as

    - - <Directory />
    -   Order Deny,Allow
    -   Deny from All
    - </Directory> -
    +
    +<Directory />
    +  Order Deny,Allow
    +  Deny from All
    +</Directory>
    +

    and then override this for directories you want accessible. See the Enclose directives that apply to file-system directories matching a regular expression and their subdirectories -<DirectoryMatch regex> +<DirectoryMatch regex> ... </Directory> server configvirtual host @@ -532,9 +545,10 @@ subdirectories sub-directories of that directory, the same as Directory. However, it takes as an argument a regular expression. For example:

    - - <DirectoryMatch "^/www/.*/[0-9]{3}"> - + + + <DirectoryMatch "^/www/.*/[0-9]{3}"> +

    would match directories in /www/ that consisted of three numbers.

    @@ -552,7 +566,7 @@ combined when a request is received DocumentRoot Directory that forms the main document tree visible from the web -DocumentRoot directory-path +DocumentRoot directory-path DocumentRoot /usr/local/apache/htdocs server configvirtual host @@ -562,9 +576,11 @@ from the web serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document. Example:

    - - DocumentRoot /usr/web - + + + DocumentRoot /usr/web + +

    then an access to http://www.my.host.com/index.html refers to /usr/web/index.html.

    @@ -592,13 +608,12 @@ Location
    delivery. By default, when the handling of a request requires access to the data within a file-- for example, when delivering a server-parsed file using mod_include-- Apache - memory-maps the file if the OS supports it. -

    -

    - This memory-mapping sometimes yields a performance improvement. + memory-maps the file if the OS supports it.

    + +

    This memory-mapping sometimes yields a performance improvement. But in some environments, it is better to disable the memory-mapping - to prevent operational problems: -

    + to prevent operational problems:

    +
    • On some multiprocessor systems, memory-mapping can reduce the performance of the httpd.
    • @@ -606,13 +621,13 @@ Location the httpd may crash due tof a segmentation fault if a file is deleted or truncated while the httpd has it memory-mapped.
    -

    - For server configurations that are vulnerable to these problems, - you should disable memory-mapping of delivered files by specifying: -

    - - EnableMMAP off - + +

    For server configurations that are vulnerable to these problems, + you should disable memory-mapping of delivered files by specifying:

    + + + EnableMMAP off + @@ -620,7 +635,7 @@ Location ErrorDocument What the server will return to the client in case of an error -ErrorDocument error-code document +ErrorDocument error-code document server configvirtual host directory.htaccess @@ -637,10 +652,10 @@ in case of an error
  • output a customized message
  • -
  • redirect to a local URL-path to handle the +
  • redirect to a local URL-path to handle the problem/error
  • -
  • redirect to an external URL to handle the +
  • redirect to an external URL to handle the problem/error
  • @@ -654,14 +669,12 @@ in case of an error URL which the client can resolve. Alternatively, a message can be provided to be displayed by the browser. Examples:

    - - ErrorDocument 500 - http://foo.example.com/cgi-bin/tester
    - ErrorDocument 404 /cgi-bin/bad_urls.pl
    - ErrorDocument 401 /subscription_info.html
    - ErrorDocument 403 "Sorry can't allow you access - today" -
    + + ErrorDocument 500 http://foo.example.com/cgi-bin/tester
    + ErrorDocument 404 /cgi-bin/bad_urls.pl
    + ErrorDocument 401 /subscription_info.html
    + ErrorDocument 403 "Sorry can't allow you access today" +

    Note that when you specify an ErrorDocument that points to a remote URL (ie. anything with a method such as @@ -699,7 +712,7 @@ in case of an error ErrorLog Location where the server will log errors - ErrorLog file-path|syslog[:facility] + ErrorLog file-path|syslog[:facility] ErrorLog logs/error_log (Unix) ErrorLog logs/error.log (Windows and OS/2) server configvirtual host @@ -708,17 +721,17 @@ 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 + the file-path does not begin with a slash (/) then it is assumed to be relative to the ServerRoot. If the file-path + module="core">ServerRoot. If the file-path begins with a pipe (|) then it is assumed to be a command to spawn to handle the error log.

    Using syslog instead of a filename enables logging via syslogd(8) if the system supports it. The default is to use syslog facility local7, but you can override this by - using the syslog:facility syntax where - facility can be one of the names usually documented in + using the syslog:facility syntax where + facility can be one of the names usually documented in syslog(1).

    SECURITY: See the FileETag File attributes used to create the ETag HTTP response header -FileETag component ... +FileETag component ... FileETag INode MTime Size server configvirtual host directory.htaccess @@ -753,6 +766,7 @@ HTTP response header FileETag directive allows you to choose which of these -- if any -- should be used. The recognized keywords are:

    +
    INode
    The file's i-node number will be included in the calculation
    @@ -761,27 +775,25 @@ HTTP response header
    Size
    The number of bytes in the file will be included
    All
    -
    All available fields will be used (equivalent to - 'FileETag INode MTime Size')
    +
    All available fields will be used. This is equivalent to: + FileETag INode MTime Size
    None
    If a document is file-based, no ETag field will be included in the response
    -

    - The INode, MTime, and Size keywords may be prefixed with either '+' - or '-', which allow changes to be made to the default setting - inherited from a broader scope. Any keyword appearing without - such a prefix immediately and completely cancels the inherited - setting. -

    -

    - If a directory's configuration includes - 'FileETag INode MTime Size', and a - subdirectory's includes 'FileETag -INode', + +

    The INode, MTime, and Size + keywords may be prefixed with either + or -, + which allow changes to be made to the default setting inherited + from a broader scope. Any keyword appearing without such a prefix + immediately and completely cancels the inherited setting.

    + +

    If a directory's configuration includes + FileETag INode MTime Size, and a + subdirectory's includes FileETag -INode, the setting for that subdirectory (which will be inherited by any sub-subdirectories that don't override it) will be equivalent to - 'FileETag MTime Size'. -

    + FileETag MTime Size.

    @@ -789,7 +801,7 @@ HTTP response header Files Contains directives that apply to matched filenames -<Files filename> ... </Files> +<Files filename> ... </Files> server configvirtual host directory.htaccess @@ -815,14 +827,16 @@ filenames module="core">Directory sections to restrict the portion of the filesystem they apply to.

    -

    The filename argument should include a filename, or +

    The filename argument should include a filename, or a wild-card string, where `?' matches any single character, and `*' matches any sequences of characters. Extended regular expressions can also be used, with the addition of the ~ character. For example:

    - - <Files ~ "\.(gif|jpe?g|png)$"> - + + + <Files ~ "\.(gif|jpe?g|png)$"> + +

    would match most common Internet graphics formats. In Apache 1.3 and later, FilesMatch is preferred, however.

    @@ -845,7 +859,7 @@ filenames FilesMatch Contains directives that apply to regular-expression matched filenames -<FilesMatch regex> ... </FilesMatch> +<FilesMatch regex> ... </FilesMatch> server configvirtual host directory.htaccess @@ -856,9 +870,10 @@ filenames provides for access control by filename, just as the Files directive does. However, it accepts a regular expression. For example:

    - - <FilesMatch "\.(gif|jpe?g|png)$"> - + + + <FilesMatch "\.(gif|jpe?g|png)$"> +

    would match most common Internet graphics formats.

    @@ -873,7 +888,7 @@ filenames ForceType Forces all matching files to be served with the specified MIME content-type -ForceType mime-type +ForceType MIME-type directory.htaccess FileInfo @@ -886,12 +901,13 @@ MIME content-type Files section, this directive forces all matching files to be served with the content type identification given by - mime-type. For example, if you had a directory full of + MIME-type. For example, if you had a directory full of GIF files, but did not want to label them all with ".gif", you might want to use:

    - - ForceType image/gif - + + + ForceType image/gif +

    Note that unlike DefaultType, this directive overrides all mime-type associations, including @@ -935,7 +951,7 @@ MIME content-type off, since DNS lookups can take considerable amounts of time. The utility logresolve, provided in - the /support directory, can be used to look up host + the /support directory, can be used to look up host names from logged IP addresses offline.

    @@ -970,7 +986,7 @@ user IfDefine Encloses directives that will be processed only if a test is true at startup -<IfDefine [!]parameter-name> ... +<IfDefine [!]parameter-name> ... </IfDefine> server configvirtual host directory.htaccess @@ -978,47 +994,45 @@ if a test is true at startup All -

    The <IfDefine - test>...</IfDefine> section is used to - mark directives that are conditional. The directives within an - IfDefine section are only - processed if the test is true. If test is false, - everything between the start and end markers is ignored.

    +

    The <IfDefine test>...</IfDefine> + section is used to mark directives that are conditional. The + directives within an IfDefine + section are only processed if the test is true. If + test is false, everything between the start and end markers is + ignored.

    -

    The test in the IfDefine section directive can be one - of two forms:

    +

    The test in the IfDefine section directive can be one of two forms:

      -
    • parameter-name
    • +
    • parameter-name
    • -
    • !parameter-name
    • +
    • !parameter-name

    In the former case, the directives between the start and end markers are only processed if the parameter named - parameter-name is defined. The second format reverses + parameter-name is defined. The second format reverses the test, and only processes the directives if - parameter-name is not defined.

    + parameter-name is not defined.

    -

    The parameter-name argument is a define as given on - the httpd command line via - -Dparameter-, at the time the server was - started.

    +

    The parameter-name argument is a define as given on + the httpd command line via -Dparameter- + , at the time the server was started.

    IfDefine sections are nest-able, which can be used to implement simple multiple-parameter tests. Example:

    -
    -  $ httpd -DReverseProxy ...
     
    -  # httpd.conf
    -  <IfDefine ReverseProxy>
    +    
    +$ httpd -DReverseProxy ...
    +
    +# httpd.conf
    +<IfDefine ReverseProxy>
       LoadModule rewrite_module modules/mod_rewrite.so
       LoadModule proxy_module   modules/libproxy.so
    -  </IfDefine>
    -
    - +</IfDefine>
    +
    @@ -1026,7 +1040,7 @@ if a test is true at startup IfModule Encloses directives that are processed conditional on the presence of absence of a specific module -<IfModule [!]module-name> ... +<IfModule [!]module-name> ... </IfModule> server configvirtual host directory.htaccess @@ -1034,33 +1048,31 @@ presence of absence of a specific module All -

    The <IfModule - test>...</IfModule> section is used to - mark directives that are conditional on the presence of a - specific module. The directives within an - IfModule section are only - processed if the test is true. If test is false, - everything between the start and end markers is ignored.

    - -

    The test in the IfModule section directive can be one - of two forms:

    +

    The <IfModule test>...</IfModule> + section is used to mark directives that are conditional on the presence of a + specific module. The directives within an IfModule section are only processed if the test + is true. If test is false, everything between the start and + end markers is ignored.

    + +

    The test in the IfModule section directive can be one of two forms:

      -
    • module name
    • +
    • module name
    • -
    • !module name
    • +
    • !module name

    In the former case, the directives between the start and end - markers are only processed if the module named module - name is included in Apache -- either compiled in or + markers are only processed if the module named module + name is included in Apache -- either compiled in or dynamically loaded using LoadModule. The second format - reverses the test, and only processes the directives if module - name is not included.

    + >LoadModule. The second format reverses the test, + and only processes the directives if module name is + not included.

    -

    The module name argument is the file name of the +

    The module name argument is the file name of the module, at the time it was compiled. For example, mod_rewrite.c. If a module consists of several source files, use the name of the file containing the string @@ -1082,7 +1094,7 @@ presence of absence of a specific module Include Includes other configuration files from within the server configuration files -Include file-path|directory-path +Include file-path|directory-path server configvirtual host directory @@ -1102,37 +1114,37 @@ the server configuration files

    Examples:

    - - Include /usr/local/apache/conf/ssl.conf
    - Include /usr/local/apache/conf/vhosts/ -
    - -

    Or, providing paths relative to your ServerRoot - directory:

    - - - Include conf/ssl.conf
    - Include conf/vhosts/ -
    - -

    Make sure that an included directory does not contain any stray - files, such as editor temporary files, for example, as Apache will - attempt to read them in and use the contents as configuration - directives, which may cause the server to fail on start up. - Running apachectl configtest will give you a list of - the files that are being processed during the configuration - check:

    - -
    - root@host# apachectl configtest
    -  Processing config directory: /usr/local/apache/conf/vhosts
    -  Processing config file: /usr/local/apache/conf/vhosts/vhost1
    -  Processing config file: /usr/local/apache/conf/vhosts/vhost2
    - Syntax OK
    -
    - -

    This will help in verifying that you are getting only the files - that you intended as part of your configuration.

    + + Include /usr/local/apache/conf/ssl.conf
    + Include /usr/local/apache/conf/vhosts/ +
    + +

    Or, providing paths relative to your ServerRoot + directory:

    + + + Include conf/ssl.conf
    + Include conf/vhosts/ +
    + +

    Make sure that an included directory does not contain any stray + files, such as editor temporary files, for example, as Apache will + attempt to read them in and use the contents as configuration + directives, which may cause the server to fail on start up. + Running apachectl configtest will give you a list of + the files that are being processed during the configuration + check:

    + + + root@host# apachectl configtest
    + Processing config directory: /usr/local/apache/conf/vhosts
    + Processing config file: /usr/local/apache/conf/vhosts/vhost1
    + Processing config file: /usr/local/apache/conf/vhosts/vhost2
    + Syntax OK +
    + +

    This will help in verifying that you are getting only the files + that you intended as part of your configuration.

    apachectl @@ -1175,7 +1187,7 @@ the server configuration files KeepAliveTimeout Amount of time the server will wait for subsequent requests on a persistent connection -KeepAliveTimeout seconds +KeepAliveTimeout seconds KeepAliveTimeout 15 server configvirtual host @@ -1197,7 +1209,7 @@ requests on a persistent connection Limit Restrict enclosed access controls to only certain HTTP methods -<Limit method [method] ... > ... +<Limit method [method] ... > ... </Limit> server configvirtual host directory.htaccess @@ -1219,16 +1231,20 @@ methods example applies the access control only to the methods POST, PUT, and DELETE, leaving all other methods unprotected:

    - - <Limit POST PUT DELETE>
    -   Require valid-user
    - </Limit>
    -
    -

    The method names listed can be one or more of: GET, POST, PUT, - DELETE, CONNECT, OPTIONS, TRACE, PATCH, PROPFIND, PROPPATCH, - MKCOL, COPY, MOVE, LOCK, and UNLOCK. The method name is - case-sensitive. If GET is used it will also restrict - HEAD requests.

    +
    +<Limit POST PUT DELETE>
    +  Require valid-user
    +</Limit>
    +
    + +

    The method names listed can be one or more of: GET, + POST, PUT, DELETE, + CONNECT, OPTIONS, TRACE, + PATCH, PROPFIND, PROPPATCH, + MKCOL, COPY, MOVE, + LOCK, and UNLOCK. The method name is + case-sensitive. If GET is used it will also + restrict HEAD requests.

    @@ -1236,7 +1252,7 @@ methods LimitExcept Restrict access controls to all HTTP methods except the named ones -<LimitExcept method [method] ... > ... +<LimitExcept method [method] ... > ... </LimitExcept> server configvirtual host directory.htaccess @@ -1256,10 +1272,10 @@ except the named ones

    For example:

    - - <LimitExcept POST GET>
    - Require valid-user
    - <LimitExcept> +
    +<LimitExcept POST GET>
    +  Require valid-user
    +<LimitExcept>
    @@ -1269,7 +1285,7 @@ except the named ones LimitRequestBody Restricts the total size of the HTTP request body sent from the client -LimitRequestBody bytes +LimitRequestBody bytes LimitRequestBody 0 server configvirtual host directory.htaccess @@ -1277,7 +1293,7 @@ from the client All -

    This directive specifies the number of bytes from 0 +

    This directive specifies the number of bytes from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in a request body. The default value is defined by the compile-time constant DEFAULT_LIMIT_REQUEST_BODY (0 as @@ -1306,7 +1322,7 @@ from the client you might use the following directive:

    - LimitRequestBody 102400 + LimitRequestBody 102400
    @@ -1316,12 +1332,12 @@ from the client LimitRequestFields Limits the number of HTTP request header fields that will be accepted from the client -LimitRequestFields number +LimitRequestFields number LimitRequestFields 100 server config -

    Number is an integer from 0 (meaning unlimited) to +

    Number is an integer from 0 (meaning unlimited) to 32767. The default value is defined by the compile-time constant DEFAULT_LIMIT_REQUEST_FIELDS (100 as distributed).

    @@ -1347,7 +1363,7 @@ will be accepted from the client

    For example:

    - LimitRequestFields 50 + LimitRequestFields 50
    @@ -1357,12 +1373,12 @@ will be accepted from the client LimitRequestFieldSize Limits the size of the HTTP request header allowed from the client -LimitRequestFieldsize bytes +LimitRequestFieldsize bytes LimitRequestFieldsize 8190 server config -

    This directive specifies the number of bytes from 0 +

    This directive specifies the number of bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_FIELDSIZE (8190 as distributed) that will be allowed in an HTTP request @@ -1385,7 +1401,7 @@ client

    For example:

    - LimitRequestFieldSize 16380 + LimitRequestFieldSize 16380 Under normal conditions, the value should not be changed from @@ -1398,12 +1414,12 @@ client LimitRequestLine Limit the size of the HTTP request line that will be accepted from the client -LimitRequestLine bytes +LimitRequestLine bytes LimitRequestLine 8190 server config -

    This directive sets the number of bytes from 0 to +

    This directive sets the number of bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_LINE (8190 as distributed) that will be allowed on the HTTP request-line.

    @@ -1426,7 +1442,7 @@ from the client

    For example:

    - LimitRequestLine 16380 + LimitRequestLine 16380 Under normal conditions, the value should not be changed from @@ -1437,7 +1453,7 @@ from the client LimitXMLRequestBody Limits the size of an XML-based request body -LimitXMLRequestBody number +LimitXMLRequestBody number LimitXMLRequestBody 1000000 server configvirtual host directory.htaccess @@ -1450,7 +1466,7 @@ from the client

    Example:

    - LimitXMLRequestBody 0 + LimitXMLRequestBody 0
    @@ -1495,9 +1511,10 @@ URLs

    Extended regular expressions can also be used, with the addition of the ~ character. For example:

    - - <Location ~ "/(extra|special)/data"> - + + + <Location ~ "/(extra|special)/data"> +

    would match URLs that contained the substring "/extra/data" or "/special/data". In Apache 1.3 and above, a new directive @@ -1510,34 +1527,37 @@ URLs SetHandler directive. For example, to enable status requests, but allow them only from browsers at foo.com, you might use:

    - - <Location /status>
    - SetHandler server-status
    - Order Deny,Allow
    - Deny from all
    - Allow from .foo.com
    - </Location> -
    - -Note about / (slash)

    The slash character has -special meaning depending on where in a URL it appears. People may be -used to its behavior in the filesystem where multiple adjacent slashes -are frequently collapsed to a single slash (i.e., -/home///foo is the same as /home/foo). In -URL-space this is not necessarily true. The LocationMatch directive and the regex -version of Location require you -to explicitly specify multiple slashes if that is your intention. For -example, <LocationMatch ^/abc> would match the -request URL /abc but not the request URL -//abc. The (non-regex) Location directive behaves similarly when -used for proxy requests. But when (non-regex) Location is used for non-proxy requests it -will implicitly match multiple slashes with a single slash. For -example, if you specify <Location /abc/def> and the -request is to /abc//def then it will match.

    -
    + +
    +<Location /status>
    +  SetHandler server-status
    +  Order Deny,Allow
    +  Deny from all
    +  Allow from .foo.com
    +</Location>
    +
    + + Note about / (slash) +

    The slash character has special meaning depending on where in a + URL it appears. People may be used to its behavior in the filesystem + where multiple adjacent slashes are frequently collapsed to a single + slash (i.e., /home///foo is the same as + /home/foo). In URL-space this is not necessarily true. + The LocationMatch + directive and the regex version of Location require you to explicitly specify multiple + slashes if that is your intention.

    + +

    For example, <LocationMatch ^/abc> would match + the request URL /abc but not the request URL + //abc. The (non-regex) Location directive behaves similarly when used for + proxy requests. But when (non-regex) Location is used for non-proxy requests it will + implicitly match multiple slashes with a single slash. For example, + if you specify <Location /abc/def> and the + request is to /abc//def then it will match.

    +
    How Directory, Location and Files sections work for an @@ -1550,23 +1570,23 @@ request is to /abc//def then it will match.

    Applies the enclosed directives only to regular-expression matching URLs <LocationMatch - regex> ... </Location> + regex> ... </Location>
    server configvirtual host

    The LocationMatch directive provides for access control by URL, in an identical manner to - Location. However, it takes a regular - expression as an argument instead of a simple string. For - example:

    - - <LocationMatch "/(extra|special)/data"> - + Location. However, + it takes a regular expression as an argument instead of a simple + string. For example:

    -

    would match URLs that contained the substring "/extra/data" - or "/special/data".

    + + <LocationMatch "/(extra|special)/data"> + + +

    would match URLs that contained the substring /extra/data + or /special/data.

    How @@ -1578,7 +1598,7 @@ matching URLs LogLevel Controls the verbosity of the ErrorLog -LogLevel level +LogLevel level LogLevel warn server configvirtual host @@ -1587,7 +1607,7 @@ matching URLs

    LogLevel adjusts the verbosity of the messages recorded in the error logs (see ErrorLog directive). The following - levels are available, in order of decreasing + levels are available, in order of decreasing significance:

    @@ -1678,8 +1698,9 @@ matching URLs

    For example:

    - LogLevel notice - + + LogLevel notice + @@ -1687,7 +1708,7 @@ matching URLsMaxKeepAliveRequestsNumber of requests allowed on a persistent connection -MaxKeepAliveRequests number +MaxKeepAliveRequests numberMaxKeepAliveRequests 100server configvirtual host @@ -1702,7 +1723,9 @@ connection

    For example:

    - MaxKeepAliveRequests 500 + + MaxKeepAliveRequests 500 + @@ -1710,7 +1733,7 @@ connectionNameVirtualHostDesignates an IP address for name-virtual hosting -NameVirtualHost addr[:port] +NameVirtualHost addr[:port]server config @@ -1718,10 +1741,12 @@ hosting required directive if you want to configure name-based virtual hosts.

    -

    Although addr can be hostname it is recommended - that you always use an IP address, e.g.

    +

    Although addr can be hostname it is recommended + that you always use an IP address, e.g.

    -NameVirtualHost 111.22.33.44 + + NameVirtualHost 111.22.33.44 +

    With the NameVirtualHost directive you specify the IP address on which the server will receive requests @@ -1740,32 +1765,38 @@ hosting don't define any VirtualHosts for that address).

    Optionally you can specify a port number on which the - name-based virtual hosts should be used, e.g.

    + name-based virtual hosts should be used, e.g.

    -NameVirtualHost 111.22.33.44:8080 + + NameVirtualHost 111.22.33.44:8080 + -

    IPv6 addresses must be enclosed in square brackets, as shown - in the following example:

    +

    IPv6 addresses must be enclosed in square brackets, as shown + in the following example:

    -NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080 + + NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080 +

    To receive requests on all interfaces, you can use an argument of *

    -NameVirtualHost * - -Argument to <VirtualHost> directive -

    Note that the argument to the <VirtualHost> directive must exactly -match the argument to the NameVirtualHost -directive.

    - -NameVirtualHost 1.2.3.4
    -<VirtualHost 1.2.3.4>
    -...
    -</VirtualHost>
    -
    -
    + + NameVirtualHost * + + Argument to <VirtualHost> directive +

    Note that the argument to the <VirtualHost> directive must + exactly match the argument to the NameVirtualHost directive.

    + + + NameVirtualHost 1.2.3.4
    + <VirtualHost 1.2.3.4>
    + # ...
    + </VirtualHost>
    +
    +
    See also: Virtual Hosts @@ -1778,7 +1809,7 @@ documentationConfigures what features are available in a particular directoryOptions - [+|-]option [[+|-]option] ... + [+|-]option [[+|-]option] ...Options Allserver configvirtual host directory.htaccess @@ -1789,7 +1820,7 @@ directory

    The Options directive controls which server features are available in a particular directory.

    -

    option can be set to None, in which +

    option can be set to None, in which case none of the extra features are enabled, or one or more of the following:

    @@ -1808,14 +1839,15 @@ directory
    - The server will follow symbolic links in this directory.
    - Note: even though the server follows the - symlink it does not change the pathname used to match - against Directory sections.
    - Note: this option gets ignored if set inside a - Location - section.
    + The server will follow symbolic links in this directory. + +

    Even though the server follows the symlink it does not + change the pathname used to match against Directory sections.

    +

    Note also, that this option gets ignored if set + inside a Location + section.

    +
    Includes
    @@ -1865,26 +1897,30 @@ directory

    For example, without any + and - symbols:

    +
    +<Directory /web/docs>
    +  Options Indexes FollowSymLinks
    +</Directory>
    +
    +<Directory /web/docs/spec>
    +  Options Includes
    +</Directory>
    +
    -<Directory /web/docs>
    - Options Indexes FollowSymLinks
    - </Directory>
    - <Directory /web/docs/spec>
    - Options Includes
    - </Directory> -

    then only Includes will be set for the /web/docs/spec directory. However if the second Options directive uses the + and - symbols:

    - - <Directory /web/docs>
    - Options Indexes FollowSymLinks
    - </Directory>
    - <Directory /web/docs/spec>
    - Options +Includes -Indexes
    - </Directory> -
    +
    +<Directory /web/docs>
    +  Options Indexes FollowSymLinks
    +</Directory>
    +
    +<Directory /web/docs/spec>
    +  Options +Includes -Indexes
    +</Directory>
    +
    +

    then the options FollowSymLinks and Includes are set for the /web/docs/spec directory.

    @@ -1902,7 +1938,7 @@ directory Require Selects which authenticated users can access a resource -Require entity-name [entity-name] ... +Require entity-name [entity-name] ... directory.htaccess AuthConfig @@ -1913,13 +1949,13 @@ a resource
    • - Require user userid [userid] ... + Require user userid [userid] ...

      Only the named users can access the directory.

    • - Require group group-name [group-name] ... + Require group group-name [group-name] ...

      Only users in the named groups can access the @@ -1940,13 +1976,13 @@ a resource and AuthGroupFile (to define users and groups) in order to work correctly. Example:

      - + AuthType Basic
      AuthName "Restricted Directory"
      AuthUserFile /web/users
      AuthGroupFile /web/groups
      - Require group admin
      -
      + Require group admin +

      Access controls which are applied in this way are effective for all methods. This is what is normally @@ -1964,7 +2000,7 @@ a resource RLimitCPU Limits the CPU consumption of processes launched by Apache children -RLimitCPU number|max [number|max] +RLimitCPU number|max [number|max] Unset; uses operating system defaults server configvirtual host directory.htaccess @@ -1974,7 +2010,7 @@ by Apache children

      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 max to indicate to the server that the limit should + 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 @@ -1997,7 +2033,7 @@ by Apache children RLimitMEM Limits the memory consumption of processes launched by Apache children -RLimitMEM number|max [number|max] +RLimitMEM number|max [number|max] Unset; uses operating system defaults server configvirtual host directory.htaccess @@ -2007,7 +2043,7 @@ by Apache children

      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 max to indicate to the server that the limit should + 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 @@ -2030,7 +2066,7 @@ by Apache children RLimitNPROC Limits the number of processes that can be launched by processes launched by Apache children -RLimitNPROC number|max [number|max] +RLimitNPROC number|max [number|max] Unset; uses operating system defaults server configvirtual host directory.htaccess @@ -2058,7 +2094,7 @@ processes launched by Apache children under userids other than the web server userid, this directive will limit the number of processes that the server itself can create. Evidence of this situation will be indicated by - cannot fork messages in the + cannot fork messages in the error_log.

      RLimitMEM @@ -2079,10 +2115,10 @@ user authentication

      Access policy if both Allow and Require used. The parameter can be - either 'all' or 'any'. This directive is only + either all or any. This directive is only useful if access to a particular area is being restricted by both username/password and client host address. In this case - the default behavior ("all") is to require that the client passes + the default behavior (all) is to require that the client passes the address access restriction and enters a valid username and password. With the "any" option the client will be granted access if they either pass the host restriction or enter a @@ -2096,9 +2132,9 @@ user authentication configuration similar to the following:

      - Require valid-user
      - Allow from 192.168.1
      - Satisfy any + Require valid-user
      + Allow from 192.168.1
      + Satisfy any
      @@ -2131,7 +2167,7 @@ scripts ServerAdmin Email address that the server includes in error messages sent to the client -ServerAdmin email-address +ServerAdmin email-address server configvirtual host @@ -2140,9 +2176,11 @@ messages sent to the client that the server includes in any error messages it returns to the client.

      -

      It may be worth setting up a dedicated address for this, - e.g.

      -ServerAdmin www-admin@foo.bar.com +

      It may be worth setting up a dedicated address for this, e.g.

      + + + ServerAdmin www-admin@foo.example.com +

      as users do not always mention that they are talking about the server!

      @@ -2152,7 +2190,7 @@ messages sent to the client ServerAlias Alternate names for a host used when matching requests to name-virtual hosts -ServerAlias hostname [hostname] ... +ServerAlias hostname [hostname] ... virtual host @@ -2160,13 +2198,13 @@ to name-virtual hosts alternate names for a host, for use with name-based virtual hosts.

      - - <VirtualHost *>
      - ServerName server.domain.com
      - ServerAlias server server2.domain.com server2
      - ...
      - </VirtualHost> -
      + + <VirtualHost *>
      + ServerName server.domain.com
      + ServerAlias server server2.domain.com server2
      + # ...
      + </VirtualHost> +
      Apache Virtual Host documentation @@ -2175,7 +2213,7 @@ to name-virtual hosts ServerName Hostname and port that the server uses to identify itself -ServerName fully-qualified-domain-name[:port] +ServerName fully-qualified-domain-name[:port] server configvirtual host In version 2.0, this @@ -2191,7 +2229,9 @@ itself and you wish the webserver to be so identified, the following directive should be used:

      -ServerName www.example.com:80 + + ServerName www.example.com:80 +

      If no ServerName is specified, then the server attempts to deduce the hostname by performing a reverse @@ -2228,7 +2268,7 @@ itself ServerPath Legacy URL pathname for a name-virtual host that is accessed by an incompatible browser -ServerPath URL-path +ServerPath URL-path virtual host @@ -2242,7 +2282,7 @@ is accessed by an incompatible browser ServerRoot Base directory for the server installation -ServerRoot directory-path +ServerRoot directory-path ServerRoot /usr/local/apache server config @@ -2254,7 +2294,7 @@ is accessed by an incompatible browser directory.

      Example - ServerRoot /home/httpd + ServerRoot /home/httpd @@ -2351,7 +2391,7 @@ is accessed by an incompatible browser SetHandler Forces all matching files to be processed by a handler -SetHandler handler-name +SetHandler handler-name server configvirtual host directory.htaccess @@ -2364,24 +2404,25 @@ handler Location section, this directive forces all matching files to be parsed through the handler given by - handler-name. For example, if you had a directory you + handler-name. For example, if you had a directory you wanted to be parsed entirely as imagemap rule files, regardless of extension, you might put the following into an .htaccess file in that directory:

      - - SetHandler imap-file - + + + SetHandler imap-file +

      Another example: if you wanted to have the server display a status report whenever a URL of http://servername/status was called, you might put the following into httpd.conf:

      - - <Location /status>
      - SetHandler server-status
      - </Location> -
      + + <Location /status>
      + SetHandler server-status
      + </Location> +
      AddHandler @@ -2392,7 +2433,7 @@ handler SetInputFilter Sets the filters that will process client requests and POST input -SetInputFilter filter[;filter...] +SetInputFilter filter[;filter...] server configvirtual host directory.htaccess @@ -2417,7 +2458,7 @@ input SetOutputFilter Sets the filters that will process responses from the server -SetOutputFilter filter[;filter...] +SetOutputFilter filter[;filter...] server configvirtual host directory.htaccess @@ -2434,11 +2475,12 @@ server

      For example, the following configuration will process all files in the /www/data/ directory for server-side includes.

      - -<Directory /www/data/>
      -  SetOutputFilter INCLUDES
      -</Directory> -
      + +
      +<Directory /www/data/>
      +  SetOutputFilter INCLUDES
      +</Directory>
      +

      If more than one filter is specified, they must be separated by semicolons in the order in which they should process the @@ -2451,7 +2493,7 @@ server TimeOut Amount of time the server will wait for certain events before failing a request -TimeOut number +TimeOut number TimeOut 300 server config @@ -2489,14 +2531,13 @@ port directory -

      In many situations Apache must construct a - self-referential URL -- that is, a URL that refers back to - the same server. With UseCanonicalName on Apache will - use the hostname and port specified in the ServerName directive to construct the canonical - name for the server. This name is used in all self-referential - URLs, and for the values of SERVER_NAME and - SERVER_PORT in CGIs.

      +

      In many situations Apache must construct a self-referential + URL -- that is, a URL that refers back to the same server. With + UseCanonicalName on Apache will use the hostname and port + specified in the ServerName + directive to construct the canonical name for the server. This name + is used in all self-referential URLs, and for the values of + SERVER_NAME and SERVER_PORT in CGIs.

      With UseCanonicalName off Apache will form self-referential URLs using the hostname and port supplied by @@ -2546,7 +2587,7 @@ port Contains directives that apply only to a specific hostname or IP address <VirtualHost - addr[:port] [addr[:port]] + addr[:port] [addr[:port]] ...> ... </VirtualHost> server config @@ -2558,7 +2599,7 @@ hostname or IP address used. When the server receives a request for a document on a particular virtual host, it uses the configuration directives enclosed in the VirtualHost - section. Addr can be

      + section. Addr can be:

      • The IP address of the virtual host;
      • @@ -2573,31 +2614,30 @@ hostname or IP address with IP virtual hosting to catch unmatched IP addresses.
      - -Example - <VirtualHost 10.1.2.3>
      - ServerAdmin webmaster@host.foo.com
      - DocumentRoot /www/docs/host.foo.com
      - ServerName host.foo.com
      - ErrorLog logs/host.foo.com-error_log
      - TransferLog logs/host.foo.com-access_log
      - </VirtualHost> -
      + Example + <VirtualHost 10.1.2.3>
      + ServerAdmin webmaster@host.foo.com
      + DocumentRoot /www/docs/host.foo.com
      + ServerName host.foo.com
      + ErrorLog logs/host.foo.com-error_log
      + TransferLog logs/host.foo.com-access_log
      + </VirtualHost> +
      -

      IPv6 addresses must be specified in square brackets because - the optional port number could not be determined otherwise. An - IPv6 example is shown below:

      - - -<VirtualHost [fe80::a00:20ff:fea7:ccea]>
      - ServerAdmin webmaster@host.foo.com
      - DocumentRoot /www/docs/host.foo.com
      - ServerName host.foo.com
      - ErrorLog logs/host.foo.com-error_log
      - TransferLog logs/host.foo.com-access_log
      - </VirtualHost> -
      +

      IPv6 addresses must be specified in square brackets because + the optional port number could not be determined otherwise. An + IPv6 example is shown below:

      + + + <VirtualHost [fe80::a00:20ff:fea7:ccea]>
      + ServerAdmin webmaster@host.example.com
      + DocumentRoot /www/docs/host.example.com
      + ServerName host.example.com
      + ErrorLog logs/host.example.com-error_log
      + TransferLog logs/host.example.com-access_log
      + </VirtualHost> +

      Each Virtual Host must correspond to a different IP address, different port number or a different host name for the server, diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 012fa2cbb3..d6dd489de7 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -34,7 +34,7 @@

    - + - @@ -95,8 +95,8 @@ expressions server - @@ -150,7 +150,7 @@ group membership environment variable - - @@ -218,22 +218,22 @@ server cannot determine a type in any other way all|host|env=env-variable [host|env=env-variable] ... - - - - - + @@ -246,15 +246,15 @@ request - - - - @@ -265,10 +265,10 @@ of the index listing - - @@ -277,7 +277,7 @@ that are not explicitly mapped - @@ -296,7 +296,7 @@ extensions - @@ -308,21 +308,21 @@ operations - - - - - - - + @@ -333,15 +333,15 @@ of active modules URL-path|URL> ... </Location> - + - @@ -366,13 +366,13 @@ spikes - extensions - - - - @@ -487,16 +487,16 @@ in the scriptlog - - - - - + @@ -508,11 +508,11 @@ is accessed by an incompatible browser [!]env-variable[=value] [[!]env-variable[=value]] ... - - - per child process - @@ -595,7 +595,7 @@ for a given virtual host
    AcceptMutex default|method default sM
    Method that Apache uses to serialize multiple children accepting requests on network sockets
    AcceptPathInfo On|Off|Default Default svdhC
    Resources accept trailing pathname information
    AccessFileName filename [filename] ... .htaccess svC
    Name of the distributed configuration file
    AccessFileName filename [filename] ... .htaccess svC
    Name of the distributed configuration file
    Action action-type cgi-scriptsvdhB
    Activates a CGI script for a particular handler or content-type
    AddAlt string file [file] ...svdhB
    Alternate text to display for a file, instead of an @@ -48,7 +48,7 @@ icon selected by MIME content-type
    AddCharset charset extension [extension] ...svdhB
    Maps the given filename extensions to the specified content charset
    AddDefaultCharset On|Off|charset Off svdhC
    Default character set to be added for a +
    AddDefaultCharset On|Off|charset Off svdhC
    Default character set to be added for a response without an explicit character set
    AddDescription string file [file] ...svdhB
    Description to display for a file
    AllowCONNECT port [port] ... 443 563 svE
    Ports that are allowed to CONNECT through the proxy
    AllowOverride All|None|directive-type -[directive-type] ... All dC
    Types of directives that are allowed in +
    AllowOverride All|None|directive-type +[directive-type] ... All dC
    Types of directives that are allowed in .htaccess files
    Anonymous user [user] ...dhE
    Specifies userIDs that areallowed access without password verification
    AuthLDAPStartTLS on|offdhX
    Use a secure TLS connection to the LDAP server
    AuthLDAPUrl urldhX
    URL specifying the LDAP search parameters
    AuthName auth-domaindhC
    Authorization realm for use in HTTP +
    AuthName auth-domaindhC
    Authorization realm for use in HTTP authentication
    AuthType Basic|DigestdhC
    Type of user authentication
    AuthUserFile file-pathdhB
    Sets the name of a text file containing the list of users and @@ -208,7 +208,7 @@ configured
    DefaultLanguage MIME-langsvdhB
    Sets all files in the given scope to the specified language
    DefaultType MIME-type text/plain svdhC
    MIME content-type that will be sent if the +
    DefaultType MIME-type text/plain svdhC
    MIME content-type that will be sent if the server cannot determine a type in any other way
    DeflateBufferSize value 8096 svE
    Fragment size to be compressed at one time by zlib
    DeflateFilterNote notenamesvE
    Places the compression ratio in a note for logging
    dhB
    Controls which hosts are denied access to the server
    <Directory directory-path> +
    <Directory directory-path> ... </Directory>svC
    Enclose a group of directives that apply only to the named file-system directory and sub-directories
    DirectoryIndex local-url [local-url] ... index.html svdhB
    List of resources to look for when the client requests a directory
    <DirectoryMatch regex> +
    <DirectoryMatch regex> ... </Directory>svC
    Enclose directives that apply to file-system directories matching a regular expression and their subdirectories
    DocumentRoot directory-path /usr/local/apache/h +svC
    Directory that forms the main document tree visible +
    DocumentRoot directory-path /usr/local/apache/h +svC
    Directory that forms the main document tree visible from the web
    EnableMMAP on|off on svdhC
    Use memory-mapping to read files during delivery
    ErrorDocument error-code documentsvdhC
    What the server will return to the client +
    ErrorDocument error-code documentsvdhC
    What the server will return to the client in case of an error
    ErrorLog file-path|syslog[:facility] logs/error_log (Uni +svC
    Location where the server will log errors
    ErrorLog file-path|syslog[:facility] logs/error_log (Uni +svC
    Location where the server will log errors
    ExamplesvdhX
    Demonstration directive to illustrate the Apache module API
    ExpiresActive On|OffsvdhE
    Enables generation of Expires headers
    ExtFilterDefine filtername parameterssX
    -
    ExtFilterOptions option [option] ... DebugLevel=0 NoLogS +dX
    -
    FileETag component ... INode MTime Size svdhC
    File attributes used to create the ETag +
    FileETag component ... INode MTime Size svdhC
    File attributes used to create the ETag HTTP response header
    <Files filename> ... </Files>svdhC
    Contains directives that apply to matched +
    <Files filename> ... </Files>svdhC
    Contains directives that apply to matched filenames
    <FilesMatch regex> ... </FilesMatch>svdhC
    Contains directives that apply to regular-expression matched +
    <FilesMatch regex> ... </FilesMatch>svdhC
    Contains directives that apply to regular-expression matched filenames
    ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdhB
    Action to take if a single acceptable document is not found
    ForceType mime-typedhC
    Forces all matching files to be served with the specified +
    ForceType MIME-typedhC
    Forces all matching files to be served with the specified MIME content-type
    Group unix-group #-1 svM
    Group under which the server will answer requests
    HostnameLookups on|off|double off svdC
    Enables DNS lookups on client IP addresses
    IdentityCheck on|off off svdC
    Enables logging of the RFC1413 identity of the remote user
    <IfDefine [!]parameter-name> ... +
    <IfDefine [!]parameter-name> ... </IfDefine>svdhC
    Encloses directives that will be processed only if a test is true at startup
    <IfModule [!]module-name> ... +
    <IfModule [!]module-name> ... </IfModule>svdhC
    Encloses directives that are processed conditional on the presence of absence of a specific module
    ImapBase map|referer|URL http://servername/ svdhB
    Default base for imagemap files
    ImapMenu none|formatted|semiformatted|unformattedsvdhB
    Action if no coordinates are given when calling an imagemap
    Include file-path|directory-pathsvdC
    Includes other configuration files from within +
    Include file-path|directory-pathsvdC
    Includes other configuration files from within the server configuration files
    IndexIgnore file [file] ...svdhB
    Adds to the list of files to hide when listing a directory
    ISAPIReadAheadBuffer size 49152 sdhB
    Size of the Read Ahead Buffer sent to ISAPI extensions
    KeepAlive on|off On svC
    Enables HTTP persistent connections
    KeepAliveTimeout seconds 15 svC
    Amount of time the server will wait for subsequent +
    KeepAliveTimeout seconds 15 svC
    Amount of time the server will wait for subsequent requests on a persistent connection
    LanguagePriority MIME-lang [MIME-lang] ...svdhB
    The precendence of language variants for cases where the client does not express a preference
    LDAPOpCacheTTL seconds 600 sX
    Time that entries in the operation cache remain valid
    LDAPSharedCacheSize bytes 102400 sX
    Size in bytes of the shared-memory cache
    <Limit method [method] ... > ... +
    <Limit method [method] ... > ... </Limit>svdhC
    Restrict enclosed access controls to only certain HTTP methods
    <LimitExcept method [method] ... > ... +
    <LimitExcept method [method] ... > ... </LimitExcept>svdhC
    Restrict access controls to all HTTP methods except the named ones
    LimitRequestBody bytes 0 svdhC
    Restricts the total size of the HTTP request body sent +
    LimitRequestBody bytes 0 svdhC
    Restricts the total size of the HTTP request body sent from the client
    LimitRequestFields number 100 sC
    Limits the number of HTTP request header fields that +
    LimitRequestFields number 100 sC
    Limits the number of HTTP request header fields that will be accepted from the client
    LimitRequestFieldsize bytessC
    Limits the size of the HTTP request header allowed from the +
    LimitRequestFieldsize bytessC
    Limits the size of the HTTP request header allowed from the client
    LimitRequestLine bytes 8190 sC
    Limit the size of the HTTP request line that will be accepted +
    LimitRequestLine bytes 8190 sC
    Limit the size of the HTTP request line that will be accepted from the client
    LimitXMLRequestBody number 1000000 svdhC
    Limits the size of an XML-based request body
    LimitXMLRequestBody number 1000000 svdhC
    Limits the size of an XML-based request body
    Listen [IP-address:]portnumbersM
    IP addresses and ports that the server listens to
    ListenBacklog backlogsM
    Maximum length of the queue of pending connections
    svC
    Applies the enclosed directives only to matching URLs
    <LocationMatch - regex> ... </Location>svC
    Applies the enclosed directives only to regular-expression + regex> ... </Location>svC
    Applies the enclosed directives only to regular-expression matching URLs
    LockFile filename logs/accept.lock sM
    Location of the accept serialization lock file
    LogFormat format|nickname [nickname] "%h %l %u %t \"%r\" +sB
    Describes a format for use in a log file
    LogLevel level warn svC
    Controls the verbosity of the ErrorLog
    LogLevel level warn svC
    Controls the verbosity of the ErrorLog
    MaxClients numbersM
    Maximum number of child processes that will be created to serve requests
    MaxKeepAliveRequests number 100 svC
    Number of requests allowed on a persistent +
    MaxKeepAliveRequests number 100 svC
    Number of requests allowed on a persistent connection
    MaxMemFree numbersM
    Maximum amount of memory that the main allocator is allowed to hold without calling free()
    MultiviewsMatch [NegotiatedOnly] [Handlers] [Filters] [Any]svdhB
    The types of files that will be included when searching for a matching file with MultiViews
    NameVirtualHost addr[:port]sC
    Designates an IP address for name-virtual +
    NameVirtualHost addr[:port]sC
    Designates an IP address for name-virtual hosting
    NoProxy host [host] ...svE
    Hosts, domains, or networks that will be connected to directly
    NumServers number 2 sM
    Total number of children alive at the same time
    Options - [+|-]option [[+|-]option] ... All svdhC
    Configures what features are available in a particular + [+|-]option [[+|-]option] ... All svdhC
    Configures what features are available in a particular directory
    Order ordering Deny,Allow dhB
    Controls the default access state and the order in which Allow and Deny are @@ -443,7 +443,7 @@ extensions
    RequestHeader set|append|add|unset header [value]svdhE
    Configure HTTP request headers
    Require entity-name [entity-name] ...dhC
    Selects which authenticated users can access +
    Require entity-name [entity-name] ...dhC
    Selects which authenticated users can access a resource
    RewriteBase URL-pathdhE
    Sets the base URL for per-directory rewrites
    RewriteCond @@ -461,11 +461,11 @@ engine
    RewriteOptions OptionssvdhE
    Sets some special options for the rewrite engine
    RewriteRule Pattern SubstitutionsvdhE
    Defines rules for the rewriting engine
    RLimitCPU number|max [number|max]svdhC
    Limits the CPU consumption of processes launched +
    RLimitCPU number|max [number|max]svdhC
    Limits the CPU consumption of processes launched by Apache children
    RLimitMEM number|max [number|max]svdhC
    Limits the memory consumption of processes launched +
    RLimitMEM number|max [number|max]svdhC
    Limits the memory consumption of processes launched by Apache children
    RLimitNPROC number|max [number|max]svdhC
    Limits the number of processes that can be launched by +
    RLimitNPROC number|max [number|max]svdhC
    Limits the number of processes that can be launched by processes launched by Apache children
    Satisfy any|all all dhC
    Interaction between host-level access control and user authentication
    ScriptLogLength bytes 10385760 svB
    Size limit of the CGI script logfile
    ScriptSock file-path logs/cgisock svB
    -
    SendBufferSize bytessM
    TCP buffer size
    ServerAdmin email-addresssvC
    Email address that the server includes in error +
    ServerAdmin email-addresssvC
    Email address that the server includes in error messages sent to the client
    ServerAlias hostname [hostname] ...vC
    Alternate names for a host used when matching requests +
    ServerAlias hostname [hostname] ...vC
    Alternate names for a host used when matching requests to name-virtual hosts
    ServerLimit number 256 (prefork), Serv +sM
    Upper limit on configurable number of processes
    ServerName fully-qualified-domain-name[:port]svC
    Hostname and port that the server uses to identify +
    ServerName fully-qualified-domain-name[:port]svC
    Hostname and port that the server uses to identify itself
    ServerPath URL-pathvC
    Legacy URL pathname for a name-virtual host that +
    ServerPath URL-pathvC
    Legacy URL pathname for a name-virtual host that is accessed by an incompatible browser
    ServerRoot directory-path /usr/local/apache sC
    Base directory for the server installation
    ServerRoot directory-path /usr/local/apache sC
    Base directory for the server installation
    ServerSignature On|Off|EMail Off svdhC
    Configures the footer on server-generated documents
    ServerTokens Major|Minor|Minimal|ProductOnly|OS|Full Full sC
    Configures the Server HTTP response header
    SetEnv env-variable valuesvdhB
    Sets environment variables
    svdhB
    Sets environment variables based on attributes of the request without respect to case
    SetHandler handler-namesvdhC
    Forces all matching files to be processed by a +
    SetHandler handler-namesvdhC
    Forces all matching files to be processed by a handler
    SetInputFilter filter[;filter...]svdhC
    Sets the filters that will process client requests and POST +
    SetInputFilter filter[;filter...]svdhC
    Sets the filters that will process client requests and POST input
    SetOutputFilter filter[;filter...]svdhC
    Sets the filters that will process responses from the +
    SetOutputFilter filter[;filter...]svdhC
    Sets the filters that will process responses from the server
    SSIEndTag tag "-->" svB
    String that ends an include element
    SSIErrorMsg message @@ -580,7 +580,7 @@ Certificate verification
    ThreadsPerChild numbersM
    Number of threads created by each child process
    ThreadStackSize number 65536 sM
    -
    TimeOut number 300 sC
    Amount of time the server will wait for +
    TimeOut number 300 sC
    Amount of time the server will wait for certain events before failing a request
    TransferLog file|pipesB
    Specifly location of a log file
    TypesConfig file-path conf/mime.types sB
    The location of the mime.types file
    VirtualDocumentRootIP interpolated-directory|none none svE
    Dynamically configure the location of the document root for a given virtual host
    <VirtualHost - addr[:port] [addr[:port]] + addr[:port] [addr[:port]] ...> ... </VirtualHost>sC
    Contains directives that apply only to a specific hostname or IP address
    VirtualScriptAlias interpolated-directory|none none svE
    Dynamically configure the location of the CGI directory for diff --git a/docs/manual/style/common.dtd b/docs/manual/style/common.dtd index 9a2d4002ea..587c1bfbcd 100644 --- a/docs/manual/style/common.dtd +++ b/docs/manual/style/common.dtd @@ -55,6 +55,8 @@ + +