From 1e160588ba2a13e994e873a1173d390dfbc79bc0 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Andr=C3=A9=20Malo?= Date: Wed, 6 Nov 2002 02:27:02 +0000 Subject: [PATCH] - rebuild index files - update mod_cache related transformation git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97419 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/directives.html.en | 321 +++++++++++++- docs/manual/mod/index.html.en | 113 ++++- docs/manual/mod/mod_cache.html.en | 250 ++++++----- docs/manual/mod/quickreference.html.en | 592 ++++++++++++++++++++++++- 4 files changed, 1160 insertions(+), 116 deletions(-) diff --git a/docs/manual/mod/directives.html.en b/docs/manual/mod/directives.html.en index 31b0dada29..3221821813 100644 --- a/docs/manual/mod/directives.html.en +++ b/docs/manual/mod/directives.html.en @@ -17,5 +17,322 @@ is also available giving details about each directive in a summary form.

-

  

-
\ No newline at end of file +

 A  |  B  |  C  |  D  |  E  |  F  |  G  |  H  |  I  |  K  |  L  |  M  |  N  |  O  |  P  |  R  |  S  |  T  |  U  |  V  |  X 

+
\ No newline at end of file diff --git a/docs/manual/mod/index.html.en b/docs/manual/mod/index.html.en index 2c6edb4d51..d8eb56d874 100644 --- a/docs/manual/mod/index.html.en +++ b/docs/manual/mod/index.html.en @@ -11,4 +11,115 @@ alphabetical list of all Apache directives.

-
top

Core Features and Multi-Processing Modules

top

Other Modules

top

Obsolete Modules

\ No newline at end of file +
top

Core Features and Multi-Processing Modules

core
Core Apache HTTP Server features that are always +available
+
mpm_common
A collection of directives that are implemented by +more than one multi-processing module (MPM)
+
mpm_netware
Multi-Processing Module implementing an exclusively threaded web + server optimized for Novell NetWare
+
mpm_winnt
This Multi-Processing Module is optimized for Windows + NT.
+
perchild
Multi-Processing Module allowing for daemon processes + serving requests to be assigned a variety of different + userids
+
prefork
Implements a non-threaded, pre-forking web server
+
worker
Multi-Processing Module implementing a hybrid + multi-threaded multi-process web server
+
top

Other Modules

mod_actions
This module provides for executing CGI scripts based on +media type or request method.
+
mod_alias
Provides for mapping different parts of the host + filesystem in the document tree and for URL redirection
+
mod_asis
Sends files that contain their own +HTTP headers
+
mod_auth_basic
Basic authentication
+
mod_auth_digest
User authentication using MD5 + Digest Authentication.
+
mod_auth_ldap
Allows an LDAP directory to be used to store the database +for HTTP Basic authentication.
+
mod_authn_anon
Allows "anonymous" user access to authenticated + areas
+
mod_authn_dbm
User authentication using DBM files
+
mod_authn_file
User authentication using text files
+
mod_authz_dbm
Group authorization using DBM files
+
mod_authz_groupfile
Group authorization using plaintext files
+
mod_authz_host
Group authorizations based on host (name or IP +address)
+
mod_autoindex
Generates directory indexes, + automatically, similar to the Unix ls command or the + Win32 dir shell command
+
mod_cache
Content cache keyed to URIs.
+
mod_cern_meta
CERN httpd metafile semantics
+
mod_cgi
Execution of CGI scripts
+
mod_cgid
Execution of CGI scripts using an + external CGI daemon
+
mod_charset_lite
Specify character set translation or recoding
+
mod_dav
Distributed Authoring and Versioning +(WebDAV) functionality
+
mod_deflate
Compress content before + it is delivered to the client
+
mod_dir
Provides for "trailing slash" redirects and + serving directory index files
+
mod_echo
A simple echo server to illustrate protocol +modules
+
mod_env
Modifies the environment which is + passed to CGI scripts and SSI pages
+
mod_example
Illustrates the Apache module API
+
mod_expires
Generation of + Expires HTTP headers according to user-specified + criteria
+
mod_ext_filter
Pass the response body + through an external program before delivery to the + client
+
mod_file_cache
Caches a static list of files in memory
+
mod_headers
Customization of HTTP request + and response headers
+
mod_imap
Server-side imagemap processing
+
mod_include
Server-parsed html documents (Server Side Includes)
+
mod_info
Provides a comprehensive overview of the server +configuration
+
mod_isapi
ISAPI Extensions within Apache for Windows
+
mod_ldap
LDAP connection pooling and result caching +services for use by other LDAP modules
+
mod_log_config
Logging of the requests made to the server
+
mod_logio
Logging of input and output bytes per request
+
mod_mime
Associates the requested filename's extensions + with the file's behavior (handlers and filters) + and content (mime-type, language, character set and + encoding)
+
mod_mime_magic
Determines the MIME type of a file + by looking at a few bytes of its contents
+
mod_negotiation
Provides for content negotiation
+
mod_proxy
HTTP/1.1 proxy/gateway server
+
mod_rewrite
Provides a rule-based rewriting engine to rewrite requested +URLs on the fly
+
mod_setenvif
Allows the setting of environment variables based +on characteristics of the request
+
mod_so
Loading of executable code and +modules into the server at start-up or restart time
+
mod_speling
Attempts to correct mistaken URLs that +users might have entered by ignoring capitalization and by +allowing up to one misspelling
+
mod_ssl
Strong cryptography using the Secure Sockets +Layer (SSL) and Transport Layer Security (TLS) protocols
+
mod_status
Provides information on server activity and +performance
+
mod_suexec
Allows CGI scripts to run as a specified user +and Group
+
mod_unique_id
Provides an environment variable with a unique +identifier for each request
+
mod_userdir
User-specific directories
+
mod_usertrack
+Clickstream logging of user activity on a site +
+
mod_vhost_alias
Provides for dynamically configured mass virtual +hosting
+
top

