mod_autoindex.html revision 2de56243b49d1c39dbc467e3f9daab152c8691b8
b6ff72be73dad3d1394cf2c71e29e67624ff030bChristian Maeder<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
beff4152e9f0fe90885458d1a1733b183a2a8816Christian Maeder XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder This file is generated from xml source: DO NOT EDIT
e6d40133bc9f858308654afb1262b8b483ec5922Till Mossakowski XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2725abe920f91de62ae5c0b7230c1627cccf5fabChristian Maeder --><title>mod_autoindex- Apache HTTP Server</title><link href="/style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img src="/images/sub.gif" alt="[APACHE DOCUMENTATION]"/><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 valign="top"><span class="help">Description:</span></td><td>Generates directory indexes,
98890889ffb2e8f6f722b00e265a211f13b5a861Corneliu-Claudiu Prodescu automatically, similar to the Unix <em>ls</em> command or the
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder Win32 <em>dir</em> shell command</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>
3f69b6948966979163bdfe8331c38833d5d90ecdChristian Maeder <p>The index of a directory can come from one of two
f3a94a197960e548ecd6520bb768cb0d547457bbChristian Maeder <li>A file written by the user, typically called
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <code>index.html</code>. The <a href="mod_dir.html#directoryindex" class="directive"><code class="directive">DirectoryIndex</code></a> directive sets the
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder name of this file. This is controlled by
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <code><a href="mod_dir.html">mod_dir</a></code>.</li>
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder <li>Otherwise, a listing generated by the server. The other
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder directives control the format of this listing. The <a href="#addicon" class="directive"><code class="directive">AddIcon</code></a>, <a href="#addiconbyencoding" class="directive"><code class="directive">AddIconByEncoding</code></a> and
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder <a href="#addiconbytype" class="directive"><code class="directive">AddIconByType</code></a> are
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder used to set a list of icons to display for various file types;
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder for each file listed, the first icon listed that matches the
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder file is displayed. These are controlled by
ea5ccb1c6e89486a54e1f4bd95840147e96093edChristian Maeder <code><a href="mod_autoindex.html">mod_autoindex</a></code>.</li>
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder <p>The two functions are separated so that you can completely
85e1d54a475bfc30b3eac5ae6c5e42a2d7e93f10Christian Maeder remove (or replace) automatic index generation should you want
91e24fc45834b35f2a3830d72565640251149bf3Christian Maeder <p>Automatic index generation is enabled with using
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder <a href="core.html#options" class="directive"><code class="directive">Options</code></a> directive for
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder more details.</p>
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder <p>If the <a href="autoindex.html#fancyindexing" class="directive"><code class="directive">FancyIndexing</code></a>
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder option is given with the <a href="autoindex.html#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> directive,
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder the column headers are links that control the order of the
0130083f314580170af1195037be3325f125fbceChristian Maeder display. If you select a header link, the listing will be
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder regenerated, sorted by the values in that column. Selecting the
0130083f314580170af1195037be3325f125fbceChristian Maeder same header repeatedly toggles between ascending and descending
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder order. These column header links are suppressed with
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder <a href="autoindex.html#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> directive's
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder <code>SuppressColumnSorting</code> option.</p>
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder <p>Note that when the display is sorted by "Size", it's the
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder <em>actual</em> size of the files that's used, not the
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder displayed value - so a 1010-byte file will always be displayed
bbba6dd86153aacb0f662b182b128df0eb09fd54Christian Maeder before a 1011-byte file (if in ascending order) even though
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder they both are shown as "1K".</p>
a461314c811f4187dff85c8be079a41b2f13f176Christian Maeder<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>
a31430de8b0632d29f42634d6395e982bf31b14dChristian Maeder <p>Apache 2.0.23 reorganized the Query Arguments for Column
109a53dbf4c9233f869f63ba7a7f3fece49973c3Christian Maeder Sorting, and introduced an entire group of new query options.
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder To effectively eliminate all client control over the output,
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder the <code><a href="#indexoptions:ignoreclient">IndexOptions
be43c3fa0292555bd126784ae27ff5c1d23438cbChristian Maeder IgnoreClient</a></code> option was introduced.</p>
16b71dad8d398af412d66a4f4763f1ada5b03d23Christian Maeder <p>The column sorting headers themselves are self-referencing
f39b8dd9651dfcc38b06191cda23cacbfc298323Christian Maeder hyperlinks that add the sort query options shown below. Any
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder option below may be added to any request for the directory
7f7460e7095628f3437b116ee78d3043d11f8febChristian Maeder resource.</p>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <li><code>C=N</code> sorts the directory by file name</li>
9d6562465b41f17c7967d4e5678f34811d958cb2Christian Maeder <li><code>C=M</code> sorts the directory by last-modified
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder date, then file name</li>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <li><code>C=S</code> sorts the directory by size, then file
16b71dad8d398af412d66a4f4763f1ada5b03d23Christian Maeder <li><code>C=D</code> sorts the directory by description, then
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder file name<br>
38c817b94e0a5b1ae94178b1075c187e07bcc5e1Christian Maeder <li><code>O=A</code> sorts the listing in Ascending
38c817b94e0a5b1ae94178b1075c187e07bcc5e1Christian Maeder <li><code>O=D</code> sorts the listing in Descending
4eb859461f8fd904f40f57261cf23e5c73cf8ecaChristian Maeder <li><code>F=0</code> formats the listing as a simple list
4eb859461f8fd904f40f57261cf23e5c73cf8ecaChristian Maeder (not FancyIndexed)</li>
4eb859461f8fd904f40f57261cf23e5c73cf8ecaChristian Maeder <li><code>F=1</code> formats the listing as a FancyIndexed
2353f65833a3da763392f771223250cd50b8d873Christian Maeder <li><code>F=2</code> formats the listing as an HTMLTable
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder FancyIndexed list<br>
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder <li><code>V=0</code> disables version sorting</li>
8c8545dd3bf34fbcbc16904b65d249658f8f9efcChristian Maeder <li><code>V=1</code> enables version sorting<br>
96ae1a1d2197d0e0d5b80da2474b64c456feb1b0Christian Maeder <li><code>P=<em>pattern</em></code> lists only files matching
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <p>Note that the 'P'attern query argument is tested
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder <em>after</em> the usual IndexIgnore directives are processed,
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder and all file names are still subjected to the same criteria as
cb2044812811d66efe038d914966e04290be93faChristian Maeder any other autoindex listing. The Query Arguments parser in
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder mod_autoindex will stop abruptly when an unrecognized option is
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder encountered. The Query Arguments must be well formed, according
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder to the table above.</p>
083bc1972a66d73749760eab3a90bf4eb9ca7951Christian Maeder <p>The simple example below, which can be clipped and saved in
6352f3c31da3043783a13be6594aacb2147378baRazvan Pascanu a header.html file, illustrates these query options. Note that
fefee7e1dee1ee5f0768a03a4abae88d1ca2c3fdRazvan Pascanu the unknown "X" argument, for the submit button, is listed last
b324cda6178c49ddeead3ce62b832ccf644cbcabRazvan Pascanu to assure the arguments are all parsed before mod_autoindex
fefee7e1dee1ee5f0768a03a4abae88d1ca2c3fdRazvan Pascanu encounters the X=Go input.</p>
966519955f5f7111abac20118563132b9dd41165Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
8c8545dd3bf34fbcbc16904b65d249658f8f9efcChristian Maeder<FORM METHOD="GET"><br>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder Show me a <SELECT NAME="F"><br>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <OPTION VALUE="0"> Plain list <br>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <OPTION VALUE="1" SELECTED> Fancy list<br>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <OPTION VALUE="2"> Table list<br>
33fcc19ef2b59493b4e91eebf701df95fd230765Christian Maeder </SELECT><br>
33fcc19ef2b59493b4e91eebf701df95fd230765Christian Maeder Sorted by <SELECT NAME="C"><br>
33fcc19ef2b59493b4e91eebf701df95fd230765Christian Maeder <OPTION VALUE="N" SELECTED> Name<br>
d4ebd9e5adc974cfa2bdf4bdd155e07be0e26f75Christian Maeder <OPTION VALUE="M"> Date Modified<br>
d4ebd9e5adc974cfa2bdf4bdd155e07be0e26f75Christian Maeder <OPTION VALUE="S"> Size<br>
d4ebd9e5adc974cfa2bdf4bdd155e07be0e26f75Christian Maeder <OPTION VALUE="D"> Description<br>
0d79ea4ed8512a802ecb6645edac141e0fbcee3fChristian Maeder </SELECT><br>
0d79ea4ed8512a802ecb6645edac141e0fbcee3fChristian Maeder <SELECT NAME="O"><br>
0d79ea4ed8512a802ecb6645edac141e0fbcee3fChristian Maeder <OPTION VALUE="A" SELECTED> Ascending<br>
a31430de8b0632d29f42634d6395e982bf31b14dChristian Maeder <OPTION VALUE="D"> Descending<br>
a31430de8b0632d29f42634d6395e982bf31b14dChristian Maeder </SELECT><br>
a31430de8b0632d29f42634d6395e982bf31b14dChristian Maeder <SELECT NAME="V"><br>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder <OPTION VALUE="0" SELECTED> in Normal order<br>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder <OPTION VALUE="1"> in Version order<br>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder </SELECT><br>
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder Matching <INPUT TYPE="text" NAME="P" VALUE="*"><br>
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder <INPUT TYPE="submit" NAME="X" VALUE="Go"><br>
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Alternate text to display for a file, instead of an
8865728716566f42fa73e7e0bc080ba3225df764Christian Maedericon selected by filename</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddAlt <em>string file</em> [<em>file</em>] ...</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>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <p><code class="directive">AddAlt</code> provides the alternate text to
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <em>File</em> is a file extension, partial filename, wild-card
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder expression or full filename for files to describe.
2360728d4185c0c04279c999941c64d36626af79Christian Maeder <em>String</em> is enclosed in double quotes (<code>"</code>).
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder This alternate text is displayed if the client is image-incapable,
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder has image loading disabled, or fails to retrieve the icon.</p>
fdac680252d7347858bd67b4c2a2aaa52e623815Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
fdac680252d7347858bd67b4c2a2aaa52e623815Christian Maeder AddAlt "PDF" *.pdf<br>
a9e804dbec424ec36e34bab955cbe90edac5baa6Christian Maeder AddAlt "Compressed" *.gz *.zip *.Z
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Alternate text to display for a file instead of an icon
b76d27eba526ecac2a20400fa505ec5c642ae7d2Dominik Lueckeselected by MIME-encoding</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddAltByEncoding <em>string MIME-encoding</em>
b76d27eba526ecac2a20400fa505ec5c642ae7d2Dominik Luecke[<em>MIME-encoding</em>] ...</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>
8a5c05062ef501bf725a86a370a5145a198e81fdKlaus Luettich <p><code class="directive">AddAltByEncoding</code> provides the alternate
8a5c05062ef501bf725a86a370a5145a198e81fdKlaus Luettich text to display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
8a5c05062ef501bf725a86a370a5145a198e81fdKlaus Luettich <em>MIME-encoding</em> is a valid content-encoding, such as
2353f65833a3da763392f771223250cd50b8d873Christian Maeder <code>x-compress</code>. <em>String</em> is enclosed in double
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder quotes (<code>"</code>). This alternate text is displayed if the
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder client is image-incapable, has image loading disabled, or fails to
2353f65833a3da763392f771223250cd50b8d873Christian Maeder retrieve the icon.</p>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder AddAltByEncoding "gzip" x-gzip
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Alternate text to display for a file, instead of an
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maedericon selected by MIME content-type</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddAltByType <em>string
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder MIME-type</em> [<em>MIME-type</em>] ...</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>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <p><code class="directive">AddAltByType</code> sets the alternate text to
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <em>MIME-type</em> is a valid content-type, such as
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <code>text/html</code>. <em>String</em> is enclosed in double
00df6fd583c19393fa141d5a0e21ac74c7bf5b19Christian Maeder quotes (<code>"</code>). This alternate text is displayed if the
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder client is image-incapable, has image loading disabled, or fails to
cb2044812811d66efe038d914966e04290be93faChristian Maeder retrieve the icon.</p>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddDescription
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <em>string file</em> [<em>file</em>] ...</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>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <p>This sets the description to display for a file, for
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <em>File</em> is a file extension, partial filename, wild-card
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder expression or full filename for files to describe.
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <em>String</em> is enclosed in double quotes (<code>"</code>).
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddDescription "The planet Mars"
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder /web/pics/mars.gif</code></td></tr></table></blockquote>
966519955f5f7111abac20118563132b9dd41165Christian Maeder <p>The typical, default description field is 23 bytes wide. 6
bbba6dd86153aacb0f662b182b128df0eb09fd54Christian Maeder more bytes are added by the
16b71dad8d398af412d66a4f4763f1ada5b03d23Christian Maeder <code>IndexOptions SuppressIcon</code> option, 7 bytes are
d96bfd1d7a4595bfff87771b91797330fa939455Christian Maeder added by the <code>IndexOptions SuppressSize</code>
d96bfd1d7a4595bfff87771b91797330fa939455Christian Maeder option, and 19 bytes are added by the
8c8545dd3bf34fbcbc16904b65d249658f8f9efcChristian Maeder <code>IndexOptions SuppressLastModified</code> option.
d27b1887e61f1dc53d77c37f59dbf5019242a686Christian Maeder Therefore, the widest default the description column is ever
34d14197eb3dd643a8e6ef3ed8cba5629528e97fAivaras Jakubauskas assigned is 55 bytes.</p>
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder <p>See the <a href="#indexoptions:descriptionwidth">DescriptionWidth</a>
d4ebd9e5adc974cfa2bdf4bdd155e07be0e26f75Christian Maeder <a href="#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> keyword
0d79ea4ed8512a802ecb6645edac141e0fbcee3fChristian Maeder for details on overriding the size of this column, or allowing
a31430de8b0632d29f42634d6395e982bf31b14dChristian Maeder descriptions of unlimited length.</p>
d4ebd9e5adc974cfa2bdf4bdd155e07be0e26f75Christian Maeder<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Caution</strong></p> <p>Descriptive text defined with
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <code class="directive">AddDescription</code> may contain HTML markup, such as
b6ff72be73dad3d1394cf2c71e29e67624ff030bChristian Maeder tags and character entities. If the width of the description
b6ff72be73dad3d1394cf2c71e29e67624ff030bChristian Maeder column should happen to truncate a tagged element (such as
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder cutting off the end of a bolded phrase), the results may
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder affect the rest of the directory listing.</p>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<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 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>AddIcon <em>icon
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder name</em> [<em>name</em>] ...</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>
2360728d4185c0c04279c999941c64d36626af79Christian Maeder <p>This sets the icon to display next to a file ending in
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <em>name</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <em>Icon</em> is either a (%-escaped) relative URL to the icon,
00df6fd583c19393fa141d5a0e21ac74c7bf5b19Christian Maeder or of the format (<em>alttext</em>,<em>url</em>) where
2360728d4185c0c04279c999941c64d36626af79Christian Maeder <em>alttext</em> is the text tag given for an icon for
2360728d4185c0c04279c999941c64d36626af79Christian Maeder non-graphical browsers.</p>
96ae1a1d2197d0e0d5b80da2474b64c456feb1b0Christian Maeder <p><em>Name</em> is either ^^DIRECTORY^^ for directories,
2360728d4185c0c04279c999941c64d36626af79Christian Maeder ^^BLANKICON^^ for blank lines (to format the list correctly), a
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder file extension, a wildcard expression, a partial filename or a
8d780c893d6df5dab3dcc7d8444b7517f6547f11Christian Maeder complete filename. Examples:</p>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm<br>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <p><a href="#addiconbytype" class="directive"><code class="directive">AddIconByType</code></a>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder should be used in preference to <code class="directive">AddIcon</code>,
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder when possible.</p>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Icon to display next to files selected by MIME
bc263f610d20a9cd3014ddfca903026127fa0d48Christian Maedercontent-encoding</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddIconByEncoding
966519955f5f7111abac20118563132b9dd41165Christian Maeder <em>icon MIME-encoding</em> [<em>MIME-encoding</em>] ...</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>
bbba6dd86153aacb0f662b182b128df0eb09fd54Christian Maeder <p>This sets the icon to display next to files with <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
5a448e9be8c4482a978b174b744237757335140fChristian Maeder <em>Icon</em> is either a (%-escaped) relative URL to the icon,
d96bfd1d7a4595bfff87771b91797330fa939455Christian Maeder or of the format (<em>alttext</em>,<em>url</em>) where
8c8545dd3bf34fbcbc16904b65d249658f8f9efcChristian Maeder <em>alttext</em> is the text tag given for an icon for
d27b1887e61f1dc53d77c37f59dbf5019242a686Christian Maeder non-graphical browsers.</p>
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder <p><em>Mime-encoding</em> is a wildcard expression matching
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder required the content-encoding. Examples:</p>
0d79ea4ed8512a802ecb6645edac141e0fbcee3fChristian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddIconByEncoding /icons/compress.xbm x-compress</code></td></tr></table></blockquote>
a31430de8b0632d29f42634d6395e982bf31b14dChristian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Icon to display next to files selected by MIME
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maedercontent-type</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddIconByType
d4ebd9e5adc974cfa2bdf4bdd155e07be0e26f75Christian Maeder <em>icon MIME-type</em> [<em>MIME-type</em>] ...</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>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <p>This sets the icon to display next to files of type
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <em>MIME-type</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder <em>Icon</em> is either a (%-escaped) relative URL to the icon,
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder or of the format (<em>alttext</em>,<em>url</em>) where
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder <em>alttext</em> is the text tag given for an icon for
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder non-graphical browsers.</p>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder <p><em>Mime-type</em> is a wildcard expression matching
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder required the mime types. Examples:</p>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddIconByType (IMG,/icons/image.xbm) image/*</code></td></tr></table></blockquote>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Icon to display for files when no specific icon is
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maederconfigured</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>DefaultIcon <em>url-path</em></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>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <p>The <code class="directive">DefaultIcon</code> directive sets the icon
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder to display for files when no specific icon is known, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <em>Url</em> is a (%-escaped) relative URL to the icon.
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder Examples:</p>
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>DefaultIcon /icon/unknown.xbm</code></td></tr></table></blockquote>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Name of the file that will be inserted at the top
cb2044812811d66efe038d914966e04290be93faChristian Maederof the index listing</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>HeaderName <em>filename</em></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>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <p>The <code class="directive">HeaderName</code> directive sets the name
96ae1a1d2197d0e0d5b80da2474b64c456feb1b0Christian Maeder of the file that will be inserted at the top of the index
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder listing. <em>Filename</em> is the name of the file to include.</p>
96ae1a1d2197d0e0d5b80da2474b64c456feb1b0Christian Maeder<blockquote><table><tr><td bgcolor="#e0e5f5">
96ae1a1d2197d0e0d5b80da2474b64c456feb1b0Christian Maeder <p>Both HeaderName and <a href="#readmename" class="directive"><code class="directive">ReadmeName</code></a> now treat
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <em>Filename</em> as a URI path relative to the one used to
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder access the directory being indexed. <em>Filename</em> must
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder resolve to a document with a major content type of
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder "<code>text/*</code>" (<em>e.g.</em>, <code>text/html</code>,
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder <code>text/plain</code>, <em>etc.</em>). This means that
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder <em>filename</em> may refer to a CGI script if the script's
16b71dad8d398af412d66a4f4763f1ada5b03d23Christian Maeder actual file type (as opposed to its output) is marked as
96ae1a1d2197d0e0d5b80da2474b64c456feb1b0Christian Maeder <code>text/html</code> such as with a directive like:</p>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder <p><a href="/content-negotiation.html">Content negotiation</a>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder will be performed if the <code>MultiViews</code> <a href="core.html#option" class="directive"><code class="directive">Option</code></a> is enabled. If
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <em>filename</em> resolves to a static <code>text/html</code>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder document (not a CGI script) and the <code>Includes</code>
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <a href="core.html#option" class="directive"><code class="directive">option</code></a> is enabled, the file
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder will be processed for server-side includes (see the
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <code><a href="mod_include.html">mod_include</a></code> documentation).</p>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder <p>If the file specified by <code class="directive">HeaderName</code> contains
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder the beginnings of an HTML document (<HTML>, <HEAD>,
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder etc) then you will probably want to set <a href="#indexoptions:suppresshtmlpreamble"><code>IndexOptions
8bb80c9684e905de8dcfcfb1291542677e7d77b6Christian Maeder +SuppressHTMLPreamble</code></a>, so that these tags are not
00df6fd583c19393fa141d5a0e21ac74c7bf5b19Christian Maeder repeated.</p>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Adds to the list of files to hide when listing
b53688bfed888214b485cf76439d57262d80e0a7Christian Maedera directory</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>IndexIgnore <em>file</em> [<em>file</em>] ...</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>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <p>The <code class="directive">IndexIgnore</code> directive adds to the
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder list of files to hide when listing a directory. <em>File</em> is a
b6ff72be73dad3d1394cf2c71e29e67624ff030bChristian Maeder file extension, partial filename, wildcard expression or full
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder filename for files to ignore. Multiple IndexIgnore directives add
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder to the list, rather than the replacing the list of ignored
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder files. By default, the list contains
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>IndexIgnore README .htaccess *~</code></td></tr></table></blockquote>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Various configuration settings for directory
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maederindexing</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>IndexOptions [+|-]<em>option</em> [[+|-]<em>option</em>] ...</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>
bc263f610d20a9cd3014ddfca903026127fa0d48Christian Maeder <p>The <code class="directive">IndexOptions</code> directive specifies the
966519955f5f7111abac20118563132b9dd41165Christian Maeder behavior of the directory indexing. <em>Option</em> can be one
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <dt><a name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder | *] (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a></dt>
cb2044812811d66efe038d914966e04290be93faChristian Maeder <dd>The <code>DescriptionWidth</code> keyword allows you to
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder specify the width of the description column in
8d780c893d6df5dab3dcc7d8444b7517f6547f11Christian Maeder characters.</dd>
96ae1a1d2197d0e0d5b80da2474b64c456feb1b0Christian Maeder <dd><code>-DescriptionWidth</code> (or unset) allows
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder mod_autoindex to calculate the best width.</dd>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <dd><code>DescriptionWidth=n</code> fixes the column width to
00df6fd583c19393fa141d5a0e21ac74c7bf5b19Christian Maeder n bytes wide.</dd>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <dd><code>DescriptionWidth=*</code> grows the column to the
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder width necessary to accommodate the longest description
16b71dad8d398af412d66a4f4763f1ada5b03d23Christian Maeder <dd><strong>See the section on <a href="#adddescription" class="directive"><code class="directive">AddDescription</code></a> for dangers
8c8545dd3bf34fbcbc16904b65d249658f8f9efcChristian Maeder inherent in truncating descriptions.</strong></dd>
d27b1887e61f1dc53d77c37f59dbf5019242a686Christian Maeder <dt><a name="indexoptions:fancyindexing">FancyIndexing</a></dt>
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder This turns on fancy indexing of directories.</dd>
0d79ea4ed8512a802ecb6645edac141e0fbcee3fChristian Maeder <dt><a name="indexoptions:foldersfirst">FoldersFirst (<em>Apache
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder <dd>If this option is enabled, subdirectory listings will
0b13f102310e03a20b38c870b5acb88712f316a4Christian Maeder <em>always</em> appear first, followed by normal files in the
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder directory. The listing is basically broken into two
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder components, the files and the subdirectories, and each is
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder sorted separately and then displayed subdirectories-first.
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder For instance, if the sort order is descending by name, and
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder <code>FoldersFirst</code> is enabled, subdirectory
9f4902edfa3d477e42343e0ec357a2f93b1119d1Christian Maeder <code>Zed</code> will be listed before subdirectory
12aef5992d3af07dee81a4e02cf4be65a83f28bcChristian Maeder <code>Beta</code>, which will be listed before normal files
2360728d4185c0c04279c999941c64d36626af79Christian Maeder <code>Gamma</code> and <code>Alpha</code>. <strong>This option
2360728d4185c0c04279c999941c64d36626af79Christian Maeder only has an effect if <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <dt><a name="indexoptions:htmltable">HTMLTable</a> <em>(Experimental,
0130083f314580170af1195037be3325f125fbceChristian Maeder This experimental option with FancyIndexing constructs a
d81905a5b924415c524d702df26204683c82c12eChristian Maeder simple table for the fancy directory listing. Note this will
96ae1a1d2197d0e0d5b80da2474b64c456feb1b0Christian Maeder confuse older browsers. It is particularly necessary if file
2360728d4185c0c04279c999941c64d36626af79Christian Maeder names or description text will alternate between
f39b8dd9651dfcc38b06191cda23cacbfc298323Christian Maeder left-to-right and right-to-left reading order, as can happen
8d780c893d6df5dab3dcc7d8444b7517f6547f11Christian Maeder on WinNT or other utf-8 enabled platforms.</dd>
bc263f610d20a9cd3014ddfca903026127fa0d48Christian Maeder <dt><a name="indexoptions:iconsarelinks">IconsAreLinks</a></dt>
2360728d4185c0c04279c999941c64d36626af79Christian Maeder This makes the icons part of the anchor for the filename, for
00df6fd583c19393fa141d5a0e21ac74c7bf5b19Christian Maeder fancy indexing.</dd>
f39b8dd9651dfcc38b06191cda23cacbfc298323Christian Maeder <dt><a name="indexoptions:iconheight">IconHeight[=pixels]
2360728d4185c0c04279c999941c64d36626af79Christian Maeder Presence of this option, when used with IconWidth, will cause
2360728d4185c0c04279c999941c64d36626af79Christian Maeder the server to include <code>HEIGHT</code> and
2360728d4185c0c04279c999941c64d36626af79Christian Maeder <code>WIDTH</code> attributes in the <code>IMG</code> tag for
d27b1887e61f1dc53d77c37f59dbf5019242a686Christian Maeder the file icon. This allows browser to precalculate the page
8994ef587ce7c7c39ddd20f0f7e4575838a6694aChristian Maeder layout without having to wait until all the images have been
33fcc19ef2b59493b4e91eebf701df95fd230765Christian Maeder loaded. If no value is given for the option, it defaults to
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder the standard height of the icons supplied with the Apache
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder software.</dd>
ce8a93047aaf0dc36fa221642292d47852a9862aChristian Maeder <dt><a name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
2360728d4185c0c04279c999941c64d36626af79Christian Maeder Presence of this option, when used with IconHeight, will
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder cause the server to include <code>HEIGHT</code> and
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <code>WIDTH</code> attributes in the <code>IMG</code> tag for
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder the file icon. This allows browser to precalculate the page
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder layout without having to wait until all the images have been
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder loaded. If no value is given for the option, it defaults to
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder the standard width of the icons supplied with the Apache
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder software.</dd>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <dt><a name="indexoptions:ignoreclient">IgnoreClient</a></dt>
91e24fc45834b35f2a3830d72565640251149bf3Christian Maeder This option causes mod_autoindex to ignore all query
91e24fc45834b35f2a3830d72565640251149bf3Christian Maeder variables from the client, including sort order (implies
91e24fc45834b35f2a3830d72565640251149bf3Christian Maeder <code><a href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></code>.)</dd>
91e24fc45834b35f2a3830d72565640251149bf3Christian Maeder <dt><a name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
d56ece59c372cb887355825901222b9f3377f7e6Thiemo Wiedemeyer <dd>The NameWidth keyword allows you to specify the width of
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder the filename column in bytes.</dd>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <dd><code>-NameWidth</code> (or unset) allows mod_autoindex
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder to calculate the best width.</dd>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <dd><code>NameWidth=n</code> fixes the column width to n
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder bytes wide.</dd>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <dd><code>NameWidth=*</code> grows the column to the
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder necessary width.</dd>
34746b7edb13c8b0fe36066b410ed4e7695b7649Christian Maeder <dt><a name="indexoptions:scanhtmltitles">ScanHTMLTitles</a></dt>
3753288339ad80053053d92409bd37b335a96197Christian Maeder This enables the extraction of the title from HTML documents
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder for fancy indexing. If the file does not have a description
76d027be764e2ff61bef959efb3ac8f56499e646Christian Maeder given by <a href="#adddescription">AddDescription</a> then
9f85afecbd79b3df5a0bb17bd28cd0b288dc3213Kristina Sojakova httpd will read the document for the value of the TITLE tag.
a166da43d4e8f9dfa7a2651d033c6bea02627ca6Mihai Codescu This is CPU and disk intensive.</dd>
7bbfb15142ab4286dfc6fcde2fc94a5512297e41Jonathan von Schroeder <dt><a name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder If specified, Apache will not make the column headings in a
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder FancyIndexed directory listing into links for sorting. The
af6e92e4a9ca308f928f9909acee115f801c5db5Ewaryst Schulz default behavior is for them to be links; selecting the
b47b1ea8a412f6e4c731779f6a572384e7cf06d8Christian Maeder column heading will sort the directory listing by the values
26b1c101b72100b69045effdfaab3889de6c8c93Christian Maeder in that column. <strong>Prior to Apache 2.0.23, this also
c4076ff1721f8901a30e4b7aa004479ecb2631e0Felix Gabriel Mance disabled parsing the Query Arguments for the sort
a68ff26ddb1d300f7e16097edef615f130fcd5ceChristian Maeder string.</strong> That behavior is now controlled by <a href="#indexoptions:ignoreclient">IndexOptions
6f70475dddc12732bdbef3e3dd116373e34cd6b9Christian Maeder <dt><a name="indexoptions:suppressdescription">SuppressDescription</a></dt>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder This will suppress the file description in fancy indexing
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder listings. By default, no file descriptions are defined, and
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder so the use of this option will regain 23 characters of screen
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder space to use for something else. See <a href="#adddescription"><code>AddDescription</code></a> for
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder information about setting the file description. See also the
34746b7edb13c8b0fe36066b410ed4e7695b7649Christian Maeder <a href="#indexoptions:descriptionwidth"><code>DescriptionWidth</code></a>
12324a24aa5aa42edc749c7473fcf5264d4a81e4Christian Maeder index option to limit the size of the description
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <dt><a name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
a166da43d4e8f9dfa7a2651d033c6bea02627ca6Mihai Codescu If the directory actually contains a file specified by the
22b772f8753f0cdb4508ba460356c238de2ee375Jonathan von Schroeder <a href="#headername" class="directive"><code class="directive">HeaderName</code></a>
7bbfb15142ab4286dfc6fcde2fc94a5512297e41Jonathan von Schroeder directive, the module usually includes the contents of the file
f730570f7c284b252ad2e24cf23cc594021f9e25Jonathan von Schroeder after a standard HTML preamble (<HTML>, <HEAD>,
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <em>et cetera</em>). The SuppressHTMLPreamble option disables
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder this behaviour, causing the module to start the display with the
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder header file contents. The header file must contain appropriate
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder HTML instructions in this case. If there is no header file, the
af6e92e4a9ca308f928f9909acee115f801c5db5Ewaryst Schulz preamble is generated as usual.</dd>
26b1c101b72100b69045effdfaab3889de6c8c93Christian Maeder <dt><a name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
6f70475dddc12732bdbef3e3dd116373e34cd6b9Christian Maeder This will suppress the icon in fancy indexing listings.
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <em>SuppressRules</em> yields proper HTML 3.2 output, which
2353f65833a3da763392f771223250cd50b8d873Christian Maeder by the final specification prohibits IMG and HR tags from the
beff4152e9f0fe90885458d1a1733b183a2a8816Christian Maeder PRE block (used to format FancyIndexed listings.)</dd>
beff4152e9f0fe90885458d1a1733b183a2a8816Christian Maeder <dt><a name="indexoptions:suppresslastmodified">SuppressLastModified</a></dt>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder This will suppress the display of the last modification date,
897a04683fb30873e84dc3360dea770a4435971cChristian Maeder in fancy indexing listings.</dd>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <dt><a name="indexoptions:suppressrules">SuppressRules</a>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder This will suppress the horizontal rule lines (HR tags) in
12324a24aa5aa42edc749c7473fcf5264d4a81e4Christian Maeder directory listings. Combining both <em>SuppressIcon</em> and
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <em>SuppressRules</em> yeilds proper HTML 3.2 output, which
12aef5992d3af07dee81a4e02cf4be65a83f28bcChristian Maeder by the final specification prohibits IMG and HR tags from the
12324a24aa5aa42edc749c7473fcf5264d4a81e4Christian Maeder PRE block (used to format FancyIndexed listings.)</dd>
7bbfb15142ab4286dfc6fcde2fc94a5512297e41Jonathan von Schroeder <dt><a name="indexoptions:suppresssize">SuppressSize</a></dt>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder This will suppress the file size in fancy indexing
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder listings.</dd>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <dt><a name="indexoptions:trackmodified">TrackModified (<em>Apache
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder This returns the Last-Modified and ETag values for the listed
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder directory in the HTTP header. It is only valid if the
2360728d4185c0c04279c999941c64d36626af79Christian Maeder operating system and file system return appropriate stat()
8a5c05062ef501bf725a86a370a5145a198e81fdKlaus Luettich results. Some Unix systems do so, as do OS2's JFS and Win32's
8a5c05062ef501bf725a86a370a5145a198e81fdKlaus Luettich NTFS volumes. OS2 and Win32 FAT volumes, for example, do not.
7ebcceae3d34771cae3bbb8c8060bef0b894376eChristian Maeder Once this feature is enabled, the client or proxy can track
8a5c05062ef501bf725a86a370a5145a198e81fdKlaus Luettich changes to the list of files when they perform a HEAD
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder request. Note some operating systems correctly track new and
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder removed files, but do not track changes for sizes or dates of
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder the files within the directory. <strong>Changes to the size
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder or date stamp of an existing file will not update the
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder Last-Modified header on all Unix platforms.</strong> If this
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder is a concern, leave this option disabled.</dd>
3ec3a22fe2b9c38a3575c98a82b4e3f988af64a6Eugen Kuksa <dt><a name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
f8cc2399c16fcda7e3bf9d901a0de0cc8a455f86Ewaryst Schulz The VersionSort keyword causes files containing version
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder numbers to sort in a natural way. Strings are sorted as
53a3042e1da2253fd3f103bfef4deb47fc0bf6a6Ewaryst Schulz usual, except that substrings of digits in the name and
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder description are compared according to their numeric value.
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
427ff3172ae2dfebe3c8fc972735158999997e8aChristian Maederfoo-1.8.2a<br>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder If the number starts with a zero, then it is considered to
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder be a fraction:
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
3ec3a22fe2b9c38a3575c98a82b4e3f988af64a6Eugen Kuksafoo-1.030<br>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder Apache 1.3.3 introduced some significant changes in the
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder handling of <code class="directive">IndexOptions</code> directives. In
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder particular,<br>
3490b73f69b58ab742417b0867d0e2d4a7778cc0Christian Maeder <li>Multiple <code class="directive">IndexOptions</code> directives for a
59aa5703ac7f3b99e97cd5926e77088b256c5f40Christian Maeder single directory are now merged together. The result of
4c872eeb600fe8479dbda395405cf13c3d573c24Soeren D. Schulze the example above will now be the equivalent of
427ff3172ae2dfebe3c8fc972735158999997e8aChristian Maeder <code>IndexOptions FancyIndexing ScanHTMLTitles</code>.</li>
beff4152e9f0fe90885458d1a1733b183a2a8816Christian Maeder <li>The addition of the incremental syntax
7968d3a131e5a684ec1ff0c6d88aae638549153dChristian Maeder (<em>i.e.</em>, prefixing keywords with '+' or '-').</li>
beff4152e9f0fe90885458d1a1733b183a2a8816Christian Maeder Whenever a '+' or '-' prefixed keyword is encountered, it
beff4152e9f0fe90885458d1a1733b183a2a8816Christian Maeder is applied to the current <code class="directive">IndexOptions</code>
8a5c05062ef501bf725a86a370a5145a198e81fdKlaus Luettich settings (which may have been inherited from an upper-level
b76d27eba526ecac2a20400fa505ec5c642ae7d2Dominik Luecke directory). However, whenever an unprefixed keyword is
beff4152e9f0fe90885458d1a1733b183a2a8816Christian Maeder processed, it clears all inherited options and any
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder incremental settings encountered so far. Consider the
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder following example:
beff4152e9f0fe90885458d1a1733b183a2a8816Christian Maeder<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>IndexOptions +ScanHTMLTitles -IconsAreLinks
7968d3a131e5a684ec1ff0c6d88aae638549153dChristian Maeder FancyIndexing<br>
beff4152e9f0fe90885458d1a1733b183a2a8816Christian Maeder IndexOptions +SuppressSize<br>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder The net effect is equivalent to
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <code>IndexOptions FancyIndexing +SuppressSize</code>,
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder because the unprefixed <code>FancyIndexing</code> discarded
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder the incremental keywords before it, but allowed them to
b6ff72be73dad3d1394cf2c71e29e67624ff030bChristian Maeder start accumulating again afterward.<br>
78c294da55788b25e175180168371c9536a6d440Christian Maeder To unconditionally set the <code class="directive">IndexOptions</code> for a
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder particular directory, clearing the inherited settings,
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder specify keywords without any '+' or '-' prefixes.
78c294da55788b25e175180168371c9536a6d440Christian Maeder<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 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>IndexOrderDefault
bc263f610d20a9cd3014ddfca903026127fa0d48Christian MaederAscending|Descending Name|Date|Size|Description</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>
511284753313165e629cedf508752d6818ccc4d2Christian Maeder <p>The <code class="directive">IndexOrderDefault</code> directive is used
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder in combination with the <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder index option. By default, fancyindexed directory listings are
78c294da55788b25e175180168371c9536a6d440Christian Maeder displayed in ascending order by filename; the
78c294da55788b25e175180168371c9536a6d440Christian Maeder <code class="directive">IndexOrderDefault</code> allows you to change this initial
78c294da55788b25e175180168371c9536a6d440Christian Maeder display order.</p>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <p><code class="directive">IndexOrderDefault</code> takes two
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder arguments. The first must be either <code>Ascending</code> or
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <code>Descending</code>, indicating the direction of the sort.
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder The second argument must be one of the keywords <code>Name</code>,
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <code>Date</code>, <code>Size</code>, or <code>Description</code>,
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder and identifies the primary key. The secondary key is
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <em>always</em> the ascending filename.</p>
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder <p>You can force a directory listing to only be displayed in a
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder particular order by combining this directive with the <a href="#indexoptions:suppresscolumnsorting"><code>SuppressColumnSorting</code></a>
8865728716566f42fa73e7e0bc080ba3225df764Christian Maeder index option; this will prevent the client from requesting the
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder directory listing in a different order.</p>
b6ff72be73dad3d1394cf2c71e29e67624ff030bChristian Maeder<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 bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td/></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>ReadmeName <em>filename</em></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>
b6ff72be73dad3d1394cf2c71e29e67624ff030bChristian Maeder <p>The <code class="directive">ReadmeName</code> directive sets the name
b53688bfed888214b485cf76439d57262d80e0a7Christian Maeder of the file that will be appended to the end of the index
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder listing. <em>Filename</em> is the name of the file to include, and
dff1de7ad15d1582e25d636c3724dd202874897fChristian Maeder is taken to be relative to the location being indexed.</p>
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder <p>See also <a href="#headername" class="directive"><code class="directive">HeaderName</code></a>, where this behavior
a3a7d8b3cdf05c8040c62dbcf9a15dc5042cd721Christian Maeder is described in greater detail.</p>
8bb80c9684e905de8dcfcfb1291542677e7d77b6Christian Maeder<hr/></blockquote><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="/images/index.gif" alt="Index"/></a><a href="../"><img src="/images/home.gif" alt="Home"/></a></body></html>
