From: Mike Rumph Date: Wed, 1 Jul 2015 18:16:20 +0000 (+0000) Subject: Grammar, spelling, and other minor corrections X-Git-Tag: 2.5.0-alpha~3025 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7babb474aca40b538d5f6c1d38b79c38a0c7adf6;p=thirdparty%2Fapache%2Fhttpd.git Grammar, spelling, and other minor corrections git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1688698 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml index 55ce1bcc213..e9f0596a4b6 100644 --- a/docs/manual/mod/core.xml +++ b/docs/manual/mod/core.xml @@ -47,12 +47,12 @@ available for that protocol. This is useful for protocols that require a server send data first, such as ftp: or nntp:

- AcceptFilter nntp none +AcceptFilter nntp none

The default protocol names are https for port 443 - and http for all other ports. To specify another protocol - is being used with a listening port, add the protocol + and http for all other ports. To specify that another + protocol is being used with a listening port, add the protocol argument to the Listen directive.

@@ -67,7 +67,7 @@ AcceptFilter https dataready sends it to the server. See the accf_http(9) man page for more details. Since HTTPS requests are - encrypted only the + encrypted, only the accf_data(9) filter is used.

The default values on Linux are:

@@ -189,7 +189,7 @@ AcceptFilter https data -

While processing a request the server looks for +

While processing a request, the server looks for the first existing configuration file from this list of names in every directory of the path to the document, if distributed configuration files are enabled for that @@ -199,11 +199,11 @@ AcceptFilter https data AccessFileName .acl -

before returning the document +

Before returning the document /usr/local/web/index.html, the server will read /.acl, /usr/.acl, /usr/local/.acl and /usr/local/web/.acl - for directives, unless they have been disabled with

+ for directives unless they have been disabled with:

<Directory "/"> @@ -274,7 +274,7 @@ NoDecode option available in 2.3.12 and later.

The AllowEncodedSlashes directive allows URLs which contain encoded path separators (%2F for / - and additionally %5C for \ on according systems) + and additionally %5C for \ on accordant systems) to be used in the path info.

With the default value, Off, such URLs are refused @@ -309,7 +309,7 @@ NoDecode option available in 2.3.12 and later.

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

@@ -324,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.

@@ -421,16 +421,16 @@ NoDecode option available in 2.3.12 and later.
Allow use of AllowOverride option to treat syntax errors in - .htaccess as non-fatal: instead of causing an Internal Server + .htaccess as nonfatal. Instead of causing an Internal Server Error, disallowed or unrecognised directives will be ignored and a warning logged:
  • Nonfatal=Override treats directives - forbidden by AllowOverride as non-fatal.
    • + forbidden by AllowOverride as nonfatal.
  • Nonfatal=Unknown treats unknown directives - as non-fatal. This covers typos and directives implemented + as nonfatal. This covers typos and directives implemented by a module that's not present.
    • -
  • Nonfatal=All treats both the above as non-fatal.
    • +
  • Nonfatal=All treats both the above as nonfatal.

Note that a syntax error in a valid directive will still cause an internal server error.

@@ -447,8 +447,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 (but no spaces) - separated lists of options that may be set using the Options command. Implicit disabling of Options @@ -472,7 +472,7 @@ NoDecode option available in 2.3.12 and later. AllowOverride AuthConfig Indexes -

In the example above all directives that are neither in the group +

In the example above, all directives that are neither in the group AuthConfig nor Indexes cause an internal server error.

@@ -501,7 +501,7 @@ AllowOverride AuthConfig Indexes

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

@@ -527,7 +527,7 @@ AllowOverride None AllowOverrideList Redirect RedirectMatch -

In the example above only the Redirect and +

In the example above, only the Redirect and RedirectMatch directives are allowed. All others will cause an internal server error.

@@ -538,7 +538,7 @@ AllowOverride AuthConfig AllowOverrideList CookieTracking CookieName -

In the example above AllowOverride +

In the example above, AllowOverride grants permission to the AuthConfig directive grouping and AllowOverrideList grants permission to only two directives from the FileInfo directive @@ -585,8 +585,8 @@ variables

