mod_autoindex.html revision 7fc6bb03c583147c40e349d1978b91414cc5407e
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<HTML>
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<HEAD>
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<TITLE>Apache module mod_autoindex</TITLE>
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey</HEAD>
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<BODY
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey BGCOLOR="#FFFFFF"
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey TEXT="#000000"
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey LINK="#0000FF"
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey VLINK="#000080"
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey ALINK="#FF0000"
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey>
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<!--#include virtual="header.html" -->
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<H1 ALIGN="CENTER">Module mod_autoindex</H1>
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom RumseyThis module is contained in the <CODE>mod_autoindex.c</CODE> file, and
8367f835047e57c70a508975d020905f0173f51aTom Rumseyis compiled in by default. It provides for automatic directory indexing.
8367f835047e57c70a508975d020905f0173f51aTom Rumsey
8367f835047e57c70a508975d020905f0173f51aTom Rumsey<H2>Summary</H2>
8367f835047e57c70a508975d020905f0173f51aTom RumseyThe index of a directory can come from one of two sources:
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<UL>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI>A file written by the user, typically called <CODE>index.html</CODE>.
f3fa3b65e8ebafc90b1044cf522ee35213299c42Tom RumseyThe <A HREF="mod_dir.html#directoryindex">DirectoryIndex</A> directive sets
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseythe name of this file.
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom RumseyThis is controlled by <A HREF="mod_dir.html"><CODE>mod_dir</CODE></A>.
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI>Otherwise, a listing generated by the server. The other directives
8367f835047e57c70a508975d020905f0173f51aTom Rumseycontrol the format of this listing. The <A HREF="#addicon">AddIcon</A>,
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A HREF="#addiconbyencoding">AddIconByEncoding</A> and
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A HREF="#addiconbytype">AddIconByType</A> are used to set a list of
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseyicons to display for various file types; for each file listed, the
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseyfirst icon listed that matches the file is displayed. These
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseyare controlled by <CODE>mod_autoindex</CODE>.
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey</UL>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom RumseyThe two functions are separated so that you can completely remove
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey(or replace) automatic index generation should you want to.
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<P>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom RumseyIf
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey HREF="#fancyindexing"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey><SAMP>FancyIndexing</SAMP></A>
8367f835047e57c70a508975d020905f0173f51aTom Rumseyis enabled, or the <SAMP>FancyIndexing</SAMP> keyword is present on the
f3fa3b65e8ebafc90b1044cf522ee35213299c42Tom Rumsey<A
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey HREF="#indexoptions"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey><SAMP>IndexOptions</SAMP></A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseydirective, the column headers are links that control the
8367f835047e57c70a508975d020905f0173f51aTom Rumseyorder of the display. If you select a header link, the
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseylisting will be regenerated, sorted by the values in that
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseycolumn. Selecting the same header repeatedly toggles
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseybetween ascending and descending order.
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey</P>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<P>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom RumseyNote that when the display is sorted by &quot;Size&quot;,
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumseyit's the <EM>actual</EM> size of the files that's used,
82f0250e57339ea51cb40e0ae859728a73f4ec56Tom Rumseynot the displayed value - so a 1010-byte file will
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseyalways be displayed before a 1011-byte file (if in ascending
8367f835047e57c70a508975d020905f0173f51aTom Rumseyorder) even though they both are shown as &quot;1K&quot;.
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey</P>
82f0250e57339ea51cb40e0ae859728a73f4ec56Tom Rumsey
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<H2>Directives</H2>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<MENU>
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey<LI><A HREF="#addalt">AddAlt</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#addaltbyencoding">AddAltByEncoding</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#addaltbytype">AddAltByType</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#adddescription">AddDescription</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#addicon">AddIcon</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#addiconbyencoding">AddIconByEncoding</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#addiconbytype">AddIconByType</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#defaulticon">DefaultIcon</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#fancyindexing">FancyIndexing</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#headername">HeaderName</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#indexignore">IndexIgnore</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#indexoptions">IndexOptions</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<LI><A HREF="#readmename">ReadmeName</A>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey</MENU>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<HR>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<H2><A NAME="addalt">AddAlt</A></H2>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<!--%plaintext &lt;?INDEX {\tt AddAlt} directive&gt; -->
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A
4daaf3ed5fb272fb8a6850af6b81c0ef1b983a52Tom Rumsey HREF="directive-dict.html#Syntax"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey REL="Help"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey><STRONG>Syntax:</STRONG></A> AddAlt <EM>string file file...</EM><BR>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A
b97263bc3b686a6f7d2b65babe2432ec9701fb7fTom Rumsey HREF="directive-dict.html#Context"
b97263bc3b686a6f7d2b65babe2432ec9701fb7fTom Rumsey REL="Help"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey><STRONG>Context:</STRONG></A> server config, virtual host, directory, .htaccess<BR>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A
4daaf3ed5fb272fb8a6850af6b81c0ef1b983a52Tom Rumsey HREF="directive-dict.html#Override"
4daaf3ed5fb272fb8a6850af6b81c0ef1b983a52Tom Rumsey REL="Help"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey><STRONG>Override:</STRONG></A> Indexes<BR>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey HREF="directive-dict.html#Status"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey REL="Help"
4daaf3ed5fb272fb8a6850af6b81c0ef1b983a52Tom Rumsey><STRONG>Status:</STRONG></A> Base<BR>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey HREF="directive-dict.html#Module"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey REL="Help"
4daaf3ed5fb272fb8a6850af6b81c0ef1b983a52Tom Rumsey><STRONG>Module:</STRONG></A> mod_autoindex<P>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey
efafbd2aa55b834f714882683fa864a0ac9e64aaTom RumseyThis sets the alternate text to display for a file, instead of an icon, for
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A HREF="#fancyindexing">FancyIndexing</A>. <EM>File</EM> is a file
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseyextension, partial filename, wild-card expression or full filename for files
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseyto describe. <EM>String</EM> is enclosed in double quotes
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey(<CODE>&quot;</CODE>). This alternate text is displayed if the client is
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumseyimage-incapable or has image loading disabled.
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<HR>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<H2><A NAME="addaltbyencoding">AddAltByEncoding</A></H2>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<!--%plaintext &lt;?INDEX {\tt AddAltByEncoding} directive&gt; -->
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey HREF="directive-dict.html#Syntax"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey REL="Help"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey><STRONG>Syntax:</STRONG></A> AddAltByEncoding <EM>string MIME-encoding
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey MIME-encoding...</EM><BR>
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey<A
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey HREF="directive-dict.html#Context"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey REL="Help"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey><STRONG>Context:</STRONG></A> server config, virtual host, directory, .htaccess<BR>
0040712a8beeb4903e52791db304c51f62487ec3Tom Rumsey<A
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey HREF="directive-dict.html#Override"
efafbd2aa55b834f714882683fa864a0ac9e64aaTom Rumsey REL="Help"
d00779d35b3db7493fcdd3f8645e094c5540f4c4Tom Rumsey><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 alternate text to display for a file, instead of an icon, for
<A HREF="#fancyindexing">FancyIndexing</A>. <EM>MIME-encoding</EM> is a
valid content-encoding, such as <SAMP>x-compress</SAMP>.
<EM>String</EM> is enclosed in double quotes
(<CODE>&quot;</CODE>). This alternate text is displayed if the client is
image-incapable or has image loading disabled.
<HR>
<H2><A NAME="addaltbytype">AddAltByType</A></H2>
<!--%plaintext &lt;?INDEX {\tt AddAltByType} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> AddAltByType <EM>string MIME-type 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 alternate text to display for a file, instead of an icon, for
<A HREF="#fancyindexing">FancyIndexing</A>. <EM>MIME-type</EM> is a
valid content-type, such as <SAMP>text/html</SAMP>.
<EM>String</EM> is enclosed in double quotes
(<CODE>&quot;</CODE>). This alternate text is displayed if the client is
image-incapable or has image loading disabled.
<HR>
<H2><A NAME="adddescription">AddDescription</A></H2>
<!--%plaintext &lt;?INDEX {\tt AddDescription} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> AddDescription <EM>string file 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
<A HREF="#fancyindexing">FancyIndexing</A>. <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>&quot;</CODE>). Example:
<BLOCKQUOTE><CODE>AddDescription "The planet Mars" /web/pics/mars.gif
</CODE></BLOCKQUOTE><P><HR>
<H2><A NAME="addicon">AddIcon</A></H2>
<!--%plaintext &lt;?INDEX {\tt AddIcon} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> AddIcon <EM>icon name 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
<A HREF="#fancyindexing">FancyIndexing</A>. <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 (IMG,/icons/image.xbm) .gif .jpg .xbm <BR>
AddIcon /icons/dir.xbm ^^DIRECTORY^^ <BR>
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></H2>
<!--%plaintext &lt;?INDEX {\tt AddIconByEncoding} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> AddIconByEncoding <EM>icon MIME-encoding 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
<EM>MIME-encoding</EM> for <A HREF="#fancyindexing">FancyIndexing</A>.
<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></H2>
<!--%plaintext &lt;?INDEX {\tt AddIconByType} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> AddIconByType <EM>icon MIME-type 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
<A HREF="#fancyindexing">FancyIndexing</A>. <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>
AddIconByType (IMG,/icons/image.xbm) image/*
</CODE></BLOCKQUOTE><P><HR>
<H2><A NAME="defaulticon">DefaultIcon</A></H2>
<!--%plaintext &lt;?INDEX {\tt DefaultIcon} directive&gt; -->
<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 <A HREF="#fancyindexing">FancyIndexing</A>.
<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></H2>
<!--%plaintext &lt;?INDEX {\tt FancyIndexing} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> FancyIndexing <EM>boolean</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 FancyIndexing directive sets the FancyIndexing option for a directory.
<EM>Boolean</EM> can be <CODE>on</CODE> or <CODE>off</CODE>. The
<A HREF="#indexoptions">IndexOptions</A> directive should be used in
preference.
</P>
<BLOCKQUOTE>
<STRONG>Note that in versions of Apache prior to 1.3.2, the
<SAMP>FancyIndexing</SAMP> and
<SAMP>IndexOptions</SAMP> directives will override each other. You
should use <SAMP>IndexOptions&nbsp;FancyIndexing</SAMP> in preference
to the standalone <SAMP>FancyIndexing</SAMP> directive.
As of Apache 1.3.2, a standalone <SAMP>FancyIndexing</SAMP> directive
is combined with any <SAMP>IndexOptions</SAMP> directive already
specified for the current scope.</STRONG>
</BLOCKQUOTE>
<HR>
<H2><A NAME="headername">HeaderName</A></H2>
<!--%plaintext &lt;?INDEX {\tt HeaderName} directive&gt; -->
<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<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, and is taken to be relative to the directory being indexed.
The server first attempts to include <EM>filename</EM><CODE>.html</CODE>
as an HTML document, otherwise it will include <EM>filename</EM> as plain
text. Example:
<BLOCKQUOTE><CODE>HeaderName HEADER</CODE></BLOCKQUOTE>
when indexing the directory <CODE>/web</CODE>, the server will first look for
the HTML file <CODE>/web/HEADER.html</CODE> and include it if found, otherwise
it will include the plain text file <CODE>/web/HEADER</CODE>, if it exists.
<P>See also <A HREF="#readmename">ReadmeName</A>.<P><HR>
<H2><A NAME="indexignore">IndexIgnore</A></H2>
<!--%plaintext &lt;?INDEX {\tt IndexIgnore} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> IndexIgnore <EM>file 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></H2>
<!--%plaintext &lt;?INDEX {\tt IndexOptions} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> IndexOptions <EM>option option ...</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 IndexOptions directive specifies the behavior of the directory indexing.
<EM>Option</EM> can be one of
<DL>
<DT>FancyIndexing
<DD><!--%plaintext &lt;?INDEX {\tt FancyIndexing} index option&gt; -->
This turns on fancy indexing of directories.
<BLOCKQUOTE>
<STRONG>Note that in versions of Apache prior to 1.3.2, the
<SAMP>FancyIndexing</SAMP> and
<SAMP>IndexOptions</SAMP> directives will override each other. You
should use <SAMP>IndexOptions&nbsp;FancyIndexing</SAMP> in preference
to the standalone <SAMP>FancyIndexing</SAMP> directive.
As of Apache 1.3.2, a standalone <SAMP>FancyIndexing</SAMP> directive
is combined with any <SAMP>IndexOptions</SAMP> directive already
specified for the current scope.</STRONG>
</BLOCKQUOTE>
<DT>IconHeight[=pixels] (<EM>Apache 1.3 and later</EM>)
<DD>
<!--%plaintext &lt;?INDEX {\tt IconHeight} index option&gt; -->
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>IconsAreLinks
<DD>
<!--%plaintext &lt;?INDEX {\tt IconsAreLinks} index option&gt; -->
This makes the icons part of the anchor for the filename, for
fancy indexing.
<DT>IconWidth[=pixels] (<EM>Apache 1.3 and later</EM>)
<DD>
<!--%plaintext &lt;?INDEX {\tt IconWidth} index option&gt; -->
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>NameLength=[<EM>n</EM> | *] (<EM>Apache 1.3.2 and later</EM>)
<DD>
The NameLength keyword allows you to specify the width of the
filename column in bytes. If the keyword value is '<SAMP>*</SAMP>',
then the column is automatically sized to the length of the longest
filename in the display.
<DT>ScanHTMLTitles
<DD><!--%plaintext &lt;?INDEX {\tt ScanHTMLTitles} index option&gt; -->
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>SuppressColumnSorting
<DD>
<!--%plaintext &lt;?INDEX {\tt SuppressColumnSorting} index option&gt; -->
If specified, Apache will not make the column headings in a FancyIndexed
directory listing into links for sorting. The default behaviour is
for them to be links; selecting the column heading will sort the directory
listing by the values in that column.
<STRONG>Only available in Apache 1.3 and later.</STRONG>
<DT>SuppressDescription
<DD>
<!--%plaintext &lt;?INDEX {\tt SuppressDescription} index option&gt; -->
This will suppress the file description in fancy indexing listings.
<DT>SuppressHTMLPreamble
<DD>
<!--%plaintext &lt;?INDEX {\tt SuppressHTMLPreamble} index option&gt; -->
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 (&lt;HTML&gt;, &lt;HEAD&gt;, <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>SuppressLastModified
<DD>
<!--%plaintext &lt;?INDEX {\tt SuppressLastModified} index option&gt; -->
This will suppress the display of the last modification date, in fancy
indexing listings.
<DT>SuppressSize
<DD>
<!--%plaintext &lt;?INDEX {\tt SuppressSize} index option&gt; -->
This will suppress the file size in fancy indexing listings.
</DL>
This default is that no options are enabled. If multiple IndexOptions
could apply to a directory, then the most specific one is taken complete;
the options are not merged. For example:
<BLOCKQUOTE><CODE>
&lt;Directory /web/docs&gt; <BR>
IndexOptions FancyIndexing <BR>
&lt;/Directory&gt;<BR>
&lt;Directory /web/docs/spec&gt; <BR>
IndexOptions ScanHTMLTitles <BR>
&lt;/Directory&gt;
</CODE></BLOCKQUOTE>
then only <CODE>ScanHTMLTitles</CODE> will be set for the /web/docs/spec
directory.<P><HR>
<H2><A NAME="readmename">ReadmeName</A></H2>
<!--%plaintext &lt;?INDEX {\tt ReadmeName} directive&gt; -->
<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<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 directory being indexed.
The server first attempts to include <EM>filename</EM><CODE>.html</CODE>
as an HTML document, otherwise it will include <EM>filename</EM> as plain
text. Example:
<BLOCKQUOTE><CODE>ReadmeName README</CODE></BLOCKQUOTE>
when indexing the directory <CODE>/web</CODE>, the server will first look for
the HTML file <CODE>/web/README.html</CODE> and include it if found, otherwise
it will include the plain text file <CODE>/web/README</CODE>, if it exists.
<P>See also <A HREF="#headername">HeaderName</A>.<P>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>