mod_autoindex.html.en revision 33f5e027b85636ab978d3f8e2c74b07e260f60b4
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
b99dbaab171d91e1b664397cc40e039d0c087c65fielding XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
f062ed7bd262a37a909dd77ce5fc23b446818823fielding This file is generated from xml source: DO NOT EDIT
2d2eda71267231c2526be701fe655db125852c1ffielding XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2d2eda71267231c2526be701fe655db125852c1ffielding --><title>mod_autoindex - Apache HTTP Server</title><link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /><link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /><link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link href="/images/favicon.ico" rel="shortcut icon" /></head><body><div id="page-header"><p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="/images/feather.gif" /></div><div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div><div id="page-content"><div id="preamble"><h1>Apache Module mod_autoindex</h1><table class="module"><tr><th><a href="module-dict.html#Description">Description:
2d2eda71267231c2526be701fe655db125852c1ffielding automatically, similar to the Unix <em>ls</em> command or the
2d2eda71267231c2526be701fe655db125852c1ffielding Win32 <em>dir</em> shell command</td></tr><tr><th><a href="module-dict.html#Status">Status:
2d2eda71267231c2526be701fe655db125852c1ffielding </a></th><td>Base</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:
2d2eda71267231c2526be701fe655db125852c1ffielding </a></th><td>autoindex_module</td></tr><tr><th><a href="module-dict.html#SourceFile">Source�File:
2d2eda71267231c2526be701fe655db125852c1ffielding </a></th><td>mod_autoindex.c</td></tr></table><h3>Summary</h3>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>The index of a directory can come from one of two
2d2eda71267231c2526be701fe655db125852c1ffielding sources:</p>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>A file written by the user, typically called
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <code>index.html</code>. The <code class="directive"><a href="/mod/mod_dir.html#directoryindex">DirectoryIndex</a></code> directive sets the
f062ed7bd262a37a909dd77ce5fc23b446818823fielding name of this file. This is controlled by
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <code class="module"><a href="/mod/mod_dir.html">mod_dir</a></code>.</li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <li>Otherwise, a listing generated by the server. The other
f062ed7bd262a37a909dd77ce5fc23b446818823fielding directives control the format of this listing. The <code class="directive"><a href="#addicon">AddIcon</a></code>, <code class="directive"><a href="#addiconbyencoding">AddIconByEncoding</a></code> and
2d2eda71267231c2526be701fe655db125852c1ffielding <code class="directive"><a href="#addiconbytype">AddIconByType</a></code> are
f062ed7bd262a37a909dd77ce5fc23b446818823fielding used to set a list of icons to display for various file types;
f062ed7bd262a37a909dd77ce5fc23b446818823fielding for each file listed, the first icon listed that matches the
f062ed7bd262a37a909dd77ce5fc23b446818823fielding file is displayed. These are controlled by
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <code class="module"><a href="/mod/mod_autoindex.html">mod_autoindex</a></code>.</li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <p>The two functions are separated so that you can completely
f062ed7bd262a37a909dd77ce5fc23b446818823fielding remove (or replace) automatic index generation should you want
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <p>Automatic index generation is enabled with using
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <code class="directive"><a href="/mod/core.html#options">Options</a></code> directive for
f062ed7bd262a37a909dd77ce5fc23b446818823fielding more details.</p>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <p>If the <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code> option is given with the <code class="directive"><a href="#indexoptions">IndexOptions</a></code> directive,
f062ed7bd262a37a909dd77ce5fc23b446818823fielding the column headers are links that control the order of the
f062ed7bd262a37a909dd77ce5fc23b446818823fielding display. If you select a header link, the listing will be
f062ed7bd262a37a909dd77ce5fc23b446818823fielding regenerated, sorted by the values in that column. Selecting the
f062ed7bd262a37a909dd77ce5fc23b446818823fielding same header repeatedly toggles between ascending and descending
f062ed7bd262a37a909dd77ce5fc23b446818823fielding order. These column header links are suppressed with
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <code class="directive"><a href="#indexoptions">IndexOptions</a></code> directive's
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Note that when the display is sorted by "Size", it's the
f062ed7bd262a37a909dd77ce5fc23b446818823fielding <em>actual</em> size of the files that's used, not the
f062ed7bd262a37a909dd77ce5fc23b446818823fielding displayed value - so a 1010-byte file will always be displayed
f062ed7bd262a37a909dd77ce5fc23b446818823fielding before a 1011-byte file (if in ascending order) even though
2d2eda71267231c2526be701fe655db125852c1ffielding they both are shown as "1K".</p>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding</div><div id="quickview"><h3 class="directives">Directives</h3><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#addalt">AddAlt</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#addaltbyencoding">AddAltByEncoding</a></li>
f062ed7bd262a37a909dd77ce5fc23b446818823fielding<li><img alt="" src="/images/down.gif" /> <a href="#addaltbytype">AddAltByType</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#adddescription">AddDescription</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#addicon">AddIcon</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#addiconbyencoding">AddIconByEncoding</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#addiconbytype">AddIconByType</a></li>
2d2eda71267231c2526be701fe655db125852c1ffielding<li><img alt="" src="/images/down.gif" /> <a href="#defaulticon">DefaultIcon</a></li>
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb<li><img alt="" src="/images/down.gif" /> <a href="#headername">HeaderName</a></li>
b980ad7fdc218b4855cde9f75a747527f50c554dwrowe<li><img alt="" src="/images/down.gif" /> <a href="#indexignore">IndexIgnore</a></li>
ab5581cc78e9d865b0a6ab1404c53347b3276968rbb<li><img alt="" src="/images/down.gif" /> <a href="#indexoptions">IndexOptions</a></li>
92f3af936ce61f25358a3ee4f28df2f6d62040dfdreid<li><img alt="" src="/images/down.gif" /> <a href="#indexorderdefault">IndexOrderDefault</a></li>
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb<li><img alt="" src="/images/down.gif" /> <a href="#readmename">ReadmeName</a></li>
c9a95767fbf0f5fb0976a06b97a256033925e433rbb</ul><h3>Topics</h3><ul id="topics"><li><img alt="" src="/images/down.gif" /> Autoindex Request Query Arguments</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="section"><h2>Autoindex Request Query Arguments</h2>
2d2eda71267231c2526be701fe655db125852c1ffielding <p>Apache 2.0.23 reorganized the Query Arguments for Column
2d2eda71267231c2526be701fe655db125852c1ffielding Sorting, and introduced an entire group of new query options.
2d2eda71267231c2526be701fe655db125852c1ffielding To effectively eliminate all client control over the output,
2d2eda71267231c2526be701fe655db125852c1ffielding the <code><a href="#indexoptions:ignoreclient">IndexOptions
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p>The column sorting headers themselves are self-referencing
61fd0cab072a05b855cbef9c585702401ac5ae29rbb hyperlinks that add the sort query options shown below. Any
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb option below may be added to any request for the directory
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb resource.</p>
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb <li><code>C=N</code> sorts the directory by file name</li>
2d2eda71267231c2526be701fe655db125852c1ffielding <li><code>C=M</code> sorts the directory by last-modified
2d2eda71267231c2526be701fe655db125852c1ffielding date, then file name</li>
2d2eda71267231c2526be701fe655db125852c1ffielding <li><code>C=S</code> sorts the directory by size, then file
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <li><code>C=D</code> sorts the directory by description, then
61fd0cab072a05b855cbef9c585702401ac5ae29rbb file name<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <li><code>O=A</code> sorts the listing in Ascending
bfb62a96023822c56c9120e4ee627d4091cc59c2rbb Order</li>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb Order<br />
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <li><code>F=0</code> formats the listing as a simple list
61fd0cab072a05b855cbef9c585702401ac5ae29rbb (not FancyIndexed)</li>
2d2eda71267231c2526be701fe655db125852c1ffielding <li><code>F=1</code> formats the listing as a FancyIndexed
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <li><code>F=2</code> formats the listing as an HTMLTable
61fd0cab072a05b855cbef9c585702401ac5ae29rbb FancyIndexed list<br />
2d2eda71267231c2526be701fe655db125852c1ffielding <li><code>P=<em>pattern</em></code> lists only files matching
000b67449410515eac43e76ef6667915bfd4d2abgstein <p>Note that the 'P'attern query argument is tested
2d2eda71267231c2526be701fe655db125852c1ffielding <em>after</em> the usual IndexIgnore directives are processed,
2d2eda71267231c2526be701fe655db125852c1ffielding and all file names are still subjected to the same criteria as
2d2eda71267231c2526be701fe655db125852c1ffielding any other autoindex listing. The Query Arguments parser in
61fd0cab072a05b855cbef9c585702401ac5ae29rbb mod_autoindex will stop abruptly when an unrecognized option is
61fd0cab072a05b855cbef9c585702401ac5ae29rbb encountered. The Query Arguments must be well formed, according
61fd0cab072a05b855cbef9c585702401ac5ae29rbb to the table above.</p>
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein <p>The simple example below, which can be clipped and saved in
61fd0cab072a05b855cbef9c585702401ac5ae29rbb a header.html file, illustrates these query options. Note that
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein the unknown "X" argument, for the submit button, is listed last
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein to assure the arguments are all parsed before mod_autoindex
61fd0cab072a05b855cbef9c585702401ac5ae29rbb encounters the X=Go input.</p>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb<form action="" method="get">
61fd0cab072a05b855cbef9c585702401ac5ae29rbb Show me a <select name="F">
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <option value="0"> Plain list</option>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <option value="1" selected="selected"> Fancy list</option>
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein <option value="2"> Table list</option>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </select>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb Sorted by <select name="C">
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <option value="N" selected="selected"> Name</option>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <option value="M"> Date Modified</option>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <option value="S"> Size</option>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <option value="D"> Description</option>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </select>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <select name="O">
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <option value="A" selected="selected"> Ascending</option>
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein <option value="D"> Descending</option>
c9a95767fbf0f5fb0976a06b97a256033925e433rbb </select>
c9a95767fbf0f5fb0976a06b97a256033925e433rbb <select name="V">
c9a95767fbf0f5fb0976a06b97a256033925e433rbb <option value="0" selected="selected"> in Normal order</option>
c9a95767fbf0f5fb0976a06b97a256033925e433rbb <option value="1"> in Version order</option>
c9a95767fbf0f5fb0976a06b97a256033925e433rbb </select>
c9a95767fbf0f5fb0976a06b97a256033925e433rbb Matching <input type="text" name="P" value="*" />
c9a95767fbf0f5fb0976a06b97a256033925e433rbb <input type="submit" name="X" value="Go" />
c9a95767fbf0f5fb0976a06b97a256033925e433rbb</form>
c9a95767fbf0f5fb0976a06b97a256033925e433rbb</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddAlt" id="AddAlt">AddAlt</a> <a name="addalt" id="addalt">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
c9a95767fbf0f5fb0976a06b97a256033925e433rbb </a></th><td>Alternate text to display for a file, instead of an
c9a95767fbf0f5fb0976a06b97a256033925e433rbbicon selected by filename</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td><code>AddAlt <em>string file</em> [<em>file</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p><code class="directive">AddAlt</code> provides the alternate text to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <em>File</em> is a file extension, partial filename, wild-card
61fd0cab072a05b855cbef9c585702401ac5ae29rbb expression or full filename for files to describe.
3d96ee83babeec32482c9082c9426340cee8c44dwrowe If <em>String</em> contains any whitespace, you have to enclose it
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein in quotes (<code>"</code> or <code>'</code>). This alternate text
61fd0cab072a05b855cbef9c585702401ac5ae29rbb is displayed if the client is image-incapable, has image loading
61fd0cab072a05b855cbef9c585702401ac5ae29rbb disabled, or fails to retrieve the icon.</p>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe AddAlt "PDF file" *.pdf<br />
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein AddAlt Compressed *.gz *.zip *.Z
61fd0cab072a05b855cbef9c585702401ac5ae29rbb</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddAltByEncoding" id="AddAltByEncoding">AddAltByEncoding</a> <a name="addaltbyencoding" id="addaltbyencoding">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Alternate text to display for a file instead of an icon
61fd0cab072a05b855cbef9c585702401ac5ae29rbbselected by MIME-encoding</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td><code>AddAltByEncoding <em>string MIME-encoding</em>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe[<em>MIME-encoding</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
7bdef86e15d47d16dcbe7a5611683191774bd5fbgstein </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p><code class="directive">AddAltByEncoding</code> provides the alternate
61fd0cab072a05b855cbef9c585702401ac5ae29rbb text to display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <em>MIME-encoding</em> is a valid content-encoding, such as
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code>x-compress</code>. If <em>String</em> contains any whitespace,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb you have to enclose it in quotes (<code>"</code> or <code>'</code>).
3d96ee83babeec32482c9082c9426340cee8c44dwrowe This alternate text is displayed if the client is image-incapable,
2d2eda71267231c2526be701fe655db125852c1ffielding has image loading disabled, or fails to retrieve the icon.</p>
2d2eda71267231c2526be701fe655db125852c1ffielding AddAltByEncoding gzip x-gzip
2d2eda71267231c2526be701fe655db125852c1ffielding</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddAltByType" id="AddAltByType">AddAltByType</a> <a name="addaltbytype" id="addaltbytype">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
2d2eda71267231c2526be701fe655db125852c1ffielding </a></th><td>Alternate text to display for a file, instead of an
2d2eda71267231c2526be701fe655db125852c1ffieldingicon selected by MIME content-type</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
2d2eda71267231c2526be701fe655db125852c1ffielding MIME-type</em> [<em>MIME-type</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
2d2eda71267231c2526be701fe655db125852c1ffielding </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p><code class="directive">AddAltByType</code> sets the alternate text to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code>text/html</code>. If <em>String</em> contains any whitespace,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb you have to enclose it in quotes (<code>"</code> or <code>'</code>).
61fd0cab072a05b855cbef9c585702401ac5ae29rbb This alternate text is displayed if the client is image-incapable,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb has image loading disabled, or fails to retrieve the icon.</p>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddDescription" id="AddDescription">AddDescription</a> <a name="adddescription" id="adddescription">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Description to display for a file</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <em>string file</em> [<em>file</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>This sets the description to display for a file, for
2d2eda71267231c2526be701fe655db125852c1ffielding <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
23ff73a56371e21f16744cb94d06399b877829f1rbb <em>File</em> is a file extension, partial filename, wild-card
2d2eda71267231c2526be701fe655db125852c1ffielding expression or full filename for files to describe.
62db15de4c1f335a64d45821796ae197cff94ef8rbb <em>String</em> is enclosed in double quotes (<code>"</code>).
62db15de4c1f335a64d45821796ae197cff94ef8rbb Example:</p>
62db15de4c1f335a64d45821796ae197cff94ef8rbb<div class="example"><p><code>AddDescription "The planet Mars"
62db15de4c1f335a64d45821796ae197cff94ef8rbb <p>The typical, default description field is 23 bytes wide. 6
62db15de4c1f335a64d45821796ae197cff94ef8rbb more bytes are added by the
62db15de4c1f335a64d45821796ae197cff94ef8rbb <code>IndexOptions�SuppressIcon</code> option, 7 bytes are
62db15de4c1f335a64d45821796ae197cff94ef8rbb option, and 19 bytes are added by the
62db15de4c1f335a64d45821796ae197cff94ef8rbb Therefore, the widest default the description column is ever
62db15de4c1f335a64d45821796ae197cff94ef8rbb assigned is 55 bytes.</p>
62db15de4c1f335a64d45821796ae197cff94ef8rbb <p>See the <a href="#indexoptions:descriptionwidth">DescriptionWidth</a>
62db15de4c1f335a64d45821796ae197cff94ef8rbb <code class="directive"><a href="#indexoptions">IndexOptions</a></code> keyword
62db15de4c1f335a64d45821796ae197cff94ef8rbb for details on overriding the size of this column, or allowing
62db15de4c1f335a64d45821796ae197cff94ef8rbb descriptions of unlimited length.</p>
62db15de4c1f335a64d45821796ae197cff94ef8rbb<div class="note"><h3>Caution</h3> <p>Descriptive text defined with
62db15de4c1f335a64d45821796ae197cff94ef8rbb <code class="directive">AddDescription</code> may contain HTML markup, such as
62db15de4c1f335a64d45821796ae197cff94ef8rbb tags and character entities. If the width of the description
62db15de4c1f335a64d45821796ae197cff94ef8rbb column should happen to truncate a tagged element (such as
62db15de4c1f335a64d45821796ae197cff94ef8rbb cutting off the end of a bolded phrase), the results may
62db15de4c1f335a64d45821796ae197cff94ef8rbb affect the rest of the directory listing.</p>
62db15de4c1f335a64d45821796ae197cff94ef8rbb</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddIcon" id="AddIcon">AddIcon</a> <a name="addicon" id="addicon">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
62db15de4c1f335a64d45821796ae197cff94ef8rbb </a></th><td>Icon to display for a file selected by name</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
62db15de4c1f335a64d45821796ae197cff94ef8rbb name</em> [<em>name</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
62db15de4c1f335a64d45821796ae197cff94ef8rbb </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <p>This sets the icon to display next to a file ending in
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <em>name</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <em>Icon</em> is either a (%-escaped) relative URL to the icon,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar non-graphical browsers.</p>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <p><em>Name</em> is either ^^DIRECTORY^^ for directories,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar ^^BLANKICON^^ for blank lines (to format the list correctly), a
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar file extension, a wildcard expression, a partial filename or a
3d96ee83babeec32482c9082c9426340cee8c44dwrowe complete filename. Examples:</p>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <p><code class="directive"><a href="#addiconbytype">AddIconByType</a></code>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar should be used in preference to <code class="directive">AddIcon</code>,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar when possible.</p>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddIconByEncoding" id="AddIconByEncoding">AddIconByEncoding</a> <a name="addiconbyencoding" id="addiconbyencoding">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar </a></th><td>Icon to display next to files selected by MIME
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarcontent-encoding</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <em>icon MIME-encoding</em> [<em>MIME-encoding</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>This sets the icon to display next to files with <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <em>Icon</em> is either a (%-escaped) relative URL to the icon,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar non-graphical browsers.</p>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <p><em>Mime-encoding</em> is a wildcard expression matching
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar required the content-encoding. Examples:</p>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar<div class="example"><p><code>AddIconByEncoding /icons/compress.xbm x-compress</code></p></div>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddIconByType" id="AddIconByType">AddIconByType</a> <a name="addiconbytype" id="addiconbytype">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
3d96ee83babeec32482c9082c9426340cee8c44dwrowe </a></th><td>Icon to display next to files selected by MIME
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarcontent-type</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <em>icon MIME-type</em> [<em>MIME-type</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <p>This sets the icon to display next to files of type
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <em>MIME-type</em> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <em>Icon</em> is either a (%-escaped) relative URL to the icon,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar non-graphical browsers.</p>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar <p><em>Mime-type</em> is a wildcard expression matching
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar required the mime types. Examples:</p>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar<div class="example"><p><code>AddIconByType (IMG,/icons/image.xbm) image/*</code></p></div>
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="DefaultIcon" id="DefaultIcon">DefaultIcon</a> <a name="defaulticon" id="defaulticon">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
3d96ee83babeec32482c9082c9426340cee8c44dwrowe </a></th><td>Icon to display for files when no specific icon is
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coarconfigured</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
2d2eda71267231c2526be701fe655db125852c1ffielding </a></th><td><code>DefaultIcon <em>url-path</em></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
2d2eda71267231c2526be701fe655db125852c1ffielding </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
2d2eda71267231c2526be701fe655db125852c1ffielding </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
2d2eda71267231c2526be701fe655db125852c1ffielding </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p>The <code class="directive">DefaultIcon</code> directive sets the icon
61fd0cab072a05b855cbef9c585702401ac5ae29rbb to display for files when no specific icon is known, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <em>Url-path</em> is a (%-escaped) relative URL to the icon.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb Examples:</p>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb<div class="example"><p><code>DefaultIcon /icon/unknown.xbm</code></p></div>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="HeaderName" id="HeaderName">HeaderName</a> <a name="headername" id="headername">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
3d96ee83babeec32482c9082c9426340cee8c44dwrowe </a></th><td>Name of the file that will be inserted at the top
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgsteinof the index listing</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td><code>HeaderName <em>filename</em></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p>The <code class="directive">HeaderName</code> directive sets the name
61fd0cab072a05b855cbef9c585702401ac5ae29rbb of the file that will be inserted at the top of the index
3d96ee83babeec32482c9082c9426340cee8c44dwrowe listing. <em>Filename</em> is the name of the file to include.</p>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p>Both HeaderName and <code class="directive"><a href="#readmename">ReadmeName</a></code> now treat
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <em>Filename</em> as a URI path relative to the one used to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb access the directory being indexed. If <em>Filename</em> begins
3d96ee83babeec32482c9082c9426340cee8c44dwrowe with a slash, it will be taken to be relative to the <code class="directive"><a href="/mod/core.html#documentroot">DocumentRoot</a></code>.</p>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb resolve to a document with a major content type of
61fd0cab072a05b855cbef9c585702401ac5ae29rbb "<code>text/*</code>" (<em>e.g.</em>, <code>text/html</code>,
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <code>text/plain</code>, <em>etc.</em>). This means that
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein <em>filename</em> may refer to a CGI script if the script's
61fd0cab072a05b855cbef9c585702401ac5ae29rbb actual file type (as opposed to its output) is marked as
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code>text/html</code> such as with a directive like:</p>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p><a href="/content-negotiation.html">Content negotiation</a>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb will be performed if <code class="directive"><a href="/mod/core.html#options">Options</a></code>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code>MultiViews</code> is in effect. If <em>filename</em> resolves
3d96ee83babeec32482c9082c9426340cee8c44dwrowe to a static <code>text/html</code> document (not a CGI script) and
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein either one of the <code class="directive"><a href="/mod/core.html#options">options</a></code>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code>Includes</code> or <code>IncludesNOEXEC</code> is enabled,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb the file will be processed for server-side includes (see the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code class="module"><a href="/mod/mod_include.html">mod_include</a></code> documentation).</p>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p>If the file specified by <code class="directive">HeaderName</code> contains
61fd0cab072a05b855cbef9c585702401ac5ae29rbb the beginnings of an HTML document (<HTML>, <HEAD>,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb etc) then you will probably want to set <a href="#indexoptions:suppresshtmlpreamble"><code>IndexOptions
3d96ee83babeec32482c9082c9426340cee8c44dwrowe +SuppressHTMLPreamble</code></a>, so that these tags are not
2d2eda71267231c2526be701fe655db125852c1ffielding repeated.</p>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="IndexIgnore" id="IndexIgnore">IndexIgnore</a> <a name="indexignore" id="indexignore">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Adds to the list of files to hide when listing
61fd0cab072a05b855cbef9c585702401ac5ae29rbba directory</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td><code>IndexIgnore <em>file</em> [<em>file</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
3d96ee83babeec32482c9082c9426340cee8c44dwrowe </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <p>The <code class="directive">IndexIgnore</code> directive adds to the
2d2eda71267231c2526be701fe655db125852c1ffielding list of files to hide when listing a directory. <em>File</em> is a
2d2eda71267231c2526be701fe655db125852c1ffielding file extension, partial filename, wildcard expression or full
61fd0cab072a05b855cbef9c585702401ac5ae29rbb filename for files to ignore. Multiple IndexIgnore directives add
61fd0cab072a05b855cbef9c585702401ac5ae29rbb to the list, rather than the replacing the list of ignored
61fd0cab072a05b855cbef9c585702401ac5ae29rbb files. By default, the list contains
2d2eda71267231c2526be701fe655db125852c1ffielding<div class="example"><p><code>IndexIgnore README .htaccess *~</code></p></div>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="IndexOptions" id="IndexOptions">IndexOptions</a> <a name="indexoptions" id="indexoptions">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
d839a9822ee53ce00da24c15f2d9fe054233d342gstein </a></th><td>Various configuration settings for directory
d839a9822ee53ce00da24c15f2d9fe054233d342gsteinindexing</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
d839a9822ee53ce00da24c15f2d9fe054233d342gstein </a></th><td><code>IndexOptions [+|-]<em>option</em> [[+|-]<em>option</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
61fd0cab072a05b855cbef9c585702401ac5ae29rbb </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <p>The <code class="directive">IndexOptions</code> directive specifies the
d839a9822ee53ce00da24c15f2d9fe054233d342gstein behavior of the directory indexing. <em>Option</em> can be one
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb | *] (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a></dt>
346029f34d03eb20d84fc35664426d3874b00f9ewrowe <dd>The <code>DescriptionWidth</code> keyword allows you to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb specify the width of the description column in
61fd0cab072a05b855cbef9c585702401ac5ae29rbb characters.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb mod_autoindex to calculate the best width.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dd><code>DescriptionWidth=n</code> fixes the column width to
3d96ee83babeec32482c9082c9426340cee8c44dwrowe n bytes wide.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dd><code>DescriptionWidth=*</code> grows the column to the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb width necessary to accommodate the longest description
61fd0cab072a05b855cbef9c585702401ac5ae29rbb string.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dd><strong>See the section on <code class="directive"><a href="#adddescription">AddDescription</a></code> for dangers
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:fancyindexing">FancyIndexing</a></dt>
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein This turns on fancy indexing of directories.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:foldersfirst">FoldersFirst (<em>Apache
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dd>If this option is enabled, subdirectory listings will
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <em>always</em> appear first, followed by normal files in the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb directory. The listing is basically broken into two
61fd0cab072a05b855cbef9c585702401ac5ae29rbb components, the files and the subdirectories, and each is
11a7b0dff22d26770b532c174d1cf2e7b56ec244wrowe sorted separately and then displayed subdirectories-first.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb For instance, if the sort order is descending by name, and
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code>Beta</code>, which will be listed before normal files
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code>Gamma</code> and <code>Alpha</code>. <strong>This option
61fd0cab072a05b855cbef9c585702401ac5ae29rbb only has an effect if <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:htmltable">HTMLTable</a> <em>(Experimental,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb This experimental option with FancyIndexing constructs a
61fd0cab072a05b855cbef9c585702401ac5ae29rbb simple table for the fancy directory listing. Note this will
3d96ee83babeec32482c9082c9426340cee8c44dwrowe confuse older browsers. It is particularly necessary if file
2d2eda71267231c2526be701fe655db125852c1ffielding names or description text will alternate between
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein left-to-right and right-to-left reading order, as can happen
61fd0cab072a05b855cbef9c585702401ac5ae29rbb on WinNT or other utf-8 enabled platforms.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:iconsarelinks">IconsAreLinks</a></dt>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb This makes the icons part of the anchor for the filename, for
61fd0cab072a05b855cbef9c585702401ac5ae29rbb fancy indexing.</dd>
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein <dt><a name="indexoptions:iconheight">IconHeight[=pixels]
61fd0cab072a05b855cbef9c585702401ac5ae29rbb Presence of this option, when used with IconWidth, will cause
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code>WIDTH</code> attributes in the <code>IMG</code> tag for
61fd0cab072a05b855cbef9c585702401ac5ae29rbb the file icon. This allows browser to precalculate the page
3d96ee83babeec32482c9082c9426340cee8c44dwrowe layout without having to wait until all the images have been
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein loaded. If no value is given for the option, it defaults to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb the standard height of the icons supplied with the Apache
61fd0cab072a05b855cbef9c585702401ac5ae29rbb software.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:iconwidth">IconWidth[=pixels] (<em>Apache
3d96ee83babeec32482c9082c9426340cee8c44dwrowe Presence of this option, when used with IconHeight, will
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code>WIDTH</code> attributes in the <code>IMG</code> tag for
61fd0cab072a05b855cbef9c585702401ac5ae29rbb the file icon. This allows browser to precalculate the page
61fd0cab072a05b855cbef9c585702401ac5ae29rbb layout without having to wait until all the images have been
61fd0cab072a05b855cbef9c585702401ac5ae29rbb loaded. If no value is given for the option, it defaults to
61fd0cab072a05b855cbef9c585702401ac5ae29rbb the standard width of the icons supplied with the Apache
61fd0cab072a05b855cbef9c585702401ac5ae29rbb software.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:ignoreclient">IgnoreClient</a></dt>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb This option causes mod_autoindex to ignore all query
61fd0cab072a05b855cbef9c585702401ac5ae29rbb variables from the client, including sort order (implies
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <code><a href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></code>.)</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding <dt><a name="indexoptions:namewidth">NameWidth=[<em>n</em> | *]
346029f34d03eb20d84fc35664426d3874b00f9ewrowe <dd>The NameWidth keyword allows you to specify the width of
61fd0cab072a05b855cbef9c585702401ac5ae29rbb the filename column in bytes.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dd><code>-NameWidth</code> (or unset) allows mod_autoindex
346029f34d03eb20d84fc35664426d3874b00f9ewrowe to calculate the best width.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dd><code>NameWidth=n</code> fixes the column width to n
61fd0cab072a05b855cbef9c585702401ac5ae29rbb bytes wide.</dd>
2d2eda71267231c2526be701fe655db125852c1ffielding necessary width.</dd>
fd8b91502bc200ed4cca3810560a2a570522b3debrianp <dt><a name="indexoptions:scanhtmltitles">ScanHTMLTitles</a></dt>
fd8b91502bc200ed4cca3810560a2a570522b3debrianp This enables the extraction of the title from HTML documents
fd8b91502bc200ed4cca3810560a2a570522b3debrianp for fancy indexing. If the file does not have a description
fd8b91502bc200ed4cca3810560a2a570522b3debrianp given by <a href="#adddescription">AddDescription</a> then
fd8b91502bc200ed4cca3810560a2a570522b3debrianp httpd will read the document for the value of the TITLE tag.
fd8b91502bc200ed4cca3810560a2a570522b3debrianp This is CPU and disk intensive.</dd>
fd8b91502bc200ed4cca3810560a2a570522b3debrianp <dt><a name="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a>
fd8b91502bc200ed4cca3810560a2a570522b3debrianp If specified, Apache will not make the column headings in a
fd8b91502bc200ed4cca3810560a2a570522b3debrianp FancyIndexed directory listing into links for sorting. The
fd8b91502bc200ed4cca3810560a2a570522b3debrianp default behavior is for them to be links; selecting the
fd8b91502bc200ed4cca3810560a2a570522b3debrianp column heading will sort the directory listing by the values
fd8b91502bc200ed4cca3810560a2a570522b3debrianp in that column. <strong>Prior to Apache 2.0.23, this also
fd8b91502bc200ed4cca3810560a2a570522b3debrianp disabled parsing the Query Arguments for the sort
fd8b91502bc200ed4cca3810560a2a570522b3debrianp string.</strong> That behavior is now controlled by <a href="#indexoptions:ignoreclient">IndexOptions
fd8b91502bc200ed4cca3810560a2a570522b3debrianp <dt><a name="indexoptions:suppressdescription">SuppressDescription</a></dt>
fd8b91502bc200ed4cca3810560a2a570522b3debrianp This will suppress the file description in fancy indexing
fd8b91502bc200ed4cca3810560a2a570522b3debrianp listings. By default, no file descriptions are defined, and
61fd0cab072a05b855cbef9c585702401ac5ae29rbb so the use of this option will regain 23 characters of screen
61fd0cab072a05b855cbef9c585702401ac5ae29rbb space to use for something else. See <a href="#adddescription"><code>AddDescription</code></a> for
2d2eda71267231c2526be701fe655db125852c1ffielding information about setting the file description. See also the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <a href="#indexoptions:descriptionwidth"><code>DescriptionWidth</code></a>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb index option to limit the size of the description
61fd0cab072a05b855cbef9c585702401ac5ae29rbb column.</dd>
3d96ee83babeec32482c9082c9426340cee8c44dwrowe <dt><a name="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a>
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar If the directory actually contains a file specified by the
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar <code class="directive"><a href="#headername">HeaderName</a></code>
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar directive, the module usually includes the contents of the file
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar after a standard HTML preamble (<HTML>, <HEAD>,
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar <em>et cetera</em>). The SuppressHTMLPreamble option disables
3d96ee83babeec32482c9082c9426340cee8c44dwrowe this behaviour, causing the module to start the display with the
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar header file contents. The header file must contain appropriate
d5df46b7972c0c4a5ca0ba5068e238f6053c2e6ftrawick HTML instructions in this case. If there is no header file, the
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding preamble is generated as usual.</dd>
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding <dt><a name="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
61fd0cab072a05b855cbef9c585702401ac5ae29rbb This will suppress the icon in fancy indexing listings.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <em>SuppressRules</em> yields proper HTML 3.2 output, which
61fd0cab072a05b855cbef9c585702401ac5ae29rbb by the final specification prohibits IMG and HR tags from the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb PRE block (used to format FancyIndexed listings.)</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:suppresslastmodified">SuppressLastModified</a></dt>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb This will suppress the display of the last modification date,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb in fancy indexing listings.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:suppressrules">SuppressRules</a>
42ce672c516baf6e4eaed18ccc1647de2d456d8edougm This will suppress the horizontal rule lines (HR tags) in
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein directory listings. Combining both <em>SuppressIcon</em> and
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <em>SuppressRules</em> yeilds proper HTML 3.2 output, which
61fd0cab072a05b855cbef9c585702401ac5ae29rbb by the final specification prohibits IMG and HR tags from the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb PRE block (used to format FancyIndexed listings.)</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:suppresssize">SuppressSize</a></dt>
42ce672c516baf6e4eaed18ccc1647de2d456d8edougm This will suppress the file size in fancy indexing
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein listings.</dd>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb <dt><a name="indexoptions:trackmodified">TrackModified (<em>Apache
61fd0cab072a05b855cbef9c585702401ac5ae29rbb This returns the Last-Modified and ETag values for the listed
42ce672c516baf6e4eaed18ccc1647de2d456d8edougm directory in the HTTP header. It is only valid if the
fd0edaa8e3d4dd67d0604ccef2e96b071db96643fielding operating system and file system return appropriate stat()
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb results. Some Unix systems do so, as do OS2's JFS and Win32's
a6b9ed64fdf548c61de9714e2cfb999ec59d149cgstein NTFS volumes. OS2 and Win32 FAT volumes, for example, do not.
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb Once this feature is enabled, the client or proxy can track
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb changes to the list of files when they perform a HEAD
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb request. Note some operating systems correctly track new and
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb removed files, but do not track changes for sizes or dates of
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb the files within the directory. <strong>Changes to the size
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb or date stamp of an existing file will not update the
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb Last-Modified header on all Unix platforms.</strong> If this
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb is a concern, leave this option disabled.</dd>
8b7047e519340545e6807c9749576a40a76b6d3frbb <dt><a name="indexoptions:versionsort">VersionSort (<em>Apache 2.0a3
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb The VersionSort keyword causes files containing version
9484ae61c7cc5fa8d8d9a836efdbdb1e88d3036dwrowe numbers to sort in a natural way. Strings are sorted as
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb usual, except that substrings of digits in the name and
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb description are compared according to their numeric value.
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb For example:
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbbfoo-1.7<br />
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbbfoo-1.7.2<br />
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbbfoo-1.7.12<br />
561e5f16a2f9fb397aac4c283aaa87a752520a4ddougmfoo-1.8.2<br />
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbbfoo-1.8.2a<br />
561e5f16a2f9fb397aac4c283aaa87a752520a4ddougmfoo-1.12<br />
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb If the number starts with a zero, then it is considered to
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb be a fraction:
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbbfoo-1.001<br />
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbbfoo-1.002<br />
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbbfoo-1.030<br />
c9a95767fbf0f5fb0976a06b97a256033925e433rbb Apache 1.3.3 introduced some significant changes in the
c9a95767fbf0f5fb0976a06b97a256033925e433rbb handling of <code class="directive">IndexOptions</code> directives. In
c9a95767fbf0f5fb0976a06b97a256033925e433rbb particular,<br />
c9a95767fbf0f5fb0976a06b97a256033925e433rbb <li>Multiple <code class="directive">IndexOptions</code> directives for a
c9a95767fbf0f5fb0976a06b97a256033925e433rbb single directory are now merged together. The result of
2d2eda71267231c2526be701fe655db125852c1ffielding the example above will now be the equivalent of
2d2eda71267231c2526be701fe655db125852c1ffielding <code>IndexOptions�FancyIndexing�ScanHTMLTitles</code>.</li>
2d2eda71267231c2526be701fe655db125852c1ffielding <li>The addition of the incremental syntax
2d2eda71267231c2526be701fe655db125852c1ffielding (<em>i.e.</em>, prefixing keywords with '+' or '-').</li>
</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="IndexOrderDefault" id="IndexOrderDefault">IndexOrderDefault</a> <a name="indexorderdefault" id="indexorderdefault">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Sets the default ordering of the directory index</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
Ascending|Descending Name|Date|Size|Description</code></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>IndexOrderDefault Ascending Name</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
particular order by combining this directive with the <a href="#indexoptions:suppresscolumnsorting"><code>SuppressColumnSorting</code></a>
</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="directive-section"><h2><a name="ReadmeName" id="ReadmeName">ReadmeName</a> <a name="readmename" id="readmename">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td><code>ReadmeName <em>filename</em></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
relative to the <code class="directive"><a href="/mod/core.html#documentroot">DocumentRoot</a></code>.
ReadmeName FOOTER.html
<p>See also <code class="directive"><a href="#headername">HeaderName</a></code>, where this behavior
</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div></body></html>