From b0af265cc03d04b791b7aa02245dc4d9ee0f57a8 Mon Sep 17 00:00:00 2001 From: Christophe Jaillet Date: Tue, 28 Jun 2016 04:43:43 +0000 Subject: [PATCH] Fix typo as spotted by Wolfgang in online doc (r1750439 in trunk) Be more consistent in block layout in XML. No visual change (r1750441 in trunk) Synch with trunk (mainly block layout) Do not use " around parameters in syntax git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1750444 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/core.xml | 191 ++++++++++++++++++++++++++------------- 1 file changed, 127 insertions(+), 64 deletions(-) diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml index 7fa1b42287..cfb5b16f2f 100644 --- a/docs/manual/mod/core.xml +++ b/docs/manual/mod/core.xml @@ -195,7 +195,9 @@ AcceptFilter https data configuration files are enabled for that directory. For example:

- AccessFileName .acl + +AccessFileName .acl +

Before returning the document /usr/local/web/index.html, the server will read @@ -240,7 +242,9 @@ content-type is text/plain or text/html charset values for use in Internet media types (MIME types). For example:

- AddDefaultCharset utf-8 + +AddDefaultCharset utf-8 +

AddDefaultCharset should only be used when all of the text resources to which it applies are known to be in that @@ -320,7 +324,7 @@ NoDecode option available in 2.3.12 and later.

When this directive is set to None and AllowOverrideList is set to - None .htaccess, files are + None, .htaccess files are completely ignored. In this case, the server will not even attempt to read .htaccess files in the filesystem.

@@ -439,8 +443,8 @@ NoDecode option available in 2.3.12 and later. Allow use of the directives controlling specific directory features (Options and XBitHack). - An equal sign may be given followed by a comma-separated list, without spaces, - of options that may be set using the Options command. Implicit disabling of Options @@ -460,7 +464,9 @@ NoDecode option available in 2.3.12 and later.

Example:

- AllowOverride AuthConfig Indexes + +AllowOverride AuthConfig Indexes +

In the example above, all directives that are neither in the group AuthConfig nor Indexes cause an internal @@ -718,7 +724,9 @@ which no other media type configuration could be found. of configuration files, it may be specified with the value none, meaning no default media type. For example:

- DefaultType None + +DefaultType None +

DefaultType None is only available in httpd-2.2.7 and later.

@@ -774,7 +782,7 @@ DocumentRoot "/var/www/${servername}/htdocs" Directory Enclose a group of directives that apply only to the named file-system directory, sub-directories, and their contents. -<Directory "directory-path"> +<Directory directory-path> ... </Directory> server configvirtual host @@ -822,7 +830,7 @@ named file-system directory, sub-directories, and their contents. <Directory ~ "^/www/[0-9]{3}"> </Directory> - +

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

@@ -928,7 +936,7 @@ the contents of file-system directories matching a regular expression. +

matches directories in /www/ (or any subdirectory thereof) that consist of three numbers.

@@ -954,11 +962,11 @@ the contents of file-system directories matching a regular expression.mod_rewrite. In order to prevent confusion, numbered (unnamed) backreferences are ignored. Use named groups instead.

- + <DirectoryMatch "^/var/www/combined/(?<sitename>[^/]+)"> Require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example </DirectoryMatch> - + Directory for a description of how regular expressions are mixed in with normal @@ -985,7 +993,9 @@ from the web path from the requested URL to the document root to make the path to the document. Example:

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

then an access to http://my.example.com/index.html refers to @@ -1130,7 +1140,9 @@ for a complete reference and more examples.

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

- EnableMMAP Off + +EnableMMAP Off +

For NFS mounted files, this feature may be disabled explicitly for the offending files by specifying:

@@ -1186,7 +1198,9 @@ version 2.3.9.

For server configurations that are not vulnerable to these problems, you may enable this feature by specifying:

- EnableSendfile On + +EnableSendfile On +

For network mounted files, this feature may be disabled explicitly for the offending files by specifying:

@@ -1366,13 +1380,17 @@ ErrorDocument 404 /cgi-bin/bad_urls.pl the file-path is not absolute then it is assumed to be relative to the ServerRoot.

- ErrorLog "/var/log/httpd/error_log" + +ErrorLog "/var/log/httpd/error_log" +

If the file-path begins with a pipe character "|" then it is assumed to be a command to spawn to handle the error log.

- ErrorLog "|/usr/local/bin/httpd_errors" + +ErrorLog "|/usr/local/bin/httpd_errors" +

See the notes on piped logs for more information.

@@ -1386,7 +1404,9 @@ ErrorDocument 404 /cgi-bin/bad_urls.pl in individual virtual hosts, the final facility specified affects the entire server.

