[deployment-guide/comm-rel: 513/727] Minor clean-up.
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 13:08:02 UTC 2010
commit 746171a0fb188872eaf01238d2a9298a8cff3dec
Author: Jaromir Hradilek <jhradile at redhat.com>
Date: Mon Aug 30 16:59:10 2010 +0200
Minor clean-up.
en-US/The_Apache_HTTP_Server.xml | 172 +++++++++++++++++++++-----------------
1 files changed, 95 insertions(+), 77 deletions(-)
---
diff --git a/en-US/The_Apache_HTTP_Server.xml b/en-US/The_Apache_HTTP_Server.xml
index ea5291e..33c4e1b 100644
--- a/en-US/The_Apache_HTTP_Server.xml
+++ b/en-US/The_Apache_HTTP_Server.xml
@@ -240,7 +240,7 @@ httpd (pid 19014) is running...</screen>
The default option is <filename>.htaccess</filename>.
</para>
<para>
- For security reasons, the directive is followed by the <literal>Files</literal> tag that prevents all files beginning with <filename>.ht</filename> from being accessed by web clients. This usually includes the <filename>.htaccess</filename> and <filename>.htpasswd</filename> files.
+ For security reasons, the directive is typically followed by the <literal>Files</literal> tag to prevent the files beginning with <filename>.ht</filename> from being accessed by web clients. This includes the <filename>.htaccess</filename> and <filename>.htpasswd</filename> files.
</para>
<example id="example-apache-httpdconf-accessfilename">
<title>Using the <option>AccessFileName</option> directive</title>
@@ -258,11 +258,11 @@ httpd (pid 19014) is running...</screen>
<term><option>Action</option></term>
<listitem>
<para>
- The <option>Action</option> directive allows you to specify a CGI script that is to be executed when a certain media type is requested. It takes the following form:
+ The <option>Action</option> directive allows you to specify a CGI script to be executed when a certain media type is requested. It takes the following form:
</para>
- <screen>Action <replaceable>media-type</replaceable> <replaceable>script-name</replaceable></screen>
+ <screen>Action <replaceable>content-type</replaceable> <replaceable>path</replaceable></screen>
<para>
- The <replaceable>media-type</replaceable> option has to be a valid MIME type such as <literal>text/html</literal>, <literal>image/png</literal>, <literal>application/pdf</literal> etc.
+ The <replaceable>content-type</replaceable> has to be a valid MIME type such as <literal>text/html</literal>, <literal>image/png</literal>, or <literal>application/pdf</literal>. The <replaceable>path</replaceable> refers to an existing CGI script, and must be relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/cgi-bin/process-image.cgi</literal>).
</para>
<example id="example-apache-httpdconf-action">
<title>Using the <option>Action</option> directive</title>
@@ -274,11 +274,11 @@ httpd (pid 19014) is running...</screen>
<term><option>AddDescription</option></term>
<listitem>
<para>
- The <option>AddDescription</option> directive allows you to specify a short description of a file to be displayed in server-generated directory listings. It takes the following form:
+ The <option>AddDescription</option> directive allows you to specify a short description to be displayed in server-generated directory listings for a given file. It takes the following form:
</para>
- <screen>AddDescription "<replaceable>description</replaceable>" <replaceable>pattern</replaceable>...</screen>
+ <screen>AddDescription "<replaceable>description</replaceable>" <replaceable>filename</replaceable>...</screen>
<para>
- The <replaceable>pattern</replaceable> option can be a filename, a file extension, or a wildcard expression.
+ The <replaceable>description</replaceable> should be a short text enclosed in double quotes (that is, <literal>"</literal>). The <replaceable>filename</replaceable> can be a full filename, a file extension, or a wildcard expression.
</para>
<example id="example-apache-httpdconf-adddescription">
<title>Using the <option>AddDescription</option> directive</title>
@@ -290,11 +290,14 @@ httpd (pid 19014) is running...</screen>
<term><option>AddEncoding</option></term>
<listitem>
<para>
- The <option>AddEncoding</option> directive allows you to specify an encoding type for a particular filename extension. This way, you can instruct some web browsers to uncompress certain file types as they are downloaded. The directive takes the following form:
+ The <option>AddEncoding</option> directive allows you to specify an encoding type for a particular file extension. It takes the following form:
</para>
- <screen>AddEncoding <replaceable>encoding</replaceable> <replaceable>file-extension</replaceable>...</screen>
+ <screen>AddEncoding <replaceable>encoding</replaceable> <replaceable>extension</replaceable>...</screen>
<para>
- The <replaceable>encoding</replaceable> option has to be a valid MIME encoding such as <literal>x-compress</literal>, <literal>x-gzip</literal> etc.
+ The <replaceable>encoding</replaceable> has to be a valid MIME encoding such as <literal>x-compress</literal>, <literal>x-gzip</literal>, etc. The <replaceable>extension</replaceable> is a case sensitive file extension, and is conventionally written with a leading dot (for example, <literal>.gz</literal>).
+ </para>
+ <para>
+ This directive is typically used to instruct web browsers to uncompress certain file types as they are downloaded.
</para>
<example id="example-apache-httpdconf-addencoding">
<title>Using the <option>AddEncoding</option> directive</title>
@@ -306,11 +309,14 @@ httpd (pid 19014) is running...</screen>
<term><option>AddHandler</option></term>
<listitem>
<para>
- The <option>AddHandler</option> directive allows you to map a file extension to a selected handler. This way, any file with the <filename>.cgi</filename> extension can be set to be treated as a CGI script regardless of the directory it is in. The directive takes the following form:
+ The <option>AddHandler</option> directive allows you to map certain file extensions to a selected handler. It takes the following form:
+ </para>
+ <screen>AddHandler <replaceable>handler</replaceable> <replaceable>extension</replaceable>...</screen>
+ <para>
+ The <replaceable>handler</replaceable> has to be a name of previously defined handler. The <replaceable>extension</replaceable> is a case sensitive file extension, and is conventionally written with a leading dot (for example, <literal>.cgi</literal>).
</para>
- <screen>AddHandler <replaceable>handler-name</replaceable> <replaceable>file-extension</replaceable>...</screen>
<para>
- In addition to CGI scripts, the <option>AddHandler</option> directive is commonly used to process server-parsed HTML and image-map files.
+ This directive is typically used to treat files with the <filename class="extension">.cgi</filename> extension as CGI scripts regardless of the directory they are in. Additionally, it is also commonly used to process server-parsed HTML and image-map files.
</para>
<example id="example-apache-httpdconf-addhandler">
<title>Using the <option>AddHandler</option> option</title>
@@ -322,14 +328,14 @@ httpd (pid 19014) is running...</screen>
<term><option>AddIcon</option></term>
<listitem>
<para>
- The <option>AddIcon</option> directive allows you to specify an icon to be displayed for different files in server-generated directory listings. It takes the following form:
+ The <option>AddIcon</option> directive allows you to specify an icon to be displayed for a particular file in server-generated directory listings. It takes the following form:
</para>
- <screen>AddIcon <replaceable>icon</replaceable> <replaceable>pattern</replaceable>...</screen>
+ <screen>AddIcon <replaceable>path</replaceable> <replaceable>pattern</replaceable>...</screen>
<para>
- The <replaceable>icon</replaceable> option is a path to an existing icon. The <replaceable>pattern</replaceable> can be a filename, a file extension, a wildcard expression, or a special form as described in <xref linkend="table-apache-httpdconf-addicon" />.
+ The <replaceable>path</replaceable> refers to an existing icon file, and must be relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/icons/folder.png</literal>). The <replaceable>pattern</replaceable> can be a filename, a file extension, a wildcard expression, or a special form as described in the following table:
</para>
<table id="table-apache-httpdconf-addicon">
- <title>Available options</title>
+ <title>Available <option>AddIcon</option> options</title>
<tgroup cols="2">
<colspec colname="option" colnum="1" colwidth="20*" />
<colspec colname="description" colnum="2" colwidth="60*" />
@@ -349,7 +355,7 @@ httpd (pid 19014) is running...</screen>
<option>^^DIRECTORY^^</option>
</entry>
<entry>
- A directory.
+ Represents a directory.
</entry>
</row>
<row>
@@ -357,7 +363,7 @@ httpd (pid 19014) is running...</screen>
<option>^^BLANKICON^^</option>
</entry>
<entry>
- A blank line.
+ Represents a blank line.
</entry>
</row>
</tbody>
@@ -378,9 +384,9 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<para>
The <option>AddIconByEncoding</option> directive allows you to specify an icon to be displayed for a particular encoding type in server-generated directory listings. It takes the following form:
</para>
- <screen>AddIconByEncoding <replaceable>icon</replaceable> <replaceable>encoding</replaceable>...</screen>
+ <screen>AddIconByEncoding <replaceable>path</replaceable> <replaceable>encoding</replaceable>...</screen>
<para>
- The <replaceable>icon</replaceable> option is a path to an existing icon. The <replaceable>encoding</replaceable> option has to be a valid MIME encoding such as x-compress, x-gzip etc.
+ The <replaceable>path</replaceable> refers to an existing icon file, and must be relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/icons/compressed.png</literal>). The <replaceable>encoding</replaceable> has to be a valid MIME encoding such as <literal>x-compress</literal>, <literal>x-gzip</literal>, etc.
</para>
<example id="example-apache-httpdconf-addiconbyencoding">
<title>Using the <option>AddIconByEncoding</option> directive</title>
@@ -394,9 +400,9 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<para>
The <option>AddIconByType</option> directive allows you to specify an icon to be displayed for a particular media type in server-generated directory listings. It takes the following form:
</para>
- <screen>AddIconByType <replaceable>icon</replaceable> <replaceable>media-type</replaceable>...</screen>
+ <screen>AddIconByType <replaceable>path</replaceable> <replaceable>content-type</replaceable>...</screen>
<para>
- The <replaceable>icon</replaceable> option is a path to an existing icon. The <replaceable>media-type</replaceable> option has to be a valid MIME type (such as <literal>text/html</literal>, <literal>image/png</literal>, <literal>application/pdf</literal> etc.), or a wildcard expression (such as <literal>text/*</literal>, <literal>image/*</literal>, or <literal>application/*</literal>).
+ The <replaceable>path</replaceable> refers to an existing icon file, and must be relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/icons/text.png</literal>). The <replaceable>content-type</replaceable> has to be either a valid MIME type (for example, <literal>text/html</literal> or <literal>image/png</literal>), or a wildcard expression such as <literal>text/*</literal>, <literal>image/*</literal>, etc.
</para>
<example id="example-apache-httpdconf-addiconbytype">
<title>Using the <option>AddIconByType</option> directive</title>
@@ -408,11 +414,14 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>AddLanguage</option></term>
<listitem>
<para>
- The <option>AddLanguage</option> directive allows you to associate a file extension with a specific language. This is especially useful for web servers that serve content in multiple languages based on the client's language settings. The directive takes the following form:
+ The <option>AddLanguage</option> directive allows you to associate a file extension with a specific language. It takes the following form:
</para>
<screen>AddLanguage <replaceable>language</replaceable> <replaceable>extension</replaceable>...</screen>
<para>
- The <replaceable>language</replaceable> option has to be a valide MIME language such as <literal>cs</literal>, <literal>en</literal>, or <literal>fr</literal>.
+ The <replaceable>language</replaceable> has to be a valide MIME language such as <literal>cs</literal>, <literal>en</literal>, or <literal>fr</literal>. The <replaceable>extension</replaceable> is a case sensitive file extension, and is conventionally written with a leading dot (for example, <literal>.cs</literal>).
+ </para>
+ <para>
+ This directive is especially useful for web servers that serve content in multiple languages based on the client's language settings.
</para>
<example id="example-apache-httpdconf-addlanguage">
<title>Using the <option>AddLanguage</option> directive</title>
@@ -424,11 +433,11 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>AddType</option></term>
<listitem>
<para>
- The <option>AddType</option> directive allows you to define or override a media type for a selected file extension. It takes the following form:
+ The <option>AddType</option> directive allows you to define or override the media type for a particular file extension. It takes the following form:
</para>
- <screen>AddType <replaceable>media-type</replaceable> <replaceable>extension</replaceable>...</screen>
+ <screen>AddType <replaceable>content-type</replaceable> <replaceable>extension</replaceable>...</screen>
<para>
- The <replaceable>media-type</replaceable> option has to be a valid MIME type such as <literal>text/html</literal>, <literal>image/png</literal>, <literal>application/pdf</literal> etc.
+ The <replaceable>content-type</replaceable> has to be a valid MIME type such as <literal>text/html</literal>, <literal>image/png</literal>, etc. The <replaceable>extension</replaceable> is a case sensitive file extension, and is conventionally written with a leading dot (for example, <literal>.cs</literal>).
</para>
<example id="example-apache-httpdconf-addtype">
<title>Using the <option>AddType</option> directive</title>
@@ -440,11 +449,14 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>Alias</option></term>
<listitem>
<para>
- The <option>Alias</option> directive allows you to refer to files and directories outside the default directory that is specified by the <option>DocumentRoot</option> directive. By default, only the <literal>/icons/</literal> alias is created, so that requesting <systemitem class="resource">http://<replaceable>hostname</replaceable>/icons/tar.png</systemitem> returns the <filename>/var/www/icons/tar.png</filename> file. The directive takes the following form:
+ The <option>Alias</option> directive allows you to refer to files and directories outside the default directory specified by the <option>DocumentRoot</option> directive. It takes the following form:
</para>
<screen>Alias <replaceable>url-path</replaceable> <replaceable>real-path</replaceable></screen>
<para>
- Note that the <replaceable>url-path</replaceable> option is case sensitive. The <option>Alias</option> directive is usually followed by the <literal>Directory</literal> tag containing additional permissions to access the target directory.
+ The <replaceable>url-path</replaceable> refers to an existing icon file, and must be relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/images/</literal>). The <replaceable>real-path</replaceable> is a full path to a file or directory in the local file system.
+ </para>
+ <para>
+ This directive is typically followed by the <literal>Directory</literal> tag with additional permissions to access the target directory. By default, the <literal>/icons/</literal> alias is created, so that the icons from <filename class="directory">/var/www/icons/</filename> are displayed in server-generated directory listings.
</para>
<example id="example-apache-httpdconf-alias">
<title>Using the <option>Alias</option> directive</title>
@@ -463,11 +475,11 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>Allow</option></term>
<listitem>
<para>
- The <option>Allow</option> directive allows you to specify which clients can access a given directory. It takes the following form:
+ The <option>Allow</option> directive allows you to specify which clients have permission to access a given directory. It takes the following form:
</para>
<screen>Allow from <replaceable>client</replaceable>...</screen>
<para>
- The <replaceable>client</replaceable> option can be either a domain name, an IP address (both full and partial), a <replaceable>network</replaceable>/<replaceable>netmask</replaceable> pair, or <literal>all</literal> for all clients.
+ The <replaceable>client</replaceable> can be a domain name, an IP address (both full and partial), a <replaceable>network</replaceable>/<replaceable>netmask</replaceable> pair, or <literal>all</literal> for all clients.
</para>
<example id="example-apache-httpdconf-allow">
<title>Using the <option>Allow</option> directive</title>
@@ -486,7 +498,7 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
The <replaceable>type</replaceable> has to be one of the available grouping options as described in <xref linkend="table-apache-httpdconf-allowoverride" />.
</para>
<table id="table-apache-httpdconf-allowoverride">
- <title>Available options</title>
+ <title>Available <option>AllowOverride</option> options</title>
<tgroup cols="2">
<colspec colname="option" colnum="1" colwidth="20*" />
<colspec colname="description" colnum="2" colwidth="60*" />
@@ -554,7 +566,7 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<option>Options[=<replaceable>option</replaceable>,...]</option>
</entry>
<entry>
- Allows the use of the <option>Options</option> directive. You can also provide a comma-separated list of options to specify which options can be set using this directive.
+ Allows the use of the <option>Options</option> directive. Additionally, you can provide a comma-separated list of options to customize which options can be set using this directive.
</entry>
</row>
</tbody>
@@ -572,9 +584,12 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<para>
The <option>BrowserMatch</option> directive allows you to modify the server behavior based on the client's web browser type. It takes the following form:
</para>
- <screen>BrowserMatch <replaceable>pattern</replaceable> <replaceable>environment-variable</replaceable>...</screen>
+ <screen>BrowserMatch <replaceable>pattern</replaceable> <replaceable>variable</replaceable>...</screen>
+ <para>
+ The <replaceable>pattern</replaceable> is a regular expression to match the User-Agent HTTP header field. The <replaceable>variable</replaceable> is an environment variable that is set when the header field matches the pattern.
+ </para>
<para>
- The <replaceable>environment-variable</replaceable> is an environment variable to be set when the User-Agent HTTP header field matches the <replaceable>pattern</replaceable>. By default, the web server uses this directive to deny connections to specific browsers with known issues, and to disable keepalives and HTTP header flushes for browsers that are known to have problems with these actions.
+ By default, this directive is used to deny connections to specific browsers with known issues, and to disable keepalives and HTTP header flushes for browsers that are known to have problems with these actions.
</para>
<example id="example-apache-httpdconf-browsermatch">
<title>Using the <option>BrowserMatch</option> directive</title>
@@ -588,9 +603,9 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<para>
The <option>CacheDefaultExpire</option> option allows you to set how long to cache a document that does not have any expiration date or the date of its last modification specified. It takes the following form:
</para>
- <screen>CacheDefaultExpire <replaceable>seconds</replaceable></screen>
+ <screen>CacheDefaultExpire <replaceable>time</replaceable></screen>
<para>
- The default option is <literal>3600</literal> seconds (that is, one hour).
+ The <replaceable>time</replaceable> is a number of seconds to cache a file before it expires. The default option is <literal>3600</literal> (that is, one hour).
</para>
<example id="example-apache-httpdconf-cachedefaultexpire">
<title>Using the <option>CacheDefaultExpire</option> directive</title>
@@ -604,9 +619,9 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<para>
The <option>CacheDisable</option> directive allows you to disable caching of certain URLs. It takes the following form:
</para>
- <screen>CacheDisable <replaceable>url</replaceable></screen>
+ <screen>CacheDisable <replaceable>path</replaceable></screen>
<para>
- Note that the <replaceable>url</replaceable> option is case sensitive.
+ The <replaceable>path</replaceable> must be relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/files/</literal>).
</para>
<example id="example-apache-httpdconf-cachedisable">
<title>Using the <option>CacheDisable</option> directive</title>
@@ -618,11 +633,11 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>CacheEnable</option></term>
<listitem>
<para>
- The <option>CacheEnable</option> directive allows you to specify a cache type to use for certain URLs. It takes the following form:
+ The <option>CacheEnable</option> directive allows you to specify a cache type to be used for certain URLs. It takes the following form:
</para>
<screen>CacheEnable <replaceable>type</replaceable> <replaceable>url</replaceable></screen>
<para>
- See <xref linkend="table-apache-httpdconf-cacheenable" /> for a list of valid <replaceable>type</replaceable> options.
+ The <replaceable>type</replaceable> has to be a valid cache type as described in <xref linkend="table-apache-httpdconf-cacheenable" />. The <option>url</option> can be a path relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/images/</literal>), a protocol (for example, <literal>ftp://</literal>), or an external URL such as <literal>http://example.com/</literal>.
</para>
<table id="table-apache-httpdconf-cacheenable">
<title>Available cache types</title>
@@ -677,11 +692,11 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>CacheLastModifiedFactor</option></term>
<listitem>
<para>
- The <option>CacheLastModifiedFactor</option> directive allows you to set how long to cache a document that does not have any expiration date specified, but provides information about the date of its last modification. It takes the following form:
+ The <option>CacheLastModifiedFactor</option> directive allows you to customize how long to cache a document that does not have any expiration date specified, but that provides information about the date of its last modification. It takes the following form:
</para>
- <screen>CacheLastModifiedFactor <replaceable>coefficient</replaceable></screen>
+ <screen>CacheLastModifiedFactor <replaceable>number</replaceable></screen>
<para>
- The <replaceable>coefficient</replaceable> will be used to multiply the time that passed since the last modification of the document. The default option is <literal>0.1</literal> (that is, one tenth).
+ The <replaceable>number</replaceable> is a coefficient to be used to multiply the time that passed since the last modification of the document. The default option is <literal>0.1</literal> (that is, one tenth).
</para>
<example id="example-apache-httpdconf-cachelastmodifiedfactor">
<title>Using the <option>CacheLastModifiedFactor</option> directive</title>
@@ -693,11 +708,11 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>CacheMaxExpire</option></term>
<listitem>
<para>
- The <option>CacheMaxExpire</option> directive allows you to specify how long to cache a document. It takes the following form:
+ The <option>CacheMaxExpire</option> directive allows you to specify a maximum amount of time to cache a document. It takes the following form:
</para>
- <screen>CacheMaxExpire <replaceable>seconds</replaceable></screen>
+ <screen>CacheMaxExpire <replaceable>time</replaceable></screen>
<para>
- The default option is <literal>86400</literal> seconds (that is, one day).
+ The <replaceable>time</replaceable> is a maximum number of seconds to cache a document before it expires. The default option is <literal>86400</literal> (that is, one day).
</para>
<example id="example-apache-httpdconf-cachemaxexpire">
<title>Using the <option>CacheMaxExpire</option> directive</title>
@@ -709,14 +724,14 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>CacheNegotiatedDocs</option></term>
<listitem>
<para>
- The <option>CacheNegotiatedDocs</option> directive allows you to enable caching the documents which were negotiated on the basis of content. It takes the following form:
+ The <option>CacheNegotiatedDocs</option> directive allows you to enable caching of the documents that were negotiated on the basis of content. It takes the following form:
</para>
<screen>CacheNegotiatedDocs <replaceable>option</replaceable></screen>
<para>
- For a list of valid <replaceable>option</replaceable>s, see <xref linkend="table-apache-httpdconf-cachenegotiateddocs" />. Note that since the content-negotiated documents may change over time or because of the input from the requester, this option is turned off by default.
+ The <replaceable>option</replaceable> has to be a valid boolean as described in <xref linkend="table-apache-httpdconf-cachenegotiateddocs" />. Since the content-negotiated documents may change over time or because of the input from the requester, the default option is <option>Off</option>.
</para>
<table id="table-apache-httpdconf-cachenegotiateddocs">
- <title>Available options</title>
+ <title>Available <option>CacheNegotiatedDocs</option> options</title>
<tgroup cols="2">
<colspec colname="option" colnum="1" colwidth="20*" />
<colspec colname="description" colnum="2" colwidth="60*" />
@@ -760,11 +775,11 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>CacheRoot</option></term>
<listitem>
<para>
- The <option>CacheRoot</option> directive allows you to specify the directory to store the cache files in. It takes the following form:
+ The <option>CacheRoot</option> directive allows you to specify the directory to store cache files in. It takes the following form:
</para>
<screen>CacheRoot <replaceable>directory</replaceable></screen>
<para>
- The default option is <filename class="directory">/var/cache/mod_proxy/</filename>.
+ The <replaceable>directory</replaceable> is a full path to an existing directory in the local file system. The default option is <filename class="directory">/var/cache/mod_proxy/</filename>.
</para>
<example id="example-apache-httpdconf-cacheroot">
<title>Using the <option>CacheRoot</option> directive</title>
@@ -778,9 +793,9 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<para>
The <option>CustomLog</option> directive allows you to specify the log filename and the log file format. It takes the following form:
</para>
- <screen>CustomLog <replaceable>filename</replaceable> <replaceable>format</replaceable></screen>
+ <screen>CustomLog <replaceable>path</replaceable> <replaceable>format</replaceable></screen>
<para>
- The <replaceable>filename</replaceable> is a path relative to the directory that is specified by the <option>ServerRoot</option> directive (that is, <filename class="directory">/etc/httpd/</filename> by default). The <replaceable>format</replaceable> has to be either an explicit format string, or a format name that was previously defined using the <option>LogFormat</option> directive.
+ The <replaceable>path</replaceable> refers to a log file, and must be relative to the directory that is specified by the <option>ServerRoot</option> directive (that is, <filename class="directory">/etc/httpd/</filename> by default). The <replaceable>format</replaceable> has to be either an explicit format string, or a format name that was previously defined using the <option>LogFormat</option> directive.
</para>
<example id="example-apache-httpdconf-customlog">
<title>Using the <option>CustomLog</option> directive</title>
@@ -794,9 +809,9 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<para>
The <option>DefaultIcon</option> directive allows you to specify an icon to be displayed for a file in server-generated directory listings when no other icon is associated with it. It takes the following form:
</para>
- <screen>DefaultIcon <replaceable>icon</replaceable></screen>
+ <screen>DefaultIcon <replaceable>path</replaceable></screen>
<para>
- The <replaceable>icon</replaceable> option is a path to an existing icon (that is, <filename>/icons/unknown.gif</filename> by default).
+ The <replaceable>path</replaceable> refers to an existing icon file, and must be relative to the directory specified by the <option>DocumentRoot</option> directive (for example, <literal>/icons/unknown.png</literal>).
</para>
<example id="example-apache-httpdconf-defaulticon">
<title>Using the <option>DefaultIcon</option> directive</title>
@@ -810,9 +825,9 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<para>
The <option>DefaultType</option> directive allows you to specify a media type to be used in case the proper MIME type cannot be determined by the server. It takes the following form:
</para>
- <screen>DefaultType <replaceable>media-type</replaceable></screen>
+ <screen>DefaultType <replaceable>content-type</replaceable></screen>
<para>
- The <replaceable>media-type</replaceable> option has to be a valid MIME type such as <literal>text/html</literal>, <literal>image/png</literal>, <literal>application/pdf</literal> etc.
+ The <replaceable>content-type</replaceable> has to be a valid MIME type such as <literal>text/html</literal>, <literal>image/png</literal>, <literal>application/pdf</literal>, etc.
</para>
<example id="example-apache-httpdconf-defaulttype">
<title>Using the <option>DefaultType</option> directive</title>
@@ -828,7 +843,7 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
</para>
<screen>Deny from <replaceable>client</replaceable>...</screen>
<para>
- The <replaceable>client</replaceable> option can be either a domain name, an IP address (both full and partial), a <replaceable>network</replaceable>/<replaceable>netmask</replaceable> pair, or <literal>all</literal> for all clients.
+ The <replaceable>client</replaceable> can be a domain name, an IP address (both full and partial), a <replaceable>network</replaceable>/<replaceable>netmask</replaceable> pair, or <literal>all</literal> for all clients.
</para>
<example id="example-apache-httpdconf-deny">
<title>Using the <option>Deny</option> directive</title>
@@ -840,11 +855,11 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
<term><option>DirectoryIndex</option></term>
<listitem>
<para>
- The <option>DirectoryIndex</option> directive allows you to specify a page to be served to a client when a directory is requested (that is, the URL ends with the <literal>/</literal> character). It takes the following form:
+ The <option>DirectoryIndex</option> directive allows you to specify a document to be served to a client when a directory is requested (that is, when the URL ends with the <literal>/</literal> character). It takes the following form:
</para>
- <screen>DirectoryIndex <replaceable>page</replaceable>...</screen>
+ <screen>DirectoryIndex <replaceable>filename</replaceable>...</screen>
<para>
- By default, the server looks for <filename>index.html</filename> or <filename>index.html.var</filename>.
+ The <replaceable>filename</replaceable> is a name of the file to look for in the requested directory. By default, the server looks for <filename>index.html</filename>, and <filename>index.html.var</filename>.
</para>
<example id="example-apache-httpdconf-directoryindex">
<title>Using the <option>DirectoryIndex</option> directive</title>
@@ -860,7 +875,7 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
</para>
<screen>DocumentRoot <replaceable>directory</replaceable></screen>
<para>
- The default option is <filename class="directory">/var/www/html/</filename>.
+ The <replaceable>directory</replaceable> is a full path to an existing directory in the local file system. The default option is <filename class="directory">/var/www/html/</filename>.
</para>
<example id="example-apache-httpdconf-documentroot">
<title>Using the <option>DocumentRoot</option> directive</title>
@@ -876,7 +891,7 @@ AddIcon /icons/blank.png ^^BLANKICON^^</screen>
</para>
<screen>ErrorDocument <replaceable>error-code</replaceable> <replaceable>action</replaceable></screen>
<para>
- The <replaceable>error-code</replaceable> has to be a valid code such as <literal>403</literal> (Forbidden), <literal>404</literal> (Not Found), or <literal>500</literal> (Internal Server Error). The <replaceable>action</replaceable> can either be a URL (both local and external), or a message string enclosed in double quotes (that is, <literal>"</literal>).
+ The <replaceable>error-code</replaceable> has to be a valid code such as <literal>403</literal> (Forbidden), <literal>404</literal> (Not Found), or <literal>500</literal> (Internal Server Error). The <replaceable>action</replaceable> can be either a URL (both local and external), or a message string enclosed in double quotes (that is, <literal>"</literal>).
</para>
<example id="example-apache-httpdconf-errordocument">
<title>Using the <option>ErrorDocument</option> directive</title>
@@ -891,9 +906,9 @@ ErrorDocument 404 /404-not_found.html</screen>
<para>
The <option>ErrorLog</option> directive allows you to specify a file to which the server errors are logged. It takes the following form:
</para>
- <screen>ErrorLog <replaceable>filename</replaceable></screen>
+ <screen>ErrorLog <replaceable>path</replaceable></screen>
<para>
- The default option is <filename>logs/error_log</filename>
+ The <replaceable>path</replaceable> refers to a log file, and must be relative to the directory that is specified by the <option>ServerRoot</option> directive (that is, <filename class="directory">/etc/httpd/</filename> by default). The default option is <filename>logs/error_log</filename>
</para>
<example id="example-apache-httpdconf-errorlog">
<title>Using the <option>ErrorLog</option> directive</title>
@@ -909,7 +924,7 @@ ErrorDocument 404 /404-not_found.html</screen>
</para>
<screen>ExtendedStatus <replaceable>option</replaceable></screen>
<para>
- For a list of valid <replaceable>option</replaceable>s, see <xref linkend="table-apache-httpdconf-extendedstatus" />. The default option is <option>Off</option>.
+ The <replaceable>option</replaceable> has to be a valid boolean as described in <xref linkend="table-apache-httpdconf-extendedstatus" />. The default option is <option>Off</option>.
</para>
<table id="table-apache-httpdconf-extendedstatus">
<title>Available options</title>
@@ -958,9 +973,12 @@ ErrorDocument 404 /404-not_found.html</screen>
<para>
The <option>Group</option> directive allows you to specify the group under which the <systemitem class="service">httpd</systemitem> service will run. It takes the following form:
</para>
- <screen>Group <replaceable>unix-group</replaceable></screen>
+ <screen>Group <replaceable>group</replaceable></screen>
+ <para>
+ The <replaceable>group</replaceable> has to be an existing UNIX group. The default option is <systemitem class="groupname">apache</systemitem>.
+ </para>
<para>
- The default option is <systemitem class="groupname">apache</systemitem>. Note that this directive is no longer supported inside <option><VirtualHost></option>.
+ Note that this directive is no longer supported inside <option><VirtualHost></option>.
</para>
<example id="example-apache-httpdconf-group">
<title>Using the <option>Group</option> directive</title>
@@ -976,7 +994,7 @@ ErrorDocument 404 /404-not_found.html</screen>
</para>
<screen>HeaderName <replaceable>filename</replaceable></screen>
<para>
- By default, the server looks for <filename>HEADER.html</filename>.
+ The <replaceable>filename</replaceable> is a name of the file to look for in the requested directory. By default, the server looks for <filename>HEADER.html</filename>.
</para>
<example id="example-apache-httpdconf-headername">
<title>Using the <option>HeaderName</option> directive</title>
@@ -992,10 +1010,10 @@ ErrorDocument 404 /404-not_found.html</screen>
</para>
<screen>HostnameLookups <replaceable>option</replaceable></screen>
<para>
- For a list of valid <replaceable>option</replaceable>s, see <xref linkend="table-apache-httpdconf-hostnamelookup" />. To conserve resources on the server, the default option is <option>Off</option>.
+ The <replaceable>option</replaceable> has to be a valid keyword as described in <xref linkend="table-apache-httpdconf-hostnamelookup" />. To conserve resources on the server, the default option is <option>Off</option>.
</para>
<table id="table-apache-httpdconf-hostnamelookup">
- <title>Available options</title>
+ <title>Available <option>HostnameLookups</option> options</title>
<tgroup cols="2">
<colspec colname="option" colnum="1" colwidth="20*" />
<colspec colname="description" colnum="2" colwidth="60*" />
@@ -1015,7 +1033,7 @@ ErrorDocument 404 /404-not_found.html</screen>
<option>On</option>
</entry>
<entry>
- Enables resolving the IP address for each connection so that the hostname can be logged. Hovewer, this adds processing overhead.
+ Enables resolving the IP address for each connection so that the hostname can be logged. However, this also adds a significant processing overhead.
</entry>
</row>
<row>
@@ -1038,7 +1056,7 @@ ErrorDocument 404 /404-not_found.html</screen>
</tgroup>
</table>
<para>
- Note that if the presence of hostnames is required in server log files, you can use one of the many log analyzer tools that perform the DNS lookups more efficiently and in bulk when rotating the web server log files.
+ Note that when the presence of hostnames is required in server log files, it is often possible to use one of the many log analyzer tools that perform the DNS lookups more efficiently.
</para>
<example id="example-apache-httpdconf-hostnamelookups">
<title>Using the <option>HostnameLookups</option> directive</title>
@@ -1054,7 +1072,7 @@ ErrorDocument 404 /404-not_found.html</screen>
</para>
<screen>Include <replaceable>filename</replaceable></screen>
<para>
- The <option>filename</option> option can be either an absolute path, a path relative to the directory specified by the <option>ServerRoot</option> directive, or a wildcard expression. All configuration files from the <filename class="directory">/etc/httpd/conf.d/</filename> directory are loaded by default.
+ The <option>filename</option> can be an absolute path, a path relative to the directory specified by the <option>ServerRoot</option> directive, or a wildcard expression. All configuration files from the <filename class="directory">/etc/httpd/conf.d/</filename> directory are loaded by default.
</para>
<example id="example-apache-httpdconf-include">
<title>Using the <option>Include</option> directive</title>
@@ -1066,7 +1084,7 @@ ErrorDocument 404 /404-not_found.html</screen>
<term><option>IndexIgnore</option></term>
<listitem>
<para>
- The <option>IndexIgnore</option> directive allows you to specify a list of filenames to be omitted from server-generated directory listings. It takes the following form:
+ The <option>IndexIgnore</option> directive allows you to specify a list of filenames to be omitted from the server-generated directory listings. It takes the following form:
</para>
<screen>IndexIgnore <replaceable>filename</replaceable>...</screen>
<para>
More information about the docs-commits
mailing list