From 34b1b3119d2c3a84c841cb52a7f02b901f83af2d Mon Sep 17 00:00:00 2001 From: Andre Malo Date: Wed, 11 Dec 2002 20:58:29 +0000 Subject: [PATCH] update transformation: part II git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97862 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/core.html.en | 1520 ++++++++++++++-------- docs/manual/mod/mod_cache.html.en | 232 ++-- docs/manual/mod/mod_cern_meta.html.en | 112 +- docs/manual/mod/mod_cgi.html.en | 118 +- docs/manual/mod/mod_cgid.html.en | 70 +- docs/manual/mod/mod_charset_lite.html.en | 107 +- docs/manual/mod/mpm_common.html.en | 465 ++++--- 7 files changed, 1763 insertions(+), 861 deletions(-) diff --git a/docs/manual/mod/core.html.en b/docs/manual/mod/core.html.en index b6fb96ef4f..743d9cc3be 100644 --- a/docs/manual/mod/core.html.en +++ b/docs/manual/mod/core.html.en @@ -4,10 +4,29 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->core - Apache HTTP Server
<-
Apache > HTTP Server > Documentation > Version 2.1 > Modules

Apache Module core

Description: - Core Apache HTTP Server features that are always -available
Status: - Core

Directives

+
+ +
top
+

AcceptPathInfo Directive

+ + + + + + + + + +
Description:Resources accept trailing pathname information
Syntax:AcceptPathInfo On|Off|Default
Default:AcceptPathInfo Default
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Core
Module:core
Compatibility:Available in Apache 2.0.30 and later

