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