Obsolete Modules

mod_access
(replaced by mod_authz_host since 2.0.44)
Provides access control based on client hostname, IP +address, or other characteristics of the client request.
+
mod_auth
(obsolete since 2.0.44)
User authentication using text files
+
mod_auth_anon
(replaced by mod_authn_anon since 2.0.44)
Allows "anonymous" user access to authenticated + areas
+
mod_auth_dbm
(obsolete since 2.0.44)
Provides for user authentication using DBM + files
+
mod_auth_digest
(obsolete since 2.0.44)
User authentication using MD5 + Digest Authentication.
+
\ 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 6cfe816dad..47492c5da9 100644 --- a/docs/manual/mod/mod_cache.html.en +++ b/docs/manual/mod/mod_cache.html.en @@ -10,23 +10,28 @@ cache_moduleSource File: mod_cache.c

Summary

- This module is experimental. Documentation is still under development... + This module is experimental. Documentation is still under development...
-

mod_cache implements an RFC 2616 compliant HTTP content - cache that can be used to cache either local or proxied content. - mod_cache requires the services of one or more storage + +

mod_cache implements an RFC 2616 compliant HTTP + content cache that can be used to cache either local or proxied content. + mod_cache requires the services of one or more storage management modules. Two storage management modules are included in the base Apache distribution:

mod_disk_cache
-
implements a disk based storage manager for use with mod_proxy
+
implements a disk based storage manager for use with + mod_proxy
+
mod_mem_cache
-
implements an in-memory based storage manager. mod_mem_cache - can be configured to operate in two modes: caching open file - descriptors or caching objects in heap storage. mod_mem_cache - is most useful when used to cache locally generated content or to cache - backend server content for mod_proxy configured for ProxyPass (aka reverse proxy)
+
implements an in-memory based storage manager. + mod_mem_cache can be configured to operate in two + modes: caching open file descriptors or caching objects in heap storage. + mod_mem_cache is most useful when used to cache + locally generated content or to cache backend server content for + mod_proxy configured for ProxyPass (aka reverse proxy)
+

Content stored and retrived keyed to the URL. Content with access protections is not cached.

Directives

Topics

top

Related Modules and Directives

+

Topics

top

Related Modules and Directives

Related ModulesRelated Directives
-
top

Sample Configuration

-

Sample httpd.conf

-#
-# Sample Cache Configuration
-#
-LoadModule cache_module modules/mod_cache.so
-<IfModule mod_cache.c>
-
-#LoadModule disk_cache_module modules/mod_disk_cache.so
- <IfModule mod_disk_cache.c>
- CacheRoot c:/cacheroot
- CacheSize 256
- CacheEnable disk /
- CacheDirLevels 5
- CacheDirLength 3
- </IfModule>
-
- LoadModule mem_cache_module modules/mod_mem_cache.so
- <IfModule mod_mem_cache.c>
- MCacheEnable mem /
- MCacheSize 4096
- MCacheMaxObjectCount 100
- MCacheMinObjectSize 1
- MCacheMaxObjectSize 2048
- </IfModule>
-
-</IfModule>
-

+
top

Sample Configuration

+

Sample httpd.conf

+ #
+ # Sample Cache Configuration
+ #
+ LoadModule cache_module modules/mod_cache.so
+
+ <IfModule mod_cache.c>
+ + #LoadModule disk_cache_module modules/mod_disk_cache.so
+ <IfModule mod_disk_cache.c>
+ + CacheRoot c:/cacheroot
+ CacheSize 256
+ CacheEnable disk /
+ CacheDirLevels 5
+ CacheDirLength 3
+ + </IfModule>
+
+ LoadModule mem_cache_module modules/mod_mem_cache.so
+ <IfModule mod_mem_cache.c>
+ + MCacheEnable mem /
+ MCacheSize 4096
+ MCacheMaxObjectCount 100
+ MCacheMinObjectSize 1
+ MCacheMaxObjectSize 2048
+ + </IfModule>
+ + </IfModule> +

top

CacheDefaultExpire Directive

Description: -
Syntax: - CacheDefaultExpire seconds
Default: + The default time in seconds to cache a document
Syntax: + CacheDefaultExpire seconds
Default: CacheDefaultExpire 3600 (one hour)
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_cache

The default time in seconds to cache a document if the page does not have - an expiry date in the Expires field.

+ an expiry date in the Expires field.

+

- CacheDefaultExpire 86400 + CacheDefaultExpire 86400

top

CacheDisable Directive

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

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

+ mod_cache to not cache urls at or below + url-string.

-

Example

- CacheDisable disk /local_files -

+

Example

+ CacheDisable disk /local_files +

top

CacheEnable Directive

Description: - Enable caching specified URLs in a specified storage manager
Syntax: - CacheEnable cache_type url-string
Context: - server config
Status: + Enable caching specified URLs in 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 store is specified with the cache_type argument. - cache_type mem instructs mod_cache to use the - in-memory cache storage manager implemented by mod_mem_cache. - cache_type disk instructs mod_cache to use the - cache storage manager implemented by mod_disk_cache .

+ mod_cache to cache urls at or below + url-string. The cache store is specified with the + cache_type argument. cache_type mem + instructs mod_cache to use the in-memory cache storage + manager implemented by mod_mem_cache. + cache_type disk instructs + mod_cache to use the cache storage manager implemented + by mod_disk_cache.

-

- CacheEnable disk /
- CacheEnable mem /manual
- CacheEnable fd /images
-

+

+ CacheEnable disk /
+ CacheEnable mem /manual
+ CacheEnable fd /images
+

top

CacheForceCompletion Directive

Description: - Percentage of download to arrive for the cache to force complete transfer
Syntax: - CacheForceCompletion Percentage
Default: + Percentage of download to arrive for the cache to force +complete transfer
Syntax: + CacheForceCompletion Percentage
Default: CacheForceCompletion 60
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_cache
-