CGIPassAuth allows scripts access to HTTP authorization headers such as Authorization, which is required for scripts that implement HTTP Basic authentication. - Normally these HTTP headers are hidden from scripts, as it allows - scripts to see user ids and passwords used to access the server when + Normally these HTTP headers are hidden from scripts. This is to disallow + scripts from seeing user ids and passwords used to access the server when HTTP Basic authentication is enabled in the web server. This directive should be used when scripts are allowed to implement HTTP Basic authentication.

@@ -673,7 +673,7 @@ DefaultRuntimeDir scratch/ at build time.

Note: ServerRoot should be specified before this - directive is used, otherwise the default value of ServerRoot + directive is used. Otherwise, the default value of ServerRoot would be used to set the base directory.

 @@ -1318,7 +1318,7 @@ ErrorDocument 404 /cgi-bin/bad_urls.pl URL in an ErrorDocument 401, the client will not know to prompt the user for a password since it will not receive the 401 status code. Therefore, if you use an - ErrorDocument 401 directive then it must refer to a local + ErrorDocument 401 directive, then it must refer to a local document.

Microsoft Internet Explorer (MSIE) will by default ignore @@ -1392,7 +1392,7 @@ ErrorLog syslog:user

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

+ is similar to the syslog example above.

SECURITY: See the security tips @@ -1585,7 +1585,7 @@ ErrorLogFormat "[%t] [%l] [pid %P] %F: %E: [client %a] %M" or request. This can be used to correlate which log lines belong to the same connection or request, which request happens on which connection. A %L format string is also available in - mod_log_config, to allow to correlate access log entries + mod_log_config to allow to correlate access log entries with error log lines. If mod_unique_id is loaded, its unique id will be used as log ID for requests.

@@ -1633,12 +1633,12 @@ request

This option tracks additional data per worker about the - currently executing request, and a utilization summary; you - can see these variables during runtime by configuring + currently executing request and creates a utilization summary. + You can see these variables during runtime by configuring mod_status. Note that other modules may rely on this scoreboard.

-

This setting applies to the entire server, and cannot be +

This setting applies to the entire server and cannot be enabled or disabled on a virtualhost-by-virtualhost basis. The collection of extended status information can slow down the server. Also note that this setting cannot be changed @@ -1650,7 +1650,7 @@ request third party modules may do the same. Such modules rely on collecting detailed information about the state of all workers. The default is changed by mod_status beginning - with version 2.3.6; the previous default was always Off.

+ with version 2.3.6. The previous default was always Off.

 @@ -1719,7 +1719,7 @@ FileETag INode MTime Size changed via FileETag. Server Side Includes - An ETag is not generated for responses parsed by mod_include, + An ETag is not generated for responses parsed by mod_include since the response entity can change without a change of the INode, MTime, or Size of the static file with embedded SSI directives. @@ -2283,7 +2283,7 @@ the server configuration files encoding will be used in order to send content of unknown length over persistent connections.

-

When a client uses a Keep-Alive connection it will be counted +

When a client uses a Keep-Alive connection, it will be counted as a single "request" for the MaxConnectionsPerChild directive, regardless of how many requests are sent using the connection.

@@ -2357,7 +2357,7 @@ methods PATCH, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. The method name is - case-sensitive. If GET is used it will also + case-sensitive. If GET is used, it will also restrict HEAD requests. The TRACE method cannot be limited (see TraceEnable).

@@ -2456,8 +2456,8 @@ subrequests

The directive stores two different limits, which are evaluated on per-request basis. The first number is the maximum number of - internal redirects, that may follow each other. The second number - determines, how deep subrequests may be nested. If you specify only one + internal redirects that may follow each other. The second number + determines how deeply subrequests may be nested. If you specify only one number, it will be assigned to both limits.

@@ -2502,7 +2502,7 @@ from the client attacks.

If, for example, you are permitting file upload to a particular - location, and wish to limit the size of the uploaded file to 100K, + location and wish to limit the size of the uploaded file to 100K, you might use the following directive:

@@ -2778,7 +2778,7 @@ URLs

The Location functionality is especially useful when combined with the SetHandler - directive. For example, to enable status requests, but allow them + directive. For example, to enable status requests but allow them only from browsers at example.com, you might use:

@@ -3041,7 +3041,7 @@ LogLevel notice Note -

When logging to a regular file messages of the level +

When logging to a regular file, messages of the level notice cannot be suppressed and thus are always logged. However, this doesn't apply when logging is done using syslog.

