mod_autoindex.html revision 3490c77f2e727c8db2b452360ff61cd004a8ee2a
02c335c23bf5fa225a467c19f2c063fb0dc7b8c3Timo Sirainen<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
f60fe422cdfbf5427938d2829f16505162d9a9aeStephan Bosch BGCOLOR="#FFFFFF"
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch TEXT="#000000"
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch LINK="#0000FF"
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch VLINK="#000080"
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch ALINK="#FF0000"
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--#include virtual="header.html" -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis module is contained in the <code>mod_autoindex.c</code> file, and
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschis compiled in by default. It provides for automatic directory indexing.
50ba4fe3a8c79c1f2194d334be6193f9f0863577Timo SirainenThe index of a directory can come from one of two sources:
50ba4fe3a8c79c1f2194d334be6193f9f0863577Timo Sirainen<li>A file written by the user, typically called <code>index.html</code>.
702ebfdbd78702e3464b5804c8a7c83c9990ae96Timo SirainenThe <A HREF="mod_dir.html#directoryindex">DirectoryIndex</A> directive sets
702ebfdbd78702e3464b5804c8a7c83c9990ae96Timo Sirainenthe name of this file.
702ebfdbd78702e3464b5804c8a7c83c9990ae96Timo SirainenThis is controlled by <a href="mod_dir.html"><code>mod_dir</code></a>.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<li>Otherwise, a listing generated by the server. The other directives
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschcontrol the format of this listing. The <A HREF="#addicon">AddIcon</A>,
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A HREF="#addiconbyencoding">AddIconByEncoding</A> and
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A HREF="#addiconbytype">AddIconByType</A> are used to set a list of
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschicons to display for various file types; for each file listed, the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschfirst icon listed that matches the file is displayed. These
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThe two functions are separated so that you can completely remove
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch(or replace) automatic index generation should you want to.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch HREF="#fancyindexing"
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschis enabled, or the <SAMP>FancyIndexing</SAMP> keyword is present on the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch HREF="#indexoptions"
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschdirective, the column headers are links that control the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschorder of the display. If you select a header link, the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschlisting will be regenerated, sorted by the values in that
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschcolumn. Selecting the same header repeatedly toggles
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschbetween ascending and descending order.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschNote that when the display is sorted by "Size",
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschit's the <EM>actual</EM> size of the files that's used,
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschnot the displayed value - so a 1010-byte file will
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschalways be displayed before a 1011-byte file (if in ascending
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschorder) even though they both are shown as "1K".
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<li><A HREF="#addaltbyencoding">AddAltByEncoding</A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<li><A HREF="#adddescription">AddDescription</A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<li><A HREF="#addiconbyencoding">AddIconByEncoding</A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt AddAlt} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> AddAlt <em>string file file...</em><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis sets the alternate text to display for a file, instead of an icon, for
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A HREF="#fancyindexing">FancyIndexing</A>. <em>File</em> is a file
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschextension, partial filename, wild-card expression or full filename for files
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschto describe. <em>String</em> is enclosed in double quotes
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch(<code>"</code>). This alternate text is displayed if the client is
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschimage-incapable or has image loading disabled.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A name="addaltbyencoding"><h2>AddAltByEncoding</h2></A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt AddAltByEncoding} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> AddAltByEncoding <em>string MIME-encoding
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis sets the alternate text to display for a file, instead of an icon, for
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-encoding</em> is a
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschvalid content-encoding, such as <SAMP>x-compress</SAMP>.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch(<code>"</code>). This alternate text is displayed if the client is
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschimage-incapable or has image loading disabled.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A name="addaltbytype"><h2>AddAltByType</h2></A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt AddAltByType} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> AddAltByType <em>string MIME-type MIME-type...</em><br>
711e8e4c5c5d702dfa062f42a1ede5de14c151c9Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis sets the alternate text to display for a file, instead of an icon, for
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-type</em> is a
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschvalid content-type, such as <SAMP>text/html</SAMP>.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch(<code>"</code>). This alternate text is displayed if the client is
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschimage-incapable or has image loading disabled.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A name="adddescription"><h2>AddDescription</h2></A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt AddDescription} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> AddDescription <em>string file file...</em><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis sets the description to display for a file, for
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A HREF="#fancyindexing">FancyIndexing</A>. <em>File</em> is a file
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschextension, partial filename, wild-card expression or full filename for files
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschto describe. <em>String</em> is enclosed in double quotes
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<blockquote><code>AddDescription "The planet Mars" /web/pics/mars.gif
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt AddIcon} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> AddIcon <em>icon name name ...</em><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
e1a4ea6ad3e799ef8df7395e765c0ae9218e6c5dStephan BoschThis sets the icon to display next to a file ending in <em>name</em> for
e1a4ea6ad3e799ef8df7395e765c0ae9218e6c5dStephan Bosch<A HREF="#fancyindexing">FancyIndexing</A>. <em>Icon</em> is either a
e1a4ea6ad3e799ef8df7395e765c0ae9218e6c5dStephan Bosch(%-escaped) relative URL to the icon, or of the format
e1a4ea6ad3e799ef8df7395e765c0ae9218e6c5dStephan Bosch(<em>alttext</em>,<em>url</em>) where <em>alttext</em> is the text tag given
e1a4ea6ad3e799ef8df7395e765c0ae9218e6c5dStephan Boschfor an icon for non-graphical browsers.<p>
e1a4ea6ad3e799ef8df7395e765c0ae9218e6c5dStephan Bosch<em>Name</em> is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ for
e1a4ea6ad3e799ef8df7395e765c0ae9218e6c5dStephan Boschblank lines (to format the list correctly), a file extension, a wildcard
e1a4ea6ad3e799ef8df7395e765c0ae9218e6c5dStephan Boschexpression, a partial filename or a complete filename. Examples:
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschAddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm <br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A HREF="#addiconbytype">AddIconByType</A> should be used in preference to
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A name="addiconbyencoding"><h2>AddIconByEncoding</h2></A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt AddIconByEncoding} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> AddIconByEncoding <em>icon mime-encoding mime-encoding
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis sets the icon to display next to files with
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<em>mime-encoding</em> for <A HREF="#fancyindexing">FancyIndexing</A>.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<em>Icon</em> is either a (%-escaped) relative URL to the icon, or of the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschformat (<em>alttext</em>,<em>url</em>) where <em>alttext</em> is the text tag
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschgiven for an icon for non-graphical browsers.<p>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<em>Mime-encoding</em> is a wildcard expression matching required the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschcontent-encoding. Examples:
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschAddIconByEncoding /icons/compress.xbm x-compress
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A name="addiconbytype"><h2>AddIconByType</h2></A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt AddIconByType} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> AddIconByType <em>icon mime-type mime-type ...</em><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis sets the icon to display next to files of type <em>mime-type</em> for
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A HREF="#fancyindexing">FancyIndexing</A>. <em>Icon</em> is either a
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch(%-escaped) relative URL to the icon, or of the format
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch(<em>alttext</em>,<em>url</em>) where <em>alttext</em> is the text tag given
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschfor an icon for non-graphical browsers.<p>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<em>Mime-type</em> is a wildcard expression matching required the mime types.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt DefaultIcon} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> DefaultIcon <em>url</em><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThe DefaultIcon directive sets the icon to display for files when no
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschspecific icon is known, for <A HREF="#fancyindexing">FancyIndexing</A>.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<em>Url</em> is a (%-escaped) relative URL to the icon. Examples:
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A name="fancyindexing"><h2>FancyIndexing</h2></A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt FancyIndexing} directive> -->
95e0b82fdff1bb511067d703bb8b67c22f242c38Timo Sirainen<strong>Syntax:</strong> FancyIndexing <em>boolean</em><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
95e0b82fdff1bb511067d703bb8b67c22f242c38Timo SirainenThe FancyIndexing directive sets the FancyIndexing option for a directory.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<em>Boolean</em> can be <code>on</code> or <code>off</code>. The
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A HREF="#indexoptions">IndexOptions</A> directive should be used in
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch <STRONG>Note that the <SAMP>FancyIndexing</SAMP> and
14137be591f29a222e00602a1f9556b843ebd26eStephan Bosch <SAMP>IndexOptions</SAMP> directives will override each other. You
14137be591f29a222e00602a1f9556b843ebd26eStephan Bosch should use <SAMP>IndexOptions FancyIndexing</SAMP> in preference
14137be591f29a222e00602a1f9556b843ebd26eStephan Bosch to the standalone <SAMP>FancyIndexing</SAMP> directive.</STRONG>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt HeaderName} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> HeaderName <em>filename</em><br>
14137be591f29a222e00602a1f9556b843ebd26eStephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
14137be591f29a222e00602a1f9556b843ebd26eStephan BoschThe HeaderName directive sets the name of the file that will be inserted
14137be591f29a222e00602a1f9556b843ebd26eStephan Boschat the top of the index listing. <em>Filename</em> is the name of the file
14137be591f29a222e00602a1f9556b843ebd26eStephan Boschto include, and is taken to be relative to the directory being indexed.
14137be591f29a222e00602a1f9556b843ebd26eStephan BoschThe server first attempts to include <em>filename</em><code>.html</code>
14137be591f29a222e00602a1f9556b843ebd26eStephan Boschas an HTML document, otherwise it will include <em>filename</em> as plain
14137be591f29a222e00602a1f9556b843ebd26eStephan Boschtext. Example:
14137be591f29a222e00602a1f9556b843ebd26eStephan Bosch<blockquote><code>HeaderName HEADER</code></blockquote>
14137be591f29a222e00602a1f9556b843ebd26eStephan Boschwhen indexing the directory <code>/web</code>, the server will first look for
14137be591f29a222e00602a1f9556b843ebd26eStephan Boschthe HTML file <code>/web/HEADER.html</code> and include it if found, otherwise
14137be591f29a222e00602a1f9556b843ebd26eStephan Boschit will include the plain text file <code>/web/HEADER</code>, if it exists.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<p>See also <A HREF="#readmename">ReadmeName</A>.<p><hr>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt IndexIgnore} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> IndexIgnore <em>file file ...</em><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThe IndexIgnore directive adds to the list of files to hide when listing
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boscha directory. <em>File</em> is a file extension, partial filename,
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschwildcard expression or full filename for files to ignore. Multiple
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschIndexIgnore directives add to the list, rather than the replacing the list
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschof ignored files. By default, the list contains `<code>.</code>'. Example:
394006e60b14ee6641127d13a10696b80a880af5Stephan BoschIndexIgnore README .htaccess *~
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<A name="indexoptions"><h2>IndexOptions</h2></A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt IndexOptions} directive> -->
95e0b82fdff1bb511067d703bb8b67c22f242c38Timo Sirainen<strong>Syntax:</strong> IndexOptions <em>option option ...</em><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThe IndexOptions directive specifies the behavior of the directory indexing.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<dt>FancyIndexing
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<dd><!--%plaintext <?INDEX {\tt FancyIndexing} index option> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis turns on fancy indexing of directories.
95e0b82fdff1bb511067d703bb8b67c22f242c38Timo Sirainen <STRONG>Note that the <SAMP>FancyIndexing</SAMP> and
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch <SAMP>IndexOptions</SAMP> directives will override each other. You
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch should use <SAMP>IndexOptions FancyIndexing</SAMP> in preference
394006e60b14ee6641127d13a10696b80a880af5Stephan Bosch to the standalone <SAMP>FancyIndexing</SAMP> directive.</STRONG>
394006e60b14ee6641127d13a10696b80a880af5Stephan Bosch<dt>IconHeight[=pixels] (<EM>Apache 1.3 and later</EM>)
394006e60b14ee6641127d13a10696b80a880af5Stephan Bosch<!--%plaintext <?INDEX {\tt IconHeight} index option> -->
394006e60b14ee6641127d13a10696b80a880af5Stephan BoschPresence of this option, when used with IconWidth, will cause the server
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschto include <SAMP>HEIGHT</SAMP> and <SAMP>WIDTH</SAMP> attributes in the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<SAMP>IMG</SAMP> tag for the file icon. This allows browser to
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschprecalculate the page layout without having to wait until all the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschimages have been loaded. If no value is given for the option, it
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschdefaults to the standard height of the icons supplied with the Apache
f60fe422cdfbf5427938d2829f16505162d9a9aeStephan Bosch<dt>IconsAreLinks
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt IconsAreLinks} index option> -->
ee2633056e67353157bfbce4d9e0d1c3ceaa627aStephan BoschThis makes the icons part of the anchor for the filename, for
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschfancy indexing.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<dt>IconWidth[=pixels] (<EM>Apache 1.3 and later</EM>)
95e0b82fdff1bb511067d703bb8b67c22f242c38Timo Sirainen<!--%plaintext <?INDEX {\tt IconWidth} index option> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschPresence of this option, when used with IconHeight, will cause the server
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschto include <SAMP>HEIGHT</SAMP> and <SAMP>WIDTH</SAMP> attributes in the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<SAMP>IMG</SAMP> tag for the file icon. This allows browser to
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschprecalculate the page layout without having to wait until all the
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschimages have been loaded. If no value is given for the option, it
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschdefaults to the standard width of the icons supplied with the Apache
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<dt>ScanHTMLTitles
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<dd><!--%plaintext <?INDEX {\tt ScanHTMLTitles} index option> -->
f60fe422cdfbf5427938d2829f16505162d9a9aeStephan BoschThis enables the extraction of the title from HTML documents for fancy
f60fe422cdfbf5427938d2829f16505162d9a9aeStephan Boschindexing. If the file does not have a description given by
f60fe422cdfbf5427938d2829f16505162d9a9aeStephan Bosch<A HREF="#adddescription">AddDescription</A> then httpd will read the
f60fe422cdfbf5427938d2829f16505162d9a9aeStephan Boschdocument for the value of the TITLE tag. This is CPU and disk intensive.
f60fe422cdfbf5427938d2829f16505162d9a9aeStephan Bosch<DT>SuppressColumnSorting
0d7dc1d6ca80cb99a61f2bb44a04c6279c7c107fTimo Sirainen<!--%plaintext <?INDEX {\tt SuppressColumnSorting} index option> -->
0d7dc1d6ca80cb99a61f2bb44a04c6279c7c107fTimo SirainenIf specified, Apache will not make the column headings in a FancyIndexed
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschdirectory listing into links for sorting. The default behaviour is
0d7dc1d6ca80cb99a61f2bb44a04c6279c7c107fTimo Sirainenfor them to be links; selecting the column heading will sort the directory
0d7dc1d6ca80cb99a61f2bb44a04c6279c7c107fTimo Sirainenlisting by the values in that column.
0d7dc1d6ca80cb99a61f2bb44a04c6279c7c107fTimo Sirainen<STRONG>Only available in Apache 1.3 and later.</STRONG>
0d7dc1d6ca80cb99a61f2bb44a04c6279c7c107fTimo Sirainen<dt>SuppressDescription
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt SuppressDescription} index option> -->
ee2633056e67353157bfbce4d9e0d1c3ceaa627aStephan BoschThis will suppress the file description in fancy indexing listings.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<dt>SuppressHTMLPreamble
1ec91e0450eb6c5f6572f6daec720dbada535b01Stephan Bosch<!--%plaintext <?INDEX {\tt SuppressHTMLPreamble} index option> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschIf the directory actually contains a file specified by the
ee2633056e67353157bfbce4d9e0d1c3ceaa627aStephan Bosch HREF="#headername"
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch>HeaderName</A>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschdirective, the module usually includes the contents of the file
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschafter a standard HTML preamble (<HTML>, <HEAD>, <EM>et
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschcetera</EM>). The SuppressHTMLPreamble option disables this behaviour,
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschcausing the module to start the display with the header file contents.
711e8e4c5c5d702dfa062f42a1ede5de14c151c9Stephan BoschThe header file must contain appropriate HTML instructions in this case.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschIf there is no header file, the preamble is generated as usual.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<dt>SuppressLastModified
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt SuppressLastModified} index option> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis will suppress the display of the last modification date, in fancy
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschindexing listings.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<dt>SuppressSize
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt SuppressSize} index option> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis will suppress the file size in fancy indexing listings.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThis default is that no options are enabled. If multiple IndexOptions
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschcould apply to a directory, then the most specific one is taken complete;
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschthe options are not merged. For example:
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschIndexOptions FancyIndexing <br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch</Directory><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschIndexOptions ScanHTMLTitles <br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch</Directory>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschthen only <code>ScanHTMLTitles</code> will be set for the /web/docs/spec
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--%plaintext <?INDEX {\tt ReadmeName} directive> -->
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<strong>Syntax:</strong> ReadmeName <em>filename</em><br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThe ReadmeName directive sets the name of the file that will be appended
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschto the end of the index listing. <em>Filename</em> is the name of the file
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschto include, and is taken to be relative to the directory being indexed.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan BoschThe server first attempts to include <em>filename</em><code>.html</code>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschas an HTML document, otherwise it will include <em>filename</em> as plain
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschtext. Example:
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<blockquote><code>ReadmeName README</code></blockquote>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschwhen indexing the directory <code>/web</code>, the server will first look for
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschthe HTML file <code>/web/README.html</code> and include it if found, otherwise
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Boschit will include the plain text file <code>/web/README</code>, if it exists.
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<p>See also <A HREF="#headername">HeaderName</A>.<p>
3fcb3d2d1f3583025ff62bae95ec706920f398b1Stephan Bosch<!--#include virtual="footer.html" -->