Percentage of download to arrive for the cache to force complete transfert.

+

Percentage of download to arrive for the cache to force complete transfer.

- CacheForceCompletion 80 + CacheForceCompletion 80

-
-This feature is currently not implemented. -
+ +
+ This feature is currently not implemented. +
top

CacheIgnoreCacheControl Directive

Description: - Ignore requests from the client for uncached content
Syntax: - CacheIgnoreCacheControl
Context: - server config
Status: + Ignore requests from the client for uncached +content
Syntax: + CacheIgnoreCacheControl On|Off
Default: + CacheIgnoreCacheControl Off
Context: + server config, virtual host
Status: Experimental
Module: mod_cache

Ignore requests from the client for uncached content

- CacheIgnoreNoLastMod + CacheIgnoreCacheControl On

top

CacheIgnoreNoLastMod Directive

Description: - Ignore responses where there is no Last Modified Header
Syntax: - CacheIgnoreNoLastMod
Context: - server config
Status: + Ignore responses where there is no Last Modified +Header
Syntax: + CacheIgnoreNoLastMod On|Off
Default: + CacheIgnoreNoLastMod Off
Context: + server config, virtual host
Status: Experimental
Module: mod_cache
-

Ignore responses where there is no Last Modified Header

+

Ignore responses where there is no Last Modified Header.

- CacheIgnoreNoLastMod + CacheIgnoreNoLastMod On

top

CacheLastModifiedFactor Directive

Description: - The factor used to estimate the Expires date from the LastModified date
Syntax: - CacheLastModifiedFactor float
Default: + The factor used to estimate the Expires date from the +LastModified date
Syntax: + CacheLastModifiedFactor float
Default: CacheLastModifiedFactor 0.1
Context: - server config
Status: + server config, virtual host
Status: Experimental
Module: mod_cache

The factor used to estimate the Expires date from the LastModified date.

- CacheLastModifiedFactor 0.5 + CacheLastModifiedFactor 0.5

top

CacheMaxExpire Directive

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

The maximum time in seconds to cache a document. The CacheMaxExpire - takes precedence over the Expire field from the header.

+

The maximum time in seconds to cache a document. The + CacheMaxExpire takes precedence over the + Expires field from the header.

+

- CacheMaxExpire 604800 + CacheMaxExpire 604800

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: + 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
Status: + server config, virtual host
Status: Experimental
Module: mod_cache
-

Maximum number of bytes of a streamed response (i.e., a response where -the entire content is not available all at once, such as a proxy or CGI -response) to buffer before deciding if the response is cacheable. By -default, a streamed response will not be cached unless it has a -Content-Length header. The reason for this is to avoid using a large amount -of memory to buffer a partial response that might end up being too large -to fit in the cache anyway. To enable caching of streamed responses, use -CacheMaxStreamingBuffer to specify the maximum amount of buffer space to use -per request.

+

Maximum number of bytes of a streamed response (i.e., a + response where the entire content is not available all at once, such + as a proxy or CGI response) to buffer before deciding if the response + is cacheable. By default, a streamed response will not be + cached unless it has a Content-Length header. The reason + for this is to avoid using a large amount of memory to buffer a partial + response that might end up being too large to fit in the cache anyway. + To enable caching of streamed responses, use CacheMaxStreamingBuffer to specify the maximum amount of + buffer space to use per request.

-

Note: Using a nonzero value for CacheMaxStreamingBuffer will not delay the -transmission of the response to the client. As soon as mod_cache copies a -block of streamed content into a buffer, it sends the block on to the next -output filter for delivery to the client.

+

Note:

+

Using a nonzero value for CacheMaxStreamingBuffer will not delay the transmission + of the response to the client. As soon as mod_cache + copies a block of streamed content into a buffer, it sends the block + on to the next output filter for delivery to the client.

+
-

-# Enable caching of streamed responses up to 64KB:
-CacheMaxStreamingBuffer 65536 -

+

+ # Enable caching of streamed responses up to 64KB:
+ CacheMaxStreamingBuffer 65536 +

\ No newline at end of file diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 67d1824891..cf0b40c8c8 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -18,7 +18,7 @@ is allowed and the status of the directive according to the legend tables below.

-
+
  
 A  |  B  |  C  |  D  |  E  |  F  |  G  |  H  |  I  |  K  |  L  |  M  |  N  |  O  |  P  |  R  |  S  |  T  |  U  |  V  |  X  @@ -31,4 +31,592 @@
