From: Ken Coar Date: Wed, 28 Jan 1998 19:11:58 +0000 (+0000) Subject: As threatened. The directive attributes in the module documentation X-Git-Tag: APACHE_1_3b5~17 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8d03a2f94434fafa977f853f946f0bb5e1e077a2;p=thirdparty%2Fapache%2Fhttpd.git As threatened. The directive attributes in the module documentation are now links back to a description of what the attributes mean. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@80041 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/bind.html b/docs/manual/bind.html index 3b31b437a26..d5caf449fab 100644 --- a/docs/manual/bind.html +++ b/docs/manual/bind.html @@ -37,10 +37,22 @@ and ports Apache listens to.

BindAddress

-Syntax: BindAddress [ * | IP-address | hostname ]
-Default: BindAddress *
-Context: server config
-Status: Core

+Syntax: BindAddress [ * | IP-address | hostname ]
+Default: BindAddress *
+Context: server config
+Status: Core

Makes the server listen to just the specified address. If the argument is *, the server listens to all addresses. The port listened to @@ -48,10 +60,22 @@ is set with the Port directive. Only one BindAddress should be used.

Listen

-Syntax: Listen [ port | IP-address:port ]
-Default: none
-Context: server config
-Status: Core

+Syntax: Listen [ port | IP-address:port ]
+Default: none
+Context: server config
+Status: Core

Listen can be used instead of BindAddress and Port. It tells the server to accept incoming requests on the diff --git a/docs/manual/bind.html.en b/docs/manual/bind.html.en index 3b31b437a26..d5caf449fab 100644 --- a/docs/manual/bind.html.en +++ b/docs/manual/bind.html.en @@ -37,10 +37,22 @@ and ports Apache listens to.

BindAddress

-Syntax: BindAddress [ * | IP-address | hostname ]
-Default: BindAddress *
-Context: server config
-Status: Core

+Syntax: BindAddress [ * | IP-address | hostname ]
+Default: BindAddress *
+Context: server config
+Status: Core

Makes the server listen to just the specified address. If the argument is *, the server listens to all addresses. The port listened to @@ -48,10 +60,22 @@ is set with the Port directive. Only one BindAddress should be used.

Listen

-Syntax: Listen [ port | IP-address:port ]
-Default: none
-Context: server config
-Status: Core

+Syntax: Listen [ port | IP-address:port ]
+Default: none
+Context: server config
+Status: Core

Listen can be used instead of BindAddress and Port. It tells the server to accept incoming requests on the diff --git a/docs/manual/handler.html b/docs/manual/handler.html index 504dd09ebfa..a87b4d319da 100644 --- a/docs/manual/handler.html +++ b/docs/manual/handler.html @@ -71,10 +71,22 @@ handlers in the standard distribution are as follows:

AddHandler

-Syntax: <AddHandler handler-name extension>
-Context: server config, virtual host, directory, .htaccess
-Status: Base
-Module: mod_mime +Syntax: <AddHandler handler-name extension>
+Context: server config, virtual host, directory, .htaccess
+Status: Base
+Module: mod_mime

AddHandler maps the filename extension extension to the handler handler-name. For example, to activate CGI scripts @@ -91,10 +103,22 @@ program.

SetHandler

-Syntax: <SetHandler handler-name>
-Context: directory, .htaccess
-Status: Base
-Module: mod_mime +Syntax: <SetHandler handler-name>
+Context: directory, .htaccess
+Status: Base
+Module: mod_mime

When placed into an .htaccess file or a <Directory> or <Location> section, diff --git a/docs/manual/handler.html.en b/docs/manual/handler.html.en index 504dd09ebfa..a87b4d319da 100644 --- a/docs/manual/handler.html.en +++ b/docs/manual/handler.html.en @@ -71,10 +71,22 @@ handlers in the standard distribution are as follows:

AddHandler

-Syntax: <AddHandler handler-name extension>
-Context: server config, virtual host, directory, .htaccess
-Status: Base
-Module: mod_mime +Syntax: <AddHandler handler-name extension>
+Context: server config, virtual host, directory, .htaccess
+Status: Base
+Module: mod_mime

AddHandler maps the filename extension extension to the handler handler-name. For example, to activate CGI scripts @@ -91,10 +103,22 @@ program.

SetHandler

-Syntax: <SetHandler handler-name>
-Context: directory, .htaccess
-Status: Base
-Module: mod_mime +Syntax: <SetHandler handler-name>
+Context: directory, .htaccess
+Status: Base
+Module: mod_mime

When placed into an .htaccess file or a <Directory> or <Location> section, diff --git a/docs/manual/location.html b/docs/manual/location.html index b5c3fd5e307..e8063f12fee 100644 --- a/docs/manual/location.html +++ b/docs/manual/location.html @@ -17,9 +17,18 @@

The <Location> Directive

-Syntax: <Location URL prefix>
-Context: server config, virtual host
-Status: core
+Syntax: <Location URL prefix>
+Context: server config, virtual host
+Status: core

The <Location> directive provides for access control by URL. It is comparable to the AccessConfig directive -Syntax: AccessConfig filename
-Default: AccessConfig conf/access.conf
-Context: server config, virtual host
-Status: core

+Syntax: AccessConfig filename
+Default: AccessConfig conf/access.conf
+Context: server config, virtual host
+Status: core

The server will read this file for more directives after reading the ResourceConfig file. Filename is @@ -103,11 +115,26 @@ contain any server directive allowed in the server config context.

AccessFileName directive

-Syntax: AccessFileName filename filename ...
-Default: AccessFileName .htaccess
-Context: server config, virtual host
-Status: core
-Compatibility: AccessFileName can accept more than one filename only in Apache 1.3 and later

+Syntax: AccessFileName filename filename ...
+Default: AccessFileName .htaccess
+Context: server config, virtual host
+Status: core
+Compatibility: AccessFileName can accept more than one filename only in Apache 1.3 and later

When returning a document to the client the server looks for the first existing access control file from this list of names in every directory of the path to @@ -125,10 +152,22 @@ AllowOverride None

AddModule directive

-Syntax: AddModule module module ...
-Context: server config
-Status: core
-Compatibility: AddModule is only available in Apache 1.2 and later

+Syntax: AddModule module module ...
+Context: server config
+Status: core
+Compatibility: AddModule is only available in Apache 1.2 and later

The server can have modules compiled in which are not actively in use. This directive can be used to enable the use of those modules. The @@ -138,10 +177,22 @@ directive.

AllowOverride directive

-Syntax: AllowOverride override override ...
-Default: AllowOverride All
-Context: directory
-Status: core

+Syntax: AllowOverride override override ...
+Default: AllowOverride All
+Context: directory
+Status: core

When the server finds an .htaccess file (as specified by AccessFileName) it needs to know which @@ -200,10 +251,22 @@ Allow use of the directives controlling specific directory features

AuthName directive

-Syntax: AuthName auth-domain
-Context: directory, .htaccess
-Override: AuthConfig
-Status: core

+Syntax: AuthName auth-domain
+Context: directory, .htaccess
+Override: AuthConfig
+Status: 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 @@ -215,10 +278,22 @@ It must be accompanied by AuthType and

AuthType directive

-Syntax: AuthType type
-Context: directory, .htaccess
-Override: AuthConfig
-Status: core

+Syntax: AuthType type
+Context: directory, .htaccess
+Override: AuthConfig
+Status: core

This directive selects the type of user authentication for a directory. Only Basic is currently implemented. @@ -230,10 +305,22 @@ It must be accompanied by AuthName and

BindAddress directive

-Syntax: BindAddress saddr
-Default: BindAddress *
-Context: server config
-Status: core

+Syntax: BindAddress saddr
+Default: BindAddress *
+Context: server config
+Status: core

A Unix® http server can either listen for connections to every IP address of the server machine, or just one IP address of the server @@ -267,10 +354,22 @@ HREF="#virtualhost"><VirtualHost> sections.

ClearModuleList directive

-Syntax: ClearModuleList
-Context: server config
-Status: core
-Compatibility: ClearModuleList is only available in Apache 1.2 and later

+Syntax: ClearModuleList
+Context: server config
+Status: core
+Compatibility: ClearModuleList is only available in Apache 1.2 and later

The server comes with a built-in list of active modules. This directive clears the list. It is assumed that the list will then be @@ -278,12 +377,30 @@ re-populated using the AddModule directive.

ContentDigest directive

-Syntax: ContentDigest on|off
-Default: ContentDigest off
-Context: server config, virtual host, directory, .htaccess
-Override: AuthConfig
-Status: experimental

-Compatibility: ContentDigest is only available in Apache 1.1 and later

+Syntax: ContentDigest on|off
+Default: ContentDigest off
+Context: server config, virtual host, directory, .htaccess
+Override: AuthConfig
+Status: experimental

+Compatibility: ContentDigest is only available in Apache 1.1 and later

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

@@ -312,10 +429,22 @@ CGI scripts, and byte range responses do not have this header.

CoreDumpDirectory directive

-Syntax: CoreDumpDirectory directory
-Default: the same location as ServerRoot
-Context: server config
-Status: core

+Syntax: CoreDumpDirectory directory
+Default: the same location as ServerRoot
+Context: server config
+Status: core

This controls the directory to which Apache attempts to switch before dumping core. The default is in the ServerRoot @@ -326,11 +455,26 @@ it in a different location.

DefaultType directive

-Syntax: DefaultType mime-type
-Default: DefaultType text/html
-Context: server config, virtual host, directory, .htaccess
-Override: FileInfo
-Status: core

+Syntax: DefaultType mime-type
+Default: DefaultType text/html
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: core

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

@@ -344,9 +488,18 @@ with filenames missing the .gif extension.

<Directory> directive

-Syntax: <Directory directory> ... </Directory>
-Context: server config, virtual host
-Status: Core.

+Syntax: <Directory directory> ... </Directory>
+Context: server config, virtual host
+Status: Core.

<Directory> and </Directory> are used to enclose a group of directives which will apply only to the named directory and sub-directories @@ -459,10 +612,22 @@ different sections are combined when a request is received

<DirectoryMatch>

-Syntax: <DirectoryMatch regex> ... </DirectoryMatch>
-Context: server config, virtual host
-Status: Core.
-Compatibility: Available in Apache 1.3 and later +Syntax: <DirectoryMatch regex> ... </DirectoryMatch>
+Context: server config, virtual host
+Status: Core.
+Compatibility: Available in Apache 1.3 and later

<DirectoryMatch> and </DirectoryMatch> are used to enclose a group of directives which will apply only to the named directory and sub-directories @@ -488,11 +653,23 @@ different sections are combined when a request is received