- ErrorLog syslog:user + +ErrorLog syslog:user +

Additional modules can provide their own ErrorLog providers. The syntax is similar to the syslog example above.

@@ -1593,7 +1613,7 @@ ErrorLogFormat "[%{u}t] [%-m:%l] [pid %P:tid %T] %7F: %E: [client\ %a] %M% 

This would result in error messages such as:

- + [Thu May 12 08:28:57.652118 2011] [core:error] [pid 8777:tid 4326490112] [client ::1:58619] File does not exist: /usr/local/apache2/htdocs/favicon.ico @@ -1687,7 +1707,9 @@ earlier.
The number of bytes in the file will be included
All
All available fields will be used. This is equivalent to: - FileETag INode MTime Size
+ +FileETag INode MTime Size +
None
If a document is file-based, no ETag field will be included in the response
@@ -1726,7 +1748,7 @@ earlier. Files Contains directives that apply to matched filenames -<Files "filename"> ... </Files> +<Files filename> ... </Files> server configvirtual host directory.htaccess @@ -1762,7 +1784,7 @@ filenames <Files "?at.*"> # This would apply to cat.html, bat.html, hat.php and so on. </Files> - +

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

@@ -1771,7 +1793,7 @@ filenames <Files ~ "\.(gif|jpe?g|png)$"> #... </Files> - +

would match most common Internet graphics formats. FilesMatch is preferred, @@ -1807,11 +1829,11 @@ filenames does. However, it accepts a regular expression. For example:

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

would match most common Internet graphics formats.

@@ -1826,11 +1848,11 @@ filenames mod_rewrite. In order to prevent confusion, numbered (unnamed) backreferences are ignored. Use named groups instead.

- + <FilesMatch "^(?<sitename>[^/]+)"> require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example </FilesMatch> - + How <Directory>, <Location> @@ -1858,7 +1880,9 @@ media type in the HTTP Content-Type header field GIF files, but did not want to label them all with .gif, you might want to use:

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

Note that this directive overrides other indirect media type associations defined in mime.types or via the @@ -1982,7 +2006,9 @@ satisfied by a request at runtime directives if and only if the expression evaluates to true. For example:

- <If "-z req('Host')"> + +<If "-z req('Host')"> +

would match HTTP/1.0 requests without a Host: header. Expressions may contain various shell-like operators for string @@ -1991,7 +2017,9 @@ satisfied by a request at runtime and others (-n, -z, -f, ...). It is also possible to use regular expressions,

- <If "%{QUERY_STRING} =~ /(delete|commit)=.*?elem/"> + +<If "%{QUERY_STRING} =~ /(delete|commit)=.*?elem/"> +

