From: Joshua Slive Date: Wed, 18 Sep 2002 22:33:02 +0000 (+0000) Subject: XML file and initial transformation for quickreference. X-Git-Tag: WROWE_2_0_43_PRE1~101 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2a88e1b775370677c5140a24f3bc0b63fc44d9fa;p=apache XML file and initial transformation for quickreference. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96887 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en new file mode 100644 index 0000000000..fb33b91c1e --- /dev/null +++ b/docs/manual/mod/quickreference.html.en @@ -0,0 +1,1258 @@ + + +Directive Quick Reference - Apache HTTP Server
<-
Apache > HTTP Server > Documentation > Version 2.0

Directive Quick Reference

+

The directive quick reference shows the usage, default, status, and context + of each Apache configuration directive. For more information about each of these, + see the Directive Dictionary. +

+ +

The first column gives the directive name and usage. The second columns shows the + default value of the directive, if a default exists. If the default is too large to + display, the first characters will be followed by "+".

+ +

The third and fourth columns lists the status of the directive and the + contexts where the directive is allowed according + to the following tables:

+ +
+ + + + + +
CCore
MMPM
BBase
EExtension
XExperimental
+
+ + + + +
sserver config
vvirtual host
ddirectory
h.htaccess
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SyntaxDefault
AcceptMutex default|method default Ms
+    + Method that Apache uses to serialize multiple children +accepting requests on network sockets
AcceptPathInfo On|Off|Default Default Csvdh
+    + Resources accept trailing pathname information
AccessFileName filename [filename] ... .htaccess Csv
+    + Name of the distributed configuration file
Action action-type cgi-scriptBsvdh
+    + Activates a CGI script for a particular handler or +content-type
AddAlt string file [file] ...Bsvdh
+    + Alternate text to display for a file, instead of an +icon selected by filename
AddAltByEncoding string MIME-encoding +[MIME-encoding] ...Bsvdh
+    + Alternate text to display for a file instead of an icon +selected by MIME-encoding
AddAltByType string + MIME-type [MIME-type] ...Bsvdh
+    + Alternate text to display for a file, instead of an +icon selected by MIME content-type
AddCharset charset extension +[extension] ...Bsvdh
+    + Maps the given filename extensions + to the specified content charset
AddDefaultCharset On|Off|charset Off Csvdh
+    + Default character set to be added for a +response without an explicit character set
AddDescription + string file [file] ...Bsvdh
+    + Description to display for a file
AddEncoding + MIME-enc extension [extension] ...Bsvdh
+    + Maps the given filename extensions + to the specified encoding type
AddHandler + handler-name extension [extension] ...Bsvdh
+    + Maps the filename extensions +to the specified handler
AddIcon icon + name [name] ...Bsvdh
+    + Icon to display for a file selected by name
AddIconByEncoding + icon MIME-encoding [MIME-encoding] ...Bsvdh
+    + Icon to display next to files selected by MIME +content-encoding
AddIconByType + icon MIME-type [MIME-type] ...Bsvdh
+    + Icon to display next to files selected by MIME +content-type
AddInputFilter + filter[;filter...] extension + [extension ...]Bsvdh
+    + Maps filename extensions + to the filters that will process + client requests
AddLanguage + MIME-lang extension [extension] ...Bsvdh
+    + Maps the given filename extension +to the specified content language
AddModuleInfo module-name stringEs
+    + Allows additional information to be added to the module +information displayed by the server-info handler
AddOutputFilter + filter[;filter...] extension + [extension ...]Bsvdh
+    + maps the filename +extensions to the filters that will process +responses from the server
AddType MIME-type + extension [extension] ...Bsvdh
+    + Maps the given filename extensions +onto the specified content type
Alias URL-path + file-path|directory-pathBsv
+    + Maps URLs to filesystem locations
AliasMatch regex + file-path|directory-pathBsv
+    + Maps URLs to filesystem locations using regular +expressions
Allow from + all|host|env=env-variable + [host|env=env-variable] ...Bdh
+    + Controls which hosts can access an area of the +server
AllowCONNECT port [port] ... 443 563 Esv
+    + Ports that are allowed to CONNECT through +the proxy
AllowOverride All|None|directive-type +[directive-type] ... All Cd
+    + Types of directives that are allowed in +.htaccess files
Anonymous user [user] ...Edh
+    + Specifies userIDs that areallowed access without +password verification
Anonymous_Authoritative on|off off Edh
+    + Configures if authorization will fall-through +to other methods
Anonymous_LogEmail on|off on Edh
+    + Sets whether the password entered will be logged in the +error log
Anonymous_MustGiveEmail on|off on Edh
+    + Specifies whether blank passwords are allowed
Anonymous_NoUserID on|off off Edh
+    + Sets whether the userID field may be empty
Anonymous_VerifyEmail on|off off Edh
+    + Sets whether to check the password field for a correctly +formatted email address
AssignUserID user_id group_idMv
+    +
AuthAuthoritative on|off on Bdh
+    + Sets whether authorization and authentication are +passed to lower level modules
AuthDBMAuthoritative on|off on Edh
+    + Sets whether authentication and authorization will be +passwed on to lower level modules
AuthDBMGroupFile file-pathEdh
+    + Sets the name of the database file containing the list +of user groups for authentication
AuthDBMType default|SDBM|GDBM|NDBM|DB default Edh
+    + Sets the type of database file that is used to +store passwords
AuthDBMUserFile file-pathEdh
+    + Sets thename of a database file containing the list of users and +passwords for authentication
AuthDigestAlgorithm MD5|MD5-sess MD5 Xdh
+    + Selects the algorithm used to calculate the challenge and +response hases in digest authentication
AuthDigestDomain URI [URI] ...Xdh
+    + URIs that are in the same protection space for digest +authentication
AuthDigestFile file-pathXdh
+    + Location of the text file containing the list +of users and encoded passwords for digest authentication
AuthDigestGroupFile file-pathXdh
+    + Name of the text file containing the list of groups +for digest authentication
AuthDigestNcCheck On|Off Off Xs
+    + Enables or disables checking of the nonce-count sent by the +server
???Xdh
+    + Determines how the nonce is generated
AuthDigestNonceLifetime seconds 300 Xdh
+    + How long the server nonce is valid
AuthDigestQop none|auth|auth-int [auth|auth-int] auth Xdh
+    + Determines the quality-of-protection to use in digest +authentication
AuthGroupFile file-pathBdh
+    + Sets the name of a text file containing the list +of user groups for authentication
AuthLDAPAuthoritative on|off on dh
+    +
AuthLDAPBindDN distinguished-namedh
+    +
AuthLDAPBindPassword passworddh
+    +
AuthLDAPCompareDNOnServer on|off on dh
+    +
AuthLDAPDereferenceAliases never|searching|finding|always Always dh
+    +
AuthLDAPEnabled on|off on dh
+    +
AuthLDAPFrontPageHack on|offdh
+    +
AuthLDAPGroupAttribute attributedh
+    +
AuthLDAPGroupAttributeIsDN on|off on dh
+    +
AuthLDAPRemoteUserIsDN on|offdh
+    +
AuthLDAPStartTLS on|offdh
+    +
AuthLDAPUrl urldh
+    +
AuthName auth-domainCdh
+    + Authorization realm for use in HTTP +authentication
AuthType Basic|DigestCdh
+    + Type of user authentication
AuthUserFile file-pathBdh
+    + Sets the name of a text file containing the list of users and +passwords for authentication
BrowserMatch regex [!]env-variable[=value] +[[!]env-variable[=value]] ...Bsvdh
+    + Sets environment variables conditional on HTTP User-Agent +
BrowserMatchNoCase regex [!]env-variable[=value] + [[!]env-variable[=value]] ...Bsvdh
+    + Sets environment variables conditional on User-Agent without +respect to case
CacheDefaultExpire seconds 3600 (one hour) Xs
+    +
CacheDisable cache_type url-stringXs
+    + Disable caching of specified URLs by specified storage manager
CacheEnable cache_type url-stringXs
+    + Enable caching specified URLs in a specified storage manager
CacheFile + file-path [file-path] ...Xs
+    +
CacheForceCompletion Percentage 60 Xs
+    + Percentage of download to arrive for the cache to force complete transfer
CacheIgnoreCacheControlXs
+    + Ignore requests from the client for uncached content
CacheIgnoreNoLastModXs
+    + Ignore responses where there is no Last Modified Header
CacheLastModifiedFactor float 0.1 Xs
+    + The factor used to estimate the Expires date from the LastModified date
CacheMaxExpire seconds 86400 (one day) Xs
+    + The maximum time in seconds to cache a document
CacheMaxStreamingBuffer size_in_bytes 0 Xs
+    + Maximum amount of a streamed response to buffer in memory before declaring the response uncacheable
CacheNegotiatedDocs on|off off Bs
+    + Allows content-negotiated documents to be +cached by proxy servers
CGIMapExtension cgi-path .extensionCdh
+    + Technique for locating the interpreter for CGI +scripts
CharsetDefault charsetXsvdh
+    + Charset to translate into
CharsetOptions option [option] ... DebugLevel=0 +NoImp + + + Xsvdh
+    + Configures charset tranlation behavior
CharsetSourceEnc charsetXsvdh
+    + Source charset of files
CheckSpelling on|off Off Esvdh
+    + Enables the spelling +module
ChildPerUserID user_id +group_id child_idMs
+    +
ContentDigest on|off off Csvdh
+    + Enables the generation of Content-MD5 HTTP Response +headers
CookieDomain domainEsvdh
+    + The domain to which the tracking cookie applies
CookieExpires expiry-periodEsvdh
+    + Expiry time for the tracking cookie
CookieLog filenameBs
+    + Sets filename for the logging of cookies
CookieName token Apache Esvdh
+    + Name of the tracking cookie
CookieStyle + Netscape|Cookie|Cookie2|RFC2109|RFC2965 Netscape Esvdh
+    + Format of the cookie header field
CookieTracking on|off off Esvdh
+    + Enables tracking cookie
CoreDumpDirectory directoryMs
+    + Directory where Apache attempts to +switch before dumping core
CustomLog + file|pipe format|nickname + [env=[!]environment-variable]Bs
+    + Sets filename and format of log file
Dav on|off off Ed
+    + Enable WebDAV HTTP methods
DavDepthInfinity on|off off Ed
+    + Allow PROPFIND, Depth: Infinity requests
DavLockDB file-pathEsv
+    + Location of the DAV lock database
DavMinTimeout seconds 0 Ed
+    + Minimum amount of time the server holds a lock on +a DAV resource
DefaultIcon url-pathBsvdh
+    + Icon to display for files when no specific icon is +configured
DefaultLanguage + MIME-langBsvdh
+    + Sets all files in the given scope to the +specified language
DefaultType MIME-type text/plain Csvdh
+    + MIME content-type that will be sent if the +server cannot determine a type in any other way
DeflateBufferSize value 8096 Esv
+    + Fragment size to be compressed at one time by zlib
DeflateFilterNote notenameEsv
+    + Places the compression ratio in a note for logging
DeflateMemLevel value 9 Esv
+    + How much memory should be used by zlib for compression
DeflateWindowSize value 15 Esv
+    + Zlib compression window size
Deny from + all|host|env=env-variable + [host|env=env-variable] ...Bdh
+    + Controls which hosts are denied access to the +server
<Directory directory-path> +... </Directory>Csv
+    + Enclose a group of directives that apply only to the +named file-system directory and sub-directories
DirectoryIndex + local-url [local-url] ... index.html Bsvdh
+    + List of resources to look for when the client requests +a directory
<Directory regex> +... </Directory>Csv
+    + Enclose a group of directives that apply only to +file-system directories that match a regular expression and their +subdirectories
DocumentRoot directory-path /usr/local/apache/h + + + Csv
+    + Directory that forms the main document tree visible +from the web
EnableMMAP on|off on Csvdh
+    + Use memory-mapping to read files during delivery
ErrorDocument error-code documentCsvdh
+    + What the server will return to the client +in case of an error
ErrorLog file-path|syslog[:facility] logs/error_log (Uni + + + Csv
+    + Location where the server will log errors
ExampleXsvdh
+    + Demonstration directive to illustrate the Apache module +API
ExpiresActive On|OffEsvdh
+    + Enables generation of Expires headers
ExpiresByType + MIME-type <code>secondsEsvdh
+    + Value of the Expires header configured +by MIME type
ExpiresDefault <code>secondsEsvdh
+    + Default algorithm for calculating expiration time
ExtendedStatus On|Off Off Bs
+    + This directive controls whether the server keeps track of +extended status information for each request. This is only +useful if the status module is enabled on the server.
ExtFilterDefine filtername parametersXs
+    +
ExtFilterOptions + option [option] ... DebugLevel=0 NoLogS + + + Xd
+    +
FileETag component ... INode MTime Size Csvdh
+    + File attributes used to create the ETag +HTTP response header
<Files filename> ... </Files>Csvdh
+    + Contains directives that apply to matched +filenames
<FilesMatch regex> ... </FilesMatch>Csvdh
+    + Contains directives that apply to regular-expression matched +filenames
ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer Bsvdh
+    + Action to take if a single acceptable document is not +found
ForceType mime-typeCdh
+    + Forces all matching files to be served with the specified +MIME content-type
Group unix-group #-1 Msv
+    + Group under which the server will answer +requests
Header set|append|add|unset|echo header +[value]Esvdh
+    + Configure HTTP response headers
HeaderName filenameBsvdh
+    + Name of the file that will be inserted at the top +of the index listing
HostnameLookups on|off|double off Csvd
+    + Enables DNS lookups on client IP addresses
IdentityCheck on|off off Csvd
+    + Enables logging of the RFC1413 identity of the remote +user
<IfDefine [!]parameter-name> ... + </IfDefine>Csvdh
+    + Encloses directives that will be processed only +if a test is true at startup
<IfModule [!]module-name> ... + </IfModule>Csvdh
+    + Encloses directives that are processed conditional on the +presence of absence of a specific module
ImapBase map|referer|URL http://servername/ Bsvdh
+    + Default base for imagemap files
ImapDefault error|nocontent|map|referer|URL nocontent Bsvdh
+    + Default action when an imagemap is called with coordinates +that are not explicitly mapped
ImapMenu + none|formatted|semiformatted|unformattedBsvdh
+    + Action if no coordinates are given when calling +an imagemap
Include file-path|directory-pathCsvd
+    + Includes other configuration files from within +the server configuration files
IndexIgnore file [file] ...Bsvdh
+    + Adds to the list of files to hide when listing +a directory
IndexOptions [+|-]option [[+|-]option] ...Bsvdh
+    + Various configuration settings for directory +indexing
IndexOrderDefault +Ascending|Descending Name|Date|Size|Description Ascending Name Bsvdh
+    + Sets the default ordering of the directory index
ISAPIAppendLogToErrors on|off off Bsvdh
+    + Record HSE_APPEND_LOG_PARAMETER requests from ISAPI +extensions to the error log
ISAPIAppendLogToQuery on|off on Bsvdh
+    + Record HSE_APPEND_LOG_PARAMETER requests from ISAPI +extensions to the query field
ISAPICacheFile file-path [file-path] ...Bsv
+    + ISAPI .dll files to be loaded at startup
ISAPIFakeAsync on|off off Bsvdh
+    + Fake asynchronous support for isapi callbacks
ISAPILogNotSupported on|off off Bsvdh
+    + Log unsupported feature requests from ISAPI +extensions
ISAPIReadAheadBuffer size 49152 Bsdh
+    + Size of the Read Ahead Buffer sent to ISAPI +extensions
KeepAlive on|off On Csv
+    + Enables HTTP persistent connections
KeepAliveTimeout seconds 15 Csv
+    + Amount of time the server will wait for subsequent +requests on a persistent connection
LanguagePriority MIME-lang [MIME-lang] ...Bsvdh
+    + The precendence of language variants for cases where +the client does not express a preference
LDAPCacheEntries number 1024 s
+    +
LDAPCacheTTL seconds 600 s
+    +
LDAPCertDBPath directory-paths
+    +
LDAPOpCacheEntries number 1024 s
+    +
LDAPOpCacheTTL seconds 600 s
+    +
LDAPSharedCacheSize bytes 102400 s
+    +
<Limit method [method] ... > ... + </Limit>Csvdh
+    + Restrict enclosed access controls to only certain HTTP +methods
<LimitExcept method [method] ... > ... + </LimitExcept>Csvdh
+    + Restrict access controls to all HTTP methods +except the named ones
LimitRequestBody bytes 0 Csvdh
+    + Restricts the total size of the HTTP request body sent +from the client
LimitRequestFields number 100 Cs
+    + Limits the number of HTTP request header fields that +will be accepted from the client
LimitRequestFieldsize bytesCs
+    + Limits the size of the HTTP request header allowed from the +client
LimitRequestLine bytes 8190 Cs
+    + Limit the size of the HTTP request line that will be accepted +from the client
LimitXMLRequestBody number 1000000 Csvdh
+    + Limits the size of an XML-based request body
Listen [IP-address:]portnumberMs
+    + IP addresses and ports that the server +listens to
ListenBacklog backlogMs
+    + Maximum length of the queue of pending connections
LoadFile filename [filename] ...s
+    + Link in the named object file or library
LoadModule module filenames
+    + Links in the object file or library, and adds to the list +of active modules
<Location + URL-path|URL> ... </Location>Csv
+    + Applies the enclosed directives only to matching +URLs
<LocationMatch + regex> ... </Location>Csv
+    + Applies the enclosed directives only to regular-expression +matching URLs
LockFile filename logs/accept.lock Ms
+    + Location of the accept serialization lock file
LogFormat + format|nickname [nickname] "%h %l %u %t \"%r\" + + + Bs
+    + Describes a format for use in a log file
LogLevel level warn Csv
+    + Controls the verbosity of the ErrorLog
MaxClients numberMs
+    + Maximum number of child processes that will be created +to serve requests
MaxKeepAliveRequests number 100 Csv
+    + Number of requests allowed on a persistent +connection
MaxMemFree numberMs
+    + Maximum amount of memory that the main allocator is allowed +to hold without calling free()
MaxRequestsPerChild number 10000 Ms
+    + Limit on the number of requests that an individual child server +will handle during its life
MaxSpareServers number
10 Ms
+    + Maximum number of idle child server processes
MaxSpareThreads numberMs
+    + Maximum number of idle threads
MaxThreads number 250 Ms
+    +
MaxThreadsPerChild number 64 Ms
+    + Maximum number of threads per child process
MetaDir directory .web Esvdh
+    + Name of the directory to find CERN-style meta information +files
MetaFiles on|off off Esvdh
+    + Activates CERN meta-file processing
MetaSuffix suffix .meta Esvdh
+    + File name suffix for the file containg CERN-style +meta information
MimeMagicFile file-pathEsv
+    + Enable MIME-type determination based on file contents +using the specified magic file
MinSpareServers number 5 Ms
+    + Minimum number of idle child server processes
MinSpareServers numberMs
+    + Minimum number of idle threads available to handle request +spikes
MMapFile file-path [file-path] ...Xs
+    +
ModMimeUsePathInfo On|OffBsvdh
+    + Tells mod_mime to treat path_info components as part of the filename
MultiviewsMatch + [NegotiatedOnly] [Handlers] [Filters] [Any]Bsvdh
+    + The types of files that will be included when +searching for a matching file with MultiViews
NameVirtualHost addr[:port]Cs
+    + Designates an IP address for name-virtual +hosting
NoProxy + Domain| + SubNet| + IpAddr| + Hostname +[Domain| + SubNet| + IpAddr| + Hostname] ...Esv
+    + Hosts, domains, or networks that will be connected +to directly
NumServers number 2 Ms
+    + Total number of children alive at the same time
Options + [+|-]option [[+|-]option] ... All Csvdh
+    + Configures what features are available in a particular +directory
Order ordering Deny,Allow Bdh
+    + Controls the default access state and the order in which +Allow and Deny are +evaluated.
PassEnv + env-variable [env-variable] ...Bsvdh
+    + Passes environment variables from the shell
PidFile filename logs/httpd.pid Ms
+    + File where the server records the process ID +of the daemon
ProtocolEcho On|OffXsv
+    + Turn the echo server on or off
<Proxy wildcard-url> ...</Proxy>Esv
+    + Container for directives applied to proxied +resources
ProxyBlock *|word|host|domain +[word|host|domain] ...Esv
+    + Words, hosts, or domains that are banned from being +proxied
ProxyDomain DomainEsv
+    + Default domain name for proxied requests
ProxyErrorOverride On|Off Off Esv
+    + Override error pages for proxied content
ProxyIOBufferSize bytesEsv
+    + IO buffer size for outgoing HTTP and FTP +connections
<Proxy regex> ...</Proxy>Esv
+    + Container for directives applied to regular-expression-matched +proxied resources
ProxyMaxForwards number 10 Esv
+    + Maximium number of proxies that a request can be forwarded +through
ProxyPass [path] !|urlEsv
+    + Maps remote servers into the local server +URL-space
ProxyPassReverse [path] urlEsv
+    + Adjusts the URL in HTTP response headers sent from +a reverse proxied server
ProxyPreserveHost on|off Off Esv
+    + Use incoming Host HTTP request header for +proxy request
ProxyReceiveBufferSize bytesEsv
+    + Network buffer size for outgoing HTTP and FTP +connections
ProxyRemote match remote-serverEsv
+    + Remote proxy used to handle certain requests
ProxyRemote regex remote-serverEsv
+    + Remote proxy used to handle requests +matched by regular expressions
ProxyRequests on|off Off Esv
+    + Enables forward (standard) proxy requests
ProxyTimeout seconds 300 Esv
+    + Network timeout for proxied requests
ProxyVia on|off|full|block off Esv
+    + Information provided in the Via HTTP response +header for proxied requests
ReadmeName filenameBsvdh
+    + Name of the file that will be inserted at the end +of the index listing
Redirect [status] URL-path URLBsvdh
+    + Sends an external redirect asking the client to fetch +a different URL
RedirectMatch [status] regex URLBsvdh
+    + Sends an external redirect asking the client to fetch +a different URL based on a regular expression match of the +current URL
RedirectPermanent URL-path URLBsvdh
+    + Sends an external permanent redirect asking the client to fetch +a different URL
RedirectTemp URL-path URLBsvdh
+    + Sends an external temporary redirect asking the client to fetch +a different URL
RemoveCharset + extension [extension] ...Bvdh
+    + Removes any character set associations for a set of file +extensions
RemoveEncoding + extension [extension] ...Bvdh
+    + Removes any content encoding associations for a set of file +extensions
RemoveHandler + extension [extension] ...Bvdh
+    + Removes any handler associations for a set of file +extensions
RemoveInputFilter + extension [extension] ...Bvdh
+    + Removes any input filter associations for a set of file +extensions
RemoveLanguage + extension [extension] ...Bvdh
+    + Removes any language associations for a set of file +extensions
RemoveOutputFilter + extension [extension] ...Bvdh
+    + Removes any output filter associations for a set of file +extensions
RemoveType + extension [extension] ...Bvdh
+    + Removes any content type associations for a set of file +extensions
RequestHeader set|append|add|unset header +[value]Esvdh
+    + Configure HTTP request headers
Require entity-name [entity-name] ...Cdh
+    + Selects which authenticated users can access +a resource
RewriteBase URL-pathEdh
+    + Sets the base URL for per-directory rewrites
RewriteCond + TestString CondPatternEsvdh
+    + Defines a condition under which rewriting will take place +
RewriteEngine on|off off Esvdh
+    + Enables or disables runtime rewriting engine
RewriteLock file-pathEs
+    + Sets the name of the lock file used for RewriteMap +synchronization
RewriteLog file-pathEsv
+    + Sets the name of the file used for logging rewrite engine +processing
RewriteLogLevel LevelEsv
+    + Sets the verbosity of the log file used by the rewrite +engine
RewriteMap MapName MapType:MapSource +Esv
+    + Defines a mapping function for key-lookup
RewriteOptions OptionsEsvdh
+    + Sets some special options for the rewrite engine
RewriteRule + Pattern SubstitutionEsvdh
+    + Defines rules for the rewriting engine
RLimitCPU number|max [number|max]Csvdh
+    + Limits the CPU consumption of processes launched +by Apache children
RLimitMEM number|max [number|max]Csvdh
+    + Limits the memory consumption of processes launched +by Apache children
RLimitNPROC number|max [number|max]Csvdh
+    + Limits the number of processes that can be launched by +processes launched by Apache children
Satisfy any|all all Cdh
+    + Interaction between host-level access control and +user authentication
ScoreBoardFile file-path logs/apache_status Ms
+    + Location of the file used to store coordination data for +the child processes
Script method cgi-scriptBsvd
+    + Activates a CGI script for a particular request +method.
ScriptAlias +URL-path file-path|directory-pathBsv
+    + Maps a URL to a filesystem location and designates the +target as a CGI script
ScriptAliasMatch +regex file-path|directory-pathBsv
+    + Maps a URL to a filesystem location using a regular expression +and designates the target as a CGI script
ScriptInterpreterSource registry|script script Csvdh
+    + Technique for locating the interpreter for CGI +scripts
ScriptLog file-pathBsv
+    + Location of the CGI script error logfile
ScriptLogBuffer bytes 1024 Bsv
+    + Maximum amount of PUT or POST requests that will be recorded +in the scriptlog
ScriptLogLength bytes 10385760 Bsv
+    + Size limit of the CGI script logfile
ScriptSock file-path logs/cgisock Bsv
+    +
SendBufferSize bytesMs
+    + TCP buffer size
ServerAdmin email-addressCsv
+    + Email address that the server includes in error +messages sent to the client
ServerAlias hostname [hostname] ...Cv
+    + Alternate names for a host used when matching requests +to name-virtual hosts
ServerLimit number 256 (prefork), Serv + + + Ms
+    + Upper limit on configurable number of processes
ServerName fully-qualified-domain-name[:port]Csv
+    + Hostname and port that the server uses to identify +itself
ServerPath URL-pathCv
+    + Legacy URL pathname for a name-virtual host that +is accessed by an incompatible browser
ServerRoot directory-path /usr/local/apache Cs
+    + Base directory for the server installation
ServerSignature On|Off|EMail Off Csvdh
+    + Configures the footer on server-generated documents
ServerTokens Major|Minor|Minimal|ProductOnly|OS|Full Full Cs
+    + Configures the Server HTTP response header
SetEnv env-variable valueBsvdh
+    + Sets environment variables
SetEnvIf attribute + regex [!]env-variable[=value] + [[!]env-variable[=value]] ...Bsvdh
+    + Sets environment variables based on attributes of the request +
SetEnvIfNoCase attribute regex + [!]env-variable[=value] + [[!]env-variable[=value]] ...Bsvdh
+    + Sets environment variables based on attributes of the request +without respect to case
SetHandler handler-nameCsvdh
+    + Forces all matching files to be processed by a +handler
SetInputFilter filter[;filter...]Csvdh
+    + Sets the filters that will process client requests and POST +input
SetOutputFilter filter[;filter...]Csvdh
+    + Sets the filters that will process responses from the +server
SSIEndTag tag "-->" Bsv
+    + String that ends an include element
SSIErrorMsg message +"[an error occurre + + + Bsvdh
+    + Error message displayed when there is an SSI error
Changes the string that mod_include looks for to start an +include element "<!--" Bsv
+    + String that starts an include element
SSITimeFormat formatstring "%A, %d-%b-%Y %H:%M + + + Bsvdh
+    + Configures the format in which date strings are +displayed
SSIUndefinedEcho tag "<!-- undef -->" Bsv
+    + String displayed when +an unset variable is echoed
SSLCACertificateFile file-pathEsv
+    + File of concatenated PEM-encoded CA Certificates +for Client Auth
SSLCACertificatePath directory-pathEsv
+    + Directory of PEM-encoded CA Certificates for +Client Auth
SSLCARevocationFile file-pathEsv
+    + File of concatenated PEM-encoded CA CRLs for +Client Auth
SSLCARevocationPath directory-pathEsv
+    + Directory of PEM-encoded CA CRLs for +Client Auth
SSLCertificateChainFile file-pathEsv
+    + File of PEM-encoded Server CA Certificates
SSLCertificateFile file-pathEsv
+    + Server PEM-encoded X.509 Certificate file
SSLCertificateKeyFile file-pathEsv
+    + Server PEM-encoded Private Key file
SSLCipherSuite cipher-spec ALL:!ADH:RC4+RSA:+H + + + Esvdh
+    + Cipher Suite available for negotiation in SSL +handshake
SSLEngine on|off off Esv
+    + SSL Engine Operation Switch
SSLMutex type none Es
+    + Semaphore for internal mutual exclusion of +operations
SSLOptions [+|-]option ...Esvdh
+    + Configure various SSL engine run-time options
SSLPassPhraseDialog type builtin Es
+    + Type of pass phrase dialog for encrypted private +keys
SSLProtocol [+|-]protocol ... all Esv
+    + Configure usable SSL protocol flavors
SSLProxyCACertificateFile file-pathEsv
+    + File of concatenated PEM-encoded CA Certificates +for Remote Server Auth
SSLProxyCACertificatePath directory-pathEsv
+    + Directory of PEM-encoded CA Certificates for +Remote Server Auth
SSLProxyCARevocationFile file-pathEsv
+    + File of concatenated PEM-encoded CA CRLs for +Remote Server Auth
SSLProxyCARevocationPath directory-pathEsv
+    + Directory of PEM-encoded CA CRLs for +Remote Server Auth
SSLProxyCipherSuite cipher-spec ALL:!ADH:RC4+RSA:+H + + + Esvdh
+    + Cipher Suite available for negotiation in SSL +proxy handshake
SSLProxyEngine on|off off Esv
+    + SSL Proxy Engine Operation Switch
SSLProxyMachineCertificateFile filenameEs
+    + File of concatenated PEM-encoded CA certificates for proxy server client certificates
SSLProxyMachineCertificatePath directoryEs
+    + Directory of PEM-encoded CA certificates for proxy server client certificates
SSLProxyProtocol [+|-]protocol ... all Esv
+    + Configure usable SSL protocol flavors for proxy usage
SSLProxyVerify level none Esvdh
+    + Type of remote server Certificate verification
SSLVerifyDepth numberEsvdh
+    + Maximum depth of CA Certificates in Remote Server +Certificate verification
SSLRandomSeed context source +[bytes]Es
+    + Pseudo Random Number Generator (PRNG) seeding +source
SSLRequire expressionEdh
+    + Allow access only when an arbitrarily complex +boolean expression is true
SSLRequireSSLEdh
+    + Deny access when SSL is not used for the +HTTP request
SSLSessionCache type none Es
+    + Type of the global/inter-process SSL Session +Cache
SSLSessionCacheTimeout seconds 300 Esv
+    + Number of seconds before an SSL session expires +in the Session Cache
SSLVerifyClient level none Esvdh
+    + Type of Client Certificate verification
SSLVerifyDepth number 1 Esvdh
+    + Maximum depth of CA Certificates in Client +Certificate verification
StartServers number 5 Ms
+    + Number of child server processes created at startup
StartThreads numberMs
+    + Nubmer of threads created on startup
SuexecUserGroup User GroupEsv
+    + User and group permissions for CGI programs
ThreadLimit numberMs
+    + Sets the upper limit on the configurable number of threads +per child process
ThreadsPerChild numberMs
+    + Number of threads created by each child process
ThreadStackSize number 65536 Ms
+    +
TimeOut number 300 Cs
+    + Amount of time the server will wait for +certain events before failing a request
TransferLog file|pipeBs
+    + Specifly location of a log file
TypesConfig file-path conf/mime.types Bs
+    + The location of the mime.types file
UnsetEnv env-variable [env-variable] ...Bsvdh
+    + Removes variables from the environment
UseCanonicalName on|off|dns on Csvd
+    + Configures how the server determines its own name and +port
User unix-userid #-1 Msv
+    + The userid under which the server will answer +requests
UserDir directory-filename public_html Bs
+    + Location of the user-specific directories
VirtualDocumentRoot interpolated-directoryEsv
+    + Dynamically configure the location of the document root +for a given virtual host
VirtualDocumentRootIP interpolated-directoryEsv
+    + Dynamically configure the location of the document root +for a given virtual host
<VirtualHost + addr[:port] [addr[:port]] + ...> ... </VirtualHost>Cs
+    + Contains directives that apply only to a specific +hostname or IP address
VirtualScriptAlias interpolated-directoryEsv
+    + Dynamically configure the location of the CGI directory for +a given virtual host
VirtualScriptAliasIP interpolated-directoryEsv
+    + Dynamically configure the location of the cgi directory for +a given virtual host
XBitHack on|off|full off Bsvdh
+    + Parse SSI directives in files with the execute +bit set
\ No newline at end of file diff --git a/docs/manual/mod/quickreference.xml b/docs/manual/mod/quickreference.xml new file mode 100644 index 0000000000..193043f8bd --- /dev/null +++ b/docs/manual/mod/quickreference.xml @@ -0,0 +1,40 @@ + + ] +> + + + + Directive Quick Reference + +

The directive quick reference shows the usage, default, status, and context + of each Apache configuration directive. For more information about each of these, + see the Directive Dictionary. +

+ +

The first column gives the directive name and usage. The second columns shows the + default value of the directive, if a default exists. If the default is too large to + display, the first characters will be followed by "+".

+ +

The third and fourth columns lists the status of the directive and the + contexts where the directive is allowed according + to the following tables:

+ +
+ + + + + +
CCore
MMPM
BBase
EExtension
XExperimental
+
+ + + + +
sserver config
vvirtual host
ddirectory
h.htaccess
+
+
+ + &allmodules; +
\ No newline at end of file