mod_autoindex.html revision dff77f20d3ca0296e740d4369989e57949a06e92
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<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
more details.
<P><A
HREF="module-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Base
<BR>
<A
HREF="module-dict.html#SourceFile"
REL="Help"
<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>
the name of this file.
<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>.
</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
more details.
<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><A HREF="#addaltbyencoding">AddAltByEncoding</A>
<LI><A HREF="#addaltbytype">AddAltByType</A>
<LI><A HREF="#adddescription">AddDescription</A>
<LI><A HREF="#addicon">AddIcon</A>
<LI><A HREF="#addiconbyencoding">AddIconByEncoding</A>
<LI><A HREF="#addiconbytype">AddIconByType</A>
<LI><A HREF="#defaulticon">DefaultIcon</A>
<LI><A HREF="#headername">HeaderName</A>
<LI><A HREF="#indexignore">IndexIgnore</A>
<LI><A HREF="#indexoptions">IndexOptions</A>
<LI><A HREF="#indexorderdefault">IndexOrderDefault</A>
<LI><A HREF="#readmename">ReadmeName</A>
</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.
<ul>
<li><SAMP>C=N</SAMP> sorts the directory by file name
<li><SAMP>C=M</SAMP> sorts the directory by last-modified date, then file name
<li><SAMP>C=S</SAMP> sorts the directory by size, then file name
<li><SAMP>C=D</SAMP> sorts the directory by description, then file name<br />
<li><SAMP>O=A</SAMP> sorts the listing in Ascending Order
<li><SAMP>O=D</SAMP> sorts the listing in Descending Order<br />
<li><SAMP>F=0</SAMP> formats the listing as a simple list (not FancyIndexed)
<li><SAMP>F=1</SAMP> formats the listing as a FancyIndexed list
<li><SAMP>F=2</SAMP> formats the listing as an HTMLTable FancyIndexed list<br />
<li><SAMP>V=0</SAMP> disables version sorting
<li><SAMP>V=1</SAMP> enables version sorting<br />
<li><SAMP>P=<EM>pattern</EM></SAMP> lists only files matching the given <EM>pattern</EM>
</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 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.
<HR>
<H2><A 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.
<HR>
<H2><A 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>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.
<HR>
<H2><A 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:
</CODE></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>
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 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>] ...</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>
<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:
<BLOCKQUOTE><CODE>
AddIcon /icons/backup.xbm *~
</CODE></BLOCKQUOTE>
<A HREF="#addiconbytype">AddIconByType</A> should be used in preference to
AddIcon, when possible.<P><HR>
<H2><A 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>
<EM>Mime-encoding</EM> is a wildcard expression matching required the
content-encoding. Examples:
<BLOCKQUOTE><CODE>
AddIconByEncoding /icons/compress.xbm x-compress
</CODE></BLOCKQUOTE><P><HR>
<H2><A 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>
<EM>Mime-type</EM> is a wildcard expression matching required the mime types.
Examples:
<BLOCKQUOTE><CODE>
</CODE></BLOCKQUOTE><P><HR>
<H2><A 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:
<BLOCKQUOTE><CODE>
DefaultIcon /icon/unknown.xbm
</CODE></BLOCKQUOTE><P><HR>
<H2><A 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 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>etc.</EM>). This means that <EM>filename</EM> may refer to a CGI script if the
script's actual file type (as opposed to its output) is marked as
<PRE>
</PRE>
will be performed if the <SAMP>MultiViews</SAMP>
(not a CGI script) and the
the file will be processed for server-side includes (see the
</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>
See also <A HREF="#readmename">ReadmeName</A>.
<P><HR>
<H2><A 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:
<BLOCKQUOTE><CODE>
IndexIgnore README .htaccess *~
</CODE></BLOCKQUOTE><P><HR>
<H2><A 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
<DL>
<dt><a 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 NAME="indexoptions:fancyindexing">FancyIndexing</A>
<DD><!--%plaintext <?INDEX {\tt FancyIndexing} index option> -->
This turns on fancy indexing of directories.
<dt><a 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 NAME="indexoptions:htmltable">HTMLTable</A>
<i>(Experimental, Apache 2.0.23 and later)</i>
<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.
<DT><A NAME="indexoptions:iconsarelinks">IconsAreLinks</A>
<DD>
<!--%plaintext <?INDEX {\tt IconsAreLinks} index option> -->
This makes the icons part of the anchor for the filename, for
fancy indexing.
<DT><A NAME="indexoptions:iconheight">IconHeight[=pixels] (<EM>Apache 1.3 and later</EM>)</A>
<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.
<DT><A NAME="indexoptions:iconwidth">IconWidth[=pixels] (<EM>Apache 1.3 and later</EM>)</A>
<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.
<DT><A NAME="indexoptions:ignoreclient">IgnoreClient</A>
<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>.)
<DT><A NAME="indexoptions:namewidth">NameWidth=[<EM>n</EM> | *] (<EM>Apache 1.3.2 and later</EM>)</A>
<DD>
The NameWidth keyword allows you to specify the width of the
filename column in bytes.
<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 NAME="indexoptions:scanhtmltitles">ScanHTMLTitles</A>
<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.
<DT><A NAME="indexoptions:suppresscolumnsorting">SuppressColumnSorting</A>
(<EM>Apache 1.3 and later</EM>)
<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.
<DT><A NAME="indexoptions:suppressdescription">SuppressDescription</A>
<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.
<DT><A NAME="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</A>
(<EM>Apache 1.3 and later</EM>)
<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.
<DT><A NAME="indexoptions:suppressicon">SuppressIcon</A>
(<EM>Apache 2.0.23 and later</EM>)
<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.)
<DT><A NAME="indexoptions:suppresslastmodified">SuppressLastModified</A>
<DD>
<!--%plaintext <?INDEX {\tt SuppressLastModified} index option> -->
This will suppress the display of the last modification date, in fancy
indexing listings.
<DT><A NAME="indexoptions:suppressrules">SuppressRules</A>
(<EM>Apache 2.0.23 and later</EM>)
<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.)
<DT><A NAME="indexoptions:suppresssize">SuppressSize</A>
<DD>
<!--%plaintext <?INDEX {\tt SuppressSize} index option> -->
This will suppress the file size in fancy indexing listings.
<DT><A NAME="indexoptions:trackmodified">TrackModified
(<EM>Apache 1.3.15 or 2.0.23 and later</EM>)</A>
<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.
<DT><A NAME="indexoptions:versionsort">VersionSort (<EM>Apache 2.0a3 and later</EM>)</A>
<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>
<DT><H3>Incremental IndexOptions</H3>
<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>
keywords with '+' or '-').
</LI>
</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 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 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>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>