shell-like pattern matches and many other operations. These operations can be done on request headers (req), environment variables @@ -2195,12 +2223,16 @@ Include conf/vhosts/*.conf path. This example will fail if there is no subdirectory in conf/vhosts that contains at least one *.conf file:

- Include conf/vhosts/*/*.conf + +Include conf/vhosts/*/*.conf +

Alternatively, the following command will just be ignored in case of missing files or directories:

- IncludeOptional conf/vhosts/*/*.conf + +IncludeOptional conf/vhosts/*/*.conf + @@ -2437,7 +2469,9 @@ subrequests determines how deeply subrequests may be nested. If you specify only one number, it will be assigned to both limits.

- LimitInternalRecursion 5 + +LimitInternalRecursion 5 + @@ -2480,7 +2514,9 @@ from the client location and wish to limit the size of the uploaded file to 100K, you might use the following directive:

- LimitRequestBody 102400 + +LimitRequestBody 102400 +

For a full description of how this directive is interpreted by proxy requests, see the mod_proxy documentation.

@@ -2523,7 +2559,9 @@ will be accepted from the client

For example:

- LimitRequestFields 50 + +LimitRequestFields 50 + Warning

When name-based virtual hosting is used, the value for this @@ -2562,7 +2600,9 @@ client

For example:

- LimitRequestFieldSize 4094 + +LimitRequestFieldSize 4094 + Under normal conditions, the value should not be changed from the default. @@ -2603,7 +2643,9 @@ from the client

For example:

- LimitRequestLine 4094 + +LimitRequestLine 4094 + Under normal conditions, the value should not be changed from the default. @@ -2632,7 +2674,9 @@ from the client

Example:

- LimitXMLRequestBody 0 + +LimitXMLRequestBody 0 + @@ -2642,7 +2686,7 @@ from the client Applies the enclosed directives only to matching URLs <Location - "URL-path|URL"> ... </Location> + URL-path|URL> ... </Location> server configvirtual host @@ -2730,7 +2774,7 @@ URLs <Location ~ "/(extra|special)/data"> #... </Location> - +

would match URLs that contained the substring /extra/data or /special/data. The directive <LocationMatch "/(extra|special)/data"> # ... </LocationMatch> - +

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

@@ -2812,7 +2856,7 @@ matching URLs regular expression with a ^ to require this.

- <LocationMatch "^/(extra|special)/data"> +<LocationMatch "^/(extra|special)/data"> @@ -2823,11 +2867,11 @@ matching URLs mod_rewrite. In order to prevent confusion, numbered (unnamed) backreferences are ignored. Use named groups instead.

- + <LocationMatch "^/combined/(?<sitename>[^/]+)"> require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example </LocationMatch> - + How <Directory>, <Location> @@ -3001,7 +3045,9 @@ matching URLs

For example:

- LogLevel notice + +LogLevel notice + Note

When logging to a regular file, messages of the level @@ -3035,9 +3081,9 @@ LogLevel info Per directory loglevel configuration only affects messages that are - logged after the request has been parsed and that are associated with - the request. Log messages which are associated with the connection or - the server are not affected. + logged after the request has been parsed and that are associated with + the request. Log messages which are associated with the connection or + the server are not affected. ErrorLog @@ -3064,7 +3110,9 @@ connection

For example:

- MaxKeepAliveRequests 500 + +MaxKeepAliveRequests 500 + @@ -3529,7 +3577,7 @@ directory

Normally, if multiple Options could apply to a directory, then the most specific one is used and others are ignored; the options are not merged. (See how sections are merged.) + href="../sections.html#merging">how sections are merged.) However if all the options on the Options directive are preceded by a + or - symbol, the options are @@ -3604,9 +3652,12 @@ On Windows, from Apache 2.3.3 and later. otherwise, http is assumed for port 80 and https for port 443.

-

For example, if you are running https on a non-standard port, specify the protocol explicitly:

+

For example, if you are running https on a non-standard port, + specify the protocol explicitly:

- Protocol https + +Protocol https +

You can also specify the protocol using the Listen directive.

@@ -3637,7 +3688,7 @@ On Windows, from Apache 2.3.3 and later. specify:

- Protocols h2 http/1.1 +Protocols h2 http/1.1

Valid protocols are http/1.1 for http and https connections, @@ -3808,11 +3859,15 @@ scripts by the shebang line (first line, starting with #!) in the script. On Win32 systems this line usually looks like:

- #!C:/Perl/bin/perl.exe + +#!C:/Perl/bin/perl.exe +

or, if perl is in the PATH, simply:

- #!perl + +#!perl +

Setting ScriptInterpreterSource Registry will cause the Windows Registry tree HKEY_CLASSES_ROOT to be @@ -3908,7 +3963,9 @@ messages sent to the client

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

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

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

@@ -3946,7 +4003,7 @@ to name-virtual hosts

The complete list of names in the VirtualHost - directive are treated just like a (non wildcard) + directive are treated just like a (non wildcard) ServerAlias.

@@ -3983,7 +4040,9 @@ itself and you wish the web server to be so identified, the following directive should be used:

- ServerName www.example.com + +ServerName www.example.com +

The ServerName directive may appear anywhere within the definition of a server. However, @@ -3994,7 +4053,7 @@ itself server attempts to deduce the client visible hostname by first asking the operating system for the system hostname, and if that fails, performing a reverse lookup on an IP address present on the system.

- +

If no port is specified in the ServerName, then the server will use the port from the incoming request. For optimal reliability and @@ -4078,7 +4137,9 @@ is accessed by an incompatible browser module="mod_so">LoadModule, for example) are taken as relative to this directory.

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

The default location of ServerRoot may be modified by using the --prefix argument to @@ -4218,7 +4279,9 @@ handler of extension, you might put the following into an .htaccess file in that directory:

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

Another example: if you wanted to have the server display a status report whenever a URL of @@ -4647,8 +4710,8 @@ hostname or IP address

This directive controls whether HTTP trailers are copied into the - internal representation of HTTP headers. This merging occurs when the - request body has been completely consumed, long after most header + internal representation of HTTP headers. This merging occurs when the + request body has been completely consumed, long after most header processing would have a chance to examine or modify request headers.

This option is provided for compatibility with releases prior to 2.4.11, where trailers were always merged.

@@ -4658,7 +4721,7 @@ hostname or IP address QualifyRedirectURL Controls whether the REDIRECT_URL environment variable is -fully qualified + fully qualified QualifyRedirectURL ON|OFF QualifyRedirectURL OFF server configvirtual host -- 2.40.0