DocumentRoot directive

-Syntax: DocumentRoot directory-filename
-Default: DocumentRoot +Syntax: DocumentRoot directory-filename
+Default: DocumentRoot /usr/local/apache/htdocs
-Context: server config, virtual host
-Status: core

+Context: server config, virtual host
+Status: core

This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path @@ -510,11 +687,26 @@ please avoid that.

ErrorDocument directive

-Syntax: ErrorDocument error-code document
-Context: server config, virtual host, directory, .htaccess
-Status: core
-Override: FileInfo
-Compatibility: The directory and .htaccess contexts +Syntax: ErrorDocument error-code document
+Context: server config, virtual host, directory, .htaccess
+Status: core
+Override: FileInfo
+Compatibility: The directory and .htaccess contexts are only available in Apache 1.1 and later.

In the event of a problem or error, Apache can be configured to do @@ -559,10 +751,22 @@ responses.

ErrorLog directive

-Syntax: ErrorLog filename
-Default: ErrorLog logs/error_log
-Context: server config, virtual host
-Status: core

+Syntax: ErrorLog filename
+Default: ErrorLog logs/error_log
+Context: server config, virtual host
+Status: core

The error log directive sets the name of the file to which the server will log any errors it encounters. If the filename does not begin with a slash (/) @@ -579,11 +783,23 @@ than the user that starts the server.

<Files> directive

-Syntax: <Files filename> +Syntax: <Files filename> ... </Files>
-Context: server config, virtual host, .htaccess
-Status: core
-Compatibility: only available in Apache +Context: server config, virtual host, .htaccess
+Status: core
+Compatibility: only available in Apache 1.2 and above.

The <Files> directive provides for access control by @@ -629,11 +845,23 @@ different sections are combined when a request is received

<FilesMatch>

-Syntax: <FilesMatch regex> +Syntax: <FilesMatch regex> ... </Files>
-Context: server config, virtual host, .htaccess
-Status: core
-Compatibility: only available in Apache +Context: server config, virtual host, .htaccess
+Status: core
+Compatibility: only available in Apache 1.3 and above.

The <FilesMatch> directive provides for access control by @@ -654,10 +882,22 @@ different sections are combined when a request is received

Group directive

-Syntax: Group unix-group
-Default: Group #-1
-Context: server config, virtual host
-Status: core

+Syntax: Group unix-group
+Default: Group #-1
+Context: server config, virtual host
+Status: core

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 @@ -688,13 +928,31 @@ considerations.

HostNameLookups directive

-Syntax: HostNameLookups on | off | double
-Default: HostNameLookups off
-Context: server config, virtual host, directory, .htaccess
-Status: core
-Compatibility: double available only in Apache +Syntax: HostNameLookups on | off | double
+Default: HostNameLookups off
+Context: server config, virtual host, directory, .htaccess
+Status: core
+Compatibility: double available only in Apache 1.3 and above.
-Compatibility: Default was on prior to Apache +Compatibility: Default was on prior to Apache 1.3.

This directive enables DNS lookups so that host names can be logged (and @@ -728,10 +986,22 @@ from logged IP addresses offline.

IdentityCheck directive

-Syntax: IdentityCheck boolean
-Default: IdentityCheck off
-Context: server config, virtual host, directory, .htaccess
-Status: core

+Syntax: IdentityCheck boolean
+Default: IdentityCheck off
+Context: server config, virtual host, directory, .htaccess
+Status: core

This directive enables RFC1413-compliant logging of the remote user name for each connection, where the client machine runs identd or something similar. @@ -749,12 +1019,27 @@ servers accessible from the Internet.

<IfModule> directive

-Syntax: <IfModule [!]module-name> ... +Syntax: <IfModule [!]module-name> ... </IfModule>
-Default: None
-Context: all
-Status: Core
-Compatibility: IfModule is only available in 1.2 and +Default: None
+Context: all
+Status: Core
+Compatibility: IfModule is only available in 1.2 and later.

@@ -790,9 +1075,18 @@ simple multiple-module tests.

Include directive

Syntax: (Apache 1.2) Include filename
-Context: server config
-Status: Core
-Compatibility: Include is only available in Apache 1.3 and later. +Context: server config
+Status: Core
+Compatibility: Include is only available in Apache 1.3 and later.

This directive allows inclusion of other configuration files from within the server configuration files. @@ -803,9 +1097,18 @@ This directive allows inclusion of other configuration files from within the ser Default: (Apache 1.1) KeepAlive 5
Syntax: (Apache 1.2) KeepAlive on/off
Default: (Apache 1.2) KeepAlive On
-Context: server config
-Status: Core
-Compatibility: KeepAlive is only available in Apache +Context: server config
+Status: Core
+Compatibility: KeepAlive is only available in Apache 1.1 and later.

This directive enables @@ -822,11 +1125,26 @@ persistent connections, "Off" to disable. See also the MaxKeepAliveRequests directive.

KeepAliveTimeout directive

-Syntax: KeepAliveTimeout seconds
-Default: KeepAliveTimeout 15
-Context: server config
-Status: Core
-Compatibility: KeepAliveTimeout is only available in Apache +Syntax: KeepAliveTimeout seconds
+Default: KeepAliveTimeout 15
+Context: server config
+Status: Core
+Compatibility: KeepAliveTimeout is only available in Apache 1.1 and later.

The number of seconds Apache will wait for a subsequent request before @@ -838,10 +1156,19 @@ applies.

<Limit> directive

-Syntax: +Syntax: <Limit method method ... > ... </Limit>
-Context: any
-Status: core

+Context: any
+Status: core

<Limit> and </Limit> are used to enclose a group of access control directives which will then apply only to the specified @@ -862,11 +1189,23 @@ OPTIONS. If GET is used it will also restrict HEAD requests. <Limit> directive at all.

Listen directive

-Syntax: +Syntax: Listen [IP address:]port number
-Context: server config
-Status: core
-Compatibility: Listen is only available in Apache +Context: server config
+Status: core
+Compatibility: Listen is only available in Apache 1.1 and later.

The Listen directive instructs Apache to listen to more than one IP @@ -916,11 +1255,26 @@ interfaces and port numbers, use

ListenBacklog directive

-Syntax: ListenBacklog backlog
-Default: ListenBacklog 511
-Context: server config
-Status: Core
-Compatibility: ListenBacklog is only available in Apache +Syntax: ListenBacklog backlog
+Default: ListenBacklog 511
+Context: server config
+Status: Core
+Compatibility: ListenBacklog is only available in Apache versions after 1.2.0.

The maximum length of the queue of pending connections. Generally no @@ -930,11 +1284,23 @@ the backlog parameter to the listen(2) system call.

<Location> directive

-Syntax: <Location URL> +Syntax: <Location URL> ... </Location>
-Context: server config, virtual host
-Status: core
-Compatibility: Location is only available in Apache +Context: server config, virtual host
+Status: core
+Compatibility: Location is only available in Apache 1.1 and later.

The <Location> directive provides for access control by @@ -991,11 +1357,23 @@ different sections are combined when a request is received

<LocationMatch>

-Syntax: <LocationMatch regex> +Syntax: <LocationMatch regex> ... </LocationMatch>
-Context: server config, virtual host
-Status: core
-Compatibility: Location is only available in Apache +Context: server config, virtual host
+Status: core
+Compatibility: Location is only available in Apache 1.3 and later.

The <LocationMatch> directive provides for access control by @@ -1017,10 +1395,22 @@ different sections are combined when a request is received

LockFile directive

-Syntax: LockFile filename
-Default: LockFile logs/accept.lock
-Context: server config
-Status: core

+Syntax: LockFile filename
+Default: LockFile logs/accept.lock
+Context: server config
+Status: core

The LockFile directive sets the path to the lockfile used when Apache is compiled with either USE_FCNTL_SERIALIZED_ACCEPT or @@ -1040,21 +1430,48 @@ server will try to create.

MaxClients directive

-Syntax: MaxClients number
-Default: MaxClients 256
-Context: server config
-Status: core

+Syntax: MaxClients number
+Default: MaxClients 256
+Context: server config
+Status: core

The MaxClients directive sets the limit on the number of simultaneous requests that can be supported; not more than this number of child server processes will be created.

MaxKeepAliveRequests directive

-Syntax: MaxKeepAliveRequests number
-Default: MaxKeepAliveRequests 100
-Context: server config
-Status: core
-Compatibility: Only available in Apache +Syntax: MaxKeepAliveRequests number
+Default: MaxKeepAliveRequests 100
+Context: server config
+Status: core
+Compatibility: Only available in Apache 1.2 and later.

The MaxKeepAliveRequests directive limits the number of requests @@ -1065,10 +1482,22 @@ maximum server performance.

MaxRequestsPerChild directive

-Syntax: MaxRequestsPerChild number
-Default: MaxRequestsPerChild 0
-Context: server config
-Status: core

+Syntax: MaxRequestsPerChild number
+Default: MaxRequestsPerChild 0
+Context: server config
+Status: core

The MaxRequestsPerChild directive sets the limit on the number of requests that an individual child server process will handle. After MaxRequestsPerChild @@ -1085,10 +1514,22 @@ number of processes when the server load reduces.

MaxSpareServers directive

-Syntax: MaxSpareServers number
-Default: MaxSpareServers 10
-Context: server config
-Status: core

+Syntax: MaxSpareServers number
+Default: MaxSpareServers 10
+Context: server config
+Status: core

The MaxSpareServers directive sets the desired maximum number of idle child server processes. An idle process is one which is not handling @@ -1103,10 +1544,22 @@ See also MinSpareServers and

MinSpareServers directive

-Syntax: MinSpareServers number
-Default: MinSpareServers 5
-Context: server config
-Status: core

+Syntax: MinSpareServers number
+Default: MinSpareServers 5
+Context: server config
+Status: core

The MinSpareServers directive sets the desired minimum number of idle child server processes. An idle process is one which is not handling @@ -1121,10 +1574,22 @@ See also MaxSpareServers and

NameVirtualHost directive

-Syntax: NameVirtualHost addr[:port]
-Context: server config
-Status: core

-Compatibility: NameVirtualHost is only available in Apache 1.3 and later

+Syntax: NameVirtualHost addr[:port]
+Context: server config
+Status: core

+Compatibility: NameVirtualHost is only available in Apache 1.3 and later

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

@@ -1149,10 +1614,22 @@ virtual hosts should be used, e.g.

Options directive

-Syntax: Options [+|-]option [+|-]option ...
-Context: server config, virtual host, directory, .htaccess
-Override: Options
-Status: core

+Syntax: Options [+|-]option [+|-]option ...
+Context: server config, virtual host, directory, .htaccess
+Override: Options
+Status: core

The Options directive controls which server features are available in a particular directory. @@ -1236,10 +1713,22 @@ are set for the /web/docs/spec directory.

PidFile directive

-Syntax: PidFile filename
-Default: PidFile logs/httpd.pid
-Context: server config
-Status: core

+Syntax: PidFile filename
+Default: PidFile logs/httpd.pid
+Context: server config
+Status: core

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 (/) @@ -1258,10 +1747,22 @@ The PidFile is subject to the same warnings about log file placement and

Port directive

-Syntax: Port number
-Default: Port 80
-Context: server config
-Status: core

+Syntax: Port number
+Default: Port 80
+Context: server config
+Status: core

Number is a number from 0 to 65535; some port numbers (especially below 1024) are reserved for particular protocols. See /etc/services @@ -1316,10 +1817,22 @@ attack.

require directive

-Syntax: require entity-name entity entity...
-Context: directory, .htaccess
-Override: AuthConfig
-Status: core

+Syntax: require entity-name entity entity...
+Context: directory, .htaccess
+Override: AuthConfig
+Status: core

This directive selects which authenticated users can access a directory. The allowed syntaxes are: @@ -1353,10 +1866,22 @@ groups) in order to work correctly.

