mod_autoindex.html revision db81e057b060e365d840d9a1d35a5797192efa81
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<HTML>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<HEAD>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<TITLE>Apache module mod_dir</TITLE>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo</HEAD>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<BODY
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo BGCOLOR="#FFFFFF"
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo TEXT="#000000"
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo LINK="#0000FF"
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo VLINK="#000080"
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo ALINK="#FF0000"
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--#include virtual="header.html" -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<H1 ALIGN="CENTER">Module mod_dir</H1>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis module is contained in the <code>mod_dir.c</code> file, and
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoois compiled in by default. It provides for directory indexing.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<h2>Summary</h2>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis module controls the directory indexing. The index of a directory
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoocan come from one of two sources:
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<ul>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li>A file written by the user, typically called <code>index.html</code>.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThe <A HREF="#directoryindex">DirectoryIndex</A> directive sets the name
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooof this file.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li>Otherwise, a listing generated by the server. The other directives
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoocontrol the format of this listing. The <A HREF="#addicon">AddIcon</A>,
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A HREF="#addiconbyencoding">AddIconByEncoding</A> and
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A HREF="#addiconbytype">AddIconByType</A> are used to set a list of
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooicons to display for various file types; for each file listed, the
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoofirst icon listed that matches the file is displayed.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo</ul>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<h2>Directives</h2>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<menu>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#addalt">AddAlt</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#addaltbyencoding">AddAltByEncoding</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#addaltbytype">AddAltByType</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#adddescription">AddDescription</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#addicon">AddIcon</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#addiconbyencoding">AddIconByEncoding</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#addiconbytype">AddIconByType</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#defaulticon">DefaultIcon</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#directoryindex">DirectoryIndex</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#fancyindexing">FancyIndexing</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#headername">HeaderName</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#indexignore">IndexIgnore</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#indexoptions">IndexOptions</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<li><A HREF="#readmename">ReadmeName</A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo</menu>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<hr>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A name="addalt"><h2>AddAlt</h2></A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--%plaintext &lt;?INDEX {\tt AddAlt} directive&gt; -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Syntax:</strong> AddAlt <em>string file file...</em><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Override:</strong> Indexes<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Status:</strong> Base<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Module:</strong> mod_dir<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis sets the alternate text to display for a file, instead of an icon, for
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A HREF="#fancyindexing">FancyIndexing</A>. <em>File</em> is a file
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooextension, partial filename, wild-card expression or full filename for files
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooto describe. <em>String</em> is enclosed in double quotes
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(<code>&quot;</code>). This alternate text is displayed if the client is
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooimage-incapable or has image loading disabled.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<HR>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A name="addaltbyencoding"><h2>AddAltByEncoding</h2></A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--%plaintext &lt;?INDEX {\tt AddAltByEncoding} directive&gt; -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Syntax:</strong> AddAltByEncoding <em>string MIME-encoding
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo MIME-encoding...</em><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Override:</strong> Indexes<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Status:</strong> Base<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Module:</strong> mod_dir<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis sets the alternate text to display for a file, instead of an icon, for
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-encoding</em> is a
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoovalid content-encoding, such as <SAMP>x-compress</SAMP>.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<em>String</em> is enclosed in double quotes
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(<code>&quot;</code>). This alternate text is displayed if the client is
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooimage-incapable or has image loading disabled.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<HR>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A name="addaltbytype"><h2>AddAltByType</h2></A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--%plaintext &lt;?INDEX {\tt AddAltByType} directive&gt; -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Syntax:</strong> AddAltByType <em>string MIME-type MIME-type...</em><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Override:</strong> Indexes<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Status:</strong> Base<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Module:</strong> mod_dir<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis sets the alternate text to display for a file, instead of an icon, for
129881b9d52cbe45ed1e2529da980fa231c4e97eStéphane Graber<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-type</em> is a
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoovalid content-type, such as <SAMP>text/html</SAMP>.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<em>String</em> is enclosed in double quotes
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(<code>&quot;</code>). This alternate text is displayed if the client is
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooimage-incapable or has image loading disabled.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<HR>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A name="adddescription"><h2>AddDescription</h2></A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--%plaintext &lt;?INDEX {\tt AddDescription} directive&gt; -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Syntax:</strong> AddDescription <em>string file file...</em><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Override:</strong> Indexes<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Status:</strong> Base<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Module:</strong> mod_dir<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis sets the description to display for a file, for
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A HREF="#fancyindexing">FancyIndexing</A>. <em>File</em> is a file
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooextension, partial filename, wild-card expression or full filename for files
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooto describe. <em>String</em> is enclosed in double quotes
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(<code>&quot;</code>). Example:
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<blockquote><code>AddDescription "The planet Mars" /web/pics/mars.gif
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo</code></blockquote><p><hr>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A name="addicon"><h2>AddIcon</h2></A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--%plaintext &lt;?INDEX {\tt AddIcon} directive&gt; -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Syntax:</strong> AddIcon <em>icon name name ...</em><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Override:</strong> Indexes<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Status:</strong> Base<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Module:</strong> mod_dir<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis sets the icon to display next to a file ending in <em>name</em> for
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A HREF="#fancyindexing">FancyIndexing</A>. <em>Icon</em> is either a
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(%-escaped) relative URL to the icon, or of the format
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(<em>alttext</em>,<em>url</em>) where <em>alttext</em> is the text tag given
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoofor an icon for non-graphical browsers.<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<em>Name</em> is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ for
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooblank lines (to format the list correctly), a file extension, a wildcard
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooexpression, a partial filename or a complete filename. Examples:
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<blockquote><code>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooAddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm <br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooAddIcon /icons/dir.xbm ^^DIRECTORY^^ <br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooAddIcon /icons/backup.xbm *~
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo</code></blockquote>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A HREF="#addiconbytype">AddIconByType</A> should be used in preference to
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooAddIcon, when possible.<p><hr>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A name="addiconbyencoding"><h2>AddIconByEncoding</h2></A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--%plaintext &lt;?INDEX {\tt AddIconByEncoding} directive&gt; -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Syntax:</strong> AddIconByEncoding <em>icon mime-encoding mime-encoding
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo...</em><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Override:</strong> Indexes<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Status:</strong> Base<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Module:</strong> mod_dir<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis sets the icon to display next to files with
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<em>mime-encoding</em> for <A HREF="#fancyindexing">FancyIndexing</A>.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<em>Icon</em> is either a (%-escaped) relative URL to the icon, or of the
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooformat (<em>alttext</em>,<em>url</em>) where <em>alttext</em> is the text tag
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoogiven for an icon for non-graphical browsers.<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<em>Mime-encoding</em> is a wildcard expression matching required the
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoocontent-encoding. Examples:
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<blockquote><code>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooAddIconByEncoding /icons/compress.xbm x-compress
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo</code></blockquote><p><hr>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A name="addiconbytype"><h2>AddIconByType</h2></A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--%plaintext &lt;?INDEX {\tt AddIconByType} directive&gt; -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Syntax:</strong> AddIconByType <em>icon mime-type mime-type ...</em><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Override:</strong> Indexes<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Status:</strong> Base<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Module:</strong> mod_dir<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThis sets the icon to display next to files of type <em>mime-type</em> for
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A HREF="#fancyindexing">FancyIndexing</A>. <em>Icon</em> is either a
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(%-escaped) relative URL to the icon, or of the format
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(<em>alttext</em>,<em>url</em>) where <em>alttext</em> is the text tag given
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoofor an icon for non-graphical browsers.<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<em>Mime-type</em> is a wildcard expression matching required the mime types.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooExamples:
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<blockquote><code>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooAddIconByType (IMG,/icons/image.xbm) image/*
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo</code></blockquote><p><hr>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A name="defaulticon"><h2>DefaultIcon</h2></A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--%plaintext &lt;?INDEX {\tt DefaultIcon} directive&gt; -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Syntax:</strong> DefaultIcon <em>url</em><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Override:</strong> Indexes<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Status:</strong> Base<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Module:</strong> mod_dir<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThe DefaultIcon directive sets the icon to display for files when no
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoospecific icon is known, for <A HREF="#fancyindexing">FancyIndexing</A>.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<em>Url</em> is a (%-escaped) relative URL to the icon. Examples:
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<blockquote><code>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooDefaultIcon /icon/unknown.xbm
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo</code></blockquote><p><hr>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<A name="directoryindex"><h2>DirectoryIndex</h2></A>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<!--%plaintext &lt;?INDEX {\tt DirectoryIndex} directive&gt; -->
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Syntax:</strong> DirectoryIndex <em>local-url local-url ...</em><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Default:</strong> <code>DirectoryIndex index.html</code><br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<Strong>Override:</strong> Indexes<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Status:</strong> Base<br>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<strong>Module:</strong> mod_dir<p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooThe DirectoryIndex directive sets the list of resources to look for,
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoowhen the client requests an index of the directory by specifying a /
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yooat the end of the a directory name. <em>Local-url</em> is the
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo(%-encoded) URL of a document on the server relative to the requested
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoodirectory; it is usually the name of a file in the directory. Several
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooURLs may be given, in which case the server will return the first one
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoothat it finds. If none of the resources exist and the
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<CODE>Indexes</CODE> option is set, the server will generate its own
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoolisting of the directory.
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<P>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooExample:
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<blockquote><code>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae YooDirectoryIndex index.html
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo</code></blockquote>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoothen a request for <code>http://myserver/docs/</code> would return
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo<code>http://myserver/docs/index.html</code> if it exists, or would list
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoothe directory if it did not. <p>
2b371b262f7272266ff18cc2aff65176a2c16383Sungbae Yoo
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>