mod_dir.html revision 2a2f335fc2510f021247f43fc52c760ee402d1e6
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<HTML>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<HEAD>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<TITLE>Apache module mod_dir</TITLE>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher</HEAD>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<BODY
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher BGCOLOR="#FFFFFF"
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher TEXT="#000000"
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher LINK="#0000FF"
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher VLINK="#000080"
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher ALINK="#FF0000"
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<!--#include virtual="header.html" -->
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<H1 ALIGN="CENTER">Module mod_dir</H1>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherThis module is contained in the <code>mod_dir.c</code> file, and
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagheris compiled in by default. It provides for directory indexing.
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<h2>Summary</h2>
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherThis module controls the directory indexing. The index of a directory
2bdadc5274df42738b97045cd01cd63d3651daf9Lukas Slebodnikcan come from one of two sources:
2bdadc5274df42738b97045cd01cd63d3651daf9Lukas Slebodnik<ul>
2bdadc5274df42738b97045cd01cd63d3651daf9Lukas Slebodnik<li>A file written by the user, typically called <code>index.html</code>.
2bdadc5274df42738b97045cd01cd63d3651daf9Lukas SlebodnikThe <A HREF="#directoryindex">DirectoryIndex</A> directive sets the name
2bdadc5274df42738b97045cd01cd63d3651daf9Lukas Slebodnikof this file.
2bdadc5274df42738b97045cd01cd63d3651daf9Lukas Slebodnik<li>Otherwise, a listing generated by the server. The other directives
2bdadc5274df42738b97045cd01cd63d3651daf9Lukas Slebodnikcontrol the format of this listing. The <A HREF="#addicon">AddIcon</A>,
2bdadc5274df42738b97045cd01cd63d3651daf9Lukas Slebodnik<A HREF="#addiconbyencoding">AddIconByEncoding</A> and
2bdadc5274df42738b97045cd01cd63d3651daf9Lukas Slebodnik<A HREF="#addiconbytype">AddIconByType</A> are used to set a list of
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallaghericons to display for various file types; for each file listed, the
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagherfirst icon listed that matches the file is displayed.
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek</ul>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<h2>Directives</h2>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<menu>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#addalt">AddAlt</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#addaltbyencoding">AddAltByEncoding</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#addaltbytype">AddAltByType</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#adddescription">AddDescription</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#addicon">AddIcon</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#addiconbyencoding">AddIconByEncoding</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#addiconbytype">AddIconByType</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#defaulticon">DefaultIcon</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#directoryindex">DirectoryIndex</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#fancyindexing">FancyIndexing</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#headername">HeaderName</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#indexignore">IndexIgnore</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#indexoptions">IndexOptions</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<li><A HREF="#readmename">ReadmeName</A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek</menu>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<hr>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<A name="addalt"><h2>AddAlt</h2></A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<!--%plaintext &lt;?INDEX {\tt AddAlt} directive&gt; -->
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<strong>Syntax:</strong> AddAlt <em>string file file...</em><br>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<Strong>Override:</strong> Indexes<br>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<strong>Status:</strong> Base<br>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<strong>Module:</strong> mod_dir<p>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek
dbea04f585a30d001b574317c068cd03a4fa332bJakub HrozekThis sets the alternate text to display for a file, instead of an icon, for
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<A HREF="#fancyindexing">FancyIndexing</A>. <em>File</em> is a file
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozekextension, partial filename, wild-card expression or full filename for files
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozekto describe. <em>String</em> is enclosed in double quotes
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek(<code>&quot;</code>). This alternate text is displayed if the client is
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozekimage-incapable or has image loading disabled.
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<HR>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<A name="addaltbyencoding"><h2>AddAltByEncoding</h2></A>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<!--%plaintext &lt;?INDEX {\tt AddAltByEncoding} directive&gt; -->
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<strong>Syntax:</strong> AddAltByEncoding <em>string MIME-encoding
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek MIME-encoding...</em><br>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<Strong>Override:</strong> Indexes<br>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<strong>Status:</strong> Base<br>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<strong>Module:</strong> mod_dir<p>
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek
dbea04f585a30d001b574317c068cd03a4fa332bJakub HrozekThis sets the alternate text to display for a file, instead of an icon, for
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-encoding</em> is a
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozekvalid content-encoding, such as <SAMP>x-compress</SAMP>.
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek<em>String</em> is enclosed in double quotes
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozek(<code>&quot;</code>). This alternate text is displayed if the client is
dbea04f585a30d001b574317c068cd03a4fa332bJakub Hrozekimage-incapable or has image loading disabled.
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<HR>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A name="addaltbytype"><h2>AddAltByType</h2></A>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<!--%plaintext &lt;?INDEX {\tt AddAltByType} directive&gt; -->
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Syntax:</strong> AddAltByType <em>string MIME-type MIME-type...</em><br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Override:</strong> Indexes<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Status:</strong> Base<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Module:</strong> mod_dir<p>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherThis sets the alternate text to display for a file, instead of an icon, for
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-type</em> is a
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallaghervalid content-type, such as <SAMP>text/html</SAMP>.
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<em>String</em> is enclosed in double quotes
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher(<code>&quot;</code>). This alternate text is displayed if the client is
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagherimage-incapable or has image loading disabled.
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<HR>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A name="adddescription"><h2>AddDescription</h2></A>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<!--%plaintext &lt;?INDEX {\tt AddDescription} directive&gt; -->
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Syntax:</strong> AddDescription <em>string file file...</em><br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Override:</strong> Indexes<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Status:</strong> Base<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Module:</strong> mod_dir<p>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherThis sets the description to display for a file, for
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A HREF="#fancyindexing">FancyIndexing</A>. <em>File</em> is a file
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagherextension, partial filename, wild-card expression or full filename for files
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagherto describe. <em>String</em> is enclosed in double quotes
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher(<code>&quot;</code>). Example:
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<blockquote><code>AddDescription "The planet Mars" /web/pics/mars.gif
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher</code></blockquote><p><hr>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A name="addicon"><h2>AddIcon</h2></A>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<!--%plaintext &lt;?INDEX {\tt AddIcon} directive&gt; -->
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Syntax:</strong> AddIcon <em>icon name name ...</em><br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Override:</strong> Indexes<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Status:</strong> Base<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Module:</strong> mod_dir<p>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherThis sets the icon to display next to a file ending in <em>name</em> for
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A HREF="#fancyindexing">FancyIndexing</A>. <em>Icon</em> is either a
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher(%-escaped) relative URL to the icon, or of the format
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher(<em>alttext</em>,<em>url</em>) where <em>alttext</em> is the text tag given
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagherfor an icon for non-graphical browsers.<p>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<em>Name</em> is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ for
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagherblank lines (to format the list correctly), a file extension, a wildcard
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagherexpression, a partial filename or a complete filename. Examples:
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<blockquote><code>
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherAddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm <br>
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherAddIcon /icons/dir.xbm ^^DIRECTORY^^ <br>
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherAddIcon /icons/backup.xbm *~
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher</code></blockquote>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A HREF="#addiconbytype">AddIconByType</A> should be used in preference to
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherAddIcon, when possible.<p><hr>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A name="addiconbyencoding"><h2>AddIconByEncoding</h2></A>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<!--%plaintext &lt;?INDEX {\tt AddIconByEncoding} directive&gt; -->
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Syntax:</strong> AddIconByEncoding <em>icon mime-encoding mime-encoding
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher...</em><br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Override:</strong> Indexes<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Status:</strong> Base<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Module:</strong> mod_dir<p>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherThis sets the icon to display next to files with
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<em>mime-encoding</em> for <A HREF="#fancyindexing">FancyIndexing</A>.
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<em>Icon</em> is either a (%-escaped) relative URL to the icon, or of the
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagherformat (<em>alttext</em>,<em>url</em>) where <em>alttext</em> is the text tag
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallaghergiven for an icon for non-graphical browsers.<p>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<em>Mime-encoding</em> is a wildcard expression matching required the
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallaghercontent-encoding. Examples:
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<blockquote><code>
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherAddIconByEncoding /icons/compress.xbm x-compress
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher</code></blockquote><p><hr>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A name="addiconbytype"><h2>AddIconByType</h2></A>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<!--%plaintext &lt;?INDEX {\tt AddIconByType} directive&gt; -->
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Syntax:</strong> AddIconByType <em>icon mime-type mime-type ...</em><br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<Strong>Override:</strong> Indexes<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Status:</strong> Base<br>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<strong>Module:</strong> mod_dir<p>
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher
b32159300fea63222d8dd9200ed634087704ea74Stephen GallagherThis sets the icon to display next to files of type <em>mime-type</em> for
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher<A HREF="#fancyindexing">FancyIndexing</A>. <em>Icon</em> is either a
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher(%-escaped) relative URL to the icon, or of the format
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagher(<em>alttext</em>,<em>url</em>) where <em>alttext</em> is the text tag given
b32159300fea63222d8dd9200ed634087704ea74Stephen Gallagherfor an icon for non-graphical browsers.<p>
2b4332767d299263a288e0a74bbfbc9de674de95Jakub Hrozek<em>Mime-type</em> is a wildcard expression matching required the mime types.
2b4332767d299263a288e0a74bbfbc9de674de95Jakub HrozekExamples:
2b4332767d299263a288e0a74bbfbc9de674de95Jakub Hrozek<blockquote><code>
2b4332767d299263a288e0a74bbfbc9de674de95Jakub HrozekAddIconByType (IMG,/icons/image.xbm) image/*
2b4332767d299263a288e0a74bbfbc9de674de95Jakub Hrozek</code></blockquote><p><hr>
2b4332767d299263a288e0a74bbfbc9de674de95Jakub Hrozek
2b4332767d299263a288e0a74bbfbc9de674de95Jakub Hrozek<A name="defaulticon"><h2>DefaultIcon</h2></A>
2b4332767d299263a288e0a74bbfbc9de674de95Jakub Hrozek<!--%plaintext &lt;?INDEX {\tt DefaultIcon} directive&gt; -->
2b4332767d299263a288e0a74bbfbc9de674de95Jakub Hrozek<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_dir<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="directoryindex"><h2>DirectoryIndex</h2></A>
<!--%plaintext &lt;?INDEX {\tt DirectoryIndex} directive&gt; -->
<strong>Syntax:</strong> DirectoryIndex <em>local-url local-url ...</em><br>
<strong>Default:</strong> <code>DirectoryIndex index.html</code><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_dir<p>
The DirectoryIndex directive sets the list of resources to look for,
when the client requests an index of the directory by specifying a /
at the end of the a directory name. <em>Local-url</em> is the
(%-encoded) URL of a document on the server relative to the requested
directory; it is usually the name of a file in the directory. Several
URLs may be given, in which case the server will return the first one
that it finds. If none of the resources exist and the
<CODE>Indexes</CODE> option is set, the server will generate its own
listing of the directory.
<P>
Example:
<blockquote><code>
DirectoryIndex index.html
</code></blockquote>
then a request for <code>http://myserver/docs/</code> would return
<code>http://myserver/docs/index.html</code> if it exists, or would list
the directory if it did not. <p>
Note that the documents do not need to be relative to the directory;
<blockquote><code>
DirectoryIndex index.html index.txt /cgi-bin/index.pl</code></blockquote>
would cause the CGI script <code>/cgi-bin/index.pl</code> to be executed
if neither <code>index.html</code> or <code>index.txt</code> existed in
a directory.<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_dir<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><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_dir<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_dir<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_dir<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.
<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>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>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.
<dt>SuppressDescription
<dd>
<!--%plaintext &lt;?INDEX {\tt SuppressDescription} index option&gt; -->
This will suppress the file description in fancy indexing listings.
<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>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.
</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_dir<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>