This directive controls whether requests that contain trailing pathname information that follows an actual filename (or @@ -130,13 +155,18 @@ availableStatus: </Files>

-
top

AccessFileName Directive

Description: - Name of the distributed configuration file
Syntax: - AccessFileName filename [filename] ...
Default: - AccessFileName .htaccess
Context: - server config, virtual host
Status: - Core
Module: - core
+ +
+
top
+

AccessFileName Directive

+ + + + + + + +
Description:Name of the distributed configuration file
Syntax:AccessFileName filename [filename] ...
Default:AccessFileName .htaccess
Context:server config, virtual host
Status:Core
Module:core

When returning a document to the client the server looks for the first existing configuration file from this list of names in every directory of the path to the document, if distributed @@ -160,15 +190,26 @@ availableStatus: </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 Off
Context: - server config, virtual host, directory, .htaccess
Override: - FileInfo
Status: - Core
Module: - core
+ +

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 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 @@ -183,15 +224,20 @@ response without an explicit character set

AddDefaultCharset utf-8

-
top

AddOutputFilterByType Directive

Description: - assigns an output filter to a particular MIME-type
Syntax: - AddOutputFilterByType filter[;filter...] MIME-type -[MIME-type] ...
Context: - server config, virtual host, directory, .htaccess
Override: - FileInfo
Status: - Core
Module: - core
Compatibility: - Available in Apache 2.0.33 and later
+ +
+
top
+

AddOutputFilterByType Directive

+ + + + + + + + +
Description:assigns an output filter to a particular MIME-type
Syntax:AddOutputFilterByType filter[;filter...] MIME-type +[MIME-type] ...
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Core
Module:core
Compatibility:Available in Apache 2.0.33 and later

This directive activates a particular output filter for a request depending on the response MIME-type.

@@ -235,15 +281,26 @@ response without an explicit character setAddOutputFilter
  • SetOutputFilter
  • filters
  • top

    AllowOverride Directive

    Description: - Types of directives that are allowed in -.htaccess files
    Syntax: - AllowOverride All|None|directive-type -[directive-type] ...
    Default: - AllowOverride All
    Context: - directory
    Status: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    AllowOverride Directive

    + + + + + + + +
    Description:Types of directives that are allowed in +.htaccess files
    Syntax:AllowOverride All|None|directive-type +[directive-type] ...
    Default:AllowOverride All
    Context:directory
    Status:Core
    Module:core

    When the server finds an .htaccess file (as specified by AccessFileName) it needs to know which directives declared in that file can override earlier access information.

    @@ -313,14 +370,25 @@ response without an explicit character set

    AllowOverride AuthConfig Indexes

    -

    See also

    top

    AuthName Directive

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

    See also

    + +
    +
    top
    +

    AuthName Directive

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

    This directive sets the name of the authorization realm for a directory. This realm is given to the client so that the user knows which username and password to send. @@ -339,14 +407,23 @@ authenticationSyntax:

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

    -

    See also

    top

    AuthType Directive

    Description: - Type of user authentication
    Syntax: - AuthType Basic|Digest
    Context: - directory, .htaccess
    Override: - AuthConfig
    Status: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    AuthType Directive

    + + + + + + + +
    Description:Type of user authentication
    Syntax:AuthType Basic|Digest
    Context:directory, .htaccess
    Override:AuthConfig
    Status:Core
    Module:core

    This directive selects the type of user authentication for a directory. Only Basic and Digest are currently implemented. @@ -355,29 +432,43 @@ authenticationSyntax: as AuthUserFile and AuthGroupFile to work.

    -

    See also

    top

    CGIMapExtension Directive

    Description: - Technique for locating the interpreter for CGI -scripts
    Syntax: - CGIMapExtension cgi-path .extension
    Default: - None
    Context: - directory, .htaccess
    Override: - FileInfo
    Status: - Core
    Module: - core
    Compatibility: - NetWare only
    + +

    See also

    + +
    +
    top
    +

    CGIMapExtension Directive

    + + + + + + + + + +
    Description:Technique for locating the interpreter for CGI +scripts
    Syntax:CGIMapExtension cgi-path .extension
    Default:None
    Context:directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    Compatibility:NetWare only

    This directive is used to control how Apache finds the interpreter used to run CGI scripts. For example, setting CGIMapExtension sys:\foo.nlm .foo will cause all CGI script files with a .foo extension to be passed to the FOO interpreter.

    -
    top

    ContentDigest Directive

    Description: - Enables the generation of Content-MD5 HTTP Response -headers
    Syntax: - ContentDigest on|off
    Default: - ContentDigest off
    Context: - server config, virtual host, directory, .htaccess
    Override: - Options
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    ContentDigest Directive

    + + + + + + + + +
    Description:Enables the generation of Content-MD5 HTTP Response +headers
    Syntax:ContentDigest on|off
    Default:ContentDigest off
    Context:server config, virtual host, directory, .htaccess
    Override:Options
    Status:Core
    Module:core

    This directive enables the generation of Content-MD5 headers as defined in RFC1864 respectively RFC2068.

    @@ -404,15 +495,20 @@ headersSyntax: by the core, and not by any module. For example, SSI documents, output from CGI scripts, and byte range responses do not have this header.

    -
    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 text/plain
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Core
    Module: - core
    + +
    +
    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 text/plain
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core

    There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings.

    @@ -432,14 +528,19 @@ server cannot determine a type in any other waytop

    <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>
    Context: - server config, virtual host
    Status: - Core
    Module: - core
    + +
    +
    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>
    Context:server config, virtual host
    Status:Core
    Module:core

    <Directory> and </Directory> are used to enclose a group of directives that will apply only to the named directory and @@ -557,18 +658,27 @@ named file-system directory and sub-directories<Directory> directives cannot nest, and cannot appear in a <Limit> or <LimitExcept> section.

    -

    See also

    top

    <DirectoryMatch> Directive

    + + + + +
    Description: - Enclose directives that apply to + request is received + + +
    top
    +

    <DirectoryMatch> Directive

    + +
    Description:Enclose directives that apply to file-system directories matching a regular expression and their -subdirectories
    Syntax: - <DirectoryMatch regex> -... </DirectoryMatch>
    Context: - server config, virtual host
    Status: - Core
    Module: - core
    +subdirectories
    Syntax:<DirectoryMatch regex> +... </DirectoryMatch>
    Context:server config, virtual host
    Status:Core
    Module:core

    <DirectoryMatch> and </DirectoryMatch> are used to enclose a group of directives which will apply only to the named directory and @@ -581,18 +691,28 @@ subdirectoriesSyntax:

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

    -

    See also

    top

    DocumentRoot Directive

    Description: - Directory that forms the main document tree visible -from the web
    Syntax: - DocumentRoot directory-path
    Default: - DocumentRoot /usr/local/apache/htdocs
    Context: - server config, virtual host
    Status: - Core
    Module: - core
    +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 /usr/local/apache/htdocs
    Context:server config, virtual host
    Status:Core
    Module:core

    This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document @@ -608,15 +728,24 @@ from the webSyntax:

    The DocumentRoot should be specified without a trailing slash.

    -

    See also

    top

    EnableMMAP Directive

    Description: - Use memory-mapping to read files during delivery
    Syntax: - EnableMMAP on|off
    Default: - EnableMMAP on
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    EnableMMAP Directive

    + + + + + + + + +
    Description:Use memory-mapping to read files during delivery
    Syntax:EnableMMAP on|off
    Default:EnableMMAP on
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core

    This directive controls whether the httpd may use memory-mapping if it needs to read the contents of a file during delivery. By default, when the handling of a request requires @@ -651,15 +780,20 @@ Location

    to
             EnableMMAP off
       </Directory>
     </code></p></div>
-</div><div class=top

    EnableSendfile Directive

    Description: - Use the kernel sendfile support to deliver files to the client
    Syntax: - EnableSendfile on|off
    Default: - EnableSendfile on
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Core
    Module: - core
    Compatibility: - Available in version 2.0.44 and later
    + +
    +
    top
    +

    EnableSendfile Directive

    + + + + + + + + + +
    Description:Use the kernel sendfile support to deliver files to the client
    Syntax:EnableSendfile on|off
    Default:EnableSendfile on
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    Compatibility:Available in version 2.0.44 and later

    This directive controls whether httpd may use the sendfile support from the kernel to transmit file contents to the client. By default, when the handling of a request requires no access @@ -697,16 +831,21 @@ Location

    to
             EnableSendfile off<br />
       </Directory>
     </code></p></div>
-</div><div class=top

    ErrorDocument Directive

    Description: - What the server will return to the client -in case of an error
    Syntax: - ErrorDocument error-code document
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Core
    Module: - core
    Compatibility: - Quoting syntax for text messages is different in Apache -2.0
    + +
    +
    top
    +

    ErrorDocument Directive

    + + + + + + + + +
    Description:What the server will return to the client +in case of an error
    Syntax:ErrorDocument error-code document
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    Compatibility:Quoting syntax for text messages is different in Apache +2.0

    In the event of a problem or error, Apache can be configured to do one of four things,

    @@ -765,15 +904,24 @@ in case of an errorSyntax

    Prior to version 2.0, messages were indicated by prefixing them with a single unmatched double quote character.

    -

    See also

    top

    ErrorLog Directive

    Description: - Location where the server will log errors
    Syntax: - 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: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    ErrorLog Directive

    + + + + + + + +
    Description:Location where the server will log errors
    Syntax: 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:Core
    Module:core

    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 @@ -806,15 +954,25 @@ 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 INode MTime Size
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    FileETag Directive

    + + + + + + + + +
    Description:File attributes used to create the ETag +HTTP response header
    Syntax:FileETag component ...
    Default:FileETag INode MTime Size
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core

    The FileETag directive configures the file attributes that are used to create the ETag (entity tag) response @@ -853,14 +1011,19 @@ HTTP response headerSynta 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.

    -
    top

    <Files> Directive

    Description: - Contains directives that apply to matched -filenames
    Syntax: - <Files filename> ... </Files>
    Context: - server config, virtual host, directory, .htaccess
    Override: - All
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    <Files> Directive

    + + + + + + + +
    Description:Contains directives that apply to matched +filenames
    Syntax:<Files filename> ... </Files>
    Context:server config, virtual host, directory, .htaccess
    Override:All
    Status:Core
    Module:core

    The <Files> directive provides for access control by filename. It is comparable to the Directory @@ -893,17 +1056,26 @@ filenamesSyntax: .htaccess files. This allows users to control access to their own files, at a file-by-file level.

    -

    See also

    top

    <FilesMatch> Directive

    Description: - Contains directives that apply to regular-expression matched -filenames
    Syntax: - <FilesMatch regex> ... </FilesMatch>
    Context: - server config, virtual host, directory, .htaccess
    Override: - All
    Status: - Core
    Module: - core
    + request is received + +
    +
    top
    +

    <FilesMatch> Directive

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

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

    @@ -913,18 +1085,27 @@ filenamesSyntax:

    would match most common Internet graphics formats.

    -

    See also

    + +
    top
    +

    ForceType Directive

    + + + + + + + + +
    Description:Forces all matching files to be served with the specified +MIME content-type
    Syntax:ForceType MIME-type|none
    Context:directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    Compatibility:Moved to the core in Apache 2.0

    When placed into an .htaccess file or a <Directory>, or <Location> or @@ -961,13 +1142,18 @@ MIME content-typeSyntax: </Location>

    -
    top

    HostnameLookups Directive

    Description: - Enables DNS lookups on client IP addresses
    Syntax: - HostnameLookups on|off|double
    Default: - HostnameLookups off
    Context: - server config, virtual host, directory
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    HostnameLookups Directive

    + + + + + + + +
    Description:Enables DNS lookups on client IP addresses
    Syntax:HostnameLookups on|off|double
    Default:HostnameLookups off
    Context:server config, virtual host, directory
    Status:Core
    Module:core

    This directive enables DNS lookups so that host names can be logged (and passed to CGIs/SSIs in REMOTE_HOST). The value double refers to doing double-reverse @@ -996,14 +1182,19 @@ MIME content-typeSyntax: amounts of time. The utility logresolve, provided in 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 -user
    Syntax: - IdentityCheck on|off
    Default: - IdentityCheck off
    Context: - server config, virtual host, directory
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    IdentityCheck Directive

    + + + + + + + +
    Description:Enables logging of the RFC1413 identity of the remote +user
    Syntax:IdentityCheck on|off
    Default:IdentityCheck off
    Context:server config, virtual host, directory
    Status:Core
    Module:core

    This directive enables RFC1413-compliant logging of the remote user name for each connection, where the client machine runs identd or something similar. This information is logged in @@ -1018,15 +1209,20 @@ userSyntax: possibly fail and add 30 seconds of latency to each hit. So in general this is not very useful on public servers accessible from the Internet.

    -
    top

    <IfDefine> Directive

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

    <IfDefine> Directive

    + + + + + + + +
    Description:Encloses directives that will be processed only +if a test is true at startup
    Syntax:<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> @@ -1067,15 +1263,20 @@ if a test is true at startuptop

    <IfModule> Directive

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

    <IfModule> Directive

    + + + + + + + +
    Description:Encloses directives that are processed conditional on the +presence or absence of a specific module
    Syntax:<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 @@ -1112,14 +1313,19 @@ presence or absence of a specific module<IfModule> sections.

    -
    top

    Include Directive

    Description: - Includes other configuration files from within -the server configuration files
    Syntax: - Include file-path|directory-path
    Context: - server config, virtual host, directory
    Status: - Core
    Module: - core
    Compatibility: - Wildcard matching available in 2.0.41 and later
    + +
    +
    top
    +

    Include Directive

    + + + + + + + +
    Description:Includes other configuration files from within +the server configuration files
    Syntax:Include file-path|directory-path
    Context:server config, virtual host, directory
    Status:Core
    Module:core
    Compatibility:Wildcard matching available in 2.0.41 and later

    This directive allows inclusion of other configuration files from within the server configuration files.

    @@ -1161,13 +1367,22 @@ the server configuration filesapachectl
    top

    KeepAlive Directive

    Description: - Enables HTTP persistent connections
    Syntax: - KeepAlive on|off
    Default: - KeepAlive On
    Context: - server config, virtual host
    Status: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    KeepAlive Directive

    + + + + + + + +
    Description:Enables HTTP persistent connections
    Syntax:KeepAlive on|off
    Default:KeepAlive On
    Context:server config, virtual host
    Status:Core
    Module:core

    The Keep-Alive extension to HTTP/1.0 and the persistent connection feature of HTTP/1.1 provide long-lived HTTP sessions which allow multiple requests to be sent over the same TCP @@ -1187,14 +1402,23 @@ the server configuration filesMaxKeepAliveRequests

    top

    KeepAliveTimeout Directive

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

    See also

    + +
    +
    top
    +

    KeepAliveTimeout Directive

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

    The number of seconds Apache will wait for a subsequent request before closing the connection. Once a request has been received, the timeout value specified by the @@ -1204,15 +1428,20 @@ requests on a persistent connectiontop

    <Limit> Directive

    Description: - Restrict enclosed access controls to only certain HTTP -methods
    Syntax: - <Limit method [method] ... > ... - </Limit>
    Context: - server config, virtual host, directory, .htaccess
    Override: - All
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    <Limit> Directive

    + + + + + + + +
    Description:Restrict enclosed access controls to only certain HTTP +methods
    Syntax:<Limit method [method] ... > ... + </Limit>
    Context:server config, virtual host, directory, .htaccess
    Override:All
    Status:Core
    Module:core

    Access controls are normally effective for all access methods, and this is the usual desired behavior. In the general case, access control @@ -1243,15 +1472,20 @@ methodsSyntax: 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>
    Context: - server config, virtual host, directory, .htaccess
    Override: - All
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    <LimitExcept> Directive

    + + + + + + + +
    Description:Restrict access controls to all HTTP methods +except the named ones
    Syntax:<LimitExcept method [method] ... > ... + </LimitExcept>
    Context:server config, virtual host, directory, .htaccess
    Override:All
    Status:Core
    Module:core

    <LimitExcept> and </LimitExcept> are used to enclose a group of access control directives which will then apply to any @@ -1270,15 +1504,20 @@ except the named onesSynt <LimitExcept>

    -
    top

    LimitRequestBody Directive

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

    LimitRequestBody Directive

    + + + + + + + + +
    Description:Restricts the total size of the HTTP request body sent +from the client
    Syntax: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 (meaning unlimited) to 2147483647 (2GB) that are allowed in a request body. The default value is defined by the compile-time @@ -1311,14 +1550,19 @@ from the clientSyntax: 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 100
    Context: - server config
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    LimitRequestFields Directive

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

    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 @@ -1348,14 +1592,19 @@ will be accepted from the clienttop

    LimitRequestFieldSize Directive

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

    LimitRequestFieldSize Directive

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

    This directive specifies the number of bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_FIELDSIZE (8190 as @@ -1385,14 +1634,19 @@ clientSyntax:

    -
    top

    LimitRequestLine Directive

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

    LimitRequestLine Directive

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

    This directive sets the number of bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_LINE (8190 as distributed) @@ -1421,14 +1675,19 @@ from the clientSyntax:

    -
    top

    LimitXMLRequestBody Directive

    Description: - Limits the size of an XML-based request body
    Syntax: - LimitXMLRequestBody number
    Default: - LimitXMLRequestBody 1000000
    Context: - server config, virtual host, directory, .htaccess
    Override: - All
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    LimitXMLRequestBody Directive

    + + + + + + + + +
    Description:Limits the size of an XML-based request body
    Syntax:LimitXMLRequestBody number
    Default:LimitXMLRequestBody 1000000
    Context:server config, virtual host, directory, .htaccess
    Override:All
    Status:Core
    Module:core

    Limit (in bytes) on maximum size of an XML-based request body. A value of 0 will disable any checking.

    @@ -1438,14 +1697,19 @@ from the clientSyntax: LimitXMLRequestBody 0

    -
    top

    <Location> Directive

    Description: - Applies the enclosed directives only to matching -URLs
    Syntax: - <Location - URL-path|URL> ... </Location>
    Context: - server config, virtual host
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    <Location> Directive

    + + + + + + +
    Description:Applies the enclosed directives only to matching +URLs
    Syntax:<Location + URL-path|URL> ... </Location>
    Context:server config, virtual host
    Status:Core
    Module:core

    The <Location> directive provides for access control by URL. It is similar to the <Directory> @@ -1518,17 +1782,26 @@ URLsSyntax: if you specify <Location /abc/def> and the request is to /abc//def then it will match.

    -

    See also

    + +
    top
    +

    <LocationMatch> Directive

    + + + + + + +
    Description:Applies the enclosed directives only to regular-expression +matching URLs
    Syntax:<LocationMatch + regex> ... </LocationMatch>
    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, @@ -1541,16 +1814,25 @@ matching URLsSyntax:

    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 warn
    Context: - server config, virtual host
    Status: - Core
    Module: - core
    + request is received + +
    +
    top
    +

    LogLevel Directive

    + + + + + + + +
    Description:Controls the verbosity of the ErrorLog
    Syntax: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 @@ -1647,14 +1929,19 @@ matching URLsSyntax:

    -
    top

    MaxKeepAliveRequests Directive

    Description: - Number of requests allowed on a persistent -connection
    Syntax: - MaxKeepAliveRequests number
    Default: - MaxKeepAliveRequests 100
    Context: - server config, virtual host
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    MaxKeepAliveRequests Directive

    + + + + + + + +
    Description:Number of requests allowed on a persistent +connection
    Syntax:MaxKeepAliveRequests number
    Default:MaxKeepAliveRequests 100
    Context:server config, virtual host
    Status:Core
    Module:core

    The MaxKeepAliveRequests directive limits the number of requests allowed per connection when KeepAlive is on. If it is @@ -1667,13 +1954,18 @@ connectionSyntax:

    -
    top

    NameVirtualHost Directive

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

    NameVirtualHost Directive

    + + + + + + +
    Description:Designates an IP address for name-virtual +hosting
    Syntax: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.

    @@ -1732,17 +2024,26 @@ hostingSyntax: </VirtualHost>

    -

    See also

    top

    Options Directive

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

    See also

    + +
    +
    top
    +

    Options Directive

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

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

    @@ -1863,14 +2164,19 @@ directorySyntax:

    The default in the absence of any other settings is All.

    -
    top

    Require Directive

    Description: - Selects which authenticated users can access -a resource
    Syntax: - Require entity-name [entity-name] ...
    Context: - directory, .htaccess
    Override: - AuthConfig
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    Require Directive

    + + + + + + + +
    Description:Selects which authenticated users can access +a resource
    Syntax:Require entity-name [entity-name] ...
    Context:directory, .htaccess
    Override:AuthConfig
    Status:Core
    Module:core

    This directive selects which authenticated users can access a directory. The allowed syntaxes are:

    @@ -1917,15 +2223,25 @@ a resourceSyntax: place the Require statement into a <Limit> section.

    -

    See also

    top

    RLimitCPU Directive

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

    See also

    + +
    +
    top
    +

    RLimitCPU Directive

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

    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, @@ -1943,15 +2259,25 @@ by Apache childrenSyntax:

    CPU resource limits are expressed in seconds per process.

    -

    See also

    top

    RLimitMEM Directive

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

    See also

    + +
    +
    top
    +

    RLimitMEM Directive

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

    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, @@ -1969,15 +2295,25 @@ by Apache childrenSyntax:

    Memory resource limits are expressed in bytes per process.

    -

    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: - Unset; uses operating system defaults
    Context: - server config, virtual host, directory, .htaccess
    Override: - All
    Status: - Core
    Module: - core
    + +

    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:Unset; uses operating system defaults
    Context:server config, virtual host, directory, .htaccess
    Override:All
    Status:Core
    Module:core

    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, @@ -2001,15 +2337,25 @@ processes launched by Apache childrenRLimitMEM

  • RLimitCPU
  • top

    Satisfy Directive

    Description: - Interaction between host-level access control and -user authentication
    Syntax: - Satisfy any|all
    Default: - Satisfy all
    Context: - directory, .htaccess
    Override: - AuthConfig
    Status: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    Satisfy Directive

    + + + + + + + + +
    Description:Interaction between host-level access control and +user authentication
    Syntax:Satisfy any|all
    Default:Satisfy all
    Context:directory, .htaccess
    Override:AuthConfig
    Status:Core
    Module:core

    Access policy if both Allow and Require used. The parameter can be either all or any. This directive is only useful if access to a particular area is being restricted by both @@ -2033,29 +2379,44 @@ user authenticationSyntax Satisfy any

    -

    See also

    top

    ScriptInterpreterSource Directive

    Description: - Technique for locating the interpreter for CGI -scripts
    Syntax: - ScriptInterpreterSource registry|script
    Default: - ScriptInterpreterSource script
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Core
    Module: - core
    Compatibility: - Win32 only
    + +

    See also

    + +
    +
    top
    +

    ScriptInterpreterSource Directive

    + + + + + + + + + +
    Description:Technique for locating the interpreter for CGI +scripts
    Syntax:ScriptInterpreterSource registry|script
    Default:ScriptInterpreterSource script
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    Compatibility:Win32 only

    This directive is used to control how Apache finds the interpreter used to run CGI scripts. The default technique is to use the interpreter pointed to by the #! line in the script. Setting ScriptInterpreterSource registry will cause the Windows Registry to be searched using the script file extension (e.g., .pl) as a search key.

    -
    top

    ServerAdmin Directive

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

    ServerAdmin Directive

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

    The ServerAdmin sets the e-mail address that the server includes in any error messages it returns to the client.

    @@ -2067,13 +2428,18 @@ messages sent to the clienttop

    ServerAlias Directive

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

    ServerAlias Directive

    + + + + + + +
    Description:Alternate names for a host used when matching requests +to name-virtual hosts
    Syntax: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.

    @@ -2084,16 +2450,25 @@ to name-virtual hostsSynt # ...
    </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: - server config, virtual host
    Status: - Core
    Module: - core
    Compatibility: - In version 2.0, this + +

    See also

    + + +
    top
    +

    ServerName Directive

    + + + + + + +
    Description:Hostname and port that the server uses to identify +itself
    Syntax:ServerName fully-qualified-domain-name[:port]
    Context:server config, virtual host
    Status:Core
    Module:core
    Compatibility:In version 2.0, this directive supersedes the functionality of the Port - directive from version 1.3.
    + directive from version 1.3.

    The ServerName directive sets the hostname and port that the server uses to identify itself. This is used when creating redirection URLs. For example, if the name of the @@ -2126,23 +2501,45 @@ itselfSyntax: mod_dir module) will refer to the specified port, or to the port number given in the client's request.

    -

    See also

    top

    ServerPath Directive

    Description: - Legacy URL pathname for a name-virtual host that -is accessed by an incompatible browser
    Syntax: - ServerPath URL-path
    Context: - virtual host
    Status: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    ServerPath Directive

    + + + + + + +
    Description:Legacy URL pathname for a name-virtual host that +is accessed by an incompatible browser
    Syntax:ServerPath URL-path
    Context:virtual host
    Status:Core
    Module:core

    The ServerPath directive sets the legacy URL pathname for a host, for use with name-based virtual hosts.

    -

    See also

    top

    ServerRoot Directive

    Description: - Base directory for the server installation
    Syntax: - ServerRoot directory-path
    Default: - ServerRoot /usr/local/apache
    Context: - server config
    Status: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    ServerRoot Directive

    + + + + + + + +
    Description:Base directory for the server installation
    Syntax:ServerRoot directory-path
    Default:ServerRoot /usr/local/apache
    Context:server config
    Status:Core
    Module:core

    The ServerRoot directive sets the directory in which the server lives. Typically it will contain the subdirectories conf/ and logs/. Relative @@ -2153,17 +2550,27 @@ is accessed by an incompatible browserthe -d - option to httpd

  • the + +

    See also

    +
  • top

    ServerSignature Directive

    Description: - Configures the footer on server-generated documents
    Syntax: - ServerSignature On|Off|EMail
    Default: - ServerSignature Off
    Context: - server config, virtual host, directory, .htaccess
    Override: - All
    Status: - Core
    Module: - core
    + permissions on the ServerRoot + +
    +
    top
    +

    ServerSignature Directive

    + + + + + + + + +
    Description:Configures the footer on server-generated documents
    Syntax:ServerSignature On|Off|EMail
    Default:ServerSignature Off
    Context:server config, virtual host, directory, .htaccess
    Override:All
    Status:Core
    Module:core

    The ServerSignature directive allows the configuration of a trailing footer line under server-generated documents (error messages, mod_proxy ftp directory listings, @@ -2181,13 +2588,22 @@ is accessed by an incompatible browserServerTokens directive.

    -

    See also

    top

    ServerTokens Directive

    Description: - Configures the Server HTTP response header
    Syntax: - ServerTokens Major|Minor|Minimal|ProductOnly|OS|Full
    Default: - ServerTokens Full
    Context: - server config
    Status: - Core
    Module: - core
    + +

    See also

    + +
    +
    top
    +

    ServerTokens Directive

    + + + + + + + +
    Description:Configures the Server HTTP response header
    Syntax:ServerTokens Major|Minor|Minimal|ProductOnly|OS|Full
    Default:ServerTokens Full
    Context:server config
    Status:Core
    Module:core

    This directive controls whether Server response header field which is sent back to clients includes a description of the generic OS-type of the server as well as @@ -2230,15 +2646,24 @@ is accessed by an incompatible browserServerSignature directive.

    -

    See also

    top

    SetHandler Directive

    Description: - Forces all matching files to be processed by a -handler
    Syntax: - SetHandler handler-name|none
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Core
    Module: - core
    Compatibility: - Moved into the core in Apache 2.0
    + +

    See also

    + +
    +
    top
    +

    SetHandler Directive

    + + + + + + + + +
    Description:Forces all matching files to be processed by a +handler
    Syntax:SetHandler handler-name|none
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    Compatibility:Moved into the core in Apache 2.0

    When placed into an .htaccess file or a <Directory> or <Location> @@ -2265,14 +2690,23 @@ handlerSyntax: </Location>

    -

    See also

    top

    SetInputFilter Directive

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

    See also

    + +
    +
    top
    +

    SetInputFilter Directive

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

    The SetInputFilter directive sets the filter or filters which will process client requests and POST input when they are received by the server. This is in addition to @@ -2283,14 +2717,23 @@ inputSyntax:

    If more than one filter is specified, they must be separated by semicolons in the order in which they should process the content.

    -

    See also

    top

    SetOutputFilter Directive

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

    See also

    + +
    +
    top
    +

    SetOutputFilter Directive

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

    The SetOutputFilter directive sets the filters which will process responses from the server before they are sent to the client. This is in addition to any filters defined @@ -2313,14 +2756,23 @@ serverSyntax:

    If more than one filter is specified, they must be separated by semicolons in the order in which they should process the content.

    -

    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 300
    Context: - server config
    Status: - Core
    Module: - core
    + +

    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 300
    Context:server config
    Status:Core
    Module:core

    The TimeOut directive currently defines the amount of time Apache will wait for three things:

    @@ -2341,14 +2793,19 @@ certain events before failing a requesttop

    UseCanonicalName Directive

    Description: - Configures how the server determines its own name and -port
    Syntax: - UseCanonicalName on|off|dns
    Default: - UseCanonicalName on
    Context: - server config, virtual host, directory
    Status: - Core
    Module: - core
    + +
    +
    top
    +

    UseCanonicalName Directive

    + + + + + + + +
    Description:Configures how the server determines its own name and +port
    Syntax:UseCanonicalName on|off|dns
    Default:UseCanonicalName on
    Context: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 @@ -2394,15 +2851,25 @@ portSyntax: only using SERVER_NAME to construct self-referential URLs then it should be just fine.

    -

    See also

    top

    <VirtualHost> Directive

    + + + +
    Description: - Contains directives that apply only to a specific -hostname or IP address
    Syntax: - <VirtualHost + +

    See also

    + + +
    top
    +

    <VirtualHost> Directive

    + + +
    Description:Contains directives that apply only to a specific +hostname or IP address
    Syntax:<VirtualHost addr[:port] [addr[:port]] - ...> ... </VirtualHost>
    Context: - server config
    Status: - Core
    Module: - core
    + ...> ... </VirtualHost>
    Context:server config
    Status:Core
    Module:core

    <VirtualHost> and </VirtualHost> are used to enclose a group of directives that will apply only to a particular virtual host. Any @@ -2493,9 +2960,22 @@ hostname or IP addressSyn directory where logfiles are stored is writable by anyone other than the user that starts the server.

    -

    See also

    + + + + \ No newline at end of file diff --git a/docs/manual/mod/mod_cache.html.en b/docs/manual/mod/mod_cache.html.en index 1a5725ba01..bb1b9b6497 100644 --- a/docs/manual/mod/mod_cache.html.en +++ b/docs/manual/mod/mod_cache.html.en @@ -4,11 +4,28 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_cache - Apache HTTP Server
    <-

    Apache Module mod_cache

    Description: - Content cache keyed to URIs.
    Status: - Experimental
    ModuleĀ Identifier: - cache_module
    SourceĀ File: - mod_cache.c

    Summary

    + --> +mod_cache - Apache HTTP Server + + + + + + +
    <-
    + +
    +

    Apache Module mod_cache

    + + + +
    Description:Content cache keyed to URIs.
    Status:Experimental
    ModuleĀ Identifier:cache_module
    SourceĀ File:mod_cache.c
    +

    Summary

    +
    This module is experimental. Documentation is still under development...
    @@ -34,7 +51,10 @@

    Content is stored in and retrieved from the cache using URI based keys. Content with access protection is not cached.

    -

    Directives

    +
    top
    +
    top
    +
    top
    top
    +
    +

    Sample Configuration

    Sample httpd.conf

    #
    # Sample Cache Configuration
    @@ -78,13 +108,17 @@ </IfModule>

    -
    top

    CacheDefaultExpire Directive

    Description: - The default duration to cache a document when no expiry date is specified.
    Syntax: - CacheDefaultExpire seconds
    Default: - CacheDefaultExpire 3600 (one hour)
    Context: - server config, virtual host
    Status: - Experimental
    Module: - mod_cache
    +
    +
    top
    +

    CacheDefaultExpire Directive

    + + + + + + + +
    Description:The default duration to cache a document when no expiry date is specified.
    Syntax:CacheDefaultExpire seconds
    Default:CacheDefaultExpire 3600 (one hour)
    Context:server config, virtual host
    Status:Experimental
    Module:mod_cache

    The CacheDefaultExpire directive specifies a default time, in seconds, to cache a document if neither an expiry date nor last-modified date are provided with the document. The value specified with the CacheMaxExpire @@ -93,12 +127,17 @@

    CacheDefaultExpire 86400

    -
    top

    CacheDisable Directive

    Description: - Disable caching of specified URLs
    Syntax: - CacheDisable url-string
    Context: - server config, virtual host
    Status: - Experimental
    Module: - mod_cache
    + +
    +
    top
    +

    CacheDisable Directive

    + + + + + + +
    Description:Disable caching of specified URLs
    Syntax:CacheDisable url-string
    Context:server config, virtual host
    Status:Experimental
    Module:mod_cache

    The CacheDisable directive instructs mod_cache to not cache urls at or below url-string.

    @@ -106,13 +145,18 @@

    Example

    CacheDisable /local_files

    -
    top

    CacheEnable Directive

    Description: - Enable caching of specified URLs using a specified storage -manager
    Syntax: - CacheEnable cache_type url-string
    Context: - server config, virtual host
    Status: - Experimental
    Module: - mod_cache
    + +
    +
    top
    +

    CacheEnable Directive

    + + + + + + +
    Description:Enable caching of specified URLs using a specified storage +manager
    Syntax:CacheEnable cache_type url-string
    Context:server config, virtual host
    Status:Experimental
    Module:mod_cache

    The CacheEnable directive instructs mod_cache to cache urls at or below url-string. The cache storage manager is specified with the @@ -137,14 +181,19 @@ managerSyntax: CacheEnable fd /images
    CacheEnable disk /

    -
    top

    CacheForceCompletion Directive

    Description: - Percentage of document served, after which the server -will complete caching the file even if the request is cancelled.
    Syntax: - CacheForceCompletion Percentage
    Default: - CacheForceCompletion 60
    Context: - server config, virtual host
    Status: - Experimental
    Module: - mod_cache
    + +
    +
    top
    +

    CacheForceCompletion Directive

    + + + + + + + +
    Description:Percentage of document served, after which the server +will complete caching the file even if the request is cancelled.
    Syntax:CacheForceCompletion Percentage
    Default:CacheForceCompletion 60
    Context:server config, virtual host
    Status:Experimental
    Module:mod_cache

    Ordinarily, if a request is cancelled while the response is being cached and delivered to the client the processing of the response will stop and the cache entry will be removed. The @@ -165,14 +214,19 @@ will complete caching the file even if the request is cancelled.

    Note:

    This feature is currently not implemented.
    -
    top

    CacheIgnoreCacheControl Directive

    Description: - Ignore the fact that the client requested the content not be -cached.
    Syntax: - CacheIgnoreCacheControl On|Off
    Default: - CacheIgnoreCacheControl Off
    Context: - server config, virtual host
    Status: - Experimental
    Module: - mod_cache
    + +
    +
    top
    +

    CacheIgnoreCacheControl Directive

    + + + + + + + +
    Description:Ignore the fact that the client requested the content not be +cached.
    Syntax:CacheIgnoreCacheControl On|Off
    Default:CacheIgnoreCacheControl Off
    Context:server config, virtual host
    Status:Experimental
    Module:mod_cache

    Ordinarily, documents with no-cache or no-store header values will not be stored in the cache. The CacheIgnoreCacheControl directive allows this behavior to be overridden. CacheIgnoreCacheControl On tells the server to attempt to cache the document @@ -182,14 +236,19 @@ cached.Syntax:

    -
    top

    CacheIgnoreNoLastMod Directive

    Description: - Ignore the fact that a response has no Last Modified -header.
    Syntax: - CacheIgnoreNoLastMod On|Off
    Default: - CacheIgnoreNoLastMod Off
    Context: - server config, virtual host
    Status: - Experimental
    Module: - mod_cache
    + +
    +
    top
    +

    CacheIgnoreNoLastMod Directive

    + + + + + + + +
    Description:Ignore the fact that a response has no Last Modified +header.
    Syntax:CacheIgnoreNoLastMod On|Off
    Default:CacheIgnoreNoLastMod Off
    Context:server config, virtual host
    Status:Experimental
    Module:mod_cache

    Ordinarily, documents without a last-modified date are not cached. Under some circumstances the last-modified date is removed (during mod_include processing for example) or not provided @@ -204,14 +263,19 @@ header.Syntax:

    -
    top

    CacheLastModifiedFactor Directive

    Description: - The factor used to compute an expiry date based on the -LastModified date.
    Syntax: - CacheLastModifiedFactor float
    Default: - CacheLastModifiedFactor 0.1
    Context: - server config, virtual host
    Status: - Experimental
    Module: - mod_cache
    + +
    +
    top
    +

    CacheLastModifiedFactor Directive

    + + + + + + + +
    Description:The factor used to compute an expiry date based on the +LastModified date.
    Syntax:CacheLastModifiedFactor float
    Default:CacheLastModifiedFactor 0.1
    Context:server config, virtual host
    Status:Experimental
    Module:mod_cache

    In the event that a document does not provide an expiry date but does provide a last-modified date, an expiry date can be calculated based on the time since the document was last modified. The @@ -234,13 +298,18 @@ LastModified date.Syntax:

    -
    top

    CacheMaxExpire Directive

    Description: - The maximum time in seconds to cache a document
    Syntax: - CacheMaxExpire seconds
    Default: - CacheMaxExpire 86400 (one day)
    Context: - server config, virtual host
    Status: - Experimental
    Module: - mod_cache
    + +
    +
    top
    +

    CacheMaxExpire Directive

    + + + + + + + +
    Description:The maximum time in seconds to cache a document
    Syntax:CacheMaxExpire seconds
    Default:CacheMaxExpire 86400 (one day)
    Context:server config, virtual host
    Status:Experimental
    Module:mod_cache

    The CacheMaxExpire directive specifies the maximum number of seconds for which cachable HTTP documents will be retained without checking the origin server. Thus, documents will be out of date at most this number of seconds. This maximum @@ -249,14 +318,19 @@ LastModified date.Syntax:

    -
    top

    CacheMaxStreamingBuffer Directive

    Description: - Maximum amount of a streamed response to buffer in memory -before declaring the response uncacheable
    Syntax: - CacheMaxStreamingBuffer size_in_bytes
    Default: - CacheMaxStreamingBuffer 0
    Context: - server config, virtual host
    Status: - Experimental
    Module: - mod_cache
    + +
    +
    top
    +

    CacheMaxStreamingBuffer Directive

    + + + + + + + +
    Description:Maximum amount of a streamed response to buffer in memory +before declaring the response uncacheable
    Syntax:CacheMaxStreamingBuffer size_in_bytes
    Default:CacheMaxStreamingBuffer 0
    Context:server config, virtual host
    Status:Experimental
    Module:mod_cache

    The CacheMaxStreamingBuffer directive specifies the maximum number of bytes of a streamed response to buffer before deciding that the response is too big to cache. @@ -285,4 +359,10 @@ before declaring the response uncacheable

    Maintained by the Apache HTTP Server Documentation Project

    \ No newline at end of file + +
    + + + \ No newline at end of file diff --git a/docs/manual/mod/mod_cern_meta.html.en b/docs/manual/mod/mod_cern_meta.html.en index e9ce361cab..79b2850443 100644 --- a/docs/manual/mod/mod_cern_meta.html.en +++ b/docs/manual/mod/mod_cern_meta.html.en @@ -4,11 +4,28 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_cern_meta - Apache HTTP Server
    <-

    Apache Module mod_cern_meta

    Description: - CERN httpd metafile semantics
    Status: - Extension
    ModuleĀ Identifier: - cern_meta_module
    SourceĀ File: - mod_cern_meta.c

    Summary

    + --> +mod_cern_meta - Apache HTTP Server + + + + + + +
    <-
    + +
    +

    Apache Module mod_cern_meta

    + + + +
    Description:CERN httpd metafile semantics
    Status:Extension
    ModuleĀ Identifier:cern_meta_module
    SourceĀ File:mod_cern_meta.c
    +

    Summary

    +

    Emulate the CERN HTTPD Meta file semantics. Meta files are HTTP headers that can be output in addition to the normal range of headers for each file accessed. They appear rather like the @@ -19,18 +36,31 @@ CERN users who can exploit this module.

    More information on the CERN metafile semantics is available.

    -

    Directives

    +
    top

    MetaDir Directive

    Description: - Name of the directory to find CERN-style meta information -files
    Syntax: - MetaDir directory
    Default: - MetaDir .web
    Context: - server config, virtual host, directory, .htaccess
    Override: - Indexes
    Status: - Extension
    Module: - mod_cern_meta
    + +

    See also

    +
    + +
    top
    +

    MetaDir Directive

    + + + + + + + + +
    Description:Name of the directory to find CERN-style meta information +files
    Syntax:MetaDir directory
    Default:MetaDir .web
    Context:server config, virtual host, directory, .htaccess
    Override:Indexes
    Status:Extension
    Module:mod_cern_meta

    Specifies the name of the directory in which Apache can find meta information files. The directory is usually a 'hidden' subdirectory of the directory that contains the file being @@ -43,24 +73,34 @@ filesSyntax: files:

    MetaDir .meta

    -
    top

    MetaFiles Directive

    Description: - Activates CERN meta-file processing
    Syntax: - MetaFiles on|off
    Default: - MetaFiles off
    Context: - server config, virtual host, directory, .htaccess
    Override: - Indexes
    Status: - Extension
    Module: - mod_cern_meta
    + +
    +
    top
    +

    MetaFiles Directive

    + + + + + + + + +
    Description:Activates CERN meta-file processing
    Syntax:MetaFiles on|off
    Default:MetaFiles off
    Context:server config, virtual host, directory, .htaccess
    Override:Indexes
    Status:Extension
    Module:mod_cern_meta

    Turns on/off Meta file processing on a per-directory basis.

    -
    top

    MetaSuffix Directive

    Description: - File name suffix for the file containg CERN-style -meta information
    Syntax: - MetaSuffix suffix
    Default: - MetaSuffix .meta
    Context: - server config, virtual host, directory, .htaccess
    Override: - Indexes
    Status: - Extension
    Module: - mod_cern_meta
    + +
    +
    top
    +

    MetaSuffix Directive

    + + + + + + + + +
    Description:File name suffix for the file containg CERN-style +meta information
    Syntax:MetaSuffix suffix
    Default:MetaSuffix .meta
    Context:server config, virtual host, directory, .htaccess
    Override:Indexes
    Status:Extension
    Module:mod_cern_meta

    Specifies the file name suffix for the file containing the meta information. For example, the default values for the two directives will cause a request to @@ -72,4 +112,10 @@ meta informationSyntax:

    -
    \ No newline at end of file + +
    +
    + + \ No newline at end of file diff --git a/docs/manual/mod/mod_cgi.html.en b/docs/manual/mod/mod_cgi.html.en index f6eb474ec1..4cfbb4829c 100644 --- a/docs/manual/mod/mod_cgi.html.en +++ b/docs/manual/mod/mod_cgi.html.en @@ -4,11 +4,28 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_cgi - Apache HTTP Server
    <-

    Apache Module mod_cgi

    Description: - Execution of CGI scripts
    Status: - Base
    ModuleĀ Identifier: - cgi_module
    SourceĀ File: - mod_cgi.c

    Summary

    + --> +mod_cgi - Apache HTTP Server + + + + + + +
    <-
    + +
    +

    Apache Module mod_cgi

    + + + +
    Description:Execution of CGI scripts
    Status:Base
    ModuleĀ Identifier:cgi_module
    SourceĀ File:mod_cgi.c
    +

    Summary

    +

    Any file that has the mime type @@ -35,10 +52,29 @@ mod_cgid should be used in place of this module. At the user level, the two modules are essentially identical.

    -

    Directives

    +
    top
    +
    top
    +
    +

    CGI Environment variables

    The server will set the CGI environment variables as described in the CGI specification, with the following provisions:

    @@ -73,7 +109,9 @@
    This will only be set if the CGI script is subject to authentication.
    -
    top
    top
    +
    +

    CGI Debugging

    Debugging CGI scripts has traditionally been difficult, mainly because it has not been possible to study the output (standard output and error) for scripts which are failing to run @@ -118,12 +156,16 @@

    (The %stdout and %stderr parts may be missing if the script did not output anything on standard output or standard error).

    -
    top

    ScriptLog Directive

    Description: - Location of the CGI script error logfile
    Syntax: - ScriptLog file-path
    Context: - server config, virtual host
    Status: - Base
    Module: - mod_cgi, mod_cgid
    +
    +
    top
    +

    ScriptLog Directive

    + + + + + + +
    Description:Location of the CGI script error logfile
    Syntax:ScriptLog file-path
    Context:server config, virtual host
    Status:Base
    Module:mod_cgi, mod_cgid

    The ScriptLog directive sets the CGI script error logfile. If no ScriptLog is given, no error log is created. If given, any CGI errors are logged into the @@ -149,26 +191,36 @@ continuously on running servers. It is not optimized for speed or efficiency, and may have security problems if used in a manner other than that for which it was designed.

    -
    top

    ScriptLogBuffer Directive

    Description: - Maximum amount of PUT or POST requests that will be recorded -in the scriptlog
    Syntax: - ScriptLogBuffer bytes
    Default: - ScriptLogBuffer 1024
    Context: - server config, virtual host
    Status: - Base
    Module: - mod_cgi, mod_cgid
    + +
    +
    top
    +

    ScriptLogBuffer Directive

    + + + + + + + +
    Description:Maximum amount of PUT or POST requests that will be recorded +in the scriptlog
    Syntax:ScriptLogBuffer bytes
    Default:ScriptLogBuffer 1024
    Context:server config, virtual host
    Status:Base
    Module:mod_cgi, mod_cgid

    The size of any PUT or POST entity body that is logged to the file is limited, to prevent the log file growing too big too quickly if large bodies are being received. By default, up to 1024 bytes are logged, but this can be changed with this directive.

    -
    top

    ScriptLogLength Directive

    Description: - Size limit of the CGI script logfile
    Syntax: - ScriptLogLength bytes
    Default: - ScriptLogLength 10385760
    Context: - server config, virtual host
    Status: - Base
    Module: - mod_cgi, mod_cgid
    + +
    +
    top
    +

    ScriptLogLength Directive

    + + + + + + + +
    Description:Size limit of the CGI script logfile
    Syntax:ScriptLogLength bytes
    Default:ScriptLogLength 10385760
    Context:server config, virtual host
    Status:Base
    Module:mod_cgi, mod_cgid

    ScriptLogLength can be used to limit the size of the CGI script logfile. Since the logfile logs a lot of information per CGI error (all request headers, all script output) @@ -176,4 +228,10 @@ in the scriptlogSyntax: growth, this directive can be used to set an maximum file-size for the CGI logfile. If the file exceeds this size, no more information will be written to it.

    -
    \ No newline at end of file + +
    +
    + + \ No newline at end of file diff --git a/docs/manual/mod/mod_cgid.html.en b/docs/manual/mod/mod_cgid.html.en index afdf5a0d66..40fe28c342 100644 --- a/docs/manual/mod/mod_cgid.html.en +++ b/docs/manual/mod/mod_cgid.html.en @@ -4,13 +4,30 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_cgid - Apache HTTP Server
    <-

    Apache Module mod_cgid

    Description: - Execution of CGI scripts using an - external CGI daemon
    Status: - Base
    ModuleĀ Identifier: - cgid_module
    SourceĀ File: - mod_cgid.c
    Compatibility: - Unix threaded MPMs only

    Summary

    + --> +mod_cgid - Apache HTTP Server + + + + + + +
    <-
    + +
    +

    Apache Module mod_cgid

    + + + + +
    Description:Execution of CGI scripts using an + external CGI daemon
    Status:Base
    ModuleĀ Identifier:cgid_module
    SourceĀ File:mod_cgid.c
    Compatibility:Unix threaded MPMs only
    +

    Summary

    +

    Except for the optimizations and the additional ScriptSock directive noted below, mod_cgid behaves similarly to mod_cgi. See the mod_cgi summary for additional details @@ -33,18 +50,31 @@ additional directive ScriptSock which gives the name of the socket to use for communication with the cgi daemon.

    -

    Directives

    +
    top

    ScriptSock Directive

    Description: - The name of the socket to use for communication with -the cgi daemon
    Syntax: - ScriptSock file-path
    Default: - ScriptSock logs/cgisock
    Context: - server config, virtual host
    Status: - Base
    Module: - mod_cgid
    + +

    See also

    +
    + +
    top
    +

    ScriptSock Directive

    + + + + + + + +
    Description:The name of the socket to use for communication with +the cgi daemon
    Syntax:ScriptSock file-path
    Default:ScriptSock logs/cgisock
    Context:server config, virtual host
    Status:Base
    Module:mod_cgid

    This directive sets the name of the socket to use for communication with the CGI daemon. The socket will be opened using the permissions of the user who starts Apache (usually @@ -56,4 +86,10 @@ the cgi daemonSyntax: ScriptSock /var/run/cgid.sock

    -
    \ No newline at end of file + +
    + + + \ No newline at end of file diff --git a/docs/manual/mod/mod_charset_lite.html.en b/docs/manual/mod/mod_charset_lite.html.en index 33ae881216..bc16956e89 100644 --- a/docs/manual/mod/mod_charset_lite.html.en +++ b/docs/manual/mod/mod_charset_lite.html.en @@ -4,11 +4,28 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_charset_lite - Apache HTTP Server
    <-

    Apache Module mod_charset_lite

    Description: - Specify character set translation or recoding
    Status: - Experimental
    ModuleĀ Identifier: - charset_lite_module
    SourceĀ File: - mod_charset_lite.c

    Summary

    + --> +mod_charset_lite - Apache HTTP Server + + + + + + +
    <-
    + +
    +

    Apache Module mod_charset_lite

    + + + +
    Description:Specify character set translation or recoding
    Status:Experimental
    ModuleĀ Identifier:charset_lite_module
    SourceĀ File:mod_charset_lite.c
    +

    Summary

    +

    This is an experimental module and should be used with care. Experiment with your mod_charset_lite configuration to ensure that it @@ -31,10 +48,20 @@

    This module provides a small subset of configuration mechanisms implemented by Russian Apache and its associated mod_charset.

    -

    Directives

    +
    top
    +
    top
    +
    +

    Common Problems

    Invalid character set names

    @@ -67,13 +94,17 @@ it cannot translate the input buffer. -
    top

    CharsetDefault Directive

    Description: - Charset to translate into
    Syntax: - CharsetDefault charset
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Experimental
    Module: - mod_charset_lite
    +
    +
    top
    +

    CharsetDefault Directive

    + + + + + + + +
    Description:Charset to translate into
    Syntax:CharsetDefault charset
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Experimental
    Module:mod_charset_lite

    The CharsetDefault directive specifies the charset that content in the associated container should be translated to.

    @@ -91,14 +122,19 @@ </Directory>

    -
    top

    CharsetOptions Directive

    Description: - Configures charset translation behavior
    Syntax: - CharsetOptions option [option] ...
    Default: - CharsetOptions DebugLevel=0 NoImplicitAdd
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Experimental
    Module: - mod_charset_lite
    + +
    +
    top
    +

    CharsetOptions Directive

    + + + + + + + + +
    Description:Configures charset translation behavior
    Syntax:CharsetOptions option [option] ...
    Default:CharsetOptions DebugLevel=0 NoImplicitAdd
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Experimental
    Module:mod_charset_lite

    The CharsetOptions directive configures certain behaviors of mod_charset_lite. Option can be one of

    @@ -126,13 +162,18 @@ should be specified so that mod_charset_lite doesn't add its filter. -
    top

    CharsetSourceEnc Directive

    Description: - Source charset of files
    Syntax: - CharsetSourceEnc charset
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Experimental
    Module: - mod_charset_lite
    + +
    +
    top
    +

    CharsetSourceEnc Directive

    + + + + + + + +
    Description:Source charset of files
    Syntax:CharsetSourceEnc charset
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Experimental
    Module:mod_charset_lite

    The CharsetSourceEnc directive specifies the source charset of files in the associated container.

    @@ -152,4 +193,10 @@

    The character set names in this example work with the iconv translation support in Solaris 8.

    -
    \ No newline at end of file + +
    + + + \ No newline at end of file diff --git a/docs/manual/mod/mpm_common.html.en b/docs/manual/mod/mpm_common.html.en index 325ccf4f3e..efa37c1332 100644 --- a/docs/manual/mod/mpm_common.html.en +++ b/docs/manual/mod/mpm_common.html.en @@ -4,10 +4,29 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mpm_common - Apache HTTP Server
    <-

    Apache Module mpm_common

    Description: - A collection of directives that are implemented by -more than one multi-processing module (MPM)
    Status: - MPM

    Directives

    +
    + +
    top
    +

    CoreDumpDirectory Directive

    + + + + + + + +
    Description:Directory where Apache attempts to +switch before dumping core
    Syntax:CoreDumpDirectory directory
    Default:See usage for the default setting
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt

    This controls the directory to which Apache attempts to switch before dumping core. The default is in the @@ -44,14 +69,19 @@ switch before dumping core -

    top

    Group Directive

    Description: - Group under which the server will answer -requests
    Syntax: - Group unix-group
    Default: - Group #-1
    Context: - server config, virtual host
    Status: - MPM
    Module: - worker, perchild, prefork
    + +
    +
    top
    +

    Group Directive

    + + + + + + + +
    Description:Group under which the server will answer +requests
    Syntax:Group unix-group
    Default:Group #-1
    Context:server config, virtual host
    Status:MPM
    Module:worker, perchild, prefork

    The Group directive sets the group under which the server will answer requests. In order to use this directive, the stand-alone server must be run initially as root. @@ -81,13 +111,18 @@ requestsSyntax: SuexecUserGroup directive. SECURITY: See User for a discussion of the security considerations.

    -
    top

    Listen Directive

    Description: - IP addresses and ports that the server -listens to
    Syntax: - Listen [IP-address:]portnumber
    Context: - server config
    Status: - MPM
    Module: - worker, perchild, prefork, mpm_winnt
    + +
    +
    top
    +

    Listen Directive

    + + + + + + +
    Description:IP addresses and ports that the server +listens to
    Syntax:Listen [IP-address:]portnumber
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt

    The Listen directive instructs Apache to listen to only specific IP addresses or ports; by default it responds to requests on all IP interfaces. The Listen directive is @@ -128,14 +163,24 @@ listens toSyntax:

    -

    See also

    top

    ListenBackLog Directive

    Description: - Maximum length of the queue of pending connections
    Syntax: - ListenBacklog backlog
    Default: - ListenBacklog 511
    Context: - server config
    Status: - MPM
    Module: - worker, perchild, prefork, mpm_winnt
    + +

    See also

    + +
    +
    top
    +

    ListenBackLog Directive

    + + + + + + + +
    Description:Maximum length of the queue of pending connections
    Syntax:ListenBacklog backlog
    Default:ListenBacklog 511
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt

    The maximum length of the queue of pending connections. Generally no tuning is needed or desired, however on some systems it is desirable to increase this when under a TCP SYN @@ -147,13 +192,18 @@ listens toSyntax: many OSes do not use exactly what is specified as the backlog, but use a number based on (but normally larger than) what is set.

    -
    top

    LockFile Directive

    Description: - Location of the accept serialization lock file
    Syntax: - LockFile filename
    Default: - LockFile logs/accept.lock
    Context: - server config
    Status: - MPM
    Module: - worker, perchild, prefork
    + +
    +
    top
    +

    LockFile Directive

    + + + + + + + +
    Description:Location of the accept serialization lock file
    Syntax:LockFile filename
    Default:LockFile logs/accept.lock
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork

    The LockFile directive sets the path to the lockfile used when Apache is compiled with either USE_FCNTL_SERIALIZED_ACCEPT or USE_FLOCK_SERIALIZED_ACCEPT. This @@ -170,13 +220,18 @@ listens toSyntax: a lockfile with the same name as the one the server will try to create.

    -
    top

    MaxClients Directive

    Description: - Maximum number of child processes that will be created -to serve requests
    Syntax: - MaxClients number
    Context: - server config
    Status: - MPM
    Module: - worker, prefork
    + +
    +
    top
    +

    MaxClients Directive

    + + + + + + +
    Description:Maximum number of child processes that will be created +to serve requests
    Syntax:MaxClients number
    Context:server config
    Status:MPM
    Module:worker, prefork

    The MaxClients directive sets the limit on the number of simultaneous requests that will be served. Any connection attempts over the MaxClients @@ -199,25 +254,35 @@ to serve requestsSyntax: To increase MaxClients to a value that requires more than 16 processes, you must also raise ServerLimit.

    -
    top

    MaxMemFree Directive

    Description: - Maximum amount of memory that the main allocator is allowed -to hold without calling free()
    Syntax: - MaxMemFree number
    Context: - server config
    Status: - MPM
    Module: - worker, prefork, mpm_netware
    + +
    +
    top
    +

    MaxMemFree Directive

    + + + + + + +
    Description:Maximum amount of memory that the main allocator is allowed +to hold without calling free()
    Syntax:MaxMemFree number
    Context:server config
    Status:MPM
    Module:worker, prefork, mpm_netware

    The MaxMemFree directive sets the maximum number of free Kbytes that the main allocator is allowed to hold without calling free(). When not set, or when set to zero, the threshold will be set to unlimited.

    -
    top

    MaxRequestsPerChild Directive

    Description: - Limit on the number of requests that an individual child server -will handle during its life
    Syntax: - MaxRequestsPerChild number
    Default: - MaxRequestsPerChild 10000
    Context: - server config
    Status: - MPM
    Module: - worker, perchild, prefork, mpm_winnt
    + +
    +
    top
    +

    MaxRequestsPerChild Directive

    + + + + + + + +
    Description:Limit on the number of requests that an individual child server +will handle during its life
    Syntax:MaxRequestsPerChild number
    Default:MaxRequestsPerChild 10000
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt

    The MaxRequestsPerChild directive sets the limit on the number of requests that an individual child server process will handle. After @@ -241,12 +306,17 @@ will handle during its lifetop

    MaxSpareThreads Directive

    Description: - Maximum number of idle threads
    Syntax: - MaxSpareThreads number
    Context: - server config
    Status: - MPM
    Module: - mpm_netware, perchild, worker
    + +
    +
    top
    +

    MaxSpareThreads Directive

    + + + + + + +
    Description:Maximum number of idle threads
    Syntax:MaxSpareThreads number
    Context:server config
    Status:MPM
    Module:mpm_netware, perchild, worker

    Maximum number of idle threads. Different MPMs deal with this directive differently.

    @@ -266,26 +336,41 @@ will handle during its lifeMinSpareThreads
  • StartServers
  • top

    MaxThreadsPerChild Directive

    Description: - Maximum number of threads per child process
    Syntax: - MaxThreadsPerChild number
    Default: - MaxThreadsPerChild 64
    Context: - server config
    Status: - MPM
    Module: - worker, perchild
    + +

    See also

    + +
    +
    top
    +

    MaxThreadsPerChild Directive

    + + + + + + + +
    Description:Maximum number of threads per child process
    Syntax:MaxThreadsPerChild number
    Default:MaxThreadsPerChild 64
    Context:server config
    Status:MPM
    Module:worker, perchild

    Maximum number of threads per child. For MPMs with a variable number of threads per child, this directive sets the maximum number of threads that will be created in each child process. To increase this value beyond its default, it is necessary to change the value of the compile-time define HARD_THREAD_LIMIT and recompile the server.

    -
    top

    MinSpareThreads Directive

    Description: - Minimum number of idle threads available to handle request -spikes
    Syntax: - MinSpareThreads number
    Context: - server config
    Status: - MPM
    Module: - mpm_netware, perchild, worker
    + +
    +
    top
    +

    MinSpareThreads Directive

    + + + + + + +
    Description:Minimum number of idle threads available to handle request +spikes
    Syntax:MinSpareThreads number
    Context:server config
    Status:MPM
    Module:mpm_netware, perchild, worker

    Minimum number of idle threads to handle request spikes. Different MPMs deal with this directive differently.

    @@ -306,25 +391,40 @@ spikesSyntax: MinSpareThreads 10 and, since it is a single-process MPM, tracks this on a server-wide bases.

    -

    See also

    top

    NumServers Directive

    Description: - Total number of children alive at the same time
    Syntax: - NumServers number
    Default: - NumServers 2
    Context: - server config
    Status: - MPM
    Module: - perchild
    + +

    See also

    + +
    +
    top
    +

    NumServers Directive

    + + + + + + + +
    Description:Total number of children alive at the same time
    Syntax:NumServers number
    Default:NumServers 2
    Context:server config
    Status:MPM
    Module:perchild

    Number of children alive at the same time. MPMs that use this directive do not dynamically create new child processes so this number should be large enough to handle the requests for the entire site.

    -
    top

    PidFile Directive

    Description: - File where the server records the process ID -of the daemon
    Syntax: - PidFile filename
    Default: - PidFile logs/httpd.pid
    Context: - server config
    Status: - MPM
    Module: - worker, perchild, prefork, mpm_winnt
    + +
    +
    top
    +

    PidFile Directive

    + + + + + + + +
    Description:File where the server records the process ID +of the daemon
    Syntax:PidFile filename
    Default:PidFile logs/httpd.pid
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt

    The PidFile directive sets the file to which the server records the process id of the daemon. If the filename does not begin with a slash (/) then it is assumed to be @@ -342,14 +442,19 @@ of the daemonSyntax:

    The PidFile is subject to the same warnings about log file placement and security.

    -
    top

    ScoreBoardFile Directive

    Description: - Location of the file used to store coordination data for -the child processes
    Syntax: - ScoreBoardFile file-path
    Default: - ScoreBoardFile logs/apache_status
    Context: - server config
    Status: - MPM
    Module: - worker, perchild, prefork
    + +
    +
    top
    +

    ScoreBoardFile Directive

    + + + + + + + +
    Description:Location of the file used to store coordination data for +the child processes
    Syntax:ScoreBoardFile file-path
    Default:ScoreBoardFile logs/apache_status
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork

    Apache uses a scoreboard to communicate between its parent and child processes. Some architectures require a file to facilitate this communication. If the file is left unspecified, Apache first @@ -369,23 +474,37 @@ the child processesSyntax you may see improved speed by placing it on a RAM disk. But be careful that you heed the same warnings about log file placement and security.

    -

    See also

    top
    +
    top
    +

    SendBufferSize Directive

    + + + + + + +
    Description:TCP buffer size
    Syntax:SendBufferSize bytes
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt

    The server will set the TCP buffer size to the number of bytes specified. Very useful to increase past standard OS defaults on high speed high latency (i.e., 100ms or so, such as transcontinental fast pipes).

    -
    top

    ServerLimit Directive

    Description: - Upper limit on configurable number of processes
    Syntax: - ServerLimit number
    Default: - ServerLimit 256 (prefork), ServerLimit 16 (worker)
    Context: - server config
    Status: - MPM
    Module: - worker, prefork
    + +
    +
    top
    +

    ServerLimit Directive

    + + + + + + + +
    Description:Upper limit on configurable number of processes
    Syntax:ServerLimit number
    Default:ServerLimit 256 (prefork), ServerLimit 16 (worker)
    Context:server config
    Status:MPM
    Module:worker, prefork

    For the prefork MPM, this directive sets the maximum configured value for MaxClients for the lifetime of the Apache process. For the worker MPM, this directive in combination @@ -413,23 +532,38 @@ the child processesSyntax settings require more than 16 server processes. Do not set the value of this directive any higher than the number of server processes required by what you may want for MaxClients and ThreadsPerChild.

    -
    top

    StartServers Directive

    Description: - Number of child server processes created at startup
    Syntax: - StartServers number
    Default: - StartServers 5
    Context: - server config
    Status: - MPM
    Module: - worker
    + +
    +
    top
    +

    StartServers Directive

    + + + + + + + +
    Description:Number of child server processes created at startup
    Syntax:StartServers number
    Default:StartServers 5
    Context:server config
    Status:MPM
    Module:worker

    The StartServers directive sets the number of child server processes created on startup. As the number of processes is dynamically controlled depending on the load, there is usually little reason to adjust this parameter.

    -

    See also

    top

    StartThreads Directive

    Description: - Nubmer of threads created on startup
    Syntax: - StartThreads number
    Context: - server config
    Status: - MPM
    Module: - mpm_netware, perchild
    + +

    See also

    + +
    +
    top
    +

    StartThreads Directive

    + + + + + + +
    Description:Nubmer of threads created on startup
    Syntax:StartThreads number
    Context:server config
    Status:MPM
    Module:mpm_netware, perchild

    Number of threads created on startup. As the number of threads is dynamically controlled depending on the load, there is usually little reason to adjust this @@ -444,13 +578,18 @@ the child processesSyntax process, this is the total number of threads created at startup to serve requests.

    -
    top

    ThreadLimit Directive

    Description: - Sets the upper limit on the configurable number of threads -per child process
    Syntax: - ThreadLimit number
    Context: - server config
    Status: - MPM
    Module: - mpm_winnt, worker
    + +
    +
    top
    +

    ThreadLimit Directive

    + + + + + + +
    Description:Sets the upper limit on the configurable number of threads +per child process
    Syntax:ThreadLimit number
    Context:server config
    Status:MPM
    Module:mpm_winnt, worker

    This directive sets the maximum configured value for ThreadsPerChild for the lifetime of the Apache process. Any attempts to change this directive during a restart will be ignored, but ThreadsPerChild can be modified @@ -470,12 +609,17 @@ per child processSyntax: 64 when used with worker and 1920 when used with mpm_winnt.

    -
    top

    ThreadsPerChild Directive

    Description: - Number of threads created by each child process
    Syntax: - ThreadsPerChild number
    Context: - server config
    Status: - MPM
    Module: - worker, mpm_winnt
    + +
    +
    top
    +

    ThreadsPerChild Directive

    + + + + + + +
    Description:Number of threads created by each child process
    Syntax:ThreadsPerChild number
    Context:server config
    Status:MPM
    Module:worker, mpm_winnt

    This directive sets the number of threads created by each child process. The child creates these threads at startup and never creates more. If using an MPM like mpmt_winnt, where @@ -489,14 +633,19 @@ per child processSyntax: worker and 64 when used with mpm_winnt.

    -
    top

    User Directive

    Description: - The userid under which the server will answer -requests
    Syntax: - User unix-userid
    Default: - User #-1
    Context: - server config, virtual host
    Status: - MPM
    Module: - worker, perchild, prefork
    + +
    +
    top
    +

    User Directive

    + + + + + + + +
    Description:The userid under which the server will answer +requests
    Syntax:User unix-userid
    Default:User #-1
    Context:server config, virtual host
    Status:MPM
    Module:worker, perchild, prefork

    The User directive sets the userid as which the server will answer requests. In order to use this directive, the standalone server must be run initially as @@ -535,4 +684,10 @@ requestsSyntax: (or Group) to root unless you know exactly what you are doing, and what the dangers are.

    - \ No newline at end of file + + + + + \ No newline at end of file -- 2.40.0