-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
- <title>Apache module mod_autoindex</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
-
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
-
- <h1 align="CENTER">Module mod_autoindex</h1>
- The module mod_autoindex generates directory indexes,
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!--
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+-->
+<title>mod_autoindex - Apache HTTP Server</title>
+<link href="../style/manual.css" type="text/css" rel="stylesheet">
+</head>
+<body>
+<blockquote>
+<div align="center">
+<img alt="[APACHE DOCUMENTATION]" src="../images/sub.gif"><h3>Apache HTTP Server Version 2.0</h3>
+</div>
+<h1 align="center">Apache Module mod_autoindex</h1>
+<table cellspacing="1" cellpadding="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table bgcolor="#ffffff">
+<tr>
+<td><span class="help">Description:</span></td><td>
+<description>Generates directory indexes,
automatically, similar to the Unix <em>ls</em> command or the
- Win32 <em>dir</em> shell command.
-
- <p>Automatic index generation must be enabled with by the
- <code>Options</code> directive's <code><i>[+]</i>Indexes</code>
- option. See the <a
- href="core.html#options"><code>Options</code></a> directive for
- more details.</p>
-
- <p><a href="module-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="module-dict.html#SourceFile"
- rel="Help"><strong>Source File:</strong></a>
- mod_autoindex.c<br />
- <a href="module-dict.html#ModuleIdentifier"
- rel="Help"><strong>Module Identifier:</strong></a>
- autoindex_module</p>
-
- <h2>Summary</h2>
- The index of a directory can come from one of two sources:
-
- <ul>
- <li>A file written by the user, typically called
- <code>index.html</code>. The <a
- href="mod_dir.html#directoryindex">DirectoryIndex</a>
- directive sets the name of this file. This is controlled by
- <a href="mod_dir.html"><code>mod_dir</code></a>.</li>
-
- <li>Otherwise, a listing generated by the server. The other
- directives control the format of this listing. The <a
- href="#addicon">AddIcon</a>, <a
- href="#addiconbyencoding">AddIconByEncoding</a> and <a
- href="#addiconbytype">AddIconByType</a> are used to set a
- list of icons to display for various file types; for each
- file listed, the first icon listed that matches the file is
- displayed. These are controlled by
- <code>mod_autoindex</code>.</li>
- </ul>
- The two functions are separated so that you can completely
+ Win32 <em>dir</em> shell command</description>
+</td>
+</tr>
+<tr>
+<td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="module-dict.html#ModuleIdentifier" class="help">Module Identifier:</a></td><td>autoindex_module</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<h2>Summary</h2>
+<summary>
+
+<p>The index of a directory can come from one of two
+ sources:</p>
+
+
+<ul>
+
+<li>A file written by the user, typically called
+ <code>index.html</code>. The <code class="directive"><a href="mod_dir.html#directoryindex" class="directive">DirectoryIndex</a></code> directive sets the
+ name of this file. This is controlled by
+ <code><a href="mod_dir.html">mod_dir</a></code>.</li>
+
+
+<li>Otherwise, a listing generated by the server. The other
+ directives control the format of this listing. The <code class="directive"><a href="#addicon" class="directive">AddIcon</a></code>, <code class="directive"><a href="#addiconbyencoding" class="directive">AddIconByEncoding</a></code> and
+ <code class="directive"><a href="#addiconbytype" class="directive">AddIconByType</a></code> are
+ used to set a list of icons to display for various file types;
+ for each file listed, the first icon listed that matches the
+ file is displayed. These are controlled by
+ <code><a href="mod_autoindex.html">mod_autoindex</a></code>.</li>
+
+</ul>
+
+<p>The two functions are separated so that you can completely
remove (or replace) automatic index generation should you want
- to.
+ to.</p>
- <p>Automatic index generation is enabled with using
- <code>Options +Indexes</code>. See the <a
- href="core.html#options"><code>Options</code></a> directive for
+
+<p>Automatic index generation is enabled with using
+ <code>Options +Indexes</code>. See the
+ <code class="directive"><a href="core.html#options" class="directive">Options</a></code> directive for
more details.</p>
- <p>If the <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>
- option is given with the <a
- href="#indexoptions"><samp>IndexOptions</samp></a> directive,
+
+<p>If the <code class="directive"><a href="autoindex.html#fancyindexing" class="directive">FancyIndexing</a></code>
+ option is given with the <code class="directive"><a href="autoindex.html#indexoptions" class="directive">IndexOptions</a></code> directive,
the column headers are links that control the order of the
display. If you select a header link, the listing will be
regenerated, sorted by the values in that column. Selecting the
same header repeatedly toggles between ascending and descending
- order. These column header links are suppressed with <a
- href="#indexoptions">IndexOptions</a> directive's
+ order. These column header links are suppressed with
+ <code class="directive"><a href="autoindex.html#indexoptions" class="directive">IndexOptions</a></code> directive's
<samp>SuppressColumnSorting</samp> option.</p>
- <p>Note that when the display is sorted by "Size", it's the
+
+<p>Note that when the display is sorted by "Size", it's the
<em>actual</em> size of the files that's used, not the
displayed value - so a 1010-byte file will always be displayed
before a 1011-byte file (if in ascending order) even though
they both are shown as "1K".</p>
- <h2>Directives</h2>
-
- <ul>
- <li><a href="#addalt">AddAlt</a></li>
-
- <li><a href="#addaltbyencoding">AddAltByEncoding</a></li>
-
- <li><a href="#addaltbytype">AddAltByType</a></li>
-
- <li><a href="#adddescription">AddDescription</a></li>
-
- <li><a href="#addicon">AddIcon</a></li>
-
- <li><a href="#addiconbyencoding">AddIconByEncoding</a></li>
-
- <li><a href="#addiconbytype">AddIconByType</a></li>
-
- <li><a href="#defaulticon">DefaultIcon</a></li>
-
- <li><a href="#headername">HeaderName</a></li>
-
- <li><a href="#indexignore">IndexIgnore</a></li>
-
- <li><a href="#indexoptions">IndexOptions</a></li>
-
- <li><a href="#indexorderdefault">IndexOrderDefault</a></li>
-
- <li><a href="#readmename">ReadmeName</a></li>
- </ul>
-
- <p>See also: <a href="core.html#options">Options</a> and <a
- href="mod_dir.html#directoryindex">DirectoryIndex</a>.</p>
-
- <h2>Autoindex Request Query Arguments</h2>
-
- <p>Apache 2.0.23 reorganized the Query Arguments for Column
+</summary>
+<h2>Directives</h2>
+<ul>
+<li>
+<a href="#addalt">AddAlt</a>
+</li>
+<li>
+<a href="#addaltbyencoding">AddAltByEncoding</a>
+</li>
+<li>
+<a href="#addaltbytype">AddAltByType</a>
+</li>
+<li>
+<a href="#adddescription">AddDescription</a>
+</li>
+<li>
+<a href="#addicon">AddIcon</a>
+</li>
+<li>
+<a href="#addiconbyencoding">AddIconByEncoding</a>
+</li>
+<li>
+<a href="#addiconbytype">AddIconByType</a>
+</li>
+<li>
+<a href="#defaulticon">DefaultIcon</a>
+</li>
+<li>
+<a href="#headername">HeaderName</a>
+</li>
+<li>
+<a href="#indexignore">IndexIgnore</a>
+</li>
+<li>
+<a href="#indexoptions">IndexOptions</a>
+</li>
+<li>
+<a href="#indexorderdefault">IndexOrderDefault</a>
+</li>
+<li>
+<a href="#readmename">ReadmeName</a>
+</li>
+</ul>
+<h2>Autoindex Request Query Arguments</h2>
+
+
+<p>Apache 2.0.23 reorganized the Query Arguments for Column
Sorting, and introduced an entire group of new query options.
To effectively eliminate all client control over the output,
- the <
samp><a href="#indexoptions:ignoreclient">IndexOptions
- IgnoreClient</a></samp> option was introduced.</p>
+ the <
code><a href="#indexoptions:ignoreclient">IndexOptions
+ IgnoreClient</a></code> option was introduced.</p>
- <p>The column sorting headers themselves are self-referencing
+
+<p>The column sorting headers themselves are self-referencing
hyperlinks that add the sort query options shown below. Any
option below may be added to any request for the directory
resource.</p>
- <ul>
- <li><samp>C=N</samp> sorts the directory by file name</li>
+
+<ul>
+
+<li>
+<samp>C=N</samp> sorts the directory by file name</li>
- <li><samp>C=M</samp> sorts the directory by last-modified
+
+<li>
+<samp>C=M</samp> sorts the directory by last-modified
date, then file name</li>
- <li><samp>C=S</samp> sorts the directory by size, then file
+
+<li>
+<samp>C=S</samp> sorts the directory by size, then file
name</li>
- <li><samp>C=D</samp> sorts the directory by description, then
- file name<br />
+
+<li>
+<samp>C=D</samp> sorts the directory by description, then
+ file name<br>
</li>
- <li><samp>O=A</samp> sorts the listing in Ascending
+
+<li>
+<samp>O=A</samp> sorts the listing in Ascending
Order</li>
- <li><samp>O=D</samp> sorts the listing in Descending
- Order<br />
+
+<li>
+<samp>O=D</samp> sorts the listing in Descending
+ Order<br>
</li>
- <li><samp>F=0</samp> formats the listing as a simple list
+
+<li>
+<samp>F=0</samp> formats the listing as a simple list
(not FancyIndexed)</li>
- <li><samp>F=1</samp> formats the listing as a FancyIndexed
+
+<li>
+<samp>F=1</samp> formats the listing as a FancyIndexed
list</li>
- <li><samp>F=2</samp> formats the listing as an HTMLTable
- FancyIndexed list<br />
+
+<li>
+<samp>F=2</samp> formats the listing as an HTMLTable
+ FancyIndexed list<br>
</li>
- <li><samp>V=0</samp> disables version sorting</li>
+
+<li>
+<samp>V=0</samp> disables version sorting</li>
- <li><samp>V=1</samp> enables version sorting<br />
+
+<li>
+<samp>V=1</samp> enables version sorting<br>
</li>
- <li><samp>P=<em>pattern</em></samp> lists only files matching
- the given <em>pattern</em></li>
- </ul>
+
+<li>
+<samp>P=<em>pattern</em></samp> lists only files matching
+ the given <em>pattern</em>
+</li>
+
+</ul>
- <p>Note that the 'P'attern query argument is tested
+
+<p>Note that the 'P'attern query argument is tested
<em>after</em> the usual IndexIgnore directives are processed,
and all file names are still subjected to the same criteria as
any other autoindex listing. The Query Arguments parser in
encountered. The Query Arguments must be well formed, according
to the table above.</p>
- <p>The simple example below, which can be clipped and saved in
+
+<p>The simple example below, which can be clipped and saved in
a header.html file, illustrates these query options. Note that
the unknown "X" argument, for the submit button, is listed last
to assure the arguments are all parsed before mod_autoindex
encounters the X=Go input.</p>
-<pre>
-<FORM METHOD="GET">
- Show me a <SELECT NAME="F">
- <OPTION VALUE="0"> Plain list
- <OPTION VALUE="1" SELECTED> Fancy list
- <OPTION VALUE="2"> Table list
- </SELECT>
- Sorted by <SELECT NAME="C">
- <OPTION VALUE="N" SELECTED> Name
- <OPTION VALUE="M"> Date Modified
- <OPTION VALUE="S"> Size
- <OPTION VALUE="D"> Description
- </SELECT>
- <SELECT NAME="O">
- <OPTION VALUE="A" SELECTED> Ascending
- <OPTION VALUE="D"> Descending
- </SELECT>
- <SELECT NAME="V">
- <OPTION VALUE="0" SELECTED> in Normal order
- <OPTION VALUE="1"> in Version order
- </SELECT>
- Matching <INPUT TYPE="text" NAME="P" VALUE="*">
- <INPUT TYPE="submit" NAME="X" VALUE="Go">
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+<FORM METHOD="GET"><br>
+ Show me a <SELECT NAME="F"><br>
+ <OPTION VALUE="0"> Plain list <br>
+ <OPTION VALUE="1" SELECTED> Fancy list<br>
+ <OPTION VALUE="2"> Table list<br>
+ </SELECT><br>
+ Sorted by <SELECT NAME="C"><br>
+ <OPTION VALUE="N" SELECTED> Name<br>
+ <OPTION VALUE="M"> Date Modified<br>
+ <OPTION VALUE="S"> Size<br>
+ <OPTION VALUE="D"> Description<br>
+ </SELECT><br>
+ <SELECT NAME="O"><br>
+ <OPTION VALUE="A" SELECTED> Ascending<br>
+ <OPTION VALUE="D"> Descending<br>
+ </SELECT><br>
+ <SELECT NAME="V"><br>
+ <OPTION VALUE="0" SELECTED> in Normal order<br>
+ <OPTION VALUE="1"> in Version order<br>
+ </SELECT><br>
+ Matching <INPUT TYPE="text" NAME="P" VALUE="*"><br>
+ <INPUT TYPE="submit" NAME="X" VALUE="Go"><br>
</FORM>
-</pre>
- <hr />
-
- <h2><a id="addalt" name="addalt">AddAlt</a> directive</h2>
- <!--%plaintext <?INDEX {\tt AddAlt} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddAlt <em>string
- file</em> [<em>file</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex
-
- <p><em>AddAlt</em> provides the alternate text to display for a
- file, instead of an icon, for <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>.
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<hr>
+<h2>
+<a name="AddAlt">AddAlt</a> <a name="addalt">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Alternate text to display for a file, instead of an
+icon selected by filename</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>AddAlt <em>string file</em> [<em>file</em>] ...</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>
+<code class="directive">AddAlt</code> provides the alternate text to
+ display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>File</em> is a file extension, partial filename, wild-card
expression or full filename for files to describe.
<em>String</em> is enclosed in double quotes (<code>"</code>).
- This alternate text is displayed if the client is
- image-incapable, has image loading disabled, or fails to
- retrieve the icon.</p>
+ This alternate text is displayed if the client is image-incapable,
+ has image loading disabled, or fails to retrieve the icon.</p>
+
+
+<p>Examples:</p>
- <p>Examples:</p>
- <pre>
- AddAlt "PDF" *.pdf
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ AddAlt "PDF" *.pdf<br>
AddAlt "Compressed" *.gz *.zip *.Z
- </pre>
-
- <hr />
-
- <h2><a id="addaltbyencoding"
- name="addaltbyencoding">AddAltByEncoding</a> directive</h2>
- <!--%plaintext <?INDEX {\tt AddAltByEncoding} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddAltByEncoding
- <em>string MIME-encoding</em> [<em>MIME-encoding</em>]
- ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex
-
- <p><em>AddAltByEncoding</em> provides the alternate text to
- display for a file, instead of an icon, for <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>.
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+</usage>
+<hr>
+<h2>
+<a name="AddAltByEncoding">AddAltByEncoding</a> <a name="addaltbyencoding">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Alternate text to display for a file instead of an icon
+selected by MIME-encoding</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>AddAltByEncoding <em>string MIME-encoding</em>
+[<em>MIME-encoding</em>] ...</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>
+<code class="directive">AddAltByEncoding</code> provides the alternate
+ text to display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>MIME-encoding</em> is a valid content-encoding, such as
- <samp>x-compress</samp>. <em>String</em> is enclosed in double
- quotes (<code>"</code>). This alternate text is displayed if
- the client is image-incapable, has image loading disabled, or
- fails to retrieve the icon.</p>
+ <code>x-compress</code>. <em>String</em> is enclosed in double
+ quotes (<code>"</code>). This alternate text is displayed if the
+ client is image-incapable, has image loading disabled, or fails to
+ retrieve the icon.</p>
- <p>Example:</p>
- <pre>
+
+<p>Example:</p>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
AddAltByEncoding "gzip" x-gzip
- </pre>
-
- <hr />
-
- <h2><a id="addaltbytype" name="addaltbytype">AddAltByType</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt AddAltByType} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddAltByType <em>string
- MIME-type</em> [<em>MIME-type</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex
-
- <p><em>AddAltByType</em> sets the alternate text to display for
- a file, instead of an icon, for <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>.
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+</usage>
+<hr>
+<h2>
+<a name="AddAltByType">AddAltByType</a> <a name="addaltbytype">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Alternate text to display for a file, instead of an
+icon selected by MIME content-type</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>AddAltByType <em>string
+ MIME-type</em> [<em>MIME-type</em>] ...</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>
+<code class="directive">AddAltByType</code> sets the alternate text to
+ display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>MIME-type</em> is a valid content-type, such as
- <samp>text/html</samp>. <em>String</em> is enclosed in double
- quotes (<code>"</code>). This alternate text is displayed if
- the client is image-incapable, has image loading disabled, or
- fails to retrieve the icon.</p>
+ <code>text/html</code>. <em>String</em> is enclosed in double
+ quotes (<code>"</code>). This alternate text is displayed if the
+ client is image-incapable, has image loading disabled, or fails to
+ retrieve the icon.</p>
+
+
+<p>Example:</p>
- <p>Example:</p>
- <pre>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
AddAltByType "TXT" text/plain
- </pre>
- <hr />
-
- <h2><a id="adddescription"
- name="adddescription">AddDescription</a> directive</h2>
- <!--%plaintext <?INDEX {\tt AddDescription} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddDescription
- <em>string file</em> [<em>file</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex
-
- <p>This sets the description to display for a file, for
- <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>.
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+</usage>
+<hr>
+<h2>
+<a name="AddDescription">AddDescription</a> <a name="adddescription">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td></td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>AddDescription
+ <em>string file</em> [<em>file</em>] ...</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>This sets the description to display for a file, for
+ <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>File</em> is a file extension, partial filename, wild-card
expression or full filename for files to describe.
<em>String</em> is enclosed in double quotes (<code>"</code>).
Example:</p>
- <blockquote>
- <code>AddDescription "The planet Mars"
- /web/pics/mars.gif</code>
- </blockquote>
- <p>The typical, default description field is 23 bytes wide. 6
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>AddDescription "The planet Mars"
+ /web/pics/mars.gif</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<p>The typical, default description field is 23 bytes wide. 6
more bytes are added by the
<code>IndexOptions SuppressIcon</code> option, 7 bytes are
added by the <code>IndexOptions SuppressSize</code>
Therefore, the widest default the description column is ever
assigned is 55 bytes.</p>
- <p>See the <a
- href="#indexoptions:descriptionwidth">DescriptionWidth</a>
- <samp>IndexOptions</samp> keyword for details on overriding the
- size of this column, or allowing descriptions of unlimited
- length.</p>
-
- <blockquote>
- <b>Caution:</b> Descriptive text defined with
- <samp>AddDescription</samp> may contain HTML markup, such as
+
+<p>See the <a href="#indexoptions:descriptionwidth">DescriptionWidth</a>
+ <code class="directive"><a href="#indexoptions" class="directive">IndexOptions</a></code> keyword
+ for details on overriding the size of this column, or allowing
+ descriptions of unlimited length.</p>
+
+
+<blockquote>
+<table>
+<tr>
+<td bgcolor="#e0e5f5">
+<p align="center">
+<strong>Caution</strong>
+</p>
+<p>Descriptive text defined with
+ <code class="directive">AddDescription</code> may contain HTML markup, such as
tags and character entities. If the width of the description
column should happen to truncate a tagged element (such as
cutting off the end of a bolded phrase), the results may
- affect the rest of the directory listing.
- </blockquote>
- <hr />
-
- <h2><a id="addicon" name="addicon">AddIcon</a> directive</h2>
- <!--%plaintext <?INDEX {\tt AddIcon} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddIcon <em>icon
- name</em> [<em>name</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex
-
- <p>This sets the icon to display next to a file ending in
- <em>name</em> for <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>.
+ affect the rest of the directory listing.</p>
+
+</td>
+</tr>
+</table>
+</blockquote>
+
+</usage>
+<hr>
+<h2>
+<a name="AddIcon">AddIcon</a> <a name="addicon">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Icon to display for a file selected by name</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>AddIcon <em>icon
+ name</em> [<em>name</em>] ...</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>This sets the icon to display next to a file ending in
+ <em>name</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>Icon</em> is either a (%-escaped) relative URL to the icon,
or of the format (<em>alttext</em>,<em>url</em>) where
<em>alttext</em> is the text tag given for an icon for
non-graphical browsers.</p>
- <p><em>Name</em> is either ^^DIRECTORY^^ for directories,
+
+<p>
+<em>Name</em> is either ^^DIRECTORY^^ for directories,
^^BLANKICON^^ for blank lines (to format the list correctly), a
file extension, a wildcard expression, a partial filename or a
complete filename. Examples:</p>
- <blockquote>
- <code>AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm<br />
- AddIcon /icons/dir.xbm ^^DIRECTORY^^<br />
- AddIcon /icons/backup.xbm *~</code>
- </blockquote>
- <a href="#addiconbytype">AddIconByType</a> should be used in
- preference to AddIcon, when possible.
- <hr />
-
- <h2><a id="addiconbyencoding"
- name="addiconbyencoding">AddIconByEncoding</a> directive</h2>
- <!--%plaintext <?INDEX {\tt AddIconByEncoding} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddIconByEncoding
- <em>icon MIME-encoding</em> [<em>MIME-encoding</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex
-
- <p>This sets the icon to display next to files with <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>.
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+ AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm<br>
+ AddIcon /icons/dir.xbm ^^DIRECTORY^^<br>
+ AddIcon /icons/backup.xbm *~
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+
+<p>
+<code class="directive"><a href="#addiconbytype" class="directive">AddIconByType</a></code>
+ should be used in preference to <code class="directive">AddIcon</code>,
+ when possible.</p>
+
+</usage>
+<hr>
+<h2>
+<a name="AddIconByEncoding">AddIconByEncoding</a> <a name="addiconbyencoding">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Icon to display next to files selected by MIME
+content-encoding</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>AddIconByEncoding
+ <em>icon MIME-encoding</em> [<em>MIME-encoding</em>] ...</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>This sets the icon to display next to files with <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>Icon</em> is either a (%-escaped) relative URL to the icon,
or of the format (<em>alttext</em>,<em>url</em>) where
<em>alttext</em> is the text tag given for an icon for
non-graphical browsers.</p>
- <p><em>Mime-encoding</em> is a wildcard expression matching
+
+<p>
+<em>Mime-encoding</em> is a wildcard expression matching
required the content-encoding. Examples:</p>
- <blockquote>
- <code>AddIconByEncoding /icons/compress.xbm x-compress</code>
- </blockquote>
- <hr />
-
- <h2><a id="addiconbytype"
- name="addiconbytype">AddIconByType</a> directive</h2>
- <!--%plaintext <?INDEX {\tt AddIconByType} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> AddIconByType <em>icon
- MIME-type</em> [<em>MIME-type</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex
-
- <p>This sets the icon to display next to files of type
- <em>MIME-type</em> for <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>.
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>AddIconByEncoding /icons/compress.xbm x-compress</code></td>
+</tr>
+</table>
+</blockquote>
+
+</usage>
+<hr>
+<h2>
+<a name="AddIconByType">AddIconByType</a> <a name="addiconbytype">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Icon to display next to files selected by MIME
+content-type</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>AddIconByType
+ <em>icon MIME-type</em> [<em>MIME-type</em>] ...</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>This sets the icon to display next to files of type
+ <em>MIME-type</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>Icon</em> is either a (%-escaped) relative URL to the icon,
or of the format (<em>alttext</em>,<em>url</em>) where
<em>alttext</em> is the text tag given for an icon for
non-graphical browsers.</p>
- <p><em>Mime-type</em> is a wildcard expression matching
+
+<p>
+<em>Mime-type</em> is a wildcard expression matching
required the mime types. Examples:</p>
- <blockquote>
- <code>AddIconByType (IMG,/icons/image.xbm) image/*</code>
- </blockquote>
- <hr />
-
- <h2><a id="defaulticon" name="defaulticon">DefaultIcon</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt DefaultIcon} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> DefaultIcon
- <em>url</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex
-
- <p>The DefaultIcon directive sets the icon to display for files
- when no specific icon is known, for <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>.
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>AddIconByType (IMG,/icons/image.xbm) image/*</code></td>
+</tr>
+</table>
+</blockquote>
+
+</usage>
+<hr>
+<h2>
+<a name="DefaultIcon">DefaultIcon</a> <a name="defaulticon">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Icon to display for files when no specific icon is
+configured</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>DefaultIcon <em>url-path</em>
+</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>The <code class="directive">DefaultIcon</code> directive sets the icon
+ to display for files when no specific icon is known, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
<em>Url</em> is a (%-escaped) relative URL to the icon.
Examples:</p>
- <blockquote>
- <code>DefaultIcon /icon/unknown.xbm</code>
- </blockquote>
- <hr />
-
- <h2><a id="fancyindexing"
- name="fancyindexing">FancyIndexing</a> directive</h2>
- <!--%plaintext <?INDEX {\tt FancyIndexing} directive> -->
- <a href="directive-dict.html#Deprecated"
- rel="Help"><strong>Deprecated:</strong></a> See <a
- href="#indexoptions">IndexOptions</a> <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp><br />
-
-
- <p>The FancyIndexing directive was replaced by the <samp><a
- href="#indexoptions:fancyindexing">FancyIndexing</a></samp>
- option to the <a href="#indexoptions">IndexOptions</a>
- directive, and is no longer supported in Apache 2.0.</p>
- <hr />
-
- <h2><a id="headername" name="headername">HeaderName</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt HeaderName} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> HeaderName
- <em>filename</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex <br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> behavior changed
- in version 1.3.7; see text
-
- <p>The HeaderName directive sets the name of the file that will
- be inserted at the top of the index listing. <em>Filename</em>
- is the name of the file to include.</p>
-
- <blockquote>
- <strong>Changes with Apache 1.3.7:</strong> Both HeaderName
- and <a href="#readmename">ReadmeName</a> now treat
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>DefaultIcon /icon/unknown.xbm</code></td>
+</tr>
+</table>
+</blockquote>
+
+</usage>
+<hr>
+<h2>
+<a name="HeaderName">HeaderName</a> <a name="headername">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Name of the file that will be inserted at the top
+of the index listing</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>HeaderName <em>filename</em>
+</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>The <code class="directive">HeaderName</code> directive sets the name
+ of the file that will be inserted at the top of the index
+ listing. <em>Filename</em> is the name of the file to include.</p>
+
+
+<blockquote>
+<table>
+<tr>
+<td bgcolor="#e0e5f5">
+
+<p>Both HeaderName and <code class="directive"><a href="#readmename" class="directive">ReadmeName</a></code> now treat
<em>Filename</em> as a URI path relative to the one used to
access the directory being indexed. <em>Filename</em> must
resolve to a document with a major content type of
- "<samp>text/*</samp>" (<em>e.g.</em>, <samp>text/html</samp>,
- <samp>text/plain</samp>, <em>etc.</em>). This means that
+ "<code>text/*</code>" (<em>e.g.</em>, <code>text/html</code>,
+ <code>text/plain</code>, <em>etc.</em>). This means that
<em>filename</em> may refer to a CGI script if the script's
actual file type (as opposed to its output) is marked as
- <samp>text/html</samp> such as with a directive like:
-<pre>
+ <code>text/html</code> such as with a directive like:</p>
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
AddType text/html .cgi
-</pre>
- <a href="../content-negotiation.html">Content negotiation</a>
- will be performed if the <samp>MultiViews</samp> <a
- href="core.html#options">option</a> is enabled. If
- <em>filename</em> resolves to a static <samp>text/html</samp>
- document (not a CGI script) and the <samp>Includes</samp> <a
- href="core.html#options">option</a> is enabled, the file will
- be processed for server-side includes (see the <a
- href="mod_include.html"><samp>mod_include</samp></a>
- documentation).
- </blockquote>
-
- <p>If the file specified by <samp>HeaderName</samp> contains
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+<p>
+<a href="../content-negotiation.html">Content negotiation</a>
+ will be performed if the <code>MultiViews</code> <code class="directive"><a href="core.html#option" class="directive">Option</a></code> is enabled. If
+ <em>filename</em> resolves to a static <code>text/html</code>
+ document (not a CGI script) and the <code>Includes</code>
+ <code class="directive"><a href="core.html#option" class="directive">option</a></code> is enabled, the file
+ will be processed for server-side includes (see the
+ <code><a href="mod_include.html">mod_include</a></code> documentation).</p>
+
+</td>
+</tr>
+</table>
+</blockquote>
+
+
+<p>If the file specified by <code class="directive">HeaderName</code> contains
the beginnings of an HTML document (<HTML>, <HEAD>,
- etc) then you will probably want to set <a
- href="#indexoptions:suppresshtmlpreamble"><samp>IndexOptions
- +SuppressHTMLPreamble</samp></a>, so that these tags are not
+ etc) then you will probably want to set <a href="#indexoptions:suppresshtmlpreamble"><code>IndexOptions
+ +SuppressHTMLPreamble</code></a>, so that these tags are not
repeated.</p>
- <p>See also <a href="#readmename">ReadmeName</a>.</p>
- <hr />
-
- <h2><a id="indexignore" name="indexignore">IndexIgnore</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt IndexIgnore} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> IndexIgnore
- <em>file</em> [<em>file</em>] ...<br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex
-
- <p>The IndexIgnore directive adds to the list of files to hide
- when listing a directory. <em>File</em> is a file extension,
- partial filename, wildcard expression or full filename for
- files to ignore. Multiple IndexIgnore directives add to the
- list, rather than the replacing the list of ignored files. By
- default, the list contains `<code>.</code>'. Example:</p>
-
- <blockquote>
- <code>IndexIgnore README .htaccess *~</code>
- </blockquote>
- <hr />
-
- <h2><a id="indexoptions" name="indexoptions">IndexOptions</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt IndexOptions} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> IndexOptions
- [+|-]<em>option</em> [[+|-]<em>option</em>] ... (Apache 1.3.3
- and later) <br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex <br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> '+/-' syntax and
- merging of multiple <samp>IndexOptions</samp> directives is
- only available with Apache 1.3.3 and later; specific options
- are listed below.
-
- <p>The IndexOptions directive specifies the behavior of the
- directory indexing. <em>Option</em> can be one of</p>
-
- <dl>
- <dt><a id="indexoptions:descriptionwidth"
- name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
- | *] (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a></dt>
-
- <dd>The <samp>DescriptionWidth</samp> keyword allows you to
+</usage>
+<hr>
+<h2>
+<a name="IndexIgnore">IndexIgnore</a> <a name="indexignore">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Adds to the list of files to hide when listing
+a directory</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>IndexIgnore <em>file</em> [<em>file</em>] ...</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>The <code class="directive">IndexIgnore</code> directive adds to the
+ list of files to hide when listing a directory. <em>File</em> is a
+ file extension, partial filename, wildcard expression or full
+ filename for files to ignore. Multiple IndexIgnore directives add
+ to the list, rather than the replacing the list of ignored
+ files. By default, the list contains
+ `<code>.</code>'. Example:</p>
+
+
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>IndexIgnore README .htaccess *~</code></td>
+</tr>
+</table>
+</blockquote>
+
+</usage>
+<hr>
+<h2>
+<a name="IndexOptions">IndexOptions</a> <a name="indexoptions">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Various configuration settings for directory
+indexing</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>IndexOptions [+|-]<em>option</em> [[+|-]<em>option</em>] ...</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>The <code class="directive">IndexOptions</code> directive specifies the
+ behavior of the directory indexing. <em>Option</em> can be one
+ of</p>
+
+
+<dl>
+
+<dt>
+<a id="indexoptions:descriptionwidth" name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
+ | *] (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a>
+</dt>
+
+
+<dd>The <code>DescriptionWidth</code> keyword allows you to
specify the width of the description column in
characters.</dd>
- <dd><samp>-DescriptionWidth</samp> (or unset) allows
+
+<dd>
+<code>-DescriptionWidth</code> (or unset) allows
mod_autoindex to calculate the best width.</dd>
- <dd><samp>DescriptionWidth=n</samp> fixes the column width to
+
+<dd>
+<code>DescriptionWidth=n</code> fixes the column width to
n bytes wide.</dd>
- <dd><samp>DescriptionWidth=*</samp> grows the column to the
+
+<dd>
+<code>DescriptionWidth=*</code> grows the column to the
width necessary to accommodate the longest description
string.</dd>
- <dd><b>See the section on <a
- href="#adddescription"><samp>AddDescription</samp></a> for
- dangers inherent in truncating descriptions.</b></dd>
+
+<dd>
+<b>See the section on <code class="directive"><a href="#adddescription" class="directive">AddDescription</a></code> for dangers
+ inherent in truncating descriptions.</b>
+</dd>
- <dt><a id="indexoptions:fancyindexing"
- name="indexoptions:fancyindexing">FancyIndexing</a></dt>
+
+<dt>
+<a id="indexoptions:fancyindexing" name="indexoptions:fancyindexing">FancyIndexing</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt FancyIndexing} index option> -->
+
+<dd>
This turns on fancy indexing of directories.</dd>
- <dt><a id="indexoptions:foldersfirst"
- name="indexoptions:foldersfirst">FoldersFirst (<i>Apache
- 1.3.10 or 2.0.23 and later</i>)</a></dt>
+
+<dt>
+<a id="indexoptions:foldersfirst" name="indexoptions:foldersfirst">FoldersFirst (<i>Apache
+ 1.3.10 or 2.0.23 and later</i>)</a>
+</dt>
- <dd>If this option is enabled, subdirectory listings will
+
+<dd>If this option is enabled, subdirectory listings will
<i>always</i> appear first, followed by normal files in the
directory. The listing is basically broken into two
components, the files and the subdirectories, and each is
sorted separately and then displayed subdirectories-first.
For instance, if the sort order is descending by name, and
- <samp>FoldersFirst</samp> is enabled, subdirectory
- <samp>Zed</samp> will be listed before subdirectory
- <samp>Beta</samp>, which will be listed before normal files
- <samp>Gamma</samp> and <samp>Alpha</samp>. <b>This option
- only has an effect if <a
- href="#indexoptions:fancyindexing"><samp>FancyIndexing</samp></a>
- is also enabled.</b></dd>
-
- <dt><a id="indexoptions:htmltable"
- name="indexoptions:htmltable">HTMLTable</a> <i>(Experimental,
- Apache 2.0.23 and later)</i></dt>
-
- <dd>
- <!--%plaintext <?INDEX {\tt HTMLTable} index option> -->
+ <code>FoldersFirst</code> is enabled, subdirectory
+ <code>Zed</code> will be listed before subdirectory
+ <code>Beta</code>, which will be listed before normal files
+ <code>Gamma</code> and <code>Alpha</code>. <b>This option
+ only has an effect if <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
+ is also enabled.</b>
+</dd>
+
+
+<dt>
+<a id="indexoptions:htmltable" name="indexoptions:htmltable">HTMLTable</a> <i>(Experimental,
+ Apache 2.0.23 and later)</i>
+</dt>
+
+
+<dd>
This experimental option with FancyIndexing constructs a
simple table for the fancy directory listing. Note this will
confuse older browsers. It is particularly necessary if file
left-to-right and right-to-left reading order, as can happen
on WinNT or other utf-8 enabled platforms.</dd>
- <dt><a id="indexoptions:iconsarelinks"
- name="indexoptions:iconsarelinks">IconsAreLinks</a></dt>
+
+<dt>
+<a id="indexoptions:iconsarelinks" name="indexoptions:iconsarelinks">IconsAreLinks</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt IconsAreLinks} index option> -->
+
+<dd>
This makes the icons part of the anchor for the filename, for
fancy indexing.</dd>
- <dt><a id="indexoptions:iconheight"
- name="indexoptions:iconheight">IconHeight[=pixels]
- (<em>Apache 1.3 and later</em>)</a></dt>
+
+<dt>
+<a id="indexoptions:iconheight" name="indexoptions:iconheight">IconHeight[=pixels]
+ (<em>Apache 1.3 and later</em>)</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt IconHeight} index option> -->
+
+<dd>
Presence of this option, when used with IconWidth, will cause
- the server to include <samp>HEIGHT</samp> and
- <samp>WIDTH</samp> attributes in the <samp>IMG</samp> tag for
+ the server to include <code>HEIGHT</code> and
+ <code>WIDTH</code> attributes in the <code>IMG</code> tag for
the file icon. This allows browser to precalculate the page
layout without having to wait until all the images have been
loaded. If no value is given for the option, it defaults to
the standard height of the icons supplied with the Apache
software.</dd>
- <dt><a id="indexoptions:iconwidth"
- name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
- 1.3 and later</em>)</a></dt>
+
+<dt>
+<a id="indexoptions:iconwidth" name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
+ 1.3 and later</em>)</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt IconWidth} index option> -->
+
+<dd>
Presence of this option, when used with IconHeight, will
- cause the server to include <samp>HEIGHT</samp> and
- <samp>WIDTH</samp> attributes in the <samp>IMG</samp> tag for
+ cause the server to include <code>HEIGHT</code> and
+ <code>WIDTH</code> attributes in the <code>IMG</code> tag for
the file icon. This allows browser to precalculate the page
layout without having to wait until all the images have been
loaded. If no value is given for the option, it defaults to
the standard width of the icons supplied with the Apache
software.</dd>
- <dt><a id="indexoptions:ignoreclient"
- name="indexoptions:ignoreclient">IgnoreClient</a></dt>
+
+<dt>
+<a id="indexoptions:ignoreclient" name="indexoptions:ignoreclient">IgnoreClient</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt IgnoreClient} index option> -->
+
+<dd>
This option causes mod_autoindex to ignore all query
variables from the client, including sort order (implies
- <samp><a
- href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></samp>.)</dd>
+ <code><a href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></code>.)</dd>
- <dt><a id="indexoptions:namewidth"
- name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
- (<em>Apache 1.3.2 and later</em>)</a></dt>
+
+<dt>
+<a id="indexoptions:namewidth" name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
+ (<em>Apache 1.3.2 and later</em>)</a>
+</dt>
- <dd>The NameWidth keyword allows you to specify the width of
+
+<dd>The NameWidth keyword allows you to specify the width of
the filename column in bytes.</dd>
- <dd><samp>-NameWidth</samp> (or unset) allows mod_autoindex
+
+<dd>
+<code>-NameWidth</code> (or unset) allows mod_autoindex
to calculate the best width.</dd>
- <dd><samp>NameWidth=n</samp> fixes the column width to n
+
+<dd>
+<code>NameWidth=n</code> fixes the column width to n
bytes wide.</dd>
- <dd><samp>NameWidth=*</samp> grows the column to the
+
+<dd>
+<code>NameWidth=*</code> grows the column to the
necessary width.</dd>
- <dt><a id="indexoptions:scanhtmltitles"
- name="indexoptions:scanhtmltitles">ScanHTMLTitles</a></dt>
+
+<dt>
+<a id="indexoptions:scanhtmltitles" name="indexoptions:scanhtmltitles">ScanHTMLTitles</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt ScanHTMLTitles} index option> -->
+
+<dd>
This enables the extraction of the title from HTML documents
for fancy indexing. If the file does not have a description
given by <a href="#adddescription">AddDescription</a> then
httpd will read the document for the value of the TITLE tag.
This is CPU and disk intensive.</dd>
- <dt><a id="indexoptions:suppresscolumnsorting"
- name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
+
+<dt>
+<a id="indexoptions:suppresscolumnsorting" name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
(<em>Apache 1.3 and later</em>)</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt SuppressColumnSorting} index option> -->
+
+<dd>
If specified, Apache will not make the column headings in a
FancyIndexed directory listing into links for sorting. The
default behavior is for them to be links; selecting the
column heading will sort the directory listing by the values
in that column. <strong>Prior to Apache 2.0.23, this also
disabled parsing the Query Arguments for the sort
- string.</strong> That behavior is now controlled by <a
- href="#indexoptions:ignoreclient">IndexOptions
+ string.</strong> That behavior is now controlled by <a href="#indexoptions:ignoreclient">IndexOptions
IgnoreClient</a> in Apache 2.0.23.</dd>
- <dt><a id="indexoptions:suppressdescription"
- name="indexoptions:suppressdescription">SuppressDescription</a></dt>
+
+<dt>
+<a id="indexoptions:suppressdescription" name="indexoptions:suppressdescription">SuppressDescription</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt SuppressDescription} index option> -->
+
+<dd>
This will suppress the file description in fancy indexing
listings. By default, no file descriptions are defined, and
so the use of this option will regain 23 characters of screen
- space to use for something else. See <a
- href="#adddescription"><samp>AddDescription</samp></a> for
+ space to use for something else. See <a href="#adddescription"><code>AddDescription</code></a> for
information about setting the file description. See also the
- <a
- href="#indexoptions:descriptionwidth"><samp>DescriptionWidth</samp></a>
+ <a href="#indexoptions:descriptionwidth"><code>DescriptionWidth</code></a>
index option to limit the size of the description
column.</dd>
- <dt><a id="indexoptions:suppresshtmlpreamble"
- name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
+
+<dt>
+<a id="indexoptions:suppresshtmlpreamble" name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
(<em>Apache 1.3 and later</em>)</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt SuppressHTMLPreamble} index option> -->
- If the directory actually contains a file specified by the <a
- href="#headername">HeaderName</a> directive, the module
- usually includes the contents of the file after a standard
- HTML preamble (<HTML>, <HEAD>, <em>et
- cetera</em>). The SuppressHTMLPreamble option disables this
- behaviour, causing the module to start the display with the
- header file contents. The header file must contain
- appropriate HTML instructions in this case. If there is no
- header file, the preamble is generated as usual.</dd>
-
- <dt><a id="indexoptions:suppressicon"
- name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
+
+<dd>
+ If the directory actually contains a file specified by the
+ <code class="directive"><a href="#headername" class="directive">HeaderName</a></code>
+ directive, the module usually includes the contents of the file
+ after a standard HTML preamble (<HTML>, <HEAD>,
+ <em>et cetera</em>). The SuppressHTMLPreamble option disables
+ this behaviour, causing the module to start the display with the
+ header file contents. The header file must contain appropriate
+ HTML instructions in this case. If there is no header file, the
+ preamble is generated as usual.</dd>
+
+
+<dt>
+<a id="indexoptions:suppressicon" name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
2.0.23 and later</em>)</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt SuppressIcon} index option> -->
+
+<dd>
This will suppress the icon in fancy indexing listings.
Combining both <em>SuppressIcon</em> and
<em>SuppressRules</em> yields proper HTML 3.2 output, which
by the final specification prohibits IMG and HR tags from the
PRE block (used to format FancyIndexed listings.)</dd>
- <dt><a id="indexoptions:suppresslastmodified"
- name="indexoptions:suppresslastmodified">SuppressLastModified</a></dt>
+
+<dt>
+<a id="indexoptions:suppresslastmodified" name="indexoptions:suppresslastmodified">SuppressLastModified</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt SuppressLastModified} index option> -->
+
+<dd>
This will suppress the display of the last modification date,
in fancy indexing listings.</dd>
- <dt><a id="indexoptions:suppressrules"
- name="indexoptions:suppressrules">SuppressRules</a>
+
+<dt>
+<a id="indexoptions:suppressrules" name="indexoptions:suppressrules">SuppressRules</a>
(<em>Apache 2.0.23 and later</em>)</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt SuppressRules} index option> -->
+
+<dd>
This will suppress the horizontal rule lines (HR tags) in
directory listings. Combining both <em>SuppressIcon</em> and
<em>SuppressRules</em> yeilds proper HTML 3.2 output, which
by the final specification prohibits IMG and HR tags from the
PRE block (used to format FancyIndexed listings.)</dd>
- <dt><a id="indexoptions:suppresssize"
- name="indexoptions:suppresssize">SuppressSize</a></dt>
+
+<dt>
+<a id="indexoptions:suppresssize" name="indexoptions:suppresssize">SuppressSize</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt SuppressSize} index option> -->
+
+<dd>
This will suppress the file size in fancy indexing
listings.</dd>
- <dt><a id="indexoptions:trackmodified"
- name="indexoptions:trackmodified">TrackModified (<em>Apache
- 1.3.15 or 2.0.23 and later</em>)</a></dt>
+
+<dt>
+<a id="indexoptions:trackmodified" name="indexoptions:trackmodified">TrackModified (<em>Apache
+ 1.3.15 or 2.0.23 and later</em>)</a>
+</dt>
- <dd>
- <!--%plaintext <?INDEX {\tt TrackModified} index option> -->
+
+<dd>
This returns the Last-Modified and ETag values for the listed
directory in the HTTP header. It is only valid if the
operating system and file system return appropriate stat()
Last-Modified header on all Unix platforms.</strong> If this
is a concern, leave this option disabled.</dd>
- <dt><a id="indexoptions:versionsort"
- name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
- and later</em>)</a></dt>
+
+<dt>
+<a id="indexoptions:versionsort" name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
+ and later</em>)</a>
+</dt>
- <dd>
+
+<dd>
The VersionSort keyword causes files containing version
numbers to sort in a natural way. Strings are sorted as
usual, except that substrings of digits in the name and
description are compared according to their numeric value.
For example:
- <blockquote>
-<pre>
-foo-1.7
-foo-1.7.2
-foo-1.7.12
-foo-1.8.2
-foo-1.8.2a
-foo-1.12
-</pre>
- </blockquote>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+foo-1.7<br>
+foo-1.7.2<br>
+foo-1.7.12<br>
+foo-1.8.2<br>
+foo-1.8.2a<br>
+foo-1.12<br>
+
+</code></td>
+</tr>
+</table>
+</blockquote>
If the number starts with a zero, then it is considered to
be a fraction:
- <blockquote>
-<pre>
-foo-1.001
-foo-1.002
-foo-1.030
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>
+foo-1.001<br>
+foo-1.002<br>
+foo-1.030<br>
foo-1.04
-</pre>
- </blockquote>
- </dd>
-
- <dd>
- <h3>Incremental IndexOptions</h3>
- </dd>
-
- <dd>
+</code></td>
+</tr>
+</table>
+</blockquote>
+
+</dd>
+
+
+<dd>
+
+<h3>Incremental IndexOptions</h3>
+
+</dd>
+
+
+<dd>
Apache 1.3.3 introduced some significant changes in the
- handling of <samp>IndexOptions</samp> directives. In
- particular,<br />
- <br />
+ handling of <code class="directive">IndexOptions</code> directives. In
+ particular,<br>
+
+<br>
- <ul>
- <li>Multiple <samp>IndexOptions</samp> directives for a
+
+<ul>
+
+<li>Multiple <code class="directive">IndexOptions</code> directives for a
single directory are now merged together. The result of
the example above will now be the equivalent of
<code>IndexOptions FancyIndexing ScanHTMLTitles</code>.</li>
- <li>The addition of the incremental syntax
+
+<li>The addition of the incremental syntax
(<em>i.e.</em>, prefixing keywords with '+' or '-').</li>
- </ul>
- <br />
+
+</ul>
+
+<br>
Whenever a '+' or '-' prefixed keyword is encountered, it
- is applied to the current <samp>IndexOptions</samp>
+ is applied to the current <code class="directive">IndexOptions</code>
settings (which may have been inherited from an upper-level
directory). However, whenever an unprefixed keyword is
processed, it clears all inherited options and any
incremental settings encountered so far. Consider the
following example:
- <blockquote>
- <code>IndexOptions +ScanHTMLTitles -IconsAreLinks
- FancyIndexing<br />
- IndexOptions +SuppressSize<br />
- </code>
- </blockquote>
+<blockquote>
+<table cellpadding="10">
+<tr>
+<td bgcolor="#eeeeee"><code>IndexOptions +ScanHTMLTitles -IconsAreLinks
+ FancyIndexing<br>
+ IndexOptions +SuppressSize<br>
+
+</code></td>
+</tr>
+</table>
+</blockquote>
The net effect is equivalent to
<code>IndexOptions FancyIndexing +SuppressSize</code>,
because the unprefixed <code>FancyIndexing</code> discarded
the incremental keywords before it, but allowed them to
- start accumulating again afterward.<br />
- <br />
- To unconditionally set the <code>IndexOptions</code> for a
+ start accumulating again afterward.<br>
+
+<br>
+ To unconditionally set the <code class="directive">IndexOptions</code> for a
particular directory, clearing the inherited settings,
specify keywords without any '+' or '-' prefixes.
</dd>
- </dl>
- <hr />
-
- <h2><a id="indexorderdefault"
- name="indexorderdefault">IndexOrderDefault</a> directive</h2>
- <!--%plaintext <?INDEX {\tt IndexOrderDefault} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> IndexOrderDefault
- Ascending|Descending Name|Date|Size|Description <br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess <br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes <br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base <br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex <br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a>
- IndexOrderDefault is only available in Apache 1.3.4 and later.
-
- <p>The <samp>IndexOrderDefault</samp> directive is used in
- combination with the <a
- href="#indexoptions:fancyindexing"><samp>FancyIndexing</samp></a>
+
+</dl>
+
+</usage>
+<hr>
+<h2>
+<a name="IndexOrderDefault">IndexOrderDefault</a> <a name="indexorderdefault">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td>Sets the default ordering of the directory index</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>IndexOrderDefault
+Ascending|Descending Name|Date|Size|Description</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>The <code class="directive">IndexOrderDefault</code> directive is used
+ in combination with the <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
index option. By default, fancyindexed directory listings are
displayed in ascending order by filename; the
- <samp>IndexOrderDefault</samp> allows you to change this
- initial display order.</p>
-
- <p><samp>IndexOrderDefault</samp> takes two arguments. The
- first must be either <samp>Ascending</samp> or
- <samp>Descending</samp>, indicating the direction of the sort.
- The second argument must be one of the keywords
- <samp>Name</samp>, <samp>Date</samp>, <samp>Size</samp>, or
- <samp>Description</samp>, and identifies the primary key. The
- secondary key is <em>always</em> the ascending filename.</p>
-
- <p>You can force a directory listing to only be displayed in a
- particular order by combining this directive with the <a
- href="#indexoptions:suppresscolumnsorting"><samp>SuppressColumnSorting</samp></a>
+ <code class="directive">IndexOrderDefault</code> allows you to change this initial
+ display order.</p>
+
+
+<p>
+<code class="directive">IndexOrderDefault</code> takes two
+ arguments. The first must be either <code>Ascending</code> or
+ <code>Descending</code>, indicating the direction of the sort.
+ The second argument must be one of the keywords <code>Name</code>,
+ <code>Date</code>, <code>Size</code>, or <code>Description</code>,
+ and identifies the primary key. The secondary key is
+ <em>always</em> the ascending filename.</p>
+
+
+<p>You can force a directory listing to only be displayed in a
+ particular order by combining this directive with the <a href="#indexoptions:suppresscolumnsorting"><code>SuppressColumnSorting</code></a>
index option; this will prevent the client from requesting the
directory listing in a different order.</p>
- <hr />
-
- <h2><a id="readmename" name="readmename">ReadmeName</a>
- directive</h2>
- <!--%plaintext <?INDEX {\tt ReadmeName} directive> -->
- <a href="directive-dict.html#Syntax"
- rel="Help"><strong>Syntax:</strong></a> ReadmeName
- <em>filename</em><br />
- <a href="directive-dict.html#Context"
- rel="Help"><strong>Context:</strong></a> server config, virtual
- host, directory, .htaccess<br />
- <a href="directive-dict.html#Override"
- rel="Help"><strong>Override:</strong></a> Indexes<br />
- <a href="directive-dict.html#Status"
- rel="Help"><strong>Status:</strong></a> Base<br />
- <a href="directive-dict.html#Module"
- rel="Help"><strong>Module:</strong></a> mod_autoindex <br />
- <a href="directive-dict.html#Compatibility"
- rel="Help"><strong>Compatibility:</strong></a> some features
- only available after 1.3.6; see <a
- href="#headername">HeaderName</a>
-
- <p>The ReadmeName directive sets the name of the file that will
- be appended to the end of the index listing. <em>Filename</em>
- is the name of the file to include, and is taken to be relative
- to the location being indexed.</p>
-
- <p>See also <a href="#headername">HeaderName</a>, where this
- behavior is described in greater detail.</p>
-
- <p><!--#include virtual="footer.html" -->
- </p>
- </body>
-</html>
+</usage>
+<hr>
+<h2>
+<a name="ReadmeName">ReadmeName</a> <a name="readmename">Directive</a>
+</h2>
+<table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc">
+<tr>
+<td>
+<table width="100%" bgcolor="#ffffff">
+<tr>
+<td><strong>Description: </strong></td><td></td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>
+<syntax>ReadmeName <em>filename</em>
+</syntax>
+</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>server config, virtual host, directory, .htaccess</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>Indexes</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Base</td>
+</tr>
+<tr>
+<td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_autoindex</td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+<usage>
+
+<p>The <code class="directive">ReadmeName</code> directive sets the name
+ of the file that will be appended to the end of the index
+ listing. <em>Filename</em> is the name of the file to include, and
+ is taken to be relative to the location being indexed.</p>
+
+
+<p>See also <code class="directive"><a href="#headername" class="directive">HeaderName</a></code>, where this behavior
+ is described in greater detail.</p>
+
+</usage>
+<hr>
+<h3 align="center">Apache HTTP Server Version 2.0</h3>
+<a href="./"><img alt="Index" src="../images/index.gif"></a><a href="../"><img alt="Home" src="../images/home.gif"></a>
+</blockquote>
+</body>
+</html>
--- /dev/null
+<?xml version="1.0"?>
+<!DOCTYPE xml:manual [ <!ENTITY nbsp " "> ]>
+<?xml-stylesheet type="text/xsl" href="../style/manual.xsl"?>
+<modulesynopsis>
+<name>mod_autoindex</name>
+
+<description>Generates directory indexes,
+ automatically, similar to the Unix <em>ls</em> command or the
+ Win32 <em>dir</em> shell command</description>
+<status>Base</status>
+<sourcefile>mod_autoindex.c</sourcefile>
+<identifier>autoindex_module</identifier>
+
+<summary>
+ <p>The index of a directory can come from one of two
+ sources:</p>
+
+ <ul>
+ <li>A file written by the user, typically called
+ <code>index.html</code>. The <directive
+ module="mod_dir">DirectoryIndex</directive> directive sets the
+ name of this file. This is controlled by
+ <module>mod_dir</module>.</li>
+
+ <li>Otherwise, a listing generated by the server. The other
+ directives control the format of this listing. The <directive
+ module="mod_autoindex">AddIcon</directive>, <directive
+ module="mod_autoindex">AddIconByEncoding</directive> and
+ <directive module="mod_autoindex">AddIconByType</directive> are
+ used to set a list of icons to display for various file types;
+ for each file listed, the first icon listed that matches the
+ file is displayed. These are controlled by
+ <module>mod_autoindex</module>.</li>
+ </ul>
+ <p>The two functions are separated so that you can completely
+ remove (or replace) automatic index generation should you want
+ to.</p>
+
+ <p>Automatic index generation is enabled with using
+ <code>Options +Indexes</code>. See the
+ <directive module="core">Options</directive> directive for
+ more details.</p>
+
+ <p>If the <directive module="autoindex">FancyIndexing</directive>
+ option is given with the <directive module="autoindex"
+ >IndexOptions</directive> directive,
+ the column headers are links that control the order of the
+ display. If you select a header link, the listing will be
+ regenerated, sorted by the values in that column. Selecting the
+ same header repeatedly toggles between ascending and descending
+ order. These column header links are suppressed with
+ <directive module="autoindex">IndexOptions</directive> directive's
+ <samp>SuppressColumnSorting</samp> option.</p>
+
+ <p>Note that when the display is sorted by "Size", it's the
+ <em>actual</em> size of the files that's used, not the
+ displayed value - so a 1010-byte file will always be displayed
+ before a 1011-byte file (if in ascending order) even though
+ they both are shown as "1K".</p>
+</summary>
+
+<section><title>Autoindex Request Query Arguments</title>
+
+ <p>Apache 2.0.23 reorganized the Query Arguments for Column
+ Sorting, and introduced an entire group of new query options.
+ To effectively eliminate all client control over the output,
+ the <code><a href="#indexoptions:ignoreclient">IndexOptions
+ IgnoreClient</a></code> option was introduced.</p>
+
+ <p>The column sorting headers themselves are self-referencing
+ hyperlinks that add the sort query options shown below. Any
+ option below may be added to any request for the directory
+ resource.</p>
+
+ <ul>
+ <li><samp>C=N</samp> sorts the directory by file name</li>
+
+ <li><samp>C=M</samp> sorts the directory by last-modified
+ date, then file name</li>
+
+ <li><samp>C=S</samp> sorts the directory by size, then file
+ name</li>
+
+ <li><samp>C=D</samp> sorts the directory by description, then
+ file name<br />
+ </li>
+
+ <li><samp>O=A</samp> sorts the listing in Ascending
+ Order</li>
+
+ <li><samp>O=D</samp> sorts the listing in Descending
+ Order<br />
+ </li>
+
+ <li><samp>F=0</samp> formats the listing as a simple list
+ (not FancyIndexed)</li>
+
+ <li><samp>F=1</samp> formats the listing as a FancyIndexed
+ list</li>
+
+ <li><samp>F=2</samp> formats the listing as an HTMLTable
+ FancyIndexed list<br />
+ </li>
+
+ <li><samp>V=0</samp> disables version sorting</li>
+
+ <li><samp>V=1</samp> enables version sorting<br />
+ </li>
+
+ <li><samp>P=<em>pattern</em></samp> lists only files matching
+ the given <em>pattern</em></li>
+ </ul>
+
+ <p>Note that the 'P'attern query argument is tested
+ <em>after</em> the usual IndexIgnore directives are processed,
+ and all file names are still subjected to the same criteria as
+ any other autoindex listing. The Query Arguments parser in
+ mod_autoindex will stop abruptly when an unrecognized option is
+ encountered. The Query Arguments must be well formed, according
+ to the table above.</p>
+
+ <p>The simple example below, which can be clipped and saved in
+ a header.html file, illustrates these query options. Note that
+ the unknown "X" argument, for the submit button, is listed last
+ to assure the arguments are all parsed before mod_autoindex
+ encounters the X=Go input.</p>
+
+<example>
+<FORM METHOD="GET"><br />
+ Show me a <SELECT NAME="F"><br />
+ <OPTION VALUE="0"> Plain list <br />
+ <OPTION VALUE="1" SELECTED> Fancy list<br />
+ <OPTION VALUE="2"> Table list<br />
+ </SELECT><br />
+ Sorted by <SELECT NAME="C"><br />
+ <OPTION VALUE="N" SELECTED> Name<br />
+ <OPTION VALUE="M"> Date Modified<br />
+ <OPTION VALUE="S"> Size<br />
+ <OPTION VALUE="D"> Description<br />
+ </SELECT><br />
+ <SELECT NAME="O"><br />
+ <OPTION VALUE="A" SELECTED> Ascending<br />
+ <OPTION VALUE="D"> Descending<br />
+ </SELECT><br />
+ <SELECT NAME="V"><br />
+ <OPTION VALUE="0" SELECTED> in Normal order<br />
+ <OPTION VALUE="1"> in Version order<br />
+ </SELECT><br />
+ Matching <INPUT TYPE="text" NAME="P" VALUE="*"><br />
+ <INPUT TYPE="submit" NAME="X" VALUE="Go"><br />
+</FORM>
+</example>
+
+</section>
+
+<directivesynopsis>
+<name>AddAlt</name>
+<description>Alternate text to display for a file, instead of an
+icon selected by filename</description>
+<syntax>AddAlt <em>string file</em> [<em>file</em>] ...</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p><directive>AddAlt</directive> provides the alternate text to
+ display for a file, instead of an icon, for <code><a
+ href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
+ <em>File</em> is a file extension, partial filename, wild-card
+ expression or full filename for files to describe.
+ <em>String</em> is enclosed in double quotes (<code>"</code>).
+ This alternate text is displayed if the client is image-incapable,
+ has image loading disabled, or fails to retrieve the icon.</p>
+
+ <p>Examples:</p>
+<example>
+ AddAlt "PDF" *.pdf<br />
+ AddAlt "Compressed" *.gz *.zip *.Z
+</example>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>AddAltByEncoding</name>
+<description>Alternate text to display for a file instead of an icon
+selected by MIME-encoding</description>
+<syntax>AddAltByEncoding <em>string MIME-encoding</em>
+[<em>MIME-encoding</em>] ...</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p><directive>AddAltByEncoding</directive> provides the alternate
+ text to display for a file, instead of an icon, for <code><a
+ href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
+ <em>MIME-encoding</em> is a valid content-encoding, such as
+ <code>x-compress</code>. <em>String</em> is enclosed in double
+ quotes (<code>"</code>). This alternate text is displayed if the
+ client is image-incapable, has image loading disabled, or fails to
+ retrieve the icon.</p>
+
+ <p>Example:</p>
+<example>
+ AddAltByEncoding "gzip" x-gzip
+</example>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>AddAltByType</name>
+<description>Alternate text to display for a file, instead of an
+icon selected by MIME content-type</description>
+<syntax>AddAltByType <em>string
+ MIME-type</em> [<em>MIME-type</em>] ...</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p><directive>AddAltByType</directive> sets the alternate text to
+ display for a file, instead of an icon, for <code><a
+ href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
+ <em>MIME-type</em> is a valid content-type, such as
+ <code>text/html</code>. <em>String</em> is enclosed in double
+ quotes (<code>"</code>). This alternate text is displayed if the
+ client is image-incapable, has image loading disabled, or fails to
+ retrieve the icon.</p>
+
+ <p>Example:</p>
+<example>
+ AddAltByType "TXT" text/plain
+</example>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>AddDescription</name>
+<syntax>AddDescription
+ <em>string file</em> [<em>file</em>] ...</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>This sets the description to display for a file, for
+ <code><a
+ href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
+ <em>File</em> is a file extension, partial filename, wild-card
+ expression or full filename for files to describe.
+ <em>String</em> is enclosed in double quotes (<code>"</code>).
+ Example:</p>
+
+<example>AddDescription "The planet Mars"
+ /web/pics/mars.gif</example>
+
+ <p>The typical, default description field is 23 bytes wide. 6
+ more bytes are added by the
+ <code>IndexOptions SuppressIcon</code> option, 7 bytes are
+ added by the <code>IndexOptions SuppressSize</code>
+ option, and 19 bytes are added by the
+ <code>IndexOptions SuppressLastModified</code> option.
+ Therefore, the widest default the description column is ever
+ assigned is 55 bytes.</p>
+
+ <p>See the <a
+ href="#indexoptions:descriptionwidth">DescriptionWidth</a>
+ <directive module="mod_autoindex">IndexOptions</directive> keyword
+ for details on overriding the size of this column, or allowing
+ descriptions of unlimited length.</p>
+
+<note><title>Caution</title> <p>Descriptive text defined with
+ <directive>AddDescription</directive> may contain HTML markup, such as
+ tags and character entities. If the width of the description
+ column should happen to truncate a tagged element (such as
+ cutting off the end of a bolded phrase), the results may
+ affect the rest of the directory listing.</p>
+</note>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>AddIcon</name>
+<description>Icon to display for a file selected by name</description>
+<syntax>AddIcon <em>icon
+ name</em> [<em>name</em>] ...</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>This sets the icon to display next to a file ending in
+ <em>name</em> for <code><a
+ href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
+ <em>Icon</em> is either a (%-escaped) relative URL to the icon,
+ or of the format (<em>alttext</em>,<em>url</em>) where
+ <em>alttext</em> is the text tag given for an icon for
+ non-graphical browsers.</p>
+
+ <p><em>Name</em> is either ^^DIRECTORY^^ for directories,
+ ^^BLANKICON^^ for blank lines (to format the list correctly), a
+ file extension, a wildcard expression, a partial filename or a
+ complete filename. Examples:</p>
+
+<example>
+ AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm<br />
+ AddIcon /icons/dir.xbm ^^DIRECTORY^^<br />
+ AddIcon /icons/backup.xbm *~
+</example>
+
+ <p><directive module="mod_autoindex">AddIconByType</directive>
+ should be used in preference to <directive>AddIcon</directive>,
+ when possible.</p>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>AddIconByEncoding</name>
+<description>Icon to display next to files selected by MIME
+content-encoding</description>
+<syntax>AddIconByEncoding
+ <em>icon MIME-encoding</em> [<em>MIME-encoding</em>] ...</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>This sets the icon to display next to files with <code><a
+ href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
+ <em>Icon</em> is either a (%-escaped) relative URL to the icon,
+ or of the format (<em>alttext</em>,<em>url</em>) where
+ <em>alttext</em> is the text tag given for an icon for
+ non-graphical browsers.</p>
+
+ <p><em>Mime-encoding</em> is a wildcard expression matching
+ required the content-encoding. Examples:</p>
+
+<example>AddIconByEncoding /icons/compress.xbm x-compress</example>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>AddIconByType</name>
+<description>Icon to display next to files selected by MIME
+content-type</description>
+<syntax>AddIconByType
+ <em>icon MIME-type</em> [<em>MIME-type</em>] ...</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>This sets the icon to display next to files of type
+ <em>MIME-type</em> for <code><a
+ href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
+ <em>Icon</em> is either a (%-escaped) relative URL to the icon,
+ or of the format (<em>alttext</em>,<em>url</em>) where
+ <em>alttext</em> is the text tag given for an icon for
+ non-graphical browsers.</p>
+
+ <p><em>Mime-type</em> is a wildcard expression matching
+ required the mime types. Examples:</p>
+
+<example>AddIconByType (IMG,/icons/image.xbm) image/*</example>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>DefaultIcon</name>
+<description>Icon to display for files when no specific icon is
+configured</description>
+<syntax>DefaultIcon <em>url-path</em></syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>The <directive>DefaultIcon</directive> directive sets the icon
+ to display for files when no specific icon is known, for <code><a
+ href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
+ <em>Url</em> is a (%-escaped) relative URL to the icon.
+ Examples:</p>
+<example>DefaultIcon /icon/unknown.xbm</example>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>HeaderName</name>
+<description>Name of the file that will be inserted at the top
+of the index listing</description>
+<syntax>HeaderName <em>filename</em></syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>The <directive>HeaderName</directive> directive sets the name
+ of the file that will be inserted at the top of the index
+ listing. <em>Filename</em> is the name of the file to include.</p>
+
+<note>
+ <p>Both HeaderName and <directive
+ module="mod_autoindex">ReadmeName</directive> now treat
+ <em>Filename</em> as a URI path relative to the one used to
+ access the directory being indexed. <em>Filename</em> must
+ resolve to a document with a major content type of
+ "<code>text/*</code>" (<em>e.g.</em>, <code>text/html</code>,
+ <code>text/plain</code>, <em>etc.</em>). This means that
+ <em>filename</em> may refer to a CGI script if the script's
+ actual file type (as opposed to its output) is marked as
+ <code>text/html</code> such as with a directive like:</p>
+<example>
+ AddType text/html .cgi
+</example>
+ <p><a href="../content-negotiation.html">Content negotiation</a>
+ will be performed if the <code>MultiViews</code> <directive
+ module="core">Option</directive> is enabled. If
+ <em>filename</em> resolves to a static <code>text/html</code>
+ document (not a CGI script) and the <code>Includes</code>
+ <directive module="core">option</directive> is enabled, the file
+ will be processed for server-side includes (see the
+ <module>mod_include</module> documentation).</p>
+</note>
+
+ <p>If the file specified by <directive>HeaderName</directive> contains
+ the beginnings of an HTML document (<HTML>, <HEAD>,
+ etc) then you will probably want to set <a
+ href="#indexoptions:suppresshtmlpreamble"><code>IndexOptions
+ +SuppressHTMLPreamble</code></a>, so that these tags are not
+ repeated.</p>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>IndexIgnore</name>
+<description>Adds to the list of files to hide when listing
+a directory</description>
+<syntax>IndexIgnore <em>file</em> [<em>file</em>] ...</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>The <directive>IndexIgnore</directive> directive adds to the
+ list of files to hide when listing a directory. <em>File</em> is a
+ file extension, partial filename, wildcard expression or full
+ filename for files to ignore. Multiple IndexIgnore directives add
+ to the list, rather than the replacing the list of ignored
+ files. By default, the list contains
+ `<code>.</code>'. Example:</p>
+
+<example>IndexIgnore README .htaccess *~</example>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>IndexOptions</name>
+<description>Various configuration settings for directory
+indexing</description>
+<syntax>IndexOptions [+|-]<em>option</em> [[+|-]<em>option</em>] ...</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>The <directive>IndexOptions</directive> directive specifies the
+ behavior of the directory indexing. <em>Option</em> can be one
+ of</p>
+
+ <dl>
+ <dt><a id="indexoptions:descriptionwidth"
+ name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
+ | *] (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a></dt>
+
+ <dd>The <code>DescriptionWidth</code> keyword allows you to
+ specify the width of the description column in
+ characters.</dd>
+
+ <dd><code>-DescriptionWidth</code> (or unset) allows
+ mod_autoindex to calculate the best width.</dd>
+
+ <dd><code>DescriptionWidth=n</code> fixes the column width to
+ n bytes wide.</dd>
+
+ <dd><code>DescriptionWidth=*</code> grows the column to the
+ width necessary to accommodate the longest description
+ string.</dd>
+
+ <dd><b>See the section on <directive
+ module="mod_autoindex">AddDescription</directive> for dangers
+ inherent in truncating descriptions.</b></dd>
+
+ <dt><a id="indexoptions:fancyindexing"
+ name="indexoptions:fancyindexing">FancyIndexing</a></dt>
+
+ <dd>
+ This turns on fancy indexing of directories.</dd>
+
+ <dt><a id="indexoptions:foldersfirst"
+ name="indexoptions:foldersfirst">FoldersFirst (<i>Apache
+ 1.3.10 or 2.0.23 and later</i>)</a></dt>
+
+ <dd>If this option is enabled, subdirectory listings will
+ <i>always</i> appear first, followed by normal files in the
+ directory. The listing is basically broken into two
+ components, the files and the subdirectories, and each is
+ sorted separately and then displayed subdirectories-first.
+ For instance, if the sort order is descending by name, and
+ <code>FoldersFirst</code> is enabled, subdirectory
+ <code>Zed</code> will be listed before subdirectory
+ <code>Beta</code>, which will be listed before normal files
+ <code>Gamma</code> and <code>Alpha</code>. <b>This option
+ only has an effect if <a
+ href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
+ is also enabled.</b></dd>
+
+ <dt><a id="indexoptions:htmltable"
+ name="indexoptions:htmltable">HTMLTable</a> <i>(Experimental,
+ Apache 2.0.23 and later)</i></dt>
+
+ <dd>
+ This experimental option with FancyIndexing constructs a
+ simple table for the fancy directory listing. Note this will
+ confuse older browsers. It is particularly necessary if file
+ names or description text will alternate between
+ left-to-right and right-to-left reading order, as can happen
+ on WinNT or other utf-8 enabled platforms.</dd>
+
+ <dt><a id="indexoptions:iconsarelinks"
+ name="indexoptions:iconsarelinks">IconsAreLinks</a></dt>
+
+ <dd>
+ This makes the icons part of the anchor for the filename, for
+ fancy indexing.</dd>
+
+ <dt><a id="indexoptions:iconheight"
+ name="indexoptions:iconheight">IconHeight[=pixels]
+ (<em>Apache 1.3 and later</em>)</a></dt>
+
+ <dd>
+ Presence of this option, when used with IconWidth, will cause
+ the server to include <code>HEIGHT</code> and
+ <code>WIDTH</code> attributes in the <code>IMG</code> tag for
+ the file icon. This allows browser to precalculate the page
+ layout without having to wait until all the images have been
+ loaded. If no value is given for the option, it defaults to
+ the standard height of the icons supplied with the Apache
+ software.</dd>
+
+ <dt><a id="indexoptions:iconwidth"
+ name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
+ 1.3 and later</em>)</a></dt>
+
+ <dd>
+ Presence of this option, when used with IconHeight, will
+ cause the server to include <code>HEIGHT</code> and
+ <code>WIDTH</code> attributes in the <code>IMG</code> tag for
+ the file icon. This allows browser to precalculate the page
+ layout without having to wait until all the images have been
+ loaded. If no value is given for the option, it defaults to
+ the standard width of the icons supplied with the Apache
+ software.</dd>
+
+ <dt><a id="indexoptions:ignoreclient"
+ name="indexoptions:ignoreclient">IgnoreClient</a></dt>
+
+ <dd>
+ This option causes mod_autoindex to ignore all query
+ variables from the client, including sort order (implies
+ <code><a
+ href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></code>.)</dd>
+
+ <dt><a id="indexoptions:namewidth"
+ name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
+ (<em>Apache 1.3.2 and later</em>)</a></dt>
+
+ <dd>The NameWidth keyword allows you to specify the width of
+ the filename column in bytes.</dd>
+
+ <dd><code>-NameWidth</code> (or unset) allows mod_autoindex
+ to calculate the best width.</dd>
+
+ <dd><code>NameWidth=n</code> fixes the column width to n
+ bytes wide.</dd>
+
+ <dd><code>NameWidth=*</code> grows the column to the
+ necessary width.</dd>
+
+ <dt><a id="indexoptions:scanhtmltitles"
+ name="indexoptions:scanhtmltitles">ScanHTMLTitles</a></dt>
+
+ <dd>
+ This enables the extraction of the title from HTML documents
+ for fancy indexing. If the file does not have a description
+ given by <a href="#adddescription">AddDescription</a> then
+ httpd will read the document for the value of the TITLE tag.
+ This is CPU and disk intensive.</dd>
+
+ <dt><a id="indexoptions:suppresscolumnsorting"
+ name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
+ (<em>Apache 1.3 and later</em>)</dt>
+
+ <dd>
+ If specified, Apache will not make the column headings in a
+ FancyIndexed directory listing into links for sorting. The
+ default behavior is for them to be links; selecting the
+ column heading will sort the directory listing by the values
+ in that column. <strong>Prior to Apache 2.0.23, this also
+ disabled parsing the Query Arguments for the sort
+ string.</strong> That behavior is now controlled by <a
+ href="#indexoptions:ignoreclient">IndexOptions
+ IgnoreClient</a> in Apache 2.0.23.</dd>
+
+ <dt><a id="indexoptions:suppressdescription"
+ name="indexoptions:suppressdescription">SuppressDescription</a></dt>
+
+ <dd>
+ This will suppress the file description in fancy indexing
+ listings. By default, no file descriptions are defined, and
+ so the use of this option will regain 23 characters of screen
+ space to use for something else. See <a
+ href="#adddescription"><code>AddDescription</code></a> for
+ information about setting the file description. See also the
+ <a
+ href="#indexoptions:descriptionwidth"><code>DescriptionWidth</code></a>
+ index option to limit the size of the description
+ column.</dd>
+
+ <dt><a id="indexoptions:suppresshtmlpreamble"
+ name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
+ (<em>Apache 1.3 and later</em>)</dt>
+
+ <dd>
+ If the directory actually contains a file specified by the
+ <directive module="mod_autoindex">HeaderName</directive>
+ directive, the module usually includes the contents of the file
+ after a standard HTML preamble (<HTML>, <HEAD>,
+ <em>et cetera</em>). The SuppressHTMLPreamble option disables
+ this behaviour, causing the module to start the display with the
+ header file contents. The header file must contain appropriate
+ HTML instructions in this case. If there is no header file, the
+ preamble is generated as usual.</dd>
+
+ <dt><a id="indexoptions:suppressicon"
+ name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
+ 2.0.23 and later</em>)</dt>
+
+ <dd>
+ This will suppress the icon in fancy indexing listings.
+ Combining both <em>SuppressIcon</em> and
+ <em>SuppressRules</em> yields proper HTML 3.2 output, which
+ by the final specification prohibits IMG and HR tags from the
+ PRE block (used to format FancyIndexed listings.)</dd>
+
+ <dt><a id="indexoptions:suppresslastmodified"
+ name="indexoptions:suppresslastmodified">SuppressLastModified</a></dt>
+
+ <dd>
+ This will suppress the display of the last modification date,
+ in fancy indexing listings.</dd>
+
+ <dt><a id="indexoptions:suppressrules"
+ name="indexoptions:suppressrules">SuppressRules</a>
+ (<em>Apache 2.0.23 and later</em>)</dt>
+
+ <dd>
+ This will suppress the horizontal rule lines (HR tags) in
+ directory listings. Combining both <em>SuppressIcon</em> and
+ <em>SuppressRules</em> yeilds proper HTML 3.2 output, which
+ by the final specification prohibits IMG and HR tags from the
+ PRE block (used to format FancyIndexed listings.)</dd>
+
+ <dt><a id="indexoptions:suppresssize"
+ name="indexoptions:suppresssize">SuppressSize</a></dt>
+
+ <dd>
+ This will suppress the file size in fancy indexing
+ listings.</dd>
+
+ <dt><a id="indexoptions:trackmodified"
+ name="indexoptions:trackmodified">TrackModified (<em>Apache
+ 1.3.15 or 2.0.23 and later</em>)</a></dt>
+
+ <dd>
+ This returns the Last-Modified and ETag values for the listed
+ directory in the HTTP header. It is only valid if the
+ operating system and file system return appropriate stat()
+ results. Some Unix systems do so, as do OS2's JFS and Win32's
+ NTFS volumes. OS2 and Win32 FAT volumes, for example, do not.
+ Once this feature is enabled, the client or proxy can track
+ changes to the list of files when they perform a HEAD
+ request. Note some operating systems correctly track new and
+ removed files, but do not track changes for sizes or dates of
+ the files within the directory. <strong>Changes to the size
+ or date stamp of an existing file will not update the
+ Last-Modified header on all Unix platforms.</strong> If this
+ is a concern, leave this option disabled.</dd>
+
+ <dt><a id="indexoptions:versionsort"
+ name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
+ and later</em>)</a></dt>
+
+ <dd>
+ The VersionSort keyword causes files containing version
+ numbers to sort in a natural way. Strings are sorted as
+ usual, except that substrings of digits in the name and
+ description are compared according to their numeric value.
+ For example:
+
+<example>
+foo-1.7<br />
+foo-1.7.2<br />
+foo-1.7.12<br />
+foo-1.8.2<br />
+foo-1.8.2a<br />
+foo-1.12<br />
+</example>
+ If the number starts with a zero, then it is considered to
+ be a fraction:
+
+<example>
+foo-1.001<br />
+foo-1.002<br />
+foo-1.030<br />
+foo-1.04
+</example>
+ </dd>
+
+ <dd>
+ <h3>Incremental IndexOptions</h3>
+ </dd>
+
+ <dd>
+ Apache 1.3.3 introduced some significant changes in the
+ handling of <directive>IndexOptions</directive> directives. In
+ particular,<br />
+ <br />
+
+
+ <ul>
+ <li>Multiple <directive>IndexOptions</directive> directives for a
+ single directory are now merged together. The result of
+ the example above will now be the equivalent of
+ <code>IndexOptions FancyIndexing ScanHTMLTitles</code>.</li>
+
+ <li>The addition of the incremental syntax
+ (<em>i.e.</em>, prefixing keywords with '+' or '-').</li>
+ </ul>
+ <br />
+ Whenever a '+' or '-' prefixed keyword is encountered, it
+ is applied to the current <directive>IndexOptions</directive>
+ settings (which may have been inherited from an upper-level
+ directory). However, whenever an unprefixed keyword is
+ processed, it clears all inherited options and any
+ incremental settings encountered so far. Consider the
+ following example:
+
+<example>IndexOptions +ScanHTMLTitles -IconsAreLinks
+ FancyIndexing<br />
+ IndexOptions +SuppressSize<br />
+</example>
+ The net effect is equivalent to
+ <code>IndexOptions FancyIndexing +SuppressSize</code>,
+ because the unprefixed <code>FancyIndexing</code> discarded
+ the incremental keywords before it, but allowed them to
+ start accumulating again afterward.<br />
+ <br />
+ To unconditionally set the <directive>IndexOptions</directive> for a
+ particular directory, clearing the inherited settings,
+ specify keywords without any '+' or '-' prefixes.
+ </dd>
+ </dl>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>IndexOrderDefault</name>
+<description>Sets the default ordering of the directory index</description>
+<syntax>IndexOrderDefault
+Ascending|Descending Name|Date|Size|Description</syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>The <directive>IndexOrderDefault</directive> directive is used
+ in combination with the <a
+ href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
+ index option. By default, fancyindexed directory listings are
+ displayed in ascending order by filename; the
+ <directive>IndexOrderDefault</directive> allows you to change this initial
+ display order.</p>
+
+ <p><directive>IndexOrderDefault</directive> takes two
+ arguments. The first must be either <code>Ascending</code> or
+ <code>Descending</code>, indicating the direction of the sort.
+ The second argument must be one of the keywords <code>Name</code>,
+ <code>Date</code>, <code>Size</code>, or <code>Description</code>,
+ and identifies the primary key. The secondary key is
+ <em>always</em> the ascending filename.</p>
+
+ <p>You can force a directory listing to only be displayed in a
+ particular order by combining this directive with the <a
+ href="#indexoptions:suppresscolumnsorting"><code>SuppressColumnSorting</code></a>
+ index option; this will prevent the client from requesting the
+ directory listing in a different order.</p>
+</usage>
+</directivesynopsis>
+
+<directivesynopsis>
+<name>ReadmeName</name>
+<syntax>ReadmeName <em>filename</em></syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<override>Indexes</override>
+
+<usage>
+ <p>The <directive>ReadmeName</directive> directive sets the name
+ of the file that will be appended to the end of the index
+ listing. <em>Filename</em> is the name of the file to include, and
+ is taken to be relative to the location being indexed.</p>
+
+ <p>See also <directive
+ module="mod_autoindex">HeaderName</directive>, where this behavior
+ is described in greater detail.</p>
+</usage>
+</directivesynopsis>
+
+</modulesynopsis>
\ No newline at end of file
projects / apache / commitdiff