sserver config
vvirtual host
EExtension
XExperimental
- \ No newline at end of file +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AcceptMutex default|method default sM
Method that Apache uses to serialize multiple children +accepting requests on network sockets
AcceptPathInfo On|Off|Default Default svdhC
Resources accept trailing pathname information
AccessFileName filename [filename] ... .htaccess svC
Name of the distributed configuration file
Action action-type cgi-scriptsvdhB
Activates a CGI script for a particular handler or +content-type
AddAlt string file [file] ...svdhB
Alternate text to display for a file, instead of an +icon selected by filename
AddAltByEncoding string MIME-encoding +[MIME-encoding] ...svdhB
Alternate text to display for a file instead of an icon +selected by MIME-encoding
AddAltByType string MIME-type +[MIME-type] ...svdhB
Alternate text to display for a file, instead of an +icon selected by MIME content-type
AddCharset charset extension +[extension] ...svdhB
Maps the given filename extensions + to the specified content charset
AddDefaultCharset On|Off|charset Off svdhC
Default character set to be added for a +response without an explicit character set
AddDescription string file [file] ...svdhB
Description to display for a file
AddEncoding + MIME-enc extension [extension] ...svdhB
Maps the given filename extensions + to the specified encoding type
AddHandler + handler-name extension [extension] ...svdhB
Maps the filename extensions +to the specified handler
AddIcon icon name [name] +...svdhB
Icon to display for a file selected by name
AddIconByEncoding icon MIME-encoding +[MIME-encoding] ...svdhB
Icon to display next to files selected by MIME +content-encoding
AddIconByType icon MIME-type +[MIME-type] ...svdhB
Icon to display next to files selected by MIME +content-type
AddInputFilter + filter[;filter...] extension + [extension ...]svdhB
Maps filename extensions + to the filters that will process + client requests
AddLanguage + MIME-lang extension [extension] ...svdhB
Maps the given filename extension +to the specified content language
AddModuleInfo module-name stringsvE
Adds additional information to the module +information displayed by the server-info handler
AddOutputFilter + filter[;filter...] extension + [extension ...]svdhB
Maps filename +extensions to the filters that will process +responses from the server
AddOutputFilterByType filter[;filter...] MIME-type +[MIME-type] ...svdhC
assigns an output filter to a particular MIME-type
AddType MIME-type + extension [extension] ...svdhB
Maps the given filename extensions +onto the specified content type
Alias URL-path +file-path|directory-pathsvB
Maps URLs to filesystem locations
AliasMatch regex +file-path|directory-pathsvB
Maps URLs to filesystem locations using regular +expressions
Allow from + all|host|env=env-variable + [host|env=env-variable] ...dhB
Controls which hosts can access an area of the +server
AllowCONNECT port [port] ... 443 563 svE
Ports that are allowed to CONNECT through +the proxy
AllowOverride All|None|directive-type +[directive-type] ... All dC
Types of directives that are allowed in +.htaccess files
Anonymous user [user] ...dhE
Specifies userIDs that areallowed access without +password verification
Anonymous_Authoritative on|off off dhE
Configures if authorization will fall-through +to other methods
Anonymous_LogEmail on|off on dhE
Sets whether the password entered will be logged in the +error log
Anonymous_MustGiveEmail on|off on dhE
Specifies whether blank passwords are allowed
Anonymous_NoUserID on|off off dhE
Sets whether the userID field may be empty
Anonymous_VerifyEmail on|off off dhE
Sets whether to check the password field for a correctly +formatted email address
AssignUserID user_id group_idvM
-
AuthBasicAuthoritative on|off on dhB
Sets whether authorization and authentication are +passed to lower level modules
AuthBasicProvider provider-namedhB
Sets the authentication provider(s) for this location
AuthDBMGroupFile file-pathdhE
Sets the name of the database file containing the list +of user groups for authentication
AuthDBMType default|SDBM|GDBM|NDBM|DB default dhE
Sets the type of database file that is used to +store passwords
AuthDBMUserFile file-pathdhE
Sets the name of a database file containing the list of users and +passwords for authentication
AuthDigestAlgorithm MD5|MD5-sess MD5 dhX
Selects the algorithm used to calculate the challenge and +response hases in digest authentication
AuthDigestDomain URI [URI] ...dhX
URIs that are in the same protection space for digest +authentication
AuthDigestFile file-pathdhX
Location of the text file containing the list +of users and encoded passwords for digest authentication
AuthDigestGroupFile file-pathdhX
Name of the text file containing the list of groups +for digest authentication
AuthDigestNcCheck On|Off Off sX
Enables or disables checking of the nonce-count sent by the +server
AuthDigestNonceFormat formatdhX
Determines how the nonce is generated
AuthDigestNonceLifetime seconds 300 dhX
How long the server nonce is valid
AuthDigestQop none|auth|auth-int [auth|auth-int] auth dhX
Determines the quality-of-protection to use in digest +authentication
AuthGroupFile file-pathdhE
Sets the name of a text file containing the list +of user groups for authentication
AuthLDAPAuthoritative on|off on dhX
Prevent other authentication modules from +authenticating the user if this one fails
AuthLDAPBindDN distinguished-namedhX
Optional DN to use in binding to the LDAP server
AuthLDAPBindPassword passworddhX
Password used in conjuction with the bind DN
AuthLDAPCompareDNOnServer on|off on dhX
Use the LDAP server to compare the DNs
AuthLDAPDereferenceAliases never|searching|finding|always Always dhX
When will the module de-reference aliases
AuthLDAPEnabled on|off on dhX
Turn on or off LDAP authentication
AuthLDAPFrontPageHack on|offdhX
Allow LDAP authentication to work with MS FrontPage
AuthLDAPGroupAttribute attributedhX
LDAP attributes used to check for group membership
AuthLDAPGroupAttributeIsDN on|off on dhX
Use the DN of the client username when checking for +group membership
AuthLDAPRemoteUserIsDN on|offdhX
Use the DN of the client username to set the REMOTE_USER +environment variable
AuthLDAPStartTLS on|offdhX
Use a secure TLS connection to the LDAP server
AuthLDAPUrl urldhX
URL specifying the LDAP search parameters
AuthName auth-domaindhC
Authorization realm for use in HTTP +authentication
AuthType Basic|DigestdhC
Type of user authentication
AuthUserFile file-pathdhB
Sets the name of a text file containing the list of users and +passwords for authentication
AuthzDBMAuthoritative on|off on dhE
Sets whether authorization will be passed on to lower level modules
AuthzDBMType default|SDBM|GDBM|NDBM|DB default dhE
Sets the type of database file that is used to +store passwords
AuthzGroupFileAuthoritative on|off on dhE
Sets whether authorization will be passed on to lower level modules
BrowserMatch regex [!]env-variable[=value] +[[!]env-variable[=value]] ...svdhB
Sets environment variables conditional on HTTP User-Agent +
BrowserMatchNoCase regex [!]env-variable[=value] + [[!]env-variable[=value]] ...svdhB
Sets environment variables conditional on User-Agent without +respect to case
CacheDefaultExpire seconds 3600 (one hour) svX
The default time in seconds to cache a document
CacheDisable cache_type url-stringsvX
Disable caching of specified URLs by specified storage +manager
CacheEnable cache_type url-stringsvX
Enable caching specified URLs in a specified storage +manager
CacheFile + file-path [file-path] ...sX
-
CacheForceCompletion Percentage 60 svX
Percentage of download to arrive for the cache to force +complete transfer
CacheIgnoreCacheControl On|Off Off svX
Ignore requests from the client for uncached +content
CacheIgnoreNoLastMod On|Off Off svX
Ignore responses where there is no Last Modified +Header
CacheLastModifiedFactor float 0.1 svX
The factor used to estimate the Expires date from the +LastModified date
CacheMaxExpire seconds 86400 (one day) svX
The maximum time in seconds to cache a document
CacheMaxStreamingBuffer size_in_bytes 0 svX
Maximum amount of a streamed response to buffer in memory +before declaring the response uncacheable
CacheNegotiatedDocs on|off off svB
Allows content-negotiated documents to be +cached by proxy servers
CGIMapExtension cgi-path .extensiondhC
Technique for locating the interpreter for CGI +scripts
CharsetDefault charsetsvdhX
Charset to translate into
CharsetOptions option [option] ... DebugLevel=0 +NoImp +svdhX
Configures charset tranlation behavior
CharsetSourceEnc charsetsvdhX
Source charset of files
CheckSpelling on|off Off svdhE
Enables the spelling +module
ChildPerUserID user_id +group_id num_childrensM
-
ContentDigest on|off off svdhC
Enables the generation of Content-MD5 HTTP Response +headers
CookieDomain domainsvdhE
The domain to which the tracking cookie applies
CookieExpires expiry-periodsvdhE
Expiry time for the tracking cookie
CookieLog filenamesvB
Sets filename for the logging of cookies
CookieName token Apache svdhE
Name of the tracking cookie
CookieStyle + Netscape|Cookie|Cookie2|RFC2109|RFC2965 Netscape svdhE
Format of the cookie header field
CookieTracking on|off off svdhE
Enables tracking cookie
CoreDumpDirectory directorysM
Directory where Apache attempts to +switch before dumping core
CustomLog + file|pipe format|nickname + [env=[!]environment-variable]svB
Sets filename and format of log file
Dav on|off off dE
Enable WebDAV HTTP methods
DavDepthInfinity on|off off dE
Allow PROPFIND, Depth: Infinity requests
DavLockDB file-pathsvE
Location of the DAV lock database
DavMinTimeout seconds 0 dE
Minimum amount of time the server holds a lock on +a DAV resource
DefaultIcon url-pathsvdhB
Icon to display for files when no specific icon is +configured
DefaultLanguage + MIME-langsvdhB
Sets all files in the given scope to the +specified language
DefaultType MIME-type text/plain svdhC
MIME content-type that will be sent if the +server cannot determine a type in any other way
DeflateBufferSize value 8096 svE
Fragment size to be compressed at one time by zlib
DeflateFilterNote notenamesvE
Places the compression ratio in a note for logging
DeflateMemLevel value 9 svE
How much memory should be used by zlib for compression
DeflateWindowSize value 15 svE
Zlib compression window size
Deny from + all|host|env=env-variable + [host|env=env-variable] ...dhB
Controls which hosts are denied access to the +server
<Directory directory-path> +... </Directory>svC
Enclose a group of directives that apply only to the +named file-system directory and sub-directories
DirectoryIndex + local-url [local-url] ... index.html svdhB
List of resources to look for when the client requests +a directory
<DirectoryMatch regex> +... </Directory>svC
Enclose directives that apply to +file-system directories matching a regular expression and their +subdirectories
DocumentRoot directory-path /usr/local/apache/h +svC
Directory that forms the main document tree visible +from the web
EnableMMAP on|off on svdhC
Use memory-mapping to read files during delivery
EnableSendfile on|off on svdhC
Use the kernel sendfile support to deliver files to the client
ErrorDocument error-code documentsvdhC
What the server will return to the client +in case of an error
ErrorLog file-path|syslog[:facility] logs/error_log (Uni +svC
Location where the server will log errors
ExamplesvdhX
Demonstration directive to illustrate the Apache module +API
ExpiresActive On|OffsvdhE
Enables generation of Expires headers
ExpiresByType + MIME-type <code>secondssvdhE
Value of the Expires header configured +by MIME type
ExpiresDefault <code>secondssvdhE
Default algorithm for calculating expiration time
ExtendedStatus On|Off Off sB
Keep track of extended status information for each +request
ExtFilterDefine filtername parameterssX
-
ExtFilterOptions + option [option] ... DebugLevel=0 NoLogS +dX
-
FileETag component ... INode MTime Size svdhC
File attributes used to create the ETag +HTTP response header
<Files filename> ... </Files>svdhC
Contains directives that apply to matched +filenames
<FilesMatch regex> ... </FilesMatch>svdhC
Contains directives that apply to regular-expression matched +filenames
ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdhB
Action to take if a single acceptable document is not +found
ForceType MIME-type|nonedhC
Forces all matching files to be served with the specified +MIME content-type
Group unix-group #-1 svM
Group under which the server will answer +requests
Header set|append|add|unset|echo header +[value]svdhE
Configure HTTP response headers
HeaderName filenamesvdhB
Name of the file that will be inserted at the top +of the index listing
HostnameLookups on|off|double off svdC
Enables DNS lookups on client IP addresses
IdentityCheck on|off off svdC
Enables logging of the RFC1413 identity of the remote +user
<IfDefine [!]parameter-name> ... + </IfDefine>svdhC
Encloses directives that will be processed only +if a test is true at startup
<IfModule [!]module-name> ... + </IfModule>svdhC
Encloses directives that are processed conditional on the +presence or absence of a specific module
ImapBase map|referer|URL http://servername/ svdhB
Default base for imagemap files
ImapDefault error|nocontent|map|referer|URL nocontent svdhB
Default action when an imagemap is called with coordinates +that are not explicitly mapped
ImapMenu + none|formatted|semiformatted|unformattedsvdhB
Action if no coordinates are given when calling +an imagemap
Include file-path|directory-pathsvdC
Includes other configuration files from within +the server configuration files
IndexIgnore file [file] ...svdhB
Adds to the list of files to hide when listing +a directory
IndexOptions [+|-]option [[+|-]option] +...svdhB
Various configuration settings for directory +indexing
IndexOrderDefault Ascending|Descending +Name|Date|Size|Description Ascending Name svdhB
Sets the default ordering of the directory index
ISAPIAppendLogToErrors on|off off svdhB
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI +extensions to the error log
ISAPIAppendLogToQuery on|off on svdhB
Record HSE_APPEND_LOG_PARAMETER requests from ISAPI +extensions to the query field
ISAPICacheFile file-path [file-path] ...svB
ISAPI .dll files to be loaded at startup
ISAPIFakeAsync on|off off svdhB
Fake asynchronous support for isapi callbacks
ISAPILogNotSupported on|off off svdhB
Log unsupported feature requests from ISAPI +extensions
ISAPIReadAheadBuffer size 49152 sdhB
Size of the Read Ahead Buffer sent to ISAPI +extensions
KeepAlive on|off On svC
Enables HTTP persistent connections
KeepAliveTimeout seconds 15 svC
Amount of time the server will wait for subsequent +requests on a persistent connection
LanguagePriority MIME-lang [MIME-lang] ...svdhB
The precendence of language variants for cases where +the client does not express a preference
LDAPCacheEntries number 1024 sX
Maximum number of entires in the primary LDAP cache
LDAPCacheTTL seconds 600 sX
Time that cached items remain valid
LDAPCertDBPath directory-pathsX
Directory containing certificates for SSL support
LDAPOpCacheEntries number 1024 sX
Number of entries used to cache LDAP compare +operations
LDAPOpCacheTTL seconds 600 sX
Time that entries in the operation cache remain +valid
LDAPSharedCacheSize bytes 102400 sX
Size in bytes of the shared-memory cache
<Limit method [method] ... > ... + </Limit>svdhC
Restrict enclosed access controls to only certain HTTP +methods
<LimitExcept method [method] ... > ... + </LimitExcept>svdhC
Restrict access controls to all HTTP methods +except the named ones
LimitRequestBody bytes 0 svdhC
Restricts the total size of the HTTP request body sent +from the client
LimitRequestFields number 100 sC
Limits the number of HTTP request header fields that +will be accepted from the client
LimitRequestFieldsize bytessC
Limits the size of the HTTP request header allowed from the +client
LimitRequestLine bytes 8190 sC
Limit the size of the HTTP request line that will be accepted +from the client
LimitXMLRequestBody number 1000000 svdhC
Limits the size of an XML-based request body
Listen [IP-address:]portnumbersM
IP addresses and ports that the server +listens to
ListenBacklog backlogsM
Maximum length of the queue of pending connections
LoadFile filename [filename] ...sE
Link in the named object file or library
LoadModule module filenamesE
Links in the object file or library, and adds to the list +of active modules
<Location + URL-path|URL> ... </Location>svC
Applies the enclosed directives only to matching +URLs
<LocationMatch + regex> ... </Location>svC
Applies the enclosed directives only to regular-expression +matching URLs
LockFile filename logs/accept.lock sM
Location of the accept serialization lock file
LogFormat + format|nickname [nickname] "%h %l %u %t \"%r\" +svB
Describes a format for use in a log file
LogLevel level warn svC
Controls the verbosity of the ErrorLog
MaxClients numbersM
Maximum number of child processes that will be created +to serve requests
MaxKeepAliveRequests number 100 svC
Number of requests allowed on a persistent +connection
MaxMemFree numbersM
Maximum amount of memory that the main allocator is allowed +to hold without calling free()
MaxRequestsPerChild number 10000 sM
Limit on the number of requests that an individual child server +will handle during its life
MaxSpareServers number
 10 sM
Maximum number of idle child server processes
MaxSpareThreads numbersM
Maximum number of idle threads
MaxThreads number 250 sM
-
MaxThreadsPerChild number 64 sM
Maximum number of threads per child process
MetaDir directory .web svdhE
Name of the directory to find CERN-style meta information +files
MetaFiles on|off off svdhE
Activates CERN meta-file processing
MetaSuffix suffix .meta svdhE
File name suffix for the file containg CERN-style +meta information
MimeMagicFile file-pathsvE
Enable MIME-type determination based on file contents +using the specified magic file
MinSpareServers number 5 sM
Minimum number of idle child server processes
MinSpareThreads numbersM
Minimum number of idle threads available to handle request +spikes
MMapFile file-path [file-path] ...sX
-
ModMimeUsePathInfo On|OffdB
Tells mod_mime to treat path_info components as part of the filename
MultiviewsMatch + [NegotiatedOnly] [Handlers] [Filters] [Any]svdhB
The types of files that will be included when +searching for a matching file with MultiViews
NameVirtualHost addr[:port]sC
Designates an IP address for name-virtual +hosting
NoProxy host [host] ...svE
Hosts, domains, or networks that will be connected +to directly
NumServers number 2 sM
Total number of children alive at the same time
Options + [+|-]option [[+|-]option] ... All svdhC
Configures what features are available in a particular +directory
Order ordering Deny,Allow dhB
Controls the default access state and the order in which +Allow and Deny are +evaluated.
PassEnv + env-variable [env-variable] ...svdhB
Passes environment variables from the shell
PidFile filename logs/httpd.pid sM
File where the server records the process ID +of the daemon
ProtocolEcho On|OffsvX
Turn the echo server on or off
<Proxy wildcard-url> ...</Proxy>svE
Container for directives applied to proxied +resources
ProxyBlock *|word|host|domain +[word|host|domain] ...svE
Words, hosts, or domains that are banned from being +proxied
ProxyDomain DomainsvE
Default domain name for proxied requests
ProxyErrorOverride On|Off Off svE
Override error pages for proxied content
ProxyIOBufferSize bytessvE
IO buffer size for outgoing HTTP and FTP +connections
<Proxy regex> ...</Proxy>svE
Container for directives applied to regular-expression-matched +proxied resources
ProxyMaxForwards number 10 svE
Maximium number of proxies that a request can be forwarded +through
ProxyPass [path] !|urlsvE
Maps remote servers into the local server +URL-space
ProxyPassReverse [path] urlsvE
Adjusts the URL in HTTP response headers sent from +a reverse proxied server
ProxyPreserveHost on|off Off svE
Use incoming Host HTTP request header for +proxy request
ProxyReceiveBufferSize bytessvE
Network buffer size for outgoing HTTP and FTP +connections
ProxyRemote match remote-serversvE
Remote proxy used to handle certain requests
ProxyRemote regex remote-serversvE
Remote proxy used to handle requests +matched by regular expressions
ProxyRequests on|off Off svE
Enables forward (standard) proxy requests
ProxyTimeout seconds 300 svE
Network timeout for proxied requests
ProxyVia on|off|full|block off svE
Information provided in the Via HTTP response +header for proxied requests
ReadmeName filenamesvdhB
Name of the file that will be inserted at the end +of the index listing
Redirect [status] URL-path +URLsvdhB
Sends an external redirect asking the client to fetch +a different URL
RedirectMatch [status] regex +URLsvdhB
Sends an external redirect based on a regular expression match +of the current URL
RedirectPermanent URL-path URLsvdhB
Sends an external permanent redirect asking the client to fetch +a different URL
RedirectTemp URL-path URLsvdhB
Sends an external temporary redirect asking the client to fetch +a different URL
RemoveCharset + extension [extension] ...vdhB
Removes any character set associations for a set of file +extensions
RemoveEncoding + extension [extension] ...vdhB
Removes any content encoding associations for a set of file +extensions
RemoveHandler + extension [extension] ...vdhB
Removes any handler associations for a set of file +extensions
RemoveInputFilter + extension [extension] ...vdhB
Removes any input filter associations for a set of file +extensions
RemoveLanguage + extension [extension] ...vdhB
Removes any language associations for a set of file +extensions
RemoveOutputFilter + extension [extension] ...vdhB
Removes any output filter associations for a set of file +extensions
RemoveType + extension [extension] ...vdhB
Removes any content type associations for a set of file +extensions
RequestHeader set|append|add|unset header +[value]svdhE
Configure HTTP request headers
Require entity-name [entity-name] ...dhC
Selects which authenticated users can access +a resource
RewriteBase URL-pathdhE
Sets the base URL for per-directory rewrites
RewriteCond + TestString CondPatternsvdhE
Defines a condition under which rewriting will take place +
RewriteEngine on|off off svdhE
Enables or disables runtime rewriting engine
RewriteLock file-pathsE
Sets the name of the lock file used for RewriteMap +synchronization
RewriteLog file-pathsvE
Sets the name of the file used for logging rewrite engine +processing
RewriteLogLevel Level 0 svE
Sets the verbosity of the log file used by the rewrite +engine
RewriteMap MapName MapType:MapSource +svE
Defines a mapping function for key-lookup
RewriteOptions OptionssvdhE
Sets some special options for the rewrite engine
RewriteRule + Pattern SubstitutionsvdhE
Defines rules for the rewriting engine
RLimitCPU number|max [number|max]svdhC
Limits the CPU consumption of processes launched +by Apache children
RLimitMEM number|max [number|max]svdhC
Limits the memory consumption of processes launched +by Apache children
RLimitNPROC number|max [number|max]svdhC
Limits the number of processes that can be launched by +processes launched by Apache children
Satisfy any|all all dhC
Interaction between host-level access control and +user authentication
ScoreBoardFile file-path logs/apache_status sM
Location of the file used to store coordination data for +the child processes
Script method cgi-scriptsvdB
Activates a CGI script for a particular request +method.
ScriptAlias URL-path +file-path|directory-pathsvB
Maps a URL to a filesystem location and designates the +target as a CGI script
ScriptAliasMatch regex +file-path|directory-pathsvB
Maps a URL to a filesystem location using a regular expression +and designates the target as a CGI script
ScriptInterpreterSource registry|script script svdhC
Technique for locating the interpreter for CGI +scripts
ScriptLog file-pathsvB
Location of the CGI script error logfile
ScriptLogBuffer bytes 1024 svB
Maximum amount of PUT or POST requests that will be recorded +in the scriptlog
ScriptLogLength bytes 10385760 svB
Size limit of the CGI script logfile
ScriptSock file-path logs/cgisock svB
-
SendBufferSize bytessM
TCP buffer size
ServerAdmin email-addresssvC
Email address that the server includes in error +messages sent to the client
ServerAlias hostname [hostname] ...vC
Alternate names for a host used when matching requests +to name-virtual hosts
ServerLimit number 256 (prefork), Serv +sM
Upper limit on configurable number of processes
ServerName fully-qualified-domain-name[:port]svC
Hostname and port that the server uses to identify +itself
ServerPath URL-pathvC
Legacy URL pathname for a name-virtual host that +is accessed by an incompatible browser
ServerRoot directory-path /usr/local/apache sC
Base directory for the server installation
ServerSignature On|Off|EMail Off svdhC
Configures the footer on server-generated documents
ServerTokens Major|Minor|Minimal|ProductOnly|OS|Full Full sC
Configures the Server HTTP response header
SetEnv env-variable valuesvdhB
Sets environment variables
SetEnvIf attribute + regex [!]env-variable[=value] + [[!]env-variable[=value]] ...svdhB
Sets environment variables based on attributes of the request +
SetEnvIfNoCase attribute regex + [!]env-variable[=value] + [[!]env-variable[=value]] ...svdhB
Sets environment variables based on attributes of the request +without respect to case
SetHandler handler-name|nonesvdhC
Forces all matching files to be processed by a +handler
SetInputFilter filter[;filter...]svdhC
Sets the filters that will process client requests and POST +input
SetOutputFilter filter[;filter...]svdhC
Sets the filters that will process responses from the +server
SSIEndTag tag "-->" svB
String that ends an include element
SSIErrorMsg message +"[an error occurre +svdhB
Error message displayed when there is an SSI error
SSIStartTag tag "<!--" svB
String that starts an include element
SSITimeFormat formatstring "%A, %d-%b-%Y %H:%M +svdhB
Configures the format in which date strings are +displayed
SSIUndefinedEcho tag "(none)" svB
String displayed when +an unset variable is echoed
SSLCACertificateFile file-pathsvE
File of concatenated PEM-encoded CA Certificates +for Client Auth
SSLCACertificatePath directory-pathsvE
Directory of PEM-encoded CA Certificates for +Client Auth
SSLCARevocationFile file-pathsvE
File of concatenated PEM-encoded CA CRLs for +Client Auth
SSLCARevocationPath directory-pathsvE
Directory of PEM-encoded CA CRLs for +Client Auth
SSLCertificateChainFile file-pathsvE
File of PEM-encoded Server CA Certificates
SSLCertificateFile file-pathsvE
Server PEM-encoded X.509 Certificate file
SSLCertificateKeyFile file-pathsvE
Server PEM-encoded Private Key file
SSLCipherSuite cipher-spec ALL:!ADH:RC4+RSA:+H +svdhE
Cipher Suite available for negotiation in SSL +handshake
SSLEngine on|off off svE
SSL Engine Operation Switch
SSLMutex type none sE
Semaphore for internal mutual exclusion of +operations
SSLOptions [+|-]option ...svdhE
Configure various SSL engine run-time options
SSLPassPhraseDialog type builtin sE
Type of pass phrase dialog for encrypted private +keys
SSLProtocol [+|-]protocol ... all svE
Configure usable SSL protocol flavors
SSLProxyCACertificateFile file-pathsvE
File of concatenated PEM-encoded CA Certificates +for Remote Server Auth
SSLProxyCACertificatePath directory-pathsvE
Directory of PEM-encoded CA Certificates for +Remote Server Auth
SSLProxyCARevocationFile file-pathsvE
File of concatenated PEM-encoded CA CRLs for +Remote Server Auth
SSLProxyCARevocationPath directory-pathsvE
Directory of PEM-encoded CA CRLs for +Remote Server Auth
SSLProxyCipherSuite cipher-spec ALL:!ADH:RC4+RSA:+H +svdhE
Cipher Suite available for negotiation in SSL +proxy handshake
SSLProxyEngine on|off off svE
SSL Proxy Engine Operation Switch
SSLProxyMachineCertificateFile filenamesE
File of concatenated PEM-encoded CA certificates for proxy server client certificates
SSLProxyMachineCertificatePath directorysE
Directory of PEM-encoded CA certificates for proxy server client certificates
SSLProxyProtocol [+|-]protocol ... all svE
Configure usable SSL protocol flavors for proxy usage
SSLProxyVerify level none svdhE
Type of remote server Certificate verification
SSLVerifyDepth numbersvdhE
Maximum depth of CA Certificates in Remote Server +Certificate verification
SSLRandomSeed context source +[bytes]sE
Pseudo Random Number Generator (PRNG) seeding +source
SSLRequire expressiondhE
Allow access only when an arbitrarily complex +boolean expression is true
SSLRequireSSLdhE
Deny access when SSL is not used for the +HTTP request
SSLSessionCache type none sE
Type of the global/inter-process SSL Session +Cache
SSLSessionCacheTimeout seconds 300 svE
Number of seconds before an SSL session expires +in the Session Cache
SSLVerifyClient level none svdhE
Type of Client Certificate verification
SSLVerifyDepth number 1 svdhE
Maximum depth of CA Certificates in Client +Certificate verification
StartServers number 5 sM
Number of child server processes created at startup
StartThreads numbersM
Nubmer of threads created on startup
SuexecUserGroup User GroupsvE
User and group permissions for CGI programs
ThreadLimit numbersM
Sets the upper limit on the configurable number of threads +per child process
ThreadsPerChild numbersM
Number of threads created by each child process
ThreadStackSize number 65536 sM
-
TimeOut number 300 sC
Amount of time the server will wait for +certain events before failing a request
TransferLog file|pipesvB
Specifly location of a log file
TypesConfig file-path conf/mime.types sB
The location of the mime.types file
UnsetEnv env-variable [env-variable] ...svdhB
Removes variables from the environment
UseCanonicalName on|off|dns on svdC
Configures how the server determines its own name and +port
User unix-userid #-1 svM
The userid under which the server will answer +requests
UserDir directory-filename public_html svB
Location of the user-specific directories
VirtualDocumentRoot interpolated-directory|none none svE
Dynamically configure the location of the document root +for a given virtual host
VirtualDocumentRootIP interpolated-directory|none none svE
Dynamically configure the location of the document root +for a given virtual host
<VirtualHost + addr[:port] [addr[:port]] + ...> ... </VirtualHost>sC
Contains directives that apply only to a specific +hostname or IP address
VirtualScriptAlias interpolated-directory|none none svE
Dynamically configure the location of the CGI directory for +a given virtual host
VirtualScriptAliasIP interpolated-directory|none none svE
Dynamically configure the location of the cgi directory for +a given virtual host
XBitHack on|off|full off svdhB
Parse SSI directives in files with the execute +bit set
\ No newline at end of file -- 2.50.1