@@ -3125,9 +3125,9 @@ LogLevel info - LogLevelOverride only affects + LogLevelOverride only affects log messages that are associated with the request or the connection. - Log messages which are associated with the server not affected. + Log messages which are associated with the server are not affected. @@ -3277,8 +3277,8 @@ or specified mutexes

The Mutex directive sets the mechanism, and optionally the lock file location, that httpd and modules use to serialize access to resources. Specify default as - the first argument to change the settings for all mutexes; specify - a mutex name (see table below) as the first argument to override + the second argument to change the settings for all mutexes; specify + a mutex name (see table below) as the second argument to override defaults only for that mutex.

The Mutex directive is typically used in @@ -3401,7 +3401,7 @@ or specified mutexes on a NFS- or AFS-filesystem. The basename of the file will be the mutex type, an optional instance string provided by the module, and unless the OmitPID keyword is specified, the process id of the httpd - parent process will be appended to to make the file name unique, avoiding + parent process will be appended to make the file name unique, avoiding conflicts when multiple httpd instances share a lock file directory. For example, if the mutex name is mpm-accept and the lock file directory is /var/httpd/locks, the lock file name for the @@ -3582,7 +3582,7 @@ directory

Indexes
- If a URL which maps to a directory is requested, and there + If a URL which maps to a directory is requested and there is no DirectoryIndex (e.g., index.html) in that directory, then mod_autoindex will return a formatted listing @@ -3633,7 +3633,7 @@ directory Note

Mixing Options with a + or - - with those without is not valid syntax, and will be + - with those without is not valid syntax and will be rejected during server startup by the syntax check with an abort.

 @@ -3684,17 +3684,20 @@ directory Protocol for a listening socket Protocol protocol server configvirtual host -On Windows only available from Apache 2.3.3 and later. +On Windows, only available from Apache 2.3.3 and later.

This directive specifies the protocol used for a specific listening socket. - The protocol is used to determine which module should handle a request, and + The protocol is used to determine which module should handle a request and to apply protocol specific optimizations with the AcceptFilter directive.

-

You only need to set the protocol if you are running on non-standard ports, otherwise http is assumed for port 80 and https for port 443.

+

You only need to set the protocol if you are running on non-standard ports; + 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 @@ -3724,13 +3727,13 @@ by Apache httpd children or max to indicate to the server that the limit should be set to the maximum allowed by the operating system configuration. Raising the maximum resource limit requires that - the server is running as root, or in the initial startup + the server is running as root or in the initial startup phase.

-

This applies to processes forked off from Apache httpd children +

This applies to processes forked from Apache httpd children servicing requests, not the Apache httpd children themselves. This includes CGI scripts and SSI exec commands, but not any - processes forked off from the Apache httpd parent such as piped + processes forked from the Apache httpd parent, such as piped logs.

CPU resource limits are expressed in seconds per @@ -3757,13 +3760,13 @@ by Apache httpd children or max to indicate to the server that the limit should be set to the maximum allowed by the operating system configuration. Raising the maximum resource limit requires that - the server is running as root, or in the initial startup + the server is running as root or in the initial startup phase.

-

This applies to processes forked off from Apache httpd children +

This applies to processes forked from Apache httpd children servicing requests, not the Apache httpd children themselves. This includes CGI scripts and SSI exec commands, but not any - processes forked off from the Apache httpd parent such as piped + processes forked from the Apache httpd parent, such as piped logs.

Memory resource limits are expressed in bytes per @@ -3785,18 +3788,18 @@ processes launched by Apache httpd children

Takes 1 or 2 parameters. The first parameter sets the soft - resource limit for all processes and the second parameter sets + resource limit for all processes, and the second parameter sets the maximum resource limit. Either parameter can be a number, or max to indicate to the server that the limit should be set to the maximum allowed by the operating system configuration. Raising the maximum resource limit requires that - the server is running as root, or in the initial startup + the server is running as root or in the initial startup phase.

-

This applies to processes forked off from Apache httpd children +

This applies to processes forked from Apache httpd children servicing requests, not the Apache httpd children themselves. This includes CGI scripts and SSI exec commands, but not any - processes forked off from the Apache httpd parent such as piped + processes forked from the Apache httpd parent, such as piped logs.

Process limits control the number of processes per user.