ResourceConfig directive

-Syntax: ResourceConfig filename
-Default: ResourceConfig conf/srm.conf
-Context: server config, virtual host
-Status: core

+Syntax: ResourceConfig filename
+Default: ResourceConfig conf/srm.conf
+Context: server config, virtual host
+Status: core

The server will read this file for more directives after reading the httpd.conf file. Filename is relative to the @@ -1372,11 +1897,26 @@ See also AccessConfig.

RLimitCPU directive

-Syntax: RLimitCPU # or 'max' [# or 'max']
-Default: Unset; uses operating system defaults
-Context: server config, virtual host
-Status: core
-Compatibility: RLimitCPU is only available in Apache 1.2 and later

+Syntax: RLimitCPU # or 'max' [# or 'max']
+Default: Unset; uses operating system defaults
+Context: server config, virtual host
+Status: core
+Compatibility: RLimitCPU is only available in Apache 1.2 and later

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 @@ -1391,11 +1931,26 @@ See also RLimitMEM or RLimitNPRO

RLimitMEM directive

-Syntax: RLimitMEM # or 'max' [# or 'max']
-Default: Unset; uses operating system defaults
-Context: server config, virtual host
-Status: core
-Compatibility: RLimitMEM is only available in Apache 1.2 and later

+Syntax: RLimitMEM # or 'max' [# or 'max']
+Default: Unset; uses operating system defaults
+Context: server config, virtual host
+Status: core
+Compatibility: RLimitMEM is only available in Apache 1.2 and later

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 @@ -1410,11 +1965,26 @@ See also RLimitCPU or RLimitNPRO

RLimitNPROC directive

-Syntax: RLimitNPROC # or 'max' [# or 'max']
-Default: Unset; uses operating system defaults
-Context: server config, virtual host
-Status: core
-Compatibility: RLimitNPROC is only available in Apache 1.2 and later

+Syntax: RLimitNPROC # or 'max' [# or 'max']
+Default: Unset; uses operating system defaults
+Context: server config, virtual host
+Status: core
+Compatibility: RLimitNPROC is only available in Apache 1.2 and later

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 @@ -1436,11 +2006,26 @@ See also RLimitMEM or RLimitCPUSatisfy directive -Syntax: Satisfy 'any' or 'all'
-Default: Satisfy all
-Context: directory, .htaccess
-Status: core
-Compatibility: Satisfy is only available in Apache 1.2 and later

+Syntax: Satisfy 'any' or 'all'
+Default: Satisfy all
+Context: directory, .htaccess
+Status: core
+Compatibility: Satisfy is only available in Apache 1.2 and later

Access policy if both allow and require used. The parameter can be either 'all' or 'any'. This directive is only useful @@ -1458,10 +2043,22 @@ clients from particular addresses in without prompting for a password.

ScoreBoardFile directive

-Syntax: ScoreBoardFile filename
-Default: ScoreBoardFile logs/apache_status
-Context: server config
-Status: core

+Syntax: ScoreBoardFile filename
+Default: ScoreBoardFile logs/apache_status
+Context: server config
+Status: core

The ScoreBoardFile directive is required on some architectures to place a file that the server will use to communicate between its children and @@ -1497,9 +2094,18 @@ release. (Prior to 1.3b4, HAVE_SHMGET would have sufficed.)

SendBufferSize directive

-Syntax: SendBufferSize bytes
-Context: server config
-Status: core

+Syntax: SendBufferSize bytes
+Context: server config
+Status: core

The server will set the TCP buffer size to the number of bytes specified. Very useful to increase past standard OS defaults on high @@ -1509,9 +2115,18 @@ fast pipes)

ServerAdmin directive

-Syntax: ServerAdmin email-address
-Context: server config, virtual host
-Status: core

+Syntax: ServerAdmin email-address
+Context: server config, virtual host
+Status: core

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

@@ -1522,10 +2137,22 @@ as users do not always mention that they are talking about the server!

ServerAlias directive

-Syntax: ServerAlias host1 host2 ...
-Context: virtual host
-Status: core
-Compatibility: ServerAlias is only available in Apache +Syntax: ServerAlias host1 host2 ...
+Context: virtual host
+Status: core
+Compatibility: ServerAlias is only available in Apache 1.1 and later.

The ServerAlias directive sets the alternate names for a host, for use @@ -1539,9 +2166,18 @@ with

ServerName directive

-Syntax: ServerName fully-qualified domain name
-Context: server config, virtual host
-Status: core

+Syntax: ServerName fully-qualified domain name
+Context: server config, virtual host
+Status: core

The ServerName directive sets the hostname of the server; this is only used when creating redirection URLs. If it is not specified, then the @@ -1556,10 +2192,22 @@ were monster.wibble.com.

ServerPath directive

-Syntax: ServerPath pathname
-Context: virtual host
-Status: core
-Compatibility: ServerPath is only available in Apache +Syntax: ServerPath pathname
+Context: virtual host
+Status: core
+Compatibility: ServerPath is only available in Apache 1.1 and later.

The ServerPath directive sets the legacy URL pathname for a host, for @@ -1572,10 +2220,22 @@ use with name-based virtual hosts.

ServerRoot directive

-Syntax: ServerRoot directory-filename
-Default: ServerRoot /usr/local/apache
-Context: server config
-Status: core

+Syntax: ServerRoot directory-filename
+Default: ServerRoot /usr/local/apache
+Context: server config
+Status: core

The ServerRoot directive sets the directory in which the server lives. Typically it will contain the subdirectories conf/ and @@ -1590,11 +2250,26 @@ for information on how to properly set permissions on the ServerRoot.

ServerSignature directive

-Syntax: ServerSignature Off | On | EMail
-Default: ServerSignature Off
-Context: directory, .htaccess
-Status: core

-Compatibility: ServerSignature is only available in Apache +Syntax: ServerSignature Off | On | EMail
+Default: ServerSignature Off
+Context: directory, .htaccess
+Status: core

+Compatibility: ServerSignature is only available in Apache 1.3 and later.

The ServerSignature directive allows the configuration of a trailing @@ -1616,10 +2291,22 @@ referenced document.

ServerType directive

-Syntax: ServerType type
-Default: ServerType standalone
-Context: server config
-Status: core

+Syntax: ServerType type
+Default: ServerType standalone
+Context: server config
+Status: core

The ServerType directive sets how the server is executed by the system. Type is one of @@ -1648,10 +2335,22 @@ standalone will probably be your only option.

StartServers directive

-Syntax: StartServers number
-Default: StartServers 5
-Context: server config
-Status: core

+Syntax: StartServers number
+Default: StartServers 5
+Context: server config
+Status: core

The StartServers directive sets the number of child server processes created on startup. As the number of processes is dynamically controlled depending @@ -1666,10 +2365,22 @@ See also MinSpareServers and MaxSpareServers.

ThreadsPerChild

-Syntax: ThreadsPerChild number
-Default: ThreadsPerChild 50
-Context: server config
-Status: core (Windows)
+Syntax: ThreadsPerChild number
+Default: ThreadsPerChild 50
+Context: server config
+Status: core (Windows)
Compatbility: Available only with Apache 1.3 and later with Windows @@ -1685,10 +2396,22 @@ with Windows

TimeOut directive

-Syntax: TimeOut number
-Default: TimeOut 300
-Context: server config
-Status: core

+Syntax: TimeOut number
+Default: TimeOut 300
+Context: server config
+Status: core

The TimeOut directive currently defines the amount of time Apache will wait for three things: @@ -1712,10 +2435,22 @@ a packet is sent.

User directive

-Syntax: User unix-userid
-Default: User #-1
-Context: server config, virtual host
-Status: core

+Syntax: User unix-userid
+Default: User #-1
+Context: server config, virtual host
+Status: core

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 @@ -1751,13 +2486,28 @@ dangers are.

<VirtualHost> directive

-Syntax: <VirtualHost addr[:port] ...> ... +Syntax: <VirtualHost addr[:port] ...> ... </VirtualHost>
-Context: server config
-Status: Core.
-Compatibility: Non-IP address-based Virtual Hosting only +Context: server config
+Status: Core.
+Compatibility: Non-IP address-based Virtual Hosting only available in Apache 1.1 and later.
-Compatibility: Multiple address support only available in +Compatibility: Multiple address support only available in Apache 1.2 and later.

<VirtualHost> and </VirtualHost> are used to enclose a group of diff --git a/docs/manual/mod/mod_access.html b/docs/manual/mod/mod_access.html index 50a17858272..b3ffda53fa4 100644 --- a/docs/manual/mod/mod_access.html +++ b/docs/manual/mod/mod_access.html @@ -34,11 +34,26 @@ hostname or IP address.

allow directive

-Syntax: allow from host host ...
-Context: directory, .htaccess
-Override: Limit
-Status: Base
-Module: mod_access +Syntax: allow from host host ...
+Context: directory, .htaccess
+Override: Limit
+Status: Base
+Module: mod_access

The allow directive affects which hosts can access a given directory. @@ -78,11 +93,26 @@ See also deny, order, and

