manual/mod/mod_autoindex.html

	mod_autoindex.html revision f9b3be308809978f797e0c57b296147532a4313c
<!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>

This module is contained in the <CODE>mod_autoindex.c</CODE> file, and
is compiled in by default. It provides for automatic directory indexing.

<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 <CODE>index.html</CODE>.
The <A HREF="mod_dir.html#directoryindex">DirectoryIndex</A> directive sets
the name of this file.
This is controlled by <A HREF="mod_dir.html"><CODE>mod_dir</CODE></A>.
<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>
If
<A
 HREF="#fancyindexing"
><SAMP>FancyIndexing</SAMP></A>
is enabled, or the <SAMP>FancyIndexing</SAMP> keyword is present on 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.
</P>
<P>
Note that when the display is sorted by &quot;Size&quot;,
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 &quot;1K&quot;.
</P>


<h2>Directives</h2>

<MENU>
<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="#fancyindexing">FancyIndexing</A>
<LI><A HREF="#headername">HeaderName</A>
<LI><A HREF="#indexignore">IndexIgnore</A>
<LI><A HREF="#indexoptions">IndexOptions</A>
<LI><A HREF="#readmename">ReadmeName</A>
</MENU>
<HR>

<A name="addalt"><h2>AddAlt</h2></A>
<!--%plaintext &lt;?INDEX {\tt AddAlt} directive&gt; -->
<STRONG>Syntax:</STRONG> AddAlt <EM>string file file...</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> mod_autoindex<P>

This sets the alternate text to display for a file, instead of an icon, 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>).  This alternate text is displayed if the client is
image-incapable or has image loading disabled.

<HR>
<A name="addaltbyencoding"><h2>AddAltByEncoding</h2></A>
<!--%plaintext &lt;?INDEX {\tt AddAltByEncoding} directive&gt; -->
<STRONG>Syntax:</STRONG> AddAltByEncoding <EM>string MIME-encoding
    MIME-encoding...</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>
<A name="addaltbytype"><h2>AddAltByType</h2></A>
<!--%plaintext &lt;?INDEX {\tt AddAltByType} directive&gt; -->
<STRONG>Syntax:</STRONG> AddAltByType <EM>string MIME-type MIME-type...</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>

<A name="adddescription"><h2>AddDescription</h2></A>
<!--%plaintext &lt;?INDEX {\tt AddDescription} directive&gt; -->
<STRONG>Syntax:</STRONG> AddDescription <EM>string file file...</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>

<A name="addicon"><h2>AddIcon</h2></A>
<!--%plaintext &lt;?INDEX {\tt AddIcon} directive&gt; -->
<STRONG>Syntax:</STRONG> AddIcon <EM>icon name name ...</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>

<A name="addiconbyencoding"><h2>AddIconByEncoding</h2></A>
<!--%plaintext &lt;?INDEX {\tt AddIconByEncoding} directive&gt; -->
<STRONG>Syntax:</STRONG> AddIconByEncoding <EM>icon mime-encoding mime-encoding
...</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>

<A name="addiconbytype"><h2>AddIconByType</h2></A>
<!--%plaintext &lt;?INDEX {\tt AddIconByType} directive&gt; -->
<STRONG>Syntax:</STRONG> AddIconByType <EM>icon mime-type mime-type ...</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>

<A name="defaulticon"><h2>DefaultIcon</h2></A>
<!--%plaintext &lt;?INDEX {\tt DefaultIcon} directive&gt; -->
<STRONG>Syntax:</STRONG> DefaultIcon <EM>url</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>

<A name="fancyindexing"><h2>FancyIndexing</h2></A>
<!--%plaintext &lt;?INDEX {\tt FancyIndexing} directive&gt; -->
<STRONG>Syntax:</STRONG> FancyIndexing <EM>boolean</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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 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.</STRONG>
</BLOCKQUOTE>
<HR>

<A name="headername"><h2>HeaderName</h2></A>
<!--%plaintext &lt;?INDEX {\tt HeaderName} directive&gt; -->
<STRONG>Syntax:</STRONG> HeaderName <EM>filename</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>

<A name="indexignore"><h2>IndexIgnore</h2></A>
<!--%plaintext &lt;?INDEX {\tt IndexIgnore} directive&gt; -->
<STRONG>Syntax:</STRONG> IndexIgnore <EM>file file ...</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>

<A name="indexoptions"><h2>IndexOptions</h2></A>
<!--%plaintext &lt;?INDEX {\tt IndexOptions} directive&gt; -->
<STRONG>Syntax:</STRONG> IndexOptions <EM>option option ...</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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 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.</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>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>

<A name="readmename"><h2>ReadmeName</h2></A>
<!--%plaintext &lt;?INDEX {\tt ReadmeName} directive&gt; -->
<STRONG>Syntax:</STRONG> ReadmeName <EM>filename</EM><BR>
<Strong>Context:</STRONG> server config, virtual host, directory, .htaccess<BR>
<Strong>Override:</STRONG> Indexes<BR>
<STRONG>Status:</STRONG> Base<BR>
<STRONG>Module:</STRONG> 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>