[deployment-guide/comm-rel: 588/727] Updated the IndexOptions directive description.
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 13:14:26 UTC 2010
commit 268b766e4b8406ead79e6d9c5c28589f595888a8
Author: Jaromir Hradilek <jhradile at redhat.com>
Date: Mon Sep 6 15:43:29 2010 +0200
Updated the IndexOptions directive description.
en-US/The_Apache_HTTP_Server.xml | 256 +++++++++++++++++++++++++++++++++----
1 files changed, 228 insertions(+), 28 deletions(-)
---
diff --git a/en-US/The_Apache_HTTP_Server.xml b/en-US/The_Apache_HTTP_Server.xml
index 9dc3bb2..f7a6435 100644
--- a/en-US/The_Apache_HTTP_Server.xml
+++ b/en-US/The_Apache_HTTP_Server.xml
@@ -563,7 +563,7 @@ httpd (pid 19014) is running...</screen>
</row>
<row>
<entry>
- <option>Options<optional>=<replaceable>option</replaceable>,…</optional></option>
+ <option>Options</option><optional>=<replaceable>option</replaceable>,…</optional>
</entry>
<entry>
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.
@@ -1096,7 +1096,233 @@ ErrorDocument 404 /404-not_found.html</screen>
</example>
</listitem>
</varlistentry>
- <!-- TODO: Add the IndexOptions directive description here. -->
+ <varlistentry>
+ <term><option>IndexOptions</option></term>
+ <listitem>
+ <para>
+ The <option>IndexOptions</option> directive allows you to customize the behavior of server-generated directory listings. It takes the following form:
+ </para>
+ <screen>IndexOptions <replaceable>option</replaceable>…</screen>
+ <para>
+ The <replaceable>option</replaceable> has to be a valid keyword as described in <xref linkend="table-apache-httpdconf-indexoptions" />. The default options are <option>Charset=UTF-8</option>, <option>FancyIndexing</option>, <option>HTMLTable</option>, <option>NameWidth=*</option>, and <option>VersionSort</option>.
+ </para>
+ <table id="table-apache-httpdconf-indexoptions">
+ <title>Available directory listing options</title>
+ <tgroup cols="2">
+ <colspec colname="option" colnum="1" colwidth="30*" />
+ <colspec colname="description" colnum="2" colwidth="60*" />
+ <thead>
+ <row>
+ <entry>
+ Option
+ </entry>
+ <entry>
+ Description
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <option>Charset</option>=<replaceable>encoding</replaceable>
+ </entry>
+ <entry>
+ Specifies the character set of a generated web page. The <replaceable>encoding</replaceable> has to be a valid character set such as <literal>UTF-8</literal> or <literal>ISO-8859-2</literal>.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>Type</option>=<replaceable>content-type</replaceable>
+ </entry>
+ <entry>
+ Specifies the media type of a generated web page. The <replaceable>content-type</replaceable> has to be a valid MIME type such as <literal>text/html</literal> or <literal>text/plain</literal>.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>DescriptionWidth</option>=<replaceable>value</replaceable>
+ </entry>
+ <entry>
+ Specifies the width of the description column. The <replaceable>value</replaceable> can be either a number of characters, or an asterisk (that is, <literal>*</literal>) to adjust the width automatically.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>FancyIndexing</option>
+ </entry>
+ <entry>
+ Enables advanced features such as different icons for certain files or possibility to re-sort a directory listing by clicking on a column header.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>FolderFirst</option>
+ </entry>
+ <entry>
+ Enables listing directories first, always placing them above files.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>HTMLTable</option>
+ </entry>
+ <entry>
+ Enables the use of HTML tables for directory listings.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>IconsAreLinks</option>
+ </entry>
+ <entry>
+ Enables using the icons as links.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>IconHeight</option>=<replaceable>value</replaceable>
+ </entry>
+ <entry>
+ Specifies an icon height. The <replaceable>value</replaceable> is a number of pixels.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>IconWidth</option>=<replaceable>value</replaceable>
+ </entry>
+ <entry>
+ Specifies an icon width. The <replaceable>value</replaceable> is a number of pixels.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>IgnoreCase</option>
+ </entry>
+ <entry>
+ Enables sorting files and directories in a case-sensitive manner.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>IgnoreClient</option>
+ </entry>
+ <entry>
+ Disables accepting query variables from a client.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>NameWidth</option>=<replaceable>value</replaceable>
+ </entry>
+ <entry>
+ Specifies the width of the filename column. The <replaceable>value</replaceable> can be either a number of characters, or an asterisk (that is, <literal>*</literal>) to adjust the width automatically.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>ScanHTMLTitles</option>
+ </entry>
+ <entry>
+ Enables parsing the file for a description (that is, the <literal>title</literal> element) in case it is not provided by the <option>AddDescription</option> directive.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>ShowForbidden</option>
+ </entry>
+ <entry>
+ Enables listing the files with otherwise restricted access.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>SuppressColumnSorting</option>
+ </entry>
+ <entry>
+ Disables re-sorting a directory listing by clicking on a column header.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>SuppressDescription</option>
+ </entry>
+ <entry>
+ Disables reserving a space for file descriptions.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>SuppressHTMLPreamble</option>
+ </entry>
+ <entry>
+ Disables the use of standard HTML preamble when a file specified by the <option>HeaderName</option> directive is present.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>SuppressIcon</option>
+ </entry>
+ <entry>
+ Disables the use of icons in directory listings.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>SuppressLastModified</option>
+ </entry>
+ <entry>
+ Disables displaying the date of the last modification field in directory listings.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>SuppressRules</option>
+ </entry>
+ <entry>
+ Disables the use of horizontal lines in directory listings.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>SuppressSize</option>
+ </entry>
+ <entry>
+ Disables displaying the file size field in directory listings.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>TrackModified</option>
+ </entry>
+ <entry>
+ Enables returning the <literal>Last-Modified</literal> and <literal>ETag</literal> values in the HTTP header.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>VersionSort</option>
+ </entry>
+ <entry>
+ Enables sorting files that contain a version number in the expected manner.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <option>XHTML</option>
+ </entry>
+ <entry>
+ Enables the use of XHTML 1.0 instead of the default HTML 3.2.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <example id="example-apache-httpdconf-indexoptions">
+ <title>Using the <option>IndexOptions</option> directive</title>
+ <screen>IndexOptions FancyIndexing VersionSort NameWidth=* HTMLTable Charset=UTF-8</screen>
+ </example>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><option>KeepAlive</option></term>
<listitem>
@@ -2197,32 +2423,6 @@ ErrorDocument 404 /404-not_found.html</screen>
</listitem>
</varlistentry>
</variablelist>
- <formalpara id="s2-apache-indexoptions">
- <title>IndexOptions</title>
- <indexterm>
- <primary><command>IndexOptions</command></primary>
- <secondary>Apache configuration directive</secondary>
- </indexterm>
- <indexterm>
- <primary>configuration directives, Apache</primary>
- <secondary><command>IndexOptions</command></secondary>
- </indexterm>
- <para>
- <command>IndexOptions</command> controls the appearance of server generated directing listings, by adding icons, file descriptions, and so on. If <command>Options Indexes</command> is set<!-- (refer to <xref linkend="s2-apache-options" />) -->, the Web server generates a directory listing when the Web server receives an HTTP request for a directory without an index.
- </para>
- </formalpara>
- <para>
- First, the Web server looks in the requested directory for a file matching the names listed in the <command>DirectoryIndex</command> directive (usually, <filename>index.html</filename>). If an <filename>index.html</filename> file is not found, Apache HTTP Server creates an HTML directory listing of the requested directory. The appearance of this directory listing is controlled, in part, by the <command>IndexOptions</command> directive.
- </para>
- <para>
- The default configuration turns on <command>FancyIndexing</command>. This means that a user can re-sort a directory listing by clicking on column headers. Another click on the same header switches from ascending to descending order. <command>FancyIndexing</command> also shows different icons for different files, based upon file extensions.
- </para>
- <para>
- The <command>AddDescription</command> option, when used in conjunction with <command>FancyIndexing</command>, presents a short description for the file in server generated directory listings.
- </para>
- <para>
- <command>IndexOptions</command> has a number of other parameters which can be set to control the appearance of server generated directories. The <command>IconHeight</command> and <command>IconWidth</command> parameters require the server to include HTML <command>HEIGHT</command> and <command>WIDTH</command> tags for the icons in server generated webpages. The <command>IconsAreLinks</command> parameter combines the graphical icon with the HTML link anchor, which contains the URL link target.
- </para>
</section>
<section id="s2-apache-httpdconf-tags">
<title>Common <filename>httpd.conf</filename> Tags</title>
More information about the docs-commits
mailing list