Syntax: allow from env=variablename
-Context: directory, .htaccess
-Override: Limit
-Status: Base
-Module: mod_access
-Compatibility: Apache 1.2 and above +Context: directory, .htaccess
+Override: Limit
+Status: Base
+Module: mod_access
+Compatibility: Apache 1.2 and above

The allow from env directive controls access to a directory by the @@ -110,11 +140,26 @@ and order.

deny directive

-Syntax: deny from host host ...
-Context: directory, .htaccess
-Override: Limit
-Status: Base
-Module: mod_access +Syntax: deny from host host ...
+Context: directory, .htaccess
+Override: Limit
+Status: Base
+Module: mod_access

The deny directive affects which hosts can access a given directory. @@ -153,11 +198,26 @@ See also allow and order.

Syntax: deny from env=variablename
-Context: directory, .htaccess
-Override: Limit
-Status: Base
-Module: mod_access
-Compatibility: Apache 1.2 and above +Context: directory, .htaccess
+Override: Limit
+Status: Base
+Module: mod_access
+Compatibility: Apache 1.2 and above

The deny from env directive controls access to a directory by the @@ -186,12 +246,30 @@ and order.

order directive

-Syntax: order ordering
-Default: order deny,allow
-Context: directory, .htaccess
-Override: Limit
-Status: Base
-Module: mod_access +Syntax: order ordering
+Default: order deny,allow
+Context: directory, .htaccess
+Override: Limit
+Status: Base
+Module: mod_access

The order directive controls the order in which allow and diff --git a/docs/manual/mod/mod_actions.html b/docs/manual/mod/mod_actions.html index dd41533dad1..2ab0537506c 100644 --- a/docs/manual/mod/mod_actions.html +++ b/docs/manual/mod/mod_actions.html @@ -36,12 +36,30 @@ process files.

Action directive

-Syntax: Action mime-type cgi-script
-Context: server config, virtual host, directory, .htaccess
-Override: FileInfo
-Status: Base
-Module: mod_actions
-Compatibility: Action is only available in Apache 1.1 +Syntax: Action mime-type cgi-script
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_actions
+Compatibility: Action is only available in Apache 1.1 and later

@@ -54,11 +72,26 @@ CGI PATH_INFO and PATH_TRANSLATED environment variables.

Script directive

-Syntax: Script method cgi-script
-Context: server config, virtual host, directory
-Status: Base
-Module: mod_actions
-Compatibility: Script is only available in Apache 1.1 +Syntax: Script method cgi-script
+Context: server config, virtual host, directory
+Status: Base
+Module: mod_actions
+Compatibility: Script is only available in Apache 1.1 and later

diff --git a/docs/manual/mod/mod_alias.html b/docs/manual/mod/mod_alias.html index 61e2b07ca0c..11758c65c56 100644 --- a/docs/manual/mod/mod_alias.html +++ b/docs/manual/mod/mod_alias.html @@ -38,10 +38,22 @@ host filesystem in the the document tree, and for URL redirection.

Alias directive

-Syntax: Alias url-path directory-filename
-Context: server config, virtual host
-Status: Base
-Module: mod_alias +Syntax: Alias url-path directory-filename
+Context: server config, virtual host
+Status: Base
+Module: mod_alias

The Alias directive allows documents to be stored in the local filesystem @@ -69,11 +81,26 @@ See also ScriptAlias.

AliasMatch

-Syntax: AliasMatch regex directory-filename
-Context: server config, virtual host
-Status: Base
-Module: mod_alias
-Compatibility: Available in Apache 1.3 and later +Syntax: AliasMatch regex directory-filename
+Context: server config, virtual host
+Status: Base
+Module: mod_alias
+Compatibility: Available in Apache 1.3 and later

This directive is equivalent to Alias, but @@ -92,11 +119,26 @@ to activate the /icons directory, one might use:

Redirect directive

-Syntax: Redirect [ status ] url-path url
-Context: server config, virtual host, directory, .htaccess
-Status: Base
-Module: mod_alias
-Compatibility: The directory and .htaccess context's +Syntax: Redirect [ status ] url-path url
+Context: server config, virtual host, directory, .htaccess
+Status: Base
+Module: mod_alias
+Compatibility: The directory and .htaccess context's are only available in versions 1.1 and later. The status argument is only available in Apache 1.2 or later.

@@ -155,11 +197,26 @@ the function send_error_response in http_protocol.c).

RedirectMatch

