mod_autoindex.html revision ac6d1ce7ccb1950bb2145a5c2c3498235353bcb0
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom GundersenXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen This file is generated from xml source: DO NOT EDIT
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom GundersenXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen--><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 valign="top"><span class="help">Description:</span></td><td>Generates directory indexes,
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen automatically, similar to the Unix <em>ls</em> command or the
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen 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&nbsp;Identifier:</a></td><td>autoindex_module</td></tr></table></td></tr></table><h2>Summary</h2>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <p>The index of a directory can come from one of two
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen sources:</p>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <ul>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <li>A file written by the user, typically called
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <code>index.html</code>. The <a href="mod_dir.html#directoryindex" class="directive"><code class="directive">DirectoryIndex</code></a> directive sets the
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen name of this file. This is controlled by
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <code><a href="mod_dir.html">mod_dir</a></code>.</li>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <li>Otherwise, a listing generated by the server. The other
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen 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
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <a href="#addiconbytype" class="directive"><code class="directive">AddIconByType</code></a> are
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen used to set a list of icons to display for various file types;
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen for each file listed, the first icon listed that matches the
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen file is displayed. These are controlled by
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <code><a href="mod_autoindex.html">mod_autoindex</a></code>.</li>
4cc7a82c9490a3c5ae03b1d6d168ce40ba499e23Eugene Yakubovich </ul>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <p>The two functions are separated so that you can completely
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen remove (or replace) automatic index generation should you want
3be1d7e0c5bf60658d34eb6311d4e77c6803578cTom Gundersen to.</p>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <p>Automatic index generation is enabled with using
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <code>Options +Indexes</code>. See the
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <a href="core.html#options" class="directive"><code class="directive">Options</code></a> directive for
1346b1f0388f4100bb3c2a2bb23bc881769c020cTom Gundersen more details.</p>
c6f7c917a1b494d4455800823472227463f87438Tom Gundersen
ed942a9eb22d50f667909ad6184b45015d28d054Tom Gundersen <p>If the <a href="autoindex.html#fancyindexing" class="directive"><code class="directive">FancyIndexing</code></a>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen option is given with the <a href="autoindex.html#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> directive,
3a67e927e3be7efb8edf314a31aa4f8f5cba4f53Tom Gundersen the column headers are links that control the order of the
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen display. If you select a header link, the listing will be
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen regenerated, sorted by the values in that column. Selecting the
aba496a58acf9d9c61314de71353550e579f85eeUmut Tezduyar Lindskog same header repeatedly toggles between ascending and descending
aba496a58acf9d9c61314de71353550e579f85eeUmut Tezduyar Lindskog order. These column header links are suppressed with
aba496a58acf9d9c61314de71353550e579f85eeUmut Tezduyar Lindskog <a href="autoindex.html#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> directive's
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <code>SuppressColumnSorting</code> option.</p>
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <p>Note that when the display is sorted by "Size", it's the
ca4e095ab9e970cb8fa472ae69ea1f0648041722Lennart Poettering <em>actual</em> size of the files that's used, not the
505f8da7325591defe5f751f328bd26915267602Tom Gundersen displayed value - so a 1010-byte file will always be displayed
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen before a 1011-byte file (if in ascending order) even though
0c2f9b84698b25e6065b9febd21486669a13870fTom Gundersen they both are shown as "1K".</p>
0c2f9b84698b25e6065b9febd21486669a13870fTom Gundersen<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>
505f8da7325591defe5f751f328bd26915267602Tom Gundersen
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <p>Apache 2.0.23 reorganized the Query Arguments for Column
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen Sorting, and introduced an entire group of new query options.
505f8da7325591defe5f751f328bd26915267602Tom Gundersen To effectively eliminate all client control over the output,
505f8da7325591defe5f751f328bd26915267602Tom Gundersen the <code><a href="#indexoptions:ignoreclient">IndexOptions
505f8da7325591defe5f751f328bd26915267602Tom Gundersen IgnoreClient</a></code> option was introduced.</p>
505f8da7325591defe5f751f328bd26915267602Tom Gundersen
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <p>The column sorting headers themselves are self-referencing
505f8da7325591defe5f751f328bd26915267602Tom Gundersen hyperlinks that add the sort query options shown below. Any
505f8da7325591defe5f751f328bd26915267602Tom Gundersen option below may be added to any request for the directory
505f8da7325591defe5f751f328bd26915267602Tom Gundersen resource.</p>
505f8da7325591defe5f751f328bd26915267602Tom Gundersen
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <ul>
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <li><code>C=N</code> sorts the directory by file name</li>
505f8da7325591defe5f751f328bd26915267602Tom Gundersen
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <li><code>C=M</code> sorts the directory by last-modified
505f8da7325591defe5f751f328bd26915267602Tom Gundersen date, then file name</li>
505f8da7325591defe5f751f328bd26915267602Tom Gundersen
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <li><code>C=S</code> sorts the directory by size, then file
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen name</li>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <li><code>C=D</code> sorts the directory by description, then
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen file name<br>
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen &nbsp;</li>
5a3eb5a77d7c491a31818c4dfdcf8fd7dcaaadb2Tom Gundersen
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <li><code>O=A</code> sorts the listing in Ascending
505f8da7325591defe5f751f328bd26915267602Tom Gundersen Order</li>
505f8da7325591defe5f751f328bd26915267602Tom Gundersen
505f8da7325591defe5f751f328bd26915267602Tom Gundersen <li><code>O=D</code> sorts the listing in Descending
505f8da7325591defe5f751f328bd26915267602Tom Gundersen Order<br>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen &nbsp;</li>
512922f8b423eed093918f78461b7bf7c45592cbTom Gundersen
512922f8b423eed093918f78461b7bf7c45592cbTom Gundersen <li><code>F=0</code> formats the listing as a simple list
1a941ac4b690cb3f4333e35f4a5036fe6fd50ff9Tom Gundersen (not FancyIndexed)</li>
512922f8b423eed093918f78461b7bf7c45592cbTom Gundersen
85b5673b337048fa881a5afb1d00d1a7b95950fbTom Gundersen <li><code>F=1</code> formats the listing as a FancyIndexed
315db1a8aed226a51a4cf700172249cfd10ae115Zbigniew Jędrzejewski-Szmek list</li>
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen
315db1a8aed226a51a4cf700172249cfd10ae115Zbigniew Jędrzejewski-Szmek <li><code>F=2</code> formats the listing as an HTMLTable
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen FancyIndexed list<br>
85b5673b337048fa881a5afb1d00d1a7b95950fbTom Gundersen &nbsp;</li>
68a8723c8592c06b2c978f391cb47db266d9d6deTom Gundersen
68a8723c8592c06b2c978f391cb47db266d9d6deTom Gundersen <li><code>V=0</code> disables version sorting</li>
68a8723c8592c06b2c978f391cb47db266d9d6deTom Gundersen
68a8723c8592c06b2c978f391cb47db266d9d6deTom Gundersen <li><code>V=1</code> enables version sorting<br>
0617ffabe86a6d366252477eafbe59a888b149d4Tom Gundersen &nbsp;</li>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <li><code>P=<em>pattern</em></code> lists only files matching
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen the given <em>pattern</em></li>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </ul>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <p>Note that the 'P'attern query argument is tested
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <em>after</em> the usual IndexIgnore directives are processed,
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen and all file names are still subjected to the same criteria as
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen any other autoindex listing. The Query Arguments parser in
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen mod_autoindex will stop abruptly when an unrecognized option is
428fd0a75873d63b9d567f9db7871551d1ee0d62Tom Gundersen encountered. The Query Arguments must be well formed, according
428fd0a75873d63b9d567f9db7871551d1ee0d62Tom Gundersen to the table above.</p>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <p>The simple example below, which can be clipped and saved in
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen a header.html file, illustrates these query options. Note that
428fd0a75873d63b9d567f9db7871551d1ee0d62Tom Gundersen the unknown "X" argument, for the submit button, is listed last
428fd0a75873d63b9d567f9db7871551d1ee0d62Tom Gundersen to assure the arguments are all parsed before mod_autoindex
428fd0a75873d63b9d567f9db7871551d1ee0d62Tom Gundersen encounters the X=Go input.</p>
428fd0a75873d63b9d567f9db7871551d1ee0d62Tom Gundersen
428fd0a75873d63b9d567f9db7871551d1ee0d62Tom Gundersen<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering&lt;FORM METHOD="GET"&gt;<br>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering&nbsp;&nbsp;Show me a &lt;SELECT NAME="F"&gt;<br>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="0"&gt; Plain list <br>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="1" SELECTED&gt; Fancy list<br>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="2"&gt; Table list<br>
e5b04c8de83aa17e324bae95f18a822931fb8078Patrik Flykt&nbsp;&nbsp;&lt;/SELECT&gt;<br>
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen&nbsp;&nbsp;Sorted by &lt;SELECT NAME="C"&gt;<br>
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="N" SELECTED&gt; Name<br>
68a8723c8592c06b2c978f391cb47db266d9d6deTom Gundersen&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="M"&gt; Date Modified<br>
68a8723c8592c06b2c978f391cb47db266d9d6deTom Gundersen&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="S"&gt; Size<br>
68a8723c8592c06b2c978f391cb47db266d9d6deTom Gundersen&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="D"&gt; Description<br>
56cd007ab83749b85670c9c7f560e083980c2ff4Patrik Flykt&nbsp;&nbsp;&lt;/SELECT&gt;<br>
4138fb2c7936758da709eaed3f6b4f3df1d04effPatrik Flykt&nbsp;&nbsp;&lt;SELECT NAME="O"&gt;<br>
6b66097b9534da434cdb56d22c49452cfc0dcaf1Tom Gundersen&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="A" SELECTED&gt; Ascending<br>
4138fb2c7936758da709eaed3f6b4f3df1d04effPatrik Flykt&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="D"&gt; Descending<br>
28aeb07f55ddf338c8705c002bde391cebbdc5a3Tom Gundersen&nbsp;&nbsp;&lt;/SELECT&gt;<br>
28aeb07f55ddf338c8705c002bde391cebbdc5a3Tom Gundersen&nbsp;&nbsp;&lt;SELECT NAME="V"&gt;<br>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="0" SELECTED&gt; in Normal order<br>
c166a070553511e402de5ad216d3fb62b49bdacbTom Gundersen&nbsp;&nbsp;&nbsp;&nbsp;&lt;OPTION VALUE="1"&gt; in Version order<br>
68a8723c8592c06b2c978f391cb47db266d9d6deTom Gundersen&nbsp;&nbsp;&lt;/SELECT&gt;<br>
68a8723c8592c06b2c978f391cb47db266d9d6deTom Gundersen&nbsp;&nbsp;Matching &lt;INPUT TYPE="text" NAME="P" VALUE="*"&gt;<br>
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen&nbsp;&nbsp;&lt;INPUT TYPE="submit" NAME="X" VALUE="Go"&gt;<br>
c166a070553511e402de5ad216d3fb62b49bdacbTom Gundersen&lt;/FORM&gt;
b5db00e52ee2e20578839e4e4488f7b9af9abc38Umut Tezduyar Lindskog</code></td></tr></table></blockquote>
b5db00e52ee2e20578839e4e4488f7b9af9abc38Umut Tezduyar Lindskog
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen<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
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersenicon 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>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <p><code class="directive">AddAlt</code> provides the alternate text to
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen <em>File</em> is a file extension, partial filename, wild-card
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen expression or full filename for files to describe.
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen <em>String</em> is enclosed in double quotes (<code>"</code>).
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen This alternate text is displayed if the client is image-incapable,
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen has image loading disabled, or fails to retrieve the icon.</p>
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen <p>Examples:</p>
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen AddAlt "PDF" *.pdf<br>
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen AddAlt "Compressed" *.gz *.zip *.Z
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen</code></td></tr></table></blockquote>
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersen<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
14b746f72132324e637c4e39694bd474f85e19f7Tom Gundersenselected 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>
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen[<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>
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen <p><code class="directive">AddAltByEncoding</code> provides the alternate
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen text to display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen <em>MIME-encoding</em> is a valid content-encoding, such as
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen <code>x-compress</code>. <em>String</em> is enclosed in double
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen quotes (<code>"</code>). This alternate text is displayed if the
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen client is image-incapable, has image loading disabled, or fails to
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen retrieve the icon.</p>
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen <p>Example:</p>
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen AddAltByEncoding "gzip" x-gzip
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen</code></td></tr></table></blockquote>
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen<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
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersenicon selected by MIME content-type</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddAltByType <em>string
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen 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>
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen <p><code class="directive">AddAltByType</code> sets the alternate text to
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
11a7f22939d21558df919cab44b8fbe36ab5dae0Tom Gundersen <em>MIME-type</em> is a valid content-type, such as
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen <code>text/html</code>. <em>String</em> is enclosed in double
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen quotes (<code>"</code>). This alternate text is displayed if the
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen client is image-incapable, has image loading disabled, or fails to
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen retrieve the icon.</p>
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen <p>Example:</p>
7619683b46bddcf753786fd20581322da9825f99Tom Gundersen<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen AddAltByType "TXT" text/plain
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen</code></td></tr></table></blockquote>
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen<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
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen <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>
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen <p>This sets the description to display for a file, for
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
57bd6899b35b84d1f23809133ae45d29a87b2eaaTom Gundersen <em>File</em> is a file extension, partial filename, wild-card
57bd6899b35b84d1f23809133ae45d29a87b2eaaTom Gundersen expression or full filename for files to describe.
57bd6899b35b84d1f23809133ae45d29a87b2eaaTom Gundersen <em>String</em> is enclosed in double quotes (<code>"</code>).
df9aa406e8e32a2fb3b2a4b42d5871ef75a32ed8Tom Gundersen Example:</p>
57bd6899b35b84d1f23809133ae45d29a87b2eaaTom Gundersen
57bd6899b35b84d1f23809133ae45d29a87b2eaaTom Gundersen<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddDescription "The planet Mars"
57bd6899b35b84d1f23809133ae45d29a87b2eaaTom Gundersen /web/pics/mars.gif</code></td></tr></table></blockquote>
57bd6899b35b84d1f23809133ae45d29a87b2eaaTom Gundersen
57bd6899b35b84d1f23809133ae45d29a87b2eaaTom Gundersen <p>The typical, default description field is 23 bytes wide. 6
57bd6899b35b84d1f23809133ae45d29a87b2eaaTom Gundersen more bytes are added by the
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <code>IndexOptions&nbsp;SuppressIcon</code> option, 7 bytes are
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen added by the <code>IndexOptions&nbsp;SuppressSize</code>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen option, and 19 bytes are added by the
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <code>IndexOptions&nbsp;SuppressLastModified</code> option.
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen Therefore, the widest default the description column is ever
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen assigned is 55 bytes.</p>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <p>See the <a href="#indexoptions:descriptionwidth">DescriptionWidth</a>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <a href="#indexoptions" class="directive"><code class="directive">IndexOptions</code></a> keyword
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen for details on overriding the size of this column, or allowing
ed942a9eb22d50f667909ad6184b45015d28d054Tom Gundersen descriptions of unlimited length.</p>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen<blockquote><table><tr><td bgcolor="#e0e5f5"><p align="center"><strong>Caution</strong></p> <p>Descriptive text defined with
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <code class="directive">AddDescription</code> may contain HTML markup, such as
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen tags and character entities. If the width of the description
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen column should happen to truncate a tagged element (such as
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen cutting off the end of a bolded phrase), the results may
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen affect the rest of the directory listing.</p>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen</td></tr></table></blockquote>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen<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
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen 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>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <p>This sets the icon to display next to a file ending in
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <em>name</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <em>Icon</em> is either a (%-escaped) relative URL to the icon,
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen or of the format (<em>alttext</em>,<em>url</em>) where
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <em>alttext</em> is the text tag given for an icon for
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen non-graphical browsers.</p>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <p><em>Name</em> is either ^^DIRECTORY^^ for directories,
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen ^^BLANKICON^^ for blank lines (to format the list correctly), a
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen file extension, a wildcard expression, a partial filename or a
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen complete filename. Examples:</p>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm<br>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen AddIcon /icons/dir.xbm ^^DIRECTORY^^<br>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen AddIcon /icons/backup.xbm *~
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen</code></td></tr></table></blockquote>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <p><a href="#addiconbytype" class="directive"><code class="directive">AddIconByType</code></a>
ed942a9eb22d50f667909ad6184b45015d28d054Tom Gundersen should be used in preference to <code class="directive">AddIcon</code>,
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt when possible.</p>
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt<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
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flyktcontent-encoding</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddIconByEncoding
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt <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>
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt <p>This sets the icon to display next to files with <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt <em>Icon</em> is either a (%-escaped) relative URL to the icon,
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt or of the format (<em>alttext</em>,<em>url</em>) where
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt <em>alttext</em> is the text tag given for an icon for
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt non-graphical browsers.</p>
4138fb2c7936758da709eaed3f6b4f3df1d04effPatrik Flykt
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt <p><em>Mime-encoding</em> is a wildcard expression matching
4138fb2c7936758da709eaed3f6b4f3df1d04effPatrik Flykt required the content-encoding. Examples:</p>
1873a3d344042e818d2a5762c0ebfc3823c8f84dPatrik Flykt
4138fb2c7936758da709eaed3f6b4f3df1d04effPatrik Flykt<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddIconByEncoding /icons/compress.xbm x-compress</code></td></tr></table></blockquote>
4138fb2c7936758da709eaed3f6b4f3df1d04effPatrik Flykt<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
4138fb2c7936758da709eaed3f6b4f3df1d04effPatrik Flyktcontent-type</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td>AddIconByType
4138fb2c7936758da709eaed3f6b4f3df1d04effPatrik Flykt <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>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <p>This sets the icon to display next to files of type
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <em>MIME-type</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <em>Icon</em> is either a (%-escaped) relative URL to the icon,
ef1ba6065c6ccea94d4ee867f36df7bbc53a5224Tom Gundersen or of the format (<em>alttext</em>,<em>url</em>) where
ef1ba6065c6ccea94d4ee867f36df7bbc53a5224Tom Gundersen <em>alttext</em> is the text tag given for an icon for
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen non-graphical browsers.</p>
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen
2139694e823935d3ac1479aa7c9a78ee3ffdc759Tom Gundersen <p><em>Mime-type</em> is a wildcard expression matching
2139694e823935d3ac1479aa7c9a78ee3ffdc759Tom Gundersen required the mime types. Examples:</p>
39032b87779323a244dd89f4832949d462b2ac68Zbigniew Jędrzejewski-Szmek
449f75549247b3b7b073a788f0f099ce6b7c5378Tom Gundersen<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>AddIconByType (IMG,/icons/image.xbm) image/*</code></td></tr></table></blockquote>
ef1ba6065c6ccea94d4ee867f36df7bbc53a5224Tom Gundersen<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
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersenconfigured</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>
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen <p>The <code class="directive">DefaultIcon</code> directive sets the icon
111bb8f93a2e936fc62fc2f34350b85c5f0000c8Tom Gundersen to display for files when no specific icon is known, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
fe8db0c5ee3365a2fc80ee7ebffa238f9a0a2ae2Tom Gundersen <em>Url</em> is a (%-escaped) relative URL to the icon.
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen Examples:</p>
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>DefaultIcon /icon/unknown.xbm</code></td></tr></table></blockquote>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering<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
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poetteringof 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>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <p>The <code class="directive">HeaderName</code> directive sets the name
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering of the file that will be inserted at the top of the index
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering listing. <em>Filename</em> is the name of the file to include.</p>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering<blockquote><table><tr><td bgcolor="#e0e5f5">
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <p>Both HeaderName and <a href="#readmename" class="directive"><code class="directive">ReadmeName</code></a> now treat
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <em>Filename</em> as a URI path relative to the one used to
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering access the directory being indexed. <em>Filename</em> must
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering resolve to a document with a major content type of
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering "<code>text/*</code>" (<em>e.g.</em>, <code>text/html</code>,
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <code>text/plain</code>, <em>etc.</em>). This means that
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <em>filename</em> may refer to a CGI script if the script's
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering actual file type (as opposed to its output) is marked as
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <code>text/html</code> such as with a directive like:</p>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering AddType text/html .cgi
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering</code></td></tr></table></blockquote>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <p><a href="/content-negotiation.html">Content negotiation</a>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering will be performed if the <code>MultiViews</code> <a href="core.html#option" class="directive"><code class="directive">Option</code></a> is enabled. If
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <em>filename</em> resolves to a static <code>text/html</code>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering document (not a CGI script) and the <code>Includes</code>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <a href="core.html#option" class="directive"><code class="directive">option</code></a> is enabled, the file
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering will be processed for server-side includes (see the
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <code><a href="mod_include.html">mod_include</a></code> documentation).</p>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering</td></tr></table></blockquote>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <p>If the file specified by <code class="directive">HeaderName</code> contains
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen the beginnings of an HTML document (&lt;HTML&gt;, &lt;HEAD&gt;,
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen etc) then you will probably want to set <a href="#indexoptions:suppresshtmlpreamble"><code>IndexOptions
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen +SuppressHTMLPreamble</code></a>, so that these tags are not
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen repeated.</p>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen<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
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersena 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>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <p>The <code class="directive">IndexIgnore</code> directive adds to the
7c16313f11e3953f3fe4dbf544f2d36f58d14138Tom Gundersen list of files to hide when listing a directory. <em>File</em> is a
7c16313f11e3953f3fe4dbf544f2d36f58d14138Tom Gundersen file extension, partial filename, wildcard expression or full
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering filename for files to ignore. Multiple IndexIgnore directives add
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering to the list, rather than the replacing the list of ignored
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering files. By default, the list contains
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering `<code>.</code>'. Example:</p>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>IndexIgnore README .htaccess *~</code></td></tr></table></blockquote>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering<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
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poetteringindexing</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>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <p>The <code class="directive">IndexOptions</code> directive specifies the
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering behavior of the directory indexing. <em>Option</em> can be one
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen of</p>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <dl>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <dt><a name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering | *] (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a></dt>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <dd>The <code>DescriptionWidth</code> keyword allows you to
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering specify the width of the description column in
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering characters.</dd>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <dd><code>-DescriptionWidth</code> (or unset) allows
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering mod_autoindex to calculate the best width.</dd>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <dd><code>DescriptionWidth=n</code> fixes the column width to
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering n bytes wide.</dd>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <dd><code>DescriptionWidth=*</code> grows the column to the
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering width necessary to accommodate the longest description
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering string.</dd>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <dd><strong>See the section on <a href="#adddescription" class="directive"><code class="directive">AddDescription</code></a> for dangers
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering inherent in truncating descriptions.</strong></dd>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering <dt><a name="indexoptions:fancyindexing">FancyIndexing</a></dt>
4f4349389760480759612b2b1d0fb02c1743dff3Lennart Poettering
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <dd>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen This turns on fancy indexing of directories.</dd>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <dt><a name="indexoptions:foldersfirst">FoldersFirst (<em>Apache
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen 1.3.10 or 2.0.23 and later</em>)</a></dt>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <dd>If this option is enabled, subdirectory listings will
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <em>always</em> appear first, followed by normal files in the
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen directory. The listing is basically broken into two
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen components, the files and the subdirectories, and each is
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen sorted separately and then displayed subdirectories-first.
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen For instance, if the sort order is descending by name, and
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <code>FoldersFirst</code> is enabled, subdirectory
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <code>Zed</code> will be listed before subdirectory
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <code>Beta</code>, which will be listed before normal files
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <code>Gamma</code> and <code>Alpha</code>. <strong>This option
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen only has an effect if <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen is also enabled.</strong></dd>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <dt><a name="indexoptions:htmltable">HTMLTable</a> <em>(Experimental,
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen Apache 2.0.23 and later)</em></dt>
5da8149fd33f07aabdac72880143ec13e516f933Tom Gundersen
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen <dd>
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen This experimental option with FancyIndexing constructs a
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen simple table for the fancy directory listing. Note this will
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen confuse older browsers. It is particularly necessary if file
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen names or description text will alternate between
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen left-to-right and right-to-left reading order, as can happen
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen on WinNT or other utf-8 enabled platforms.</dd>
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen <dt><a name="indexoptions:iconsarelinks">IconsAreLinks</a></dt>
5da8149fd33f07aabdac72880143ec13e516f933Tom Gundersen
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen <dd>
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen This makes the icons part of the anchor for the filename, for
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen fancy indexing.</dd>
c166a070553511e402de5ad216d3fb62b49bdacbTom Gundersen
c9ccc19f9eb0599109094c57b7a2f668d708f0c1Tom Gundersen <dt><a name="indexoptions:iconheight">IconHeight[=pixels]
97578344f3bd03c8ea651d8888622e82c599eadfTom Gundersen (<em>Apache 1.3 and later</em>)</a></dt>
987efa17dd5c9be156d8f49ddd942df20a72dcb1Tom Gundersen
c9ccc19f9eb0599109094c57b7a2f668d708f0c1Tom Gundersen <dd>
c9ccc19f9eb0599109094c57b7a2f668d708f0c1Tom Gundersen Presence of this option, when used with IconWidth, will cause
c9ccc19f9eb0599109094c57b7a2f668d708f0c1Tom Gundersen the server to include <code>HEIGHT</code> and
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen <code>WIDTH</code> attributes in the <code>IMG</code> tag for
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen the file icon. This allows browser to precalculate the page
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen layout without having to wait until all the images have been
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen loaded. If no value is given for the option, it defaults to
39032b87779323a244dd89f4832949d462b2ac68Zbigniew Jędrzejewski-Szmek the standard height of the icons supplied with the Apache
dd3efc0993b6e95ff04775e9125e2fc9d30fe261Tom Gundersen software.</dd>
dd3efc0993b6e95ff04775e9125e2fc9d30fe261Tom Gundersen
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen <dt><a name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen 1.3 and later</em>)</a></dt>
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen <dd>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich Presence of this option, when used with IconHeight, will
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich cause the server to include <code>HEIGHT</code> and
a2ba62c719224a4b47751623ca5e8b0333f49721Lennart Poettering <code>WIDTH</code> attributes in the <code>IMG</code> tag for
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich the file icon. This allows browser to precalculate the page
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich layout without having to wait until all the images have been
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich loaded. If no value is given for the option, it defaults to
a2ba62c719224a4b47751623ca5e8b0333f49721Lennart Poettering the standard width of the icons supplied with the Apache
a2ba62c719224a4b47751623ca5e8b0333f49721Lennart Poettering software.</dd>
a2ba62c719224a4b47751623ca5e8b0333f49721Lennart Poettering
a2ba62c719224a4b47751623ca5e8b0333f49721Lennart Poettering <dt><a name="indexoptions:ignoreclient">IgnoreClient</a></dt>
a2ba62c719224a4b47751623ca5e8b0333f49721Lennart Poettering
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <dd>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich This option causes mod_autoindex to ignore all query
a2ba62c719224a4b47751623ca5e8b0333f49721Lennart Poettering variables from the client, including sort order (implies
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <code><a href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></code>.)</dd>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <dt><a name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich (<em>Apache 1.3.2 and later</em>)</a></dt>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <dd>The NameWidth keyword allows you to specify the width of
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich the filename column in bytes.</dd>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <dd><code>-NameWidth</code> (or unset) allows mod_autoindex
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich to calculate the best width.</dd>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <dd><code>NameWidth=n</code> fixes the column width to n
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich bytes wide.</dd>
4faefc7ff884eae65a80e82313fd9f4bb859d6dbLennart Poettering
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <dd><code>NameWidth=*</code> grows the column to the
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich necessary width.</dd>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <dt><a name="indexoptions:scanhtmltitles">ScanHTMLTitles</a></dt>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <dd>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich This enables the extraction of the title from HTML documents
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich for fancy indexing. If the file does not have a description
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich given by <a href="#adddescription">AddDescription</a> then
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich httpd will read the document for the value of the TITLE tag.
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich This is CPU and disk intensive.</dd>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <dt><a name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich (<em>Apache 1.3 and later</em>)</dt>
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen <dd>
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen If specified, Apache will not make the column headings in a
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen FancyIndexed directory listing into links for sorting. The
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen default behavior is for them to be links; selecting the
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen column heading will sort the directory listing by the values
ef1ba6065c6ccea94d4ee867f36df7bbc53a5224Tom Gundersen in that column. <strong>Prior to Apache 2.0.23, this also
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen disabled parsing the Query Arguments for the sort
ef1ba6065c6ccea94d4ee867f36df7bbc53a5224Tom Gundersen string.</strong> That behavior is now controlled by <a href="#indexoptions:ignoreclient">IndexOptions
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen IgnoreClient</a> in Apache 2.0.23.</dd>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog
370e9930c3260cc58984ec70e44b1e2ab7676496Tom Gundersen <dt><a name="indexoptions:suppressdescription">SuppressDescription</a></dt>
dd3efc0993b6e95ff04775e9125e2fc9d30fe261Tom Gundersen
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen <dd>
39032b87779323a244dd89f4832949d462b2ac68Zbigniew Jędrzejewski-Szmek This will suppress the file description in fancy indexing
449f75549247b3b7b073a788f0f099ce6b7c5378Tom Gundersen listings. By default, no file descriptions are defined, and
3d3d425547a3f38473fcf8737b85dfebb630479dTom Gundersen so the use of this option will regain 23 characters of screen
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen space to use for something else. See <a href="#adddescription"><code>AddDescription</code></a> for
dd3efc0993b6e95ff04775e9125e2fc9d30fe261Tom Gundersen information about setting the file description. See also the
3333d748facc15f49935b6b793490ba0824976e6Zbigniew Jędrzejewski-Szmek <a href="#indexoptions:descriptionwidth"><code>DescriptionWidth</code></a>
3333d748facc15f49935b6b793490ba0824976e6Zbigniew Jędrzejewski-Szmek index option to limit the size of the description
ef1ba6065c6ccea94d4ee867f36df7bbc53a5224Tom Gundersen column.</dd>
ef1ba6065c6ccea94d4ee867f36df7bbc53a5224Tom Gundersen
dd3efc0993b6e95ff04775e9125e2fc9d30fe261Tom Gundersen <dt><a name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
c166a070553511e402de5ad216d3fb62b49bdacbTom Gundersen (<em>Apache 1.3 and later</em>)</dt>
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen <dd>
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen If the directory actually contains a file specified by the
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <a href="#headername" class="directive"><code class="directive">HeaderName</code></a>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog directive, the module usually includes the contents of the file
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog after a standard HTML preamble (&lt;HTML&gt;, &lt;HEAD&gt;,
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <em>et cetera</em>). The SuppressHTMLPreamble option disables
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog this behaviour, causing the module to start the display with the
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog header file contents. The header file must contain appropriate
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog HTML instructions in this case. If there is no header file, the
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog preamble is generated as usual.</dd>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <dt><a name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog 2.0.23 and later</em>)</dt>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <dd>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog This will suppress the icon in fancy indexing listings.
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog Combining both <em>SuppressIcon</em> and
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <em>SuppressRules</em> yields proper HTML 3.2 output, which
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog by the final specification prohibits IMG and HR tags from the
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog PRE block (used to format FancyIndexed listings.)</dd>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <dt><a name="indexoptions:suppresslastmodified">SuppressLastModified</a></dt>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog
4faefc7ff884eae65a80e82313fd9f4bb859d6dbLennart Poettering <dd>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog This will suppress the display of the last modification date,
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog in fancy indexing listings.</dd>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <dt><a name="indexoptions:suppressrules">SuppressRules</a>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog (<em>Apache 2.0.23 and later</em>)</dt>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <dd>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog This will suppress the horizontal rule lines (HR tags) in
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog directory listings. Combining both <em>SuppressIcon</em> and
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <em>SuppressRules</em> yeilds proper HTML 3.2 output, which
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog by the final specification prohibits IMG and HR tags from the
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog PRE block (used to format FancyIndexed listings.)</dd>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen <dt><a name="indexoptions:suppresssize">SuppressSize</a></dt>
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen
9765ce69e15fd294db9553777b621515fa57f2c6Brandon Philips <dd>
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen This will suppress the file size in fancy indexing
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen listings.</dd>
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog <dt><a name="indexoptions:trackmodified">TrackModified (<em>Apache
b16665806a448186f432b47e944f1682284a0182Tom Gundersen 1.3.15 or 2.0.23 and later</em>)</a></dt>
b16665806a448186f432b47e944f1682284a0182Tom Gundersen
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen <dd>
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen This returns the Last-Modified and ETag values for the listed
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen directory in the HTTP header. It is only valid if the
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog operating system and file system return appropriate stat()
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog results. Some Unix systems do so, as do OS2's JFS and Win32's
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog NTFS volumes. OS2 and Win32 FAT volumes, for example, do not.
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog Once this feature is enabled, the client or proxy can track
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog changes to the list of files when they perform a HEAD
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog request. Note some operating systems correctly track new and
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog removed files, but do not track changes for sizes or dates of
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersen the files within the directory. <strong>Changes to the size
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog or date stamp of an existing file will not update the
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog Last-Modified header on all Unix platforms.</strong> If this
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog is a concern, leave this option disabled.</dd>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog <dt><a name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog and later</em>)</a></dt>
9765ce69e15fd294db9553777b621515fa57f2c6Brandon Philips
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog <dd>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog The VersionSort keyword causes files containing version
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog numbers to sort in a natural way. Strings are sorted as
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog usual, except that substrings of digits in the name and
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog description are compared according to their numeric value.
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog For example:
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog
4faefc7ff884eae65a80e82313fd9f4bb859d6dbLennart Poettering<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
9765ce69e15fd294db9553777b621515fa57f2c6Brandon Philipsfoo-1.7<br>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskogfoo-1.7.2<br>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskogfoo-1.7.12<br>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskogfoo-1.8.2<br>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskogfoo-1.8.2a<br>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskogfoo-1.12<br>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog</code></td></tr></table></blockquote>
9765ce69e15fd294db9553777b621515fa57f2c6Brandon Philips If the number starts with a zero, then it is considered to
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog be a fraction:
9765ce69e15fd294db9553777b621515fa57f2c6Brandon Philips
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskogfoo-1.001<br>
4faefc7ff884eae65a80e82313fd9f4bb859d6dbLennart Poetteringfoo-1.002<br>
a6cc569e33a05b07550c6c7b4d67d83d868f8bc1Tom Gundersenfoo-1.030<br>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskogfoo-1.04
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog</code></td></tr></table></blockquote>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog </dd>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog <dd>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog <strong>Incremental IndexOptions</strong>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog </dd>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog <dd>
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen Apache 1.3.3 introduced some significant changes in the
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich handling of <code class="directive">IndexOptions</code> directives. In
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich particular,<br>
e1ea665edac17d75fce01b72dadfa3211b60df2cEugene Yakubovich <br>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog <ul>
8ddbeaa23c20659fe3b1b79502d746aceb396ce8Umut Tezduyar Lindskog <li>Multiple <code class="directive">IndexOptions</code> directives for a
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen single directory are now merged together. The result of
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen the example above will now be the equivalent of
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen <code>IndexOptions&nbsp;FancyIndexing&nbsp;ScanHTMLTitles</code>.</li>
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen <li>The addition of the incremental syntax
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog (<em>i.e.</em>, prefixing keywords with '+' or '-').</li>
5da8149fd33f07aabdac72880143ec13e516f933Tom Gundersen </ul>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <br>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog Whenever a '+' or '-' prefixed keyword is encountered, it
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog is applied to the current <code class="directive">IndexOptions</code>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog settings (which may have been inherited from an upper-level
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog directory). However, whenever an unprefixed keyword is
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog processed, it clears all inherited options and any
5da8149fd33f07aabdac72880143ec13e516f933Tom Gundersen incremental settings encountered so far. Consider the
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog following example:
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>IndexOptions +ScanHTMLTitles -IconsAreLinks
b90b025af151eb4e07121f86495d9362e54b3455Tom Gundersen FancyIndexing<br>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog IndexOptions +SuppressSize<br>
97578344f3bd03c8ea651d8888622e82c599eadfTom Gundersen</code></td></tr></table></blockquote>
987efa17dd5c9be156d8f49ddd942df20a72dcb1Tom Gundersen The net effect is equivalent to
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <code>IndexOptions&nbsp;FancyIndexing&nbsp;+SuppressSize</code>,
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog because the unprefixed <code>FancyIndexing</code> discarded
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog the incremental keywords before it, but allowed them to
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog start accumulating again afterward.<br>
5bdd314cd9954b605542571490738326f007c46cTom Gundersen <br>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog To unconditionally set the <code class="directive">IndexOptions</code> for a
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog particular directory, clearing the inherited settings,
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen specify keywords without any '+' or '-' prefixes.
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen </dd>
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen </dl>
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen<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
4958aee4977f325be19f0e1e4b424922c3cada5fTom GundersenAscending|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>
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen <p>The <code class="directive">IndexOrderDefault</code> directive is used
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen in combination with the <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen index option. By default, fancyindexed directory listings are
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen displayed in ascending order by filename; the
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen <code class="directive">IndexOrderDefault</code> allows you to change this initial
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen display order.</p>
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen <p><code class="directive">IndexOrderDefault</code> takes two
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen arguments. The first must be either <code>Ascending</code> or
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen <code>Descending</code>, indicating the direction of the sort.
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen The second argument must be one of the keywords <code>Name</code>,
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen <code>Date</code>, <code>Size</code>, or <code>Description</code>,
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen and identifies the primary key. The secondary key is
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen <em>always</em> the ascending filename.</p>
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen <p>You can force a directory listing to only be displayed in a
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen particular order by combining this directive with the <a href="#indexoptions:suppresscolumnsorting"><code>SuppressColumnSorting</code></a>
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen index option; this will prevent the client from requesting the
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen directory listing in a different order.</p>
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen<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>
5da8149fd33f07aabdac72880143ec13e516f933Tom Gundersen <p>The <code class="directive">ReadmeName</code> directive sets the name
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen of the file that will be appended to the end of the index
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen listing. <em>Filename</em> is the name of the file to include, and
4958aee4977f325be19f0e1e4b424922c3cada5fTom Gundersen is taken to be relative to the location being indexed.</p>
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen <p>See also <a href="#headername" class="directive"><code class="directive">HeaderName</code></a>, where this behavior
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen is described in greater detail.</p>
f5be560181d092c5f52a2b819aedcd48220f36abTom Gundersen<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>