--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<HTML>
+<HEAD>
+<TITLE>Apache module mod_dir</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_dir</H1>
+
+This module is contained in the <code>mod_dir.c</code> file, and
+is compiled in by default. It provides for directory indexing.
+
+<h2>Summary</h2>
+This module controls the directory indexing. 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="#directoryindex">DirectoryIndex</A> directive sets the name
+of this file.
+<li>Otherwise, a listing generated by the server. The other directives
+control the format of this listing. The <A HREF="#addicon">AddIcon</A>,
+<A HREF="#addiconbyencoding">AddIconByEncoding</A> and
+<A HREF="#addiconbytype">AddIconByType</A> are used to set a list of
+icons to display for various file types; for each file listed, the
+first icon listed that matches the file is displayed.
+</ul>
+
+
+<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="#directoryindex">DirectoryIndex</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 <?INDEX {\tt AddAlt} directive> -->
+<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_dir<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>"</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 <?INDEX {\tt AddAltByEncoding} directive> -->
+<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_dir<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>"</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 <?INDEX {\tt AddAltByType} directive> -->
+<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_dir<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>"</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 <?INDEX {\tt AddDescription} directive> -->
+<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_dir<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>"</code>). Example:
+<blockquote><code>AddDescription "The planet Mars" /web/pics/mars.gif
+</code></blockquote><p><hr>
+
+<A name="addicon"><h2>AddIcon</h2></A>
+<!--%plaintext <?INDEX {\tt AddIcon} directive> -->
+<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_dir<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 <?INDEX {\tt AddIconByEncoding} directive> -->
+<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_dir<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 <?INDEX {\tt AddIconByType} directive> -->
+<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_dir<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 <?INDEX {\tt DefaultIcon} directive> -->
+<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 <?INDEX {\tt DirectoryIndex} directive> -->
+<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 <?INDEX {\tt FancyIndexing} directive> -->
+<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 <?INDEX {\tt HeaderName} directive> -->
+<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 <?INDEX {\tt IndexIgnore} directive> -->
+<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 <?INDEX {\tt IndexOptions} directive> -->
+<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 <?INDEX {\tt FancyIndexing} index option> -->
+This turns on fancy indexing of directories.
+<dt>IconsAreLinks
+<dd>
+<!--%plaintext <?INDEX {\tt IconsAreLinks} index option> -->
+This makes the icons part of the anchor for the filename, for
+fancy indexing.
+<dt>ScanHTMLTitles
+<dd><!--%plaintext <?INDEX {\tt ScanHTMLTitles} index option> -->
+This enables the extraction of the title from HTML documents for fancy
+indexing. If the file does not have a description given by
+<A HREF="#adddescription">AddDescription</A> then httpd will read the
+document for the value of the TITLE tag. This is CPU and disk intensive.
+<dt>SuppressLastModified
+<dd>
+<!--%plaintext <?INDEX {\tt SuppressLastModified} index option> -->
+This will suppress the display of the last modification date, in fancy
+indexing listings.
+<dt>SuppressSize
+<dd>
+<!--%plaintext <?INDEX {\tt SuppressSize} index option> -->
+This will suppress the file size in fancy indexing listings.
+<dt>SuppressDescription
+<dd>
+<!--%plaintext <?INDEX {\tt SuppressDescription} index option> -->
+This will suppress the file description 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>
+<Directory /web/docs> <br>
+IndexOptions FancyIndexing <br>
+</Directory><br>
+<Directory /web/docs/spec> <br>
+IndexOptions ScanHTMLTitles <br>
+</Directory>
+</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 <?INDEX {\tt ReadmeName} directive> -->
+<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>
+
projects / thirdparty / apache / httpd.git / commitdiff