@@ -4212,9 +4215,8 @@ header minimal is not recommended because it makes it more difficult to debug interoperational problems. Also note that disabling the Server: header does nothing at all to make your - server more secure; the idea of "security through obscurity" + server more secure. The idea of "security through obscurity" is a myth and leads to a false sense of safety. - ServerSignature @@ -4398,9 +4400,9 @@ certain events before failing a request Note

Despite claims to the contrary, TRACE is not - a security vulnerability and there is no viable reason for + a security vulnerability, and there is no viable reason for it to be disabled. Doing so necessarily makes your server - non-compliant.

+ noncompliant.

 @@ -4420,7 +4422,7 @@ certain events before failing a request -D arguments in any startup scripts.

While this directive is supported in virtual host context, the changes it makes are visible to any later configuration - directives, beyond any enclosing virtual host

+ directives, beyond any enclosing virtual host.

@@ -4447,7 +4449,7 @@ port the client if any are supplied (otherwise it will use the canonical name, as defined above). These values are the same that are used to implement name-based virtual hosts, + href="../vhosts/name-based.html">name-based virtual hosts and are available with the same clients. The CGI variables SERVER_NAME and SERVER_PORT will be constructed from the client supplied values as well.

@@ -4455,9 +4457,9 @@ port

An example where this may be useful is on an intranet server where you have users connecting to the machine using short names such as www. You'll notice that if the users - type a shortname, and a URL which is a directory, such as + type a shortname and a URL which is a directory, such as http://www/splat, without the trailing - slash then Apache httpd will redirect them to + slash, then Apache httpd will redirect them to http://www.example.com/splat/. If you have authentication enabled, this will cause the user to have to authenticate twice (once for www and once again @@ -4470,15 +4472,15 @@ port

There is a third option, UseCanonicalName DNS, which is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a - Host: header. With this option Apache httpd does a + Host: header. With this option, Apache httpd does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs.

Warning -

If CGIs make assumptions about the values of SERVER_NAME +

If CGIs make assumptions about the values of SERVER_NAME, they may be broken by this option. The client is essentially free to give whatever value they want as a hostname. But if the CGI is - only using SERVER_NAME to construct self-referential URLs + only using SERVER_NAME to construct self-referential URLs, then it should be just fine.

 @@ -4498,11 +4500,11 @@ port

In many situations Apache httpd must construct a self-referential URL -- that is, a URL that refers back to the same server. With - UseCanonicalPhysicalPort On Apache httpd will, when + UseCanonicalPhysicalPort On, Apache httpd will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request - as a potential port. With UseCanonicalPhysicalPort Off + as a potential port. With UseCanonicalPhysicalPort Off, Apache httpd will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number.

@@ -4598,7 +4600,7 @@ hostname or IP address

Each Virtual Host must correspond to a different IP address, - different port number or a different host name for the server, + different port number, or a different host name for the server, in the former case the server machine must be configured to accept IP packets for multiple addresses. (If the machine does not have multiple network interfaces, then this can be @@ -4629,7 +4631,7 @@ hostname or IP address requested hostname. If no matching name-based virtual host is found, then the first listed virtual host that matched the IP address will be used. As a consequence, the first listed virtual host for a given IP address - and port combination is default virtual host for that IP and port + and port combination is the default virtual host for that IP and port combination.

Security @@ -4660,7 +4662,7 @@ hostname or IP address rejected by request processing in Apache HTTPD. To avoid this, modules can register non-standard HTTP methods they support. The RegisterHttpMethod allows to register such -methods manually. This can be useful for if such methods are forwared +methods manually. This can be useful if such methods are forwarded for external processing, e.g. to a CGI script.

 @@ -4677,7 +4679,7 @@ for external processing, e.g. to a CGI script.

If an issue can be detected from within the configuration, this directive can be used to generate a custom warning message. The - configuration parsing is not halted. The typical use it to check + configuration parsing is not halted. The typical use is to check whether some user define options are set, and warn if not.

@@ -4697,18 +4699,18 @@ for external processing, e.g. to a CGI script.

MergeTrailers -Determins whether trailers are merged into headers +Determines whether trailers are merged into headers MergeTrailers [on|off] MergeTrailers off server configvirtual host -2.4.10 and later +2.4.11 and later

This directive controls whether HTTP trailers are copied into the - internal representation of HTTP headers. This mergeing occurs when the + 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.10, +

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