-Syntax: RedirectMatch [status regex url
-Context: server config, virtual host
-Status: Base
-Module: mod_alias
-Compatibility: Available in Apache 1.3 and later +Syntax: RedirectMatch [status regex url
+Context: server config, virtual host
+Status: Base
+Module: mod_alias
+Compatibility: Available in Apache 1.3 and later

This directive is equivalent to Redirect, but @@ -179,11 +236,26 @@ one might use:

RedirectTemp directive

-Syntax: RedirectTemp url-path url
-Context: server config, virtual host, directory, .htaccess
-Status: Base
-Module: mod_alias
-Compatibility: This directive is only available in 1.2 +Syntax: RedirectTemp url-path url
+Context: server config, virtual host, directory, .htaccess
+Status: Base
+Module: mod_alias
+Compatibility: This directive is only available in 1.2

This directive makes the client know that the Redirect is only @@ -195,11 +267,26 @@ temporary.

RedirectPermanent directive

-Syntax: RedirectPermanent url-path url
-Context: server config, virtual host, directory, .htaccess
-Status: Base
-Module: mod_alias
-Compatibility: This directive is only available in 1.2 +Syntax: RedirectPermanent url-path url
+Context: server config, virtual host, directory, .htaccess
+Status: Base
+Module: mod_alias
+Compatibility: This directive is only available in 1.2

This directive makes the client know that the Redirect is permanent @@ -210,10 +297,22 @@ This directive makes the client know that the Redirect is permanent

ScriptAlias directive

-Syntax: ScriptAlias url-path directory-filename
-Context: server config, virtual host
-Status: Base
-Module: mod_alias +Syntax: ScriptAlias url-path directory-filename
+Context: server config, virtual host
+Status: Base
+Module: mod_alias

The ScriptAlias directive has the same behavior as the @@ -234,11 +333,26 @@ run the script /web/cgi-bin/foo.

ScriptAliasMatch

-Syntax: ScriptAliasMatch regex directory-filename
-Context: server config, virtual host
-Status: Base
-Module: mod_alias
-Compatibility: Available in Apache 1.3 and later +Syntax: ScriptAliasMatch regex directory-filename
+Context: server config, virtual host
+Status: Base
+Module: mod_alias
+Compatibility: Available in Apache 1.3 and later

This directive is equivalent to ScriptAlias, but diff --git a/docs/manual/mod/mod_auth.html b/docs/manual/mod/mod_auth.html index eb006f48371..52e9cf7d67a 100644 --- a/docs/manual/mod/mod_auth.html +++ b/docs/manual/mod/mod_auth.html @@ -31,11 +31,26 @@ textual files.

AuthGroupFile

-Syntax: AuthGroupFile filename
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Base
-Module: mod_auth

+Syntax: AuthGroupFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Base
+Module: mod_auth

The AuthGroupFile directive sets the name of a textual file containing the list of user groups for user authentication. Filename is the path @@ -59,11 +74,26 @@ See also AuthName,

AuthUserFile

-Syntax: AuthUserFile filename
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Base
-Module: mod_auth

+Syntax: AuthUserFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Base
+Module: mod_auth

The AuthUserFile directive sets the name of a textual file containing the list of users and passwords for user @@ -89,11 +119,26 @@ See also AuthName,

AuthAuthoritative

 -Syntax: AuthAuthoritative < on(default) | off >
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Base
-Module: mod_auth

+Syntax: AuthAuthoritative < on(default) | off >
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Base
+Module: mod_auth

Setting the AuthAuthoritative directive explicitly to 'off' allows for both authentication and authorization to be passed on to @@ -124,7 +169,10 @@ well protected AuthUserFile.

-Default: By default; control is not passed on; and an unknown +Default: By default; control is not passed on; and an unknown userID or rule will result in an Authorization Required reply. Not setting it thus keeps the system secure; and forces an NSCA compliant behaviour. diff --git a/docs/manual/mod/mod_auth_anon.html b/docs/manual/mod/mod_auth_anon.html index 82acd9812f0..f228cde7495 100644 --- a/docs/manual/mod/mod_auth_anon.html +++ b/docs/manual/mod/mod_auth_anon.html @@ -54,12 +54,30 @@ allows users to share URLs.

Anonymous directive

-Syntax: Anonymous user user ...
-Default: none
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_anon

+Syntax: Anonymous user user ...
+Default: none
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_anon

A list of one or more 'magic' userIDs which are allowed access without password verification. The userIDs are space separated. @@ -81,12 +99,30 @@ allows users to share URLs.

Anonymous_Authoritative directive

-Syntax: Anonymous_Authoritative on | off
-Default: Anonymous_Authoritative off
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_anon

+Syntax: Anonymous_Authoritative on | off
+Default: Anonymous_Authoritative off
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_anon

When set 'on', there is no fall-through to other authorization methods. So if a @@ -100,12 +136,30 @@ allows users to share URLs.

Anonymous_LogEmail directive

-Syntax: Anonymous_LogEmail on | off
-Default: Anonymous_LogEmail on
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_anon

+Syntax: Anonymous_LogEmail on | off
+Default: Anonymous_LogEmail on
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_anon

When set 'on', the default, the 'password' entered (which hopefully contains a sensible email address) is logged in the httpd-log file. @@ -113,24 +167,60 @@ allows users to share URLs.

Anonymous_MustGiveEmail directive

-Syntax: Anonymous_MustGiveEmail on | off
-Default: Anonymous_MustGiveEmail on
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_anon

+Syntax: Anonymous_MustGiveEmail on | off
+Default: Anonymous_MustGiveEmail on
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_anon

Specifies whether the user must specify an email address as the password. This prohibits blank passwords.

Anonymous_NoUserID directive

-Syntax: Anonymous_NoUserID on | off
-Default: Anonymous_NoUserID off
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_anon

+Syntax: Anonymous_NoUserID on | off
+Default: Anonymous_NoUserID off
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_anon

When set 'on', users can leave the userID (and perhaps the password field) empty. This @@ -141,12 +231,30 @@ allows users to share URLs.

Anonymous_VerifyEmail directive

-Syntax: Anonymous_VerifyEmail on | off
-Default: Anonymous_VerifyEmail off
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_anon

+Syntax: Anonymous_VerifyEmail on | off
+Default: Anonymous_VerifyEmail off
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_anon

When set 'on' the 'password' entered is checked for at least one '@' and a '.' to encourage users to enter diff --git a/docs/manual/mod/mod_auth_db.html b/docs/manual/mod/mod_auth_db.html index 55173ea97ac..f3453c149b9 100644 --- a/docs/manual/mod/mod_auth_db.html +++ b/docs/manual/mod/mod_auth_db.html @@ -32,11 +32,26 @@ available in Apache 1.1 and later.

AuthDBGroupFile

-Syntax: AuthDBGroupFile filename
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_db

+Syntax: AuthDBGroupFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_db

The AuthDBGroupFile directive sets the name of a DB file containing the list of user groups for user authentication. Filename is the absolute path @@ -80,11 +95,26 @@ See also AuthName,

AuthDBUserFile

-Syntax: AuthDBUserFile filename
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_db

+Syntax: AuthDBUserFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_db

The AuthDBUserFile directive sets the name of a DB file containing the list of users and passwords for user authentication. Filename is the @@ -114,11 +144,26 @@ See also AuthName,

AuthDBAuthoritative

 -Syntax: AuthDBAuthoritative < on(default) | off >
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Base
-Module: mod_auth

+Syntax: AuthDBAuthoritative < on(default) | off >
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Base
+Module: mod_auth

Setting the AuthDBAuthoritative directive explicitly to 'off' allows for both authentication and authorization to be passed on @@ -139,7 +184,10 @@ Whereas this DB module supplies the bulk of the user credential checking; a few (administrator) related accesses fall through to a lower level with a well protected .htpasswd file.

-Default: By default; control is not passed on; and an unknown +Default: By default; control is not passed on; and an unknown userID or rule will result in an Authorization Required reply. Not setting it thus keeps the system secure; and forces an NSCA compliant behaviour.

diff --git a/docs/manual/mod/mod_auth_dbm.html b/docs/manual/mod/mod_auth_dbm.html index abc34a1ed4d..7e9ba00f363 100644 --- a/docs/manual/mod/mod_auth_dbm.html +++ b/docs/manual/mod/mod_auth_dbm.html @@ -31,11 +31,26 @@ DBM files.

AuthDbmGroupFile

-Syntax: AuthDBMGroupFile filename
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_dbm

+Syntax: AuthDBMGroupFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_dbm

The AuthDBMGroupFile directive sets the name of a DBM file containing the list of user groups for user authentication. Filename is the absolute path @@ -80,11 +95,26 @@ See also AuthName,

AuthDBMUserFile

-Syntax: AuthDBMUserFile filename
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Extension
-Module: mod_auth_dbm

+Syntax: AuthDBMUserFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_dbm

The AuthDBMUserFile directive sets the name of a DBM file containing the list of users and passwords for user authentication. Filename is the @@ -115,11 +145,26 @@ See also AuthName,

AuthDBMAuthoritative

 -Syntax: AuthDBMAuthoritative < on(default) | off >
-Context: directory, .htaccess
-Override: AuthConfig
-Status: Base
-Module: mod_auth

+Syntax: AuthDBMAuthoritative < on(default) | off >
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Base
+Module: mod_auth

Setting the AuthDBMAuthoritative directive explicitly to 'off' allows for both authentication and authorization to be passed on @@ -140,7 +185,10 @@ Whereas this DBM module supplies the bulk of the user credential checking; a few (administrator) related accesses fall through to a lower level with a well protected .htpasswd file.

-Default: By default; control is not passed on; and an unknown +Default: By default; control is not passed on; and an unknown userID or rule will result in an Authorization Required reply. Not setting it thus keeps the system secure; and forces an NSCA compliant behaviour.

diff --git a/docs/manual/mod/mod_autoindex.html b/docs/manual/mod/mod_autoindex.html index 10c438158ad..3833be1050a 100644 --- a/docs/manual/mod/mod_autoindex.html +++ b/docs/manual/mod/mod_autoindex.html @@ -80,11 +80,26 @@ order) even though they both are shown as "1K".

AddAlt

-Syntax: AddAlt string file file...
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: AddAlt string file file...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

This sets the alternate text to display for a file, instead of an icon, for FancyIndexing. File is a file @@ -96,12 +111,27 @@ image-incapable or has image loading disabled.

AddAltByEncoding

 -Syntax: AddAltByEncoding string MIME-encoding +Syntax: AddAltByEncoding string MIME-encoding MIME-encoding...
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

This sets the alternate text to display for a file, instead of an icon, for FancyIndexing. MIME-encoding is a @@ -113,11 +143,26 @@ image-incapable or has image loading disabled.

AddAltByType

 -Syntax: AddAltByType string MIME-type MIME-type...
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: AddAltByType string MIME-type MIME-type...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

This sets the alternate text to display for a file, instead of an icon, for FancyIndexing. MIME-type is a @@ -130,11 +175,26 @@ image-incapable or has image loading disabled.

AddDescription

-Syntax: AddDescription string file file...
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: AddDescription string file file...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

This sets the description to display for a file, for FancyIndexing. File is a file @@ -146,11 +206,26 @@ to describe. String is enclosed in double quotes

AddIcon

-Syntax: AddIcon icon name name ...
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: AddIcon icon name name ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

This sets the icon to display next to a file ending in name for FancyIndexing. Icon is either a @@ -171,12 +246,27 @@ AddIcon, when possible.

AddIconByEncoding

 -Syntax: AddIconByEncoding icon mime-encoding mime-encoding +Syntax: AddIconByEncoding icon mime-encoding mime-encoding ...
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

This sets the icon to display next to files with mime-encoding for FancyIndexing. @@ -192,11 +282,26 @@ AddIconByEncoding /icons/compress.xbm x-compress

AddIconByType

-Syntax: AddIconByType icon mime-type mime-type ...
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: AddIconByType icon mime-type mime-type ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

This sets the icon to display next to files of type mime-type for FancyIndexing. Icon is either a @@ -211,11 +316,26 @@ AddIconByType (IMG,/icons/image.xbm) image/*

DefaultIcon

-Syntax: DefaultIcon url
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: DefaultIcon url
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

The DefaultIcon directive sets the icon to display for files when no specific icon is known, for FancyIndexing. @@ -226,11 +346,26 @@ DefaultIcon /icon/unknown.xbm

FancyIndexing

-Syntax: FancyIndexing boolean
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex +Syntax: FancyIndexing boolean
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

The FancyIndexing directive sets the FancyIndexing option for a directory. Boolean can be on or off. The @@ -247,11 +382,26 @@ preference.

HeaderName

-Syntax: HeaderName filename
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: HeaderName filename
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

The HeaderName directive sets the name of the file that will be inserted at the top of the index listing. Filename is the name of the file @@ -268,11 +418,26 @@ it will include the plain text file /web/HEADER, if it exists.

IndexIgnore

-Syntax: IndexIgnore file file ...
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: IndexIgnore file file ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

The IndexIgnore directive adds to the list of files to hide when listing a directory. File is a file extension, partial filename, @@ -285,11 +450,26 @@ IndexIgnore README .htaccess *~

IndexOptions

-Syntax: IndexOptions option option ...
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: IndexOptions option option ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

The IndexOptions directive specifies the behavior of the directory indexing. Option can be one of @@ -385,11 +565,26 @@ directory.

ReadmeName

 -Syntax: ReadmeName filename
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_autoindex

+Syntax: ReadmeName filename
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_autoindex

The ReadmeName directive sets the name of the file that will be appended to the end of the index listing. Filename is the name of the file diff --git a/docs/manual/mod/mod_cern_meta.html b/docs/manual/mod/mod_cern_meta.html index 9e311e33459..162517511d6 100644 --- a/docs/manual/mod/mod_cern_meta.html +++ b/docs/manual/mod/mod_cern_meta.html @@ -44,24 +44,57 @@ who can exploit this module.

MetaFiles

-Syntax: MetaFiles on/off
-Default: MetaFiles off
-Context: per-directory config
-Status: Base
-Module: mod_cern_meta
-Compatibility: MetaFiles is only available in Apache 1.3 +Syntax: MetaFiles on/off
+Default: MetaFiles off
+Context: per-directory config
+Status: Base
+Module: mod_cern_meta
+Compatibility: MetaFiles is only available in Apache 1.3 and later.

Turns on/off Meta file processing on a per-directory basis. This option was introduced in Apache 1.3.

MetaDir

-Syntax: MetaDir directory name
-Default: MetaDir .web
+Syntax: MetaDir directory name
+Default: MetaDir .web
Context: (Apache prior to 1.3) server config
Context: (Apache 1.3) per-directory config
-Status: Base
-Module: mod_cern_meta
-Compatibility: MetaDir is only available in Apache 1.1 +Status: Base
+Module: mod_cern_meta
+Compatibility: MetaDir is only available in Apache 1.1 and later.

Specifies the name of the directory in which Apache can find @@ -71,13 +104,28 @@ accessed. Set to "." to look in the same directory as the file.

MetaSuffix

-Syntax: MetaSuffix suffix
-Default: MetaSuffix .meta
+Syntax: MetaSuffix suffix
+Default: MetaSuffix .meta
Context: (Apache prior to 1.3) server config
Context: (Apache 1.3) per-directory config
-Status: Base
-Module: mod_cern_meta
-Compatibility: MetaSuffix is only available in Apache 1.1 +Status: Base
+Module: mod_cern_meta
+Compatibility: MetaSuffix is only available in Apache 1.1 and later.

Specifies the file name suffix for the file containing the diff --git a/docs/manual/mod/mod_cgi.html b/docs/manual/mod/mod_cgi.html index 0447f881ddc..2621141e093 100644 --- a/docs/manual/mod/mod_cgi.html +++ b/docs/manual/mod/mod_cgi.html @@ -115,10 +115,22 @@ anything on standard output or standard error).

ScriptLog

-Syntax: ScriptLog filename
-Default: none
-Context: resource config
-Status: mod_cgi +Syntax: ScriptLog filename
+Default: none
+Context: resource config
+Status: mod_cgi

The ScriptLog directive sets the CGI script error logfile. @@ -143,10 +155,22 @@ it was designed.

ScriptLogLength

-Syntax: ScriptLogLength size
-Default: 10385760
-Context: resource config
-Status: mod_cgi +Syntax: ScriptLogLength size
+Default: 10385760
+Context: resource config
+Status: mod_cgi

ScriptLogLength can be used to limit the size of the CGI @@ -158,10 +182,22 @@ exceeds this size, no more information will be written to it.

ScriptLogBuffer

-Syntax: ScriptLogBuffer size
-Default: 1024
-Context: resource config
-Status: mod_cgi +Syntax: ScriptLogBuffer size
+Default: 1024
+Context: resource config
+Status: mod_cgi

The size of any PUT or POST entity body that is logged to the file is diff --git a/docs/manual/mod/mod_dir.html b/docs/manual/mod/mod_dir.html index 9fc99ab2d30..a92c1c33271 100644 --- a/docs/manual/mod/mod_dir.html +++ b/docs/manual/mod/mod_dir.html @@ -46,12 +46,30 @@ slash, so mod_dir issues a redirect to

DirectoryIndex

-Syntax: DirectoryIndex local-url local-url ...
-Default: DirectoryIndex index.html
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Status: Base
-Module: mod_dir

+Syntax: DirectoryIndex local-url local-url ...
+Default: DirectoryIndex index.html
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

The DirectoryIndex directive sets the list of resources to look for, when the client requests an index of the directory by specifying a / diff --git a/docs/manual/mod/mod_env.html b/docs/manual/mod/mod_env.html index 4283b138db4..965084375f1 100644 --- a/docs/manual/mod/mod_env.html +++ b/docs/manual/mod/mod_env.html @@ -38,11 +38,26 @@ rewriting all their scripts

PassEnv

-Syntax: PassEnv variable variable ...
-Context: server config, virtual host
-Status: Base
-Module: mod_env
-Compatibility: PassEnv is only available in +Syntax: PassEnv variable variable ...
+Context: server config, virtual host
+Status: Base
+Module: mod_env
+Compatibility: PassEnv is only available in Apache 1.1 and later.

Specifies one or more environment variables to pass to CGI scripts @@ -54,11 +69,26 @@ from the server's own environment. Example:

SetEnv

-Syntax: SetEnv variable value
-Context: server config, virtual host
-Status: Base
-Module: mod_env
-Compatibility: SetEnv is only available in +Syntax: SetEnv variable value
+Context: server config, virtual host
+Status: Base
+Module: mod_env
+Compatibility: SetEnv is only available in Apache 1.1 and later.

Sets an environment variable, which is then passed on to CGI @@ -70,11 +100,26 @@ scripts. Example:

UnsetEnv

-Syntax: UnsetEnv variable variable ...
-Context: server config, virtual host
-Status: Base
-Module: mod_env
-Compatibility: UnsetEnv is only available in +Syntax: UnsetEnv variable variable ...
+Context: server config, virtual host
+Status: Base
+Module: mod_env
+Compatibility: UnsetEnv is only available in Apache 1.1 and later.

Removes one or more environment variables from those passed on to diff --git a/docs/manual/mod/mod_expires.html b/docs/manual/mod/mod_expires.html index a6f1914fe2c..3a3ead97833 100644 --- a/docs/manual/mod/mod_expires.html +++ b/docs/manual/mod/mod_expires.html @@ -56,15 +56,30 @@

- Syntax: ExpiresActive boolean + Syntax: ExpiresActive boolean
- Context: server config, virtual host, directory, .htaccess + Context: server config, virtual host, directory, .htaccess
- Override: Indexes + Override: Indexes
- Status: Extension + Status: Extension
- Module: mod_expires + Module: mod_expires

This directive enables or disables the generation of the @@ -97,15 +112,30 @@

- Syntax: ExpiresByType mime-type <code>seconds + Syntax: ExpiresByType mime-type <code>seconds
- Context: server config, virtual host, directory, .htaccess + Context: server config, virtual host, directory, .htaccess
- Override: Indexes + Override: Indexes
- Status: Extension + Status: Extension
- Module: mod_expires + Module: mod_expires

This directive defines the value of the Expires header @@ -167,15 +197,30 @@

- Syntax: ExpiresDefault <code>seconds + Syntax: ExpiresDefault <code>seconds
- Context: server config, virtual host, directory, .htaccess + Context: server config, virtual host, directory, .htaccess
- Override: Indexes + Override: Indexes
- Status: Extension + Status: Extension
- Module: mod_expires + Module: mod_expires

This directive sets the default algorithm for calculating the diff --git a/docs/manual/mod/mod_headers.html b/docs/manual/mod/mod_headers.html index e5745b2bbcb..3b854dfcac4 100644 --- a/docs/manual/mod/mod_headers.html +++ b/docs/manual/mod/mod_headers.html @@ -30,11 +30,26 @@ compiled with mod_headers.c.

Header

-Syntax: Header [ set | append | add ] header value
-Syntax: Header unset header
-Context: server config, virtual host, access.conf, .htaccess
-Status: optional
-Module: mod_header

+Syntax: Header [ set | append | add ] header value
+Syntax: Header unset header
+Context: server config, virtual host, access.conf, .htaccess
+Status: optional
+Module: mod_header

This directive can replace, merge or remove HTTP response headers. The action it performs is determined by the first argument. This can be one diff --git a/docs/manual/mod/mod_imap.html b/docs/manual/mod/mod_imap.html index eb647df2414..adef4af12ce 100644 --- a/docs/manual/mod/mod_imap.html +++ b/docs/manual/mod/mod_imap.html @@ -63,12 +63,27 @@ possible with previously distributed imagemap programs.

ImapMenu

-Syntax: ImapMenu {none, formatted, semi-formatted, +Syntax: ImapMenu {none, formatted, semi-formatted, unformatted}
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Module: mod_imap.c
-Compatibility: ImapMenu is only available in Apache +Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Module: mod_imap.c
+Compatibility: ImapMenu is only available in Apache 1.1 and later.

The ImapMenu directive determines the action taken if an imagemap file @@ -101,12 +116,27 @@ is called without valid coordinates.

ImapDefault

-Syntax: ImapDefault {error, nocontent, +Syntax: ImapDefault {error, nocontent, map, referer, URL}
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Module: mod_imap.c
-Compatibility: ImapDefault is only available in Apache +Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Module: mod_imap.c
+Compatibility: ImapDefault is only available in Apache 1.1 and later.

@@ -120,11 +150,26 @@ case, the client should continue to display the original page.

ImapBase

-Syntax: ImapBase {map, referer, URL}
-Context: server config, virtual host, directory, .htaccess
-Override: Indexes
-Module: mod_imap.c
-Compatibility: ImapBase is only available in Apache +Syntax: ImapBase {map, referer, URL}
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Module: mod_imap.c
+Compatibility: ImapBase is only available in Apache 1.1 and later.

The ImapBase directive sets the default base used in diff --git a/docs/manual/mod/mod_include.html b/docs/manual/mod/mod_include.html index 81647ed8735..1ab38248ddf 100644 --- a/docs/manual/mod/mod_include.html +++ b/docs/manual/mod/mod_include.html @@ -360,12 +360,30 @@ elements are:

XBitHack

-Syntax: XBitHack status
-Default: XBitHack off
-Context: server config, virtual host, directory, .htaccess
-Override: Options
-Status: Base
-Module: mod_include

+Syntax: XBitHack status
+Default: XBitHack off
+Context: server config, virtual host, directory, .htaccess
+Override: Options
+Status: Base
+Module: mod_include

The XBitHack directives controls the parsing of ordinary html documents. This directive only affects files associated with the MIME type diff --git a/docs/manual/mod/mod_info.html b/docs/manual/mod/mod_info.html index d6728e7d03f..306bc8663c3 100644 --- a/docs/manual/mod/mod_info.html +++ b/docs/manual/mod/mod_info.html @@ -77,11 +77,26 @@ Once configured, the server information is obtained by accessing

AddModuleInfo

-Syntax: AddModuleInfo module-name string
-Context: server config, virtual host
-Status: base
-Module: mod_browser
-Compatibility: Apache 1.3 and above

+Syntax: AddModuleInfo module-name string
+Context: server config, virtual host
+Status: base
+Module: mod_browser
+Compatibility: Apache 1.3 and above

This allows the content of string to be shown as HTML interpreted, diff --git a/docs/manual/mod/mod_log_agent.html b/docs/manual/mod/mod_log_agent.html index 2a43155c254..43252dd4a24 100644 --- a/docs/manual/mod/mod_log_agent.html +++ b/docs/manual/mod/mod_log_agent.html @@ -27,11 +27,26 @@ compiled in by default. It provides for logging of the client user agents.

AgentLog

-Syntax: AgentLog file-pipe
-Default: AgentLog logs/agent_log
-Context: server config, virtual host
-Status: Extension
-Module: mod_log_agent

+Syntax: AgentLog file-pipe
+Default: AgentLog logs/agent_log
+Context: server config, virtual host
+Status: Extension
+Module: mod_log_agent

The AgentLog directive sets the name of the file to which the server will log the UserAgent header of incoming requests. File-pipe is one diff --git a/docs/manual/mod/mod_log_config.html b/docs/manual/mod/mod_log_config.html index 489148989f7..5ec74a32127 100644 --- a/docs/manual/mod/mod_log_config.html +++ b/docs/manual/mod/mod_log_config.html @@ -191,10 +191,22 @@ the user that starts the server.

CookieLog

-Syntax: CookieLog filename
-Context: server config, virtual host
-Module: mod_cookies
-Compatibility: Only available in Apache 1.2 and above

+Syntax: CookieLog filename
+Context: server config, virtual host
+Module: mod_cookies
+Compatibility: Only available in Apache 1.2 and above

The CookieLog directive sets the filename for logging of cookies. The filename is relative to the mod_cookies, and is deprecated.

CustomLog

-Syntax: CustomLog file-pipe +Syntax: CustomLog file-pipe format-or-nickname
-Context: server config, virtual host
-Status: Base
+Context: server config, virtual host
+Status: Base
Compatibility: Nickname only available in Apache 1.3 or later
-Module: mod_log_config +Module: mod_log_config

The first argument is the filename to which log records should be written. This is used @@ -241,16 +265,31 @@ directive.

LogFormat

-Syntax: LogFormat format [nickname] +Syntax: LogFormat format [nickname]
-Default: LogFormat "%h %l %u %t \"%r\" +Default: LogFormat "%h %l %u %t \"%r\" %s %b"
-Context: server config, virtual host
-Status: Base
+Context: server config, virtual host
+Status: Base
Compatibility: Nickname only available in Apache 1.3 or later
-Module: mod_log_config +Module: mod_log_config

This sets the format of the default logfile named by the

TransferLog

-Syntax: TransferLog file-pipe
-Default: none
-Context: server config, virtual host
-Status: Base
-Module: mod_log_config

+Syntax: TransferLog file-pipe
+Default: none
+Context: server config, virtual host
+Status: Base
+Module: mod_log_config

The TransferLog directive adds a log file in the format defined by the most recent diff --git a/docs/manual/mod/mod_log_referer.html b/docs/manual/mod/mod_log_referer.html index d98228f4e98..341b93a6570 100644 --- a/docs/manual/mod/mod_log_referer.html +++ b/docs/manual/mod/mod_log_referer.html @@ -38,10 +38,22 @@ local URL to the document being referred to.

RefererIgnore

-Syntax: RefererIgnore string string ...
-Context: server config, virtual host
-Status: Extension
-Module: mod_log_referer

+Syntax: RefererIgnore string string ...
+Context: server config, virtual host
+Status: Extension
+Module: mod_log_referer

The RefererIgnore directive adds to the list of strings to ignore in Referer headers. If any of the strings in the list is contained in @@ -54,11 +66,26 @@ This avoids logging references from www.ncsa.uiuc.edu.

RefererLog

-Syntax: RefererLog file-pipe
-Default: RefererLog logs/referer_log
-Context: server config, virtual host
-Status: Extension
-Module: mod_log_referer

+Syntax: RefererLog file-pipe
+Default: RefererLog logs/referer_log
+Context: server config, virtual host
+Status: Extension
+Module: mod_log_referer

The RefererLog directive sets the name of the file to which the server will log the Referer header of incoming requests. File-pipe is one diff --git a/docs/manual/mod/mod_mime.html b/docs/manual/mod/mod_mime.html index e71bd844e3f..4dffe98377b 100644 --- a/docs/manual/mod/mod_mime.html +++ b/docs/manual/mod/mod_mime.html @@ -86,11 +86,26 @@ copies may still be used by a client or proxy.

AddEncoding

-Syntax: AddEncoding mime-enc extension extension...
-Context: server config, virtual host, directory, .htaccess
-Override: FileInfo
-Status: Base
-Module: mod_mime

+Syntax: AddEncoding mime-enc extension extension...
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_mime

The AddEncoding directive adds to the list of filename extensions which filenames may end in for the specified encoding type. Mime-enc @@ -106,11 +121,26 @@ encoding, and .Z files to be marked as encoded with x-compress.

AddHandler

-Syntax: AddHandler handler-name extension extension...
-Context: server config, virtual host, directory, .htaccess
-Status: Base
-Module: mod_mime
-Compatibility: AddHandler is only available in Apache +Syntax: AddHandler handler-name extension extension...
+Context: server config, virtual host, directory, .htaccess
+Status: Base
+Module: mod_mime
+Compatibility: AddHandler is only available in Apache 1.1 and later

AddHandler maps the filename extensions extension to the @@ -128,11 +158,26 @@ program.

AddLanguage

-Syntax: AddLanguage mime-lang extension extension...
-Context: server config, virtual host, directory, .htaccess
-Override: FileInfo
-Status: Base
-Module: mod_mime

+Syntax: AddLanguage mime-lang extension extension...
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_mime

The AddLanguage directive adds to the list of filename extensions which filenames may end in for the specified content language. Mime-lang @@ -152,11 +197,26 @@ from several documents based on the client's language preference.

AddType

-Syntax: AddType mime-type extension extension...
-Context: server config, virtual host, directory, .htaccess
-Override: FileInfo
-Status: Base
-Module: mod_mime

+Syntax: AddType mime-type extension extension...
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_mime

The AddType directive adds to the list of filename extensions which filenames may end in for the specified content type. Mime-enc @@ -172,11 +232,26 @@ type of particular files.

ForceType

-Syntax: ForceType media type
-Context: directory, .htaccess
-Status: Base
-Module: mod_mime
-Compatibility: ForceType is only available in Apache +Syntax: ForceType media type
+Context: directory, .htaccess
+Status: Base
+Module: mod_mime
+Compatibility: ForceType is only available in Apache 1.1 and later.

When placed into an .htaccess file or a @@ -193,11 +268,26 @@ media type.

SetHandler

-Syntax: SetHandler handler-name
-Context: directory, .htaccess
-Status: Base
-Module: mod_mime
-Compatibility: SetHandler is only available in Apache +Syntax: SetHandler handler-name
+Context: directory, .htaccess
+Status: Base
+Module: mod_mime
+Compatibility: SetHandler is only available in Apache 1.1 and later.

When placed into an .htaccess file or a @@ -224,11 +314,26 @@ called, you might put the following into access.conf:

TypesConfig

-Syntax: TypesConfig filename
-Default: TypesConfig conf/mime.types
-Context: server config
-Status: Base
-Module: mod_mime

+Syntax: TypesConfig filename
+Default: TypesConfig conf/mime.types
+Context: server config
+Status: Base
+Module: mod_mime

The TypesConfig directive sets the location of the mime types configuration file. Filename is relative to the diff --git a/docs/manual/mod/mod_mime_magic.html b/docs/manual/mod/mod_mime_magic.html index af00aaa82a5..42e9c23500d 100644 --- a/docs/manual/mod/mod_mime_magic.html +++ b/docs/manual/mod/mod_mime_magic.html @@ -170,15 +170,30 @@ MimeMagicFile

- Syntax: MimeMagicFile magic-file-name + Syntax: MimeMagicFile magic-file-name
- Default: none + Default: none
- Context: server config, virtual host + Context: server config, virtual host
- Status: Extension + Status: Extension
- Module: mod_mime_magic + Module: mod_mime_magic

The MimeMagicFile directive can be used to enable this module, diff --git a/docs/manual/mod/mod_negotiation.html b/docs/manual/mod/mod_negotiation.html index c1ba2b0b173..1deea4238f2 100644 --- a/docs/manual/mod/mod_negotiation.html +++ b/docs/manual/mod/mod_negotiation.html @@ -95,11 +95,26 @@ requirements, and returns that document.

CacheNegotiatedDocs

-Syntax: CacheNegotiatedDocs
-Context: server config
-Status: Base
-Module: mod_negotiation
-Compatibility: CacheNegotiatedDocs is only available +Syntax: CacheNegotiatedDocs
+Context: server config
+Status: Base
+Module: mod_negotiation
+Compatibility: CacheNegotiatedDocs is only available in Apache 1.1 and later.

If set, this directive allows content-negotiated documents to be @@ -118,11 +133,26 @@ HTTP/1.1 requests.

LanguagePriority

-Syntax: LanguagePriority mime-lang mime-lang...
-Context: server config, virtual host, directory, .htaccess
-Override: FileInfo
-Status: Base
-Module: mod_negotiation

+Syntax: LanguagePriority mime-lang mime-lang...
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_negotiation

The LanguagePriority sets the precedence of language variants for the case where the client does not express a preference, when handling a diff --git a/docs/manual/mod/mod_proxy.html b/docs/manual/mod/mod_proxy.html index b571bb3a91e..80dcc1014f9 100644 --- a/docs/manual/mod/mod_proxy.html +++ b/docs/manual/mod/mod_proxy.html @@ -60,13 +60,34 @@ and other protocols.

ProxyRequests

 -Syntax: ProxyRequests on/off
-Default: ProxyRequests Off
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: ProxyRequests is only available in +Syntax: ProxyRequests on/off
+Default: ProxyRequests Off
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: ProxyRequests is only available in Apache 1.1 and later.

This allows or prevents Apache from functioning as a proxy @@ -76,13 +97,34 @@ HREF="#proxypass">ProxyPass directive.

ProxyRemote

 -Syntax: ProxyRemote <match> <remote-server>
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: ProxyRemote is only available in +Syntax: ProxyRemote <match> <remote-server>
+Default: None
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: ProxyRemote is only available in Apache 1.1 and later.

This defines remote proxies to this proxy. <match> is either the @@ -112,13 +154,34 @@ them.

ProxyPass

 -Syntax: ProxyPass <path> <url>
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: ProxyPass is only available in +Syntax: ProxyPass <path> <url>
+Default: None
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: ProxyPass is only available in Apache 1.1 and later.

This directive allows remote servers to be mapped into the space of the local @@ -138,13 +201,34 @@ internally converted into a proxy request to

ProxyBlock

 -Syntax: ProxyBlock <word/host/domain list>
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: ProxyBlock is only available in +Syntax: ProxyBlock <word/host/domain list>
+Default: None
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: ProxyBlock is only available in Apache 1.2 and later.

The ProxyBlock directive specifies a list of words, hosts and/or domains, @@ -172,17 +256,38 @@ blocks connections to all sites.

NoProxy

 -Syntax: NoProxy { <Domain> +Syntax: NoProxy { <Domain> | <SubNet> | <IpAddr> | <Hostname> }
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: NoProxy is only available in +Default: None
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: NoProxy is only available in Apache 1.3 and later.

This directive is only useful for Apache proxy servers within intranets. @@ -288,13 +393,34 @@ The arguments to the NoProxy directive are one of the following type list:

ProxyDomain

 -Syntax: ProxyDomain <Domain>
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: ProxyDomain is only available in +Syntax: ProxyDomain <Domain>
+Default: None
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: ProxyDomain is only available in Apache 1.3 and later.

This directive is only useful for Apache proxy servers within intranets. @@ -314,13 +440,34 @@ Example:

CacheRoot

 -Syntax: CacheRoot <directory>
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: CacheRoot is only available in +Syntax: CacheRoot <directory>
+Default: None
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: CacheRoot is only available in Apache 1.1 and later.

Sets the name of the directory to contain cache files; this must be @@ -330,13 +477,34 @@ by the httpd server.

CacheSize

 -Syntax: CacheSize <size>
-Default: CacheSize 5
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: CacheSize is only available in +Syntax: CacheSize <size>
+Default: CacheSize 5
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: CacheSize is only available in Apache 1.1 and later.

Sets the desired space usage of the cache, in KB (1024-byte units). Although @@ -346,13 +514,34 @@ until the usage is at or below this setting.

CacheGcInterval

 -Syntax: CacheGcInterval <time>
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: CacheGcinterval is only available in +Syntax: CacheGcInterval <time>
+Default: None
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: CacheGcinterval is only available in Apache 1.1 and later.

Check the cache every <time> hours, and delete files if the space @@ -361,13 +550,34 @@ usage is greater than that set by CacheSize.

CacheMaxExpire

 -Syntax: CacheMaxExpire <time>
-Default: CacheMaxExpire 24
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: CacheMaxExpire is only available in +Syntax: CacheMaxExpire <time>
+Default: CacheMaxExpire 24
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: CacheMaxExpire is only available in Apache 1.1 and later.

Cachable HTTP documents will be retained for at most <time> hours without @@ -378,13 +588,34 @@ was supplied with the document.

CacheLastModifiedFactor

 -Syntax: CacheLastModifiedFactor <factor>
-Default: CacheLastModifiedFactor 0.1
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: CacheLastModifiedFactor is only available in +Syntax: CacheLastModifiedFactor <factor>
+Default: CacheLastModifiedFactor 0.1
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: CacheLastModifiedFactor is only available in Apache 1.1 and later.

If the origin HTTP server did not supply an expiry date for the @@ -401,13 +632,34 @@ then the latter takes precedence.

CacheDirLevels

 -Syntax: CacheDirLevels <levels>
-Default: CacheDirLevels 3
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: CacheDirLevels is only available in +Syntax: CacheDirLevels <levels>
+Default: CacheDirLevels 3
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: CacheDirLevels is only available in Apache 1.1 and later.

CacheDirLevels sets the number of levels of subdirectories in the cache. @@ -416,13 +668,34 @@ Cached data will be saved this many directory levels below CacheRoot.

CacheDirLength

 -Syntax: CacheDirLength <length>
-Default: CacheDirLength 1
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: CacheDirLength is only available in +Syntax: CacheDirLength <length>
+Default: CacheDirLength 1
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: CacheDirLength is only available in Apache 1.1 and later.

CacheDirLength sets the number of characters in proxy cache subdirectory names. @@ -430,13 +703,34 @@ CacheDirLength sets the number of characters in proxy cache subdirectory names.

CacheDefaultExpire

 -Syntax: CacheDefaultExpire <time>
-Default: CacheDefaultExpire 1
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: CacheDefaultExpire is only available in +Syntax: CacheDefaultExpire <time>
+Default: CacheDefaultExpire 1
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: CacheDefaultExpire is only available in Apache 1.1 and later.

If the document is fetched via a protocol that does not support expiry times, @@ -447,13 +741,34 @@ override this setting.

NoCache

 -Syntax: NoCache <word/host/domain list>
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Base
-Module: mod_proxy
-Compatibility: NoCache is only available in +Syntax: NoCache <word/host/domain list>
+Default: None
+Context: server config, virtual host
+Override: Not applicable
+Status: Base
+Module: mod_proxy
+Compatibility: NoCache is only available in Apache 1.1 and later.

The NoCache directive specifies a list of words, hosts and/or domains, separated diff --git a/docs/manual/mod/mod_rewrite.html b/docs/manual/mod/mod_rewrite.html index be9cb2215ea..854d41edd95 100644 --- a/docs/manual/mod/mod_rewrite.html +++ b/docs/manual/mod/mod_rewrite.html @@ -86,9 +86,18 @@ gifted exclusively to the The Apache Group in July 1997 by

RewriteEngine

-Syntax: RewriteEngine {on,off}
-Default: RewriteEngine off
-Context: server config, virtual host, per-directory config
+Syntax: RewriteEngine {on,off}
+Default: RewriteEngine off
+Context: server config, virtual host, per-directory config

The RewriteEngine directive enables or disables the @@ -111,9 +120,18 @@ HREF="#RewriteOptions">RewriteOptions inherit is enabled.

RewriteOptions

-Syntax: RewriteOptions Option ...
-Default: -None-
-Context: server config, virtual host, per-directory config
+Syntax: RewriteOptions Option ...
+Default: -None-
+Context: server config, virtual host, per-directory config

The RewriteOptions directive sets some special options for the @@ -134,9 +152,18 @@ strings can be one of the following:

RewriteLog

-Syntax: RewriteLog Filename
-Default: -None-
-Context: server config, virtual host
+Syntax: RewriteLog Filename
+Default: -None-
+Context: server config, virtual host

The RewriteLog directive sets the name of the file to which the @@ -183,9 +210,18 @@ RewriteLog "/usr/local/var/apache/logs/rewrite.log"

RewriteLogLevel

-Syntax: RewriteLogLevel Level
-Default: RewriteLogLevel 0
-Context: server config, virtual host
+Syntax: RewriteLogLevel Level
+Default: RewriteLogLevel 0
+Context: server config, virtual host

The RewriteLogLevel directive set the verbosity level of the rewriting @@ -219,9 +255,18 @@ RewriteLogLevel 3

RewriteMap

-Syntax: RewriteMap Mapname {txt,dbm,prg}:Filename
-Default: not used per default
-Context: server config, virtual host
+Syntax: RewriteMap Mapname {txt,dbm,prg}:Filename
+Default: not used per default
+Context: server config, virtual host

The RewriteMap directive defines an external Rewriting Map @@ -361,9 +406,18 @@ only happens once!

RewriteBase

-Syntax: RewriteBase BaseURL
-Default: default is the physical directory path
-Context: per-directory config
+Syntax: RewriteBase BaseURL
+Default: default is the physical directory path
+Context: per-directory config

The RewriteBase directive explicitly sets the base URL for @@ -464,9 +518,18 @@ sure the design and implementation is correct.

RewriteCond

-Syntax: RewriteCond TestString CondPattern
-Default: -None-
-Context: server config, virtual host, per-directory config
+Syntax: RewriteCond TestString CondPattern
+Default: -None-
+Context: server config, virtual host, per-directory config

The RewriteCond directive defines a rule condition. Precede a @@ -760,9 +823,18 @@ use any other browser you get the standard homepage.

RewriteRule

-Syntax: RewriteRule Pattern Substitution
-Default: -None-
-Context: server config, virtual host, per-directory config
+Syntax: RewriteRule Pattern Substitution
+Default: -None-
+Context: server config, virtual host, per-directory config

The RewriteRule directive is the real rewriting workhorse. The diff --git a/docs/manual/mod/mod_setenvif.html b/docs/manual/mod/mod_setenvif.html index d089fa37dba..cb80be0e38a 100644 --- a/docs/manual/mod/mod_setenvif.html +++ b/docs/manual/mod/mod_setenvif.html @@ -41,19 +41,40 @@

The BrowserMatch Directive

- Syntax: BrowserMatch regex envar[=value] [...] + Syntax: BrowserMatch regex envar[=value] [...]
- Default: none + Default: none
- Context: server config + Context: server config
- Override: none + Override: none
- Status: Base + Status: Base
- Module: mod_setenvif + Module: mod_setenvif
- Compatibility: Apache 1.2 and above + Compatibility: Apache 1.2 and above

The BrowserMatch directive defines environment variables based on the @@ -120,19 +141,40 @@

- Syntax: BrowserMatchNoCase regex envar[=value] [...] + Syntax: BrowserMatchNoCase regex envar[=value] [...]
- Default: none + Default: none
- Context: server config + Context: server config
- Override: none + Override: none
- Status: Base + Status: Base
- Module: mod_setenvif + Module: mod_setenvif
- Compatibility: Apache 1.2 and above + Compatibility: Apache 1.2 and above

The BrowserMatchNoCase directive is semantically identical to @@ -171,19 +213,40 @@

- Syntax: SetEnvIf attribute regex envar[=value] [...] + Syntax: SetEnvIf attribute regex envar[=value] [...]
- Default: none + Default: none
- Context: server config + Context: server config
- Override: none + Override: none
- Status: Base + Status: Base
- Module: mod_setenvif + Module: mod_setenvif
- Compatibility: Apache 1.3 and above + Compatibility: Apache 1.3 and above

The SetEnvIf directive defines environment variables @@ -237,20 +300,41 @@

- Syntax: SetEnvIfNoCase + Syntax: SetEnvIfNoCase attribute regex envar[=value] [...]
- Default: none + Default: none
- Context: server config + Context: server config
- Override: none + Override: none
- Status: Base + Status: Base
- Module: mod_setenvif + Module: mod_setenvif
- Compatibility: Apache 1.3 and above + Compatibility: Apache 1.3 and above

The SetEnvIfNoCase is semantically identical to the diff --git a/docs/manual/mod/mod_speling.html b/docs/manual/mod/mod_speling.html index b2ed9e5ec56..b0e3d98a755 100644 --- a/docs/manual/mod/mod_speling.html +++ b/docs/manual/mod/mod_speling.html @@ -59,12 +59,30 @@

CheckSpelling

 - Syntax: CheckSpelling on/off
- Default: CheckSpelling Off
- Context: server config, virtual host
- Status: Base
- Module: mod_speling
- Compatibility: CheckSpelling was available as a separately + Syntax: CheckSpelling on/off
+ Default: CheckSpelling Off
+ Context: server config, virtual host
+ Status: Base
+ Module: mod_speling
+ Compatibility: CheckSpelling was available as a separately available module for Apache 1.1, but was limited to miscapitalizations. As of Apache 1.3, it is part of the apache distribution.

diff --git a/docs/manual/mod/mod_userdir.html b/docs/manual/mod/mod_userdir.html index 2d79f119404..76e24c77cd0 100644 --- a/docs/manual/mod/mod_userdir.html +++ b/docs/manual/mod/mod_userdir.html @@ -27,12 +27,30 @@ is compiled in by default. It provides for user-specific directories.

UserDir

-Syntax: UserDir directory/filename
-Default: UserDir public_html
-Context: server config, virtual host
-Status: Base
-Module: mod_userdir
-Compatibility: All forms except the UserDir +Syntax: UserDir directory/filename
+Default: UserDir public_html
+Context: server config, virtual host
+Status: Base
+Module: mod_userdir
+Compatibility: All forms except the UserDir public_html form are only available in Apache 1.1 or above. Use of the enabled keyword, or disabled with a list of usernames, is only available in Apache 1.3 and above.

diff --git a/docs/manual/mod/mod_usertrack.html b/docs/manual/mod/mod_usertrack.html index af88b17c43c..59f861996a1 100644 --- a/docs/manual/mod/mod_usertrack.html +++ b/docs/manual/mod/mod_usertrack.html @@ -53,10 +53,22 @@ above CustomLog directive.

CookieExpires

-Syntax: CookieExpires expiry-period
-Context: server config, virtual host
-Status: optional
-Module: mod_usertrack

+Syntax: CookieExpires expiry-period
+Context: server config, virtual host
+Status: optional
+Module: mod_usertrack

When used, this directive sets an expiry time on the cookie generated by the usertrack module. The expiry-period can be given either @@ -70,12 +82,27 @@ double quotes. browser session.

CookieTracking

-Syntax: CookieTracking on | off
-Context: server config, virtual host, directory, +Syntax: CookieTracking on | off
+Context: server config, virtual host, directory, .htaccess
-Override: FileInfo
-Status: optional
-Module: mod_usertrack

+Override: FileInfo
+Status: optional
+Module: mod_usertrack

When the user track module is compiled in, and "CookieTracking on" is set, Apache will start sending a user-tracking cookie for all new