mod_autoindex.html revision dff77f20d3ca0296e740d4369989e57949a06e92
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen BGCOLOR="#FFFFFF"
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen TEXT="#000000"
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen LINK="#0000FF"
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen VLINK="#000080"
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen ALINK="#FF0000"
f16c114c20bbd7d292d93415d1e56c8dd6abd3e7Timo Sirainen<!--#include virtual="header.html" -->
f16c114c20bbd7d292d93415d1e56c8dd6abd3e7Timo SirainenThe module mod_autoindex generates directory indexes, automatically, similar to
f16c114c20bbd7d292d93415d1e56c8dd6abd3e7Timo Sirainenthe Unix <em>ls</em> command or the Win32 <em>dir</em> shell command.
f16c114c20bbd7d292d93415d1e56c8dd6abd3e7Timo SirainenAutomatic index generation must be enabled with by the <CODE>Options</CODE>
f16c114c20bbd7d292d93415d1e56c8dd6abd3e7Timo Sirainendirective's <CODE><I>[+]</I>Indexes</CODE> option. See the
f16c114c20bbd7d292d93415d1e56c8dd6abd3e7Timo Sirainen<A HREF="core.html#options"><CODE>Options</CODE></a> directive for
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenHREF="module-dict.html#SourceFile"
8fcff4c5b52f24d9c681805fdf06b486f1d0fcbeTimo Sirainen><STRONG>Source File:</STRONG></A> mod_autoindex.c
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenHREF="module-dict.html#ModuleIdentifier"
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen><STRONG>Module Identifier:</STRONG></A> autoindex_module
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo SirainenThe index of a directory can come from one of two sources:
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen<LI>A file written by the user, typically called <CODE>index.html</CODE>.
8fcff4c5b52f24d9c681805fdf06b486f1d0fcbeTimo SirainenThe <A HREF="mod_dir.html#directoryindex">DirectoryIndex</A> directive sets
8fcff4c5b52f24d9c681805fdf06b486f1d0fcbeTimo Sirainenthe name of this file.
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo SirainenThis is controlled by <A HREF="mod_dir.html"><CODE>mod_dir</CODE></A>.
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainen<LI>Otherwise, a listing generated by the server. The other directives
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainencontrol the format of this listing. The <A HREF="#addicon">AddIcon</A>,
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainen<A HREF="#addiconbyencoding">AddIconByEncoding</A> and
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainen<A HREF="#addiconbytype">AddIconByType</A> are used to set a list of
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainenicons to display for various file types; for each file listed, the
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainenfirst icon listed that matches the file is displayed. These
02b79f9c2636da1829eee5b92753602bba8b67edTimo SirainenThe two functions are separated so that you can completely remove
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainen(or replace) automatic index generation should you want to.
02b79f9c2636da1829eee5b92753602bba8b67edTimo SirainenAutomatic index generation is enabled with using
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainen<A HREF="core.html#options"><CODE>Options</CODE></a> directive for
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo SirainenIf the <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainenoption is given with the <A HREF="#indexoptions"><SAMP>IndexOptions</SAMP></A>
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainendirective, the column headers are links that control the
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainenorder of the display. If you select a header link, the
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainenlisting will be regenerated, sorted by the values in that
445f9e31c6c3aa6c0a72be8565da8f6e594d24fbTimo Sirainencolumn. Selecting the same header repeatedly toggles
445f9e31c6c3aa6c0a72be8565da8f6e594d24fbTimo Sirainenbetween ascending and descending order. These column header links are
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainensuppressed with <A HREF="#indexoptions">IndexOptions</A> directive's
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo SirainenNote that when the display is sorted by "Size",
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainenit's the <EM>actual</EM> size of the files that's used,
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainennot the displayed value - so a 1010-byte file will
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainenalways be displayed before a 1011-byte file (if in ascending
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainenorder) even though they both are shown as "1K".
178511b57faa7c3f8203dd8b7e4059d00cbfc23aTimo Sirainen<LI><A HREF="#addaltbyencoding">AddAltByEncoding</A>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<LI><A HREF="#adddescription">AddDescription</A>
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainen<LI><A HREF="#addiconbyencoding">AddIconByEncoding</A>
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainen<LI><A HREF="#indexorderdefault">IndexOrderDefault</A>
9e59a1f3f095b3099478562cf3f3970a24736970Timo Sirainen<p>See also: <A HREF="core.html#options">Options</A> and <A
96c253a039f102fa78a313ee05200ab3970112dcTimo SirainenHREF="mod_dir.html#directoryindex">DirectoryIndex</A>.</p>
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainen<P>Apache 2.0.23 reorganized the Query Arguments for Column Sorting, and introduced
268fe0fe3e748ae313e08b0918aa114815cf9d7cTimo Sirainenan entire group of new query options. To effectively eliminate all client control
268fe0fe3e748ae313e08b0918aa114815cf9d7cTimo Sirainenover the output, the <SAMP><A HREF="#indexoptions:ignoreclient">IndexOptions
268fe0fe3e748ae313e08b0918aa114815cf9d7cTimo SirainenIgnoreClient</A></SAMP> option was introduced.</P>
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainen<P>The column sorting headers themselves are self-referencing hyperlinks that add the
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainensort query options shown below. Any option below may be added to any request for the
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainendirectory resource.
9a06cabdfdf4d5e2f19a07e506c3c7d08a7e7038Timo Sirainen<li><SAMP>C=N</SAMP> sorts the directory by file name
9a06cabdfdf4d5e2f19a07e506c3c7d08a7e7038Timo Sirainen<li><SAMP>C=M</SAMP> sorts the directory by last-modified date, then file name
9a06cabdfdf4d5e2f19a07e506c3c7d08a7e7038Timo Sirainen<li><SAMP>C=S</SAMP> sorts the directory by size, then file name
9a06cabdfdf4d5e2f19a07e506c3c7d08a7e7038Timo Sirainen<li><SAMP>C=D</SAMP> sorts the directory by description, then file name<br />
9aa52288a4b53186d81b0ec9afa7d9e0a8ee8753Timo Sirainen<li><SAMP>O=A</SAMP> sorts the listing in Ascending Order
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<li><SAMP>O=D</SAMP> sorts the listing in Descending Order<br />
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<li><SAMP>F=0</SAMP> formats the listing as a simple list (not FancyIndexed)
b3febb0933fdce10394d25093e23ce0a5aadddd3Timo Sirainen<li><SAMP>F=1</SAMP> formats the listing as a FancyIndexed list
b3febb0933fdce10394d25093e23ce0a5aadddd3Timo Sirainen<li><SAMP>F=2</SAMP> formats the listing as an HTMLTable FancyIndexed list<br />
b3febb0933fdce10394d25093e23ce0a5aadddd3Timo Sirainen<li><SAMP>V=1</SAMP> enables version sorting<br />
b3febb0933fdce10394d25093e23ce0a5aadddd3Timo Sirainen<li><SAMP>P=<EM>pattern</EM></SAMP> lists only files matching the given <EM>pattern</EM>
b3febb0933fdce10394d25093e23ce0a5aadddd3Timo Sirainen<P>Note that the 'P'attern query argument is tested <em>after</em> the usual IndexIgnore
b3febb0933fdce10394d25093e23ce0a5aadddd3Timo Sirainendirectives are processed, and all file names are still subjected to the same criteria
b3febb0933fdce10394d25093e23ce0a5aadddd3Timo Sirainenas any other autoindex listing. The Query Arguments parser in mod_autoindex will stop
b3febb0933fdce10394d25093e23ce0a5aadddd3Timo Sirainenabruptly when an unrecognized option is encountered. The Query Arguments must be well
b3febb0933fdce10394d25093e23ce0a5aadddd3Timo Sirainenformed, according to the table above.</P>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<P>The simple example below, which can be clipped and saved in a header.html file,
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenillustrates these query options. Note that the unknown "X" argument, for the
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainensubmit button, is listed last to assure the arguments are all parsed before
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenmod_autoindex encounters the X=Go input.</P>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<pre><FORM METHOD="GET">
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen Show me a <SELECT NAME="F">
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen <OPTION VALUE="0"> Plain list
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen <OPTION VALUE="1" SELECTED> Fancy list
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen <OPTION VALUE="2"> Table list
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen </SELECT>
6843896c40bee4f9b6680ca7ced598c446e9f999Timo Sirainen Sorted by <SELECT NAME="C">
6843896c40bee4f9b6680ca7ced598c446e9f999Timo Sirainen <OPTION VALUE="N" SELECTED> Name
6843896c40bee4f9b6680ca7ced598c446e9f999Timo Sirainen <OPTION VALUE="M"> Date Modified
6843896c40bee4f9b6680ca7ced598c446e9f999Timo Sirainen <OPTION VALUE="S"> Size
6843896c40bee4f9b6680ca7ced598c446e9f999Timo Sirainen <OPTION VALUE="D"> Description
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen </SELECT>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen <SELECT NAME="O">
755fe6da51ab7f54aa1d86913cb344bffef60e79Timo Sirainen <OPTION VALUE="A" SELECTED> Ascending
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen <OPTION VALUE="D"> Descending
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen </SELECT>
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen <SELECT NAME="V">
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen <OPTION VALUE="0" SELECTED> in Normal order
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen <OPTION VALUE="1"> in Version order
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen </SELECT>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen Matching <INPUT TYPE="text" NAME="P" VALUE="*">
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen <INPUT TYPE="submit" NAME="X" VALUE="Go">
36e2fa21c22452470c1509cc63de20f7415c7b5eTimo Sirainen<!--%plaintext <?INDEX {\tt AddAlt} directive> -->
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Syntax:</STRONG></A> AddAlt <EM>string file</em>
345212e8f61ebf14ff4f80df26df9e655eb5121eTimo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
345212e8f61ebf14ff4f80df26df9e655eb5121eTimo Sirainen .htaccess<BR>
9aa52288a4b53186d81b0ec9afa7d9e0a8ee8753Timo Sirainen<EM>AddAlt</EM> provides the alternate text to display for a file, instead of an icon,
9aa52288a4b53186d81b0ec9afa7d9e0a8ee8753Timo Sirainenfor <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>. <EM>File</EM>
9aa52288a4b53186d81b0ec9afa7d9e0a8ee8753Timo Sirainenis a file extension, partial filename, wild-card expression or full filename for
9aa52288a4b53186d81b0ec9afa7d9e0a8ee8753Timo Sirainenfiles to describe. <EM>String</EM> is enclosed in double quotes (<CODE>"</CODE>).
9aa52288a4b53186d81b0ec9afa7d9e0a8ee8753Timo SirainenThis alternate text is displayed if the client is image-incapable, has image loading
9aa52288a4b53186d81b0ec9afa7d9e0a8ee8753Timo Sirainendisabled, or fails to retrieve the icon.
db7c9201c88e3d9bee10485194ee5b0c67249916Timo Sirainen<H2><A NAME="addaltbyencoding">AddAltByEncoding</A> directive</H2>
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen<!--%plaintext <?INDEX {\tt AddAltByEncoding} directive> -->
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Syntax:</STRONG></A> AddAltByEncoding <EM>string MIME-encoding</em>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
6843896c40bee4f9b6680ca7ced598c446e9f999Timo Sirainen .htaccess<BR>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<EM>AddAltByEncoding</EM> provides the alternate text to display for a file, instead
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenof an icon, for <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<EM>MIME-encoding</EM> is a valid content-encoding, such as <SAMP>x-compress</SAMP>.
a393d9d6dabdc46cf724f8cb004a652b4036d53dTimo Sirainen<EM>String</EM> is enclosed in double quotes (<CODE>"</CODE>). This alternate
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainentext is displayed if the client is image-incapable, has image loading disabled, or
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenfails to retrieve the icon.
9a06cabdfdf4d5e2f19a07e506c3c7d08a7e7038Timo Sirainen<H2><A NAME="addaltbytype">AddAltByType</A> directive</H2>
9a06cabdfdf4d5e2f19a07e506c3c7d08a7e7038Timo Sirainen<!--%plaintext <?INDEX {\tt AddAltByType} directive> -->
2ae575a66f2a302f047f6de062a70b75f8bebc7bTimo Sirainen><STRONG>Syntax:</STRONG></A> AddAltByType <EM>string MIME-type</em>
7f773564b94e6054a40d3785cb63c29f1e4d4deeTimo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
484efa22e65c509f787dbbc892351146c726c257Timo Sirainen .htaccess<BR>
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen<EM>AddAltByType</EM> sets the alternate text to display for a file, instead of
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainenan icon, for <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen<EM>MIME-type</EM> is a valid content-type, such as <SAMP>text/html</SAMP>.
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen<EM>String</EM> is enclosed in double quotes (<CODE>"</CODE>). This
df4018ae2f0a95be602f724ca70df7e0e3bd6a7dTimo Sirainenalternate text is displayed if the client is image-incapable, has image loading
df4018ae2f0a95be602f724ca70df7e0e3bd6a7dTimo Sirainendisabled, or fails to retrieve the icon.
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen<H2><A NAME="adddescription">AddDescription</A> directive</H2>
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen<!--%plaintext <?INDEX {\tt AddDescription} directive> -->
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen><STRONG>Syntax:</STRONG></A> AddDescription <EM>string file</em>
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen .htaccess<BR>
7f3be7d885c75cdd77f536929a45bc9764595960Timo SirainenThis sets the description to display for a file, for
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<EM>File</EM> is a file extension, partial filename, wild-card expression
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenor full filename for files to describe. <EM>String</EM> is enclosed in double
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<BLOCKQUOTE><CODE>AddDescription "The planet Mars" /web/pics/mars.gif
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo SirainenThe typical, default description field is 23 bytes wide. 6 more bytes are
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenadded by the <CODE>IndexOptions SuppressIcon</CODE> option, 7 bytes are
4d25408732be27e91f0430f71e87242760c2517cTimo Sirainenadded by the <CODE>IndexOptions SuppressSize</CODE> option, and 19 bytes
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainenare added by the <CODE>IndexOptions SuppressLastModified</CODE> option.
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo SirainenTherefore, the widest default the description column is ever assigned is 55 bytes.
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo SirainenSee the <a href="#indexoptions:descriptionwidth">DescriptionWidth</a>
4d25408732be27e91f0430f71e87242760c2517cTimo Sirainen<samp>IndexOptions</samp> keyword for details on overriding the size of this
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainencolumn, or allowing descriptions of unlimited length.
4d25408732be27e91f0430f71e87242760c2517cTimo Sirainen<b>Caution:</b> Descriptive text defined with <samp>AddDescription</samp>
4d25408732be27e91f0430f71e87242760c2517cTimo Sirainenmay contain HTML markup, such as tags and character entities. If the
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenwidth of the description column should happen to truncate a tagged
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenelement (such as cutting off the end of a bolded phrase), the results
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenmay affect the rest of the directory listing.
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<H2><A NAME="addicon">AddIcon</A> directive</H2>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<!--%plaintext <?INDEX {\tt AddIcon} directive> -->
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Syntax:</STRONG></A> AddIcon <EM>icon name</em>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen .htaccess<BR>
6a19e109ee8c5a6f688da83a86a7f6abeb71abddTimo SirainenThis sets the icon to display next to a file ending in <EM>name</EM> for
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>. <EM>Icon</EM>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenis either a (%-escaped) relative URL to the icon, or of the format
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen(<EM>alttext</EM>,<EM>url</EM>) where <EM>alttext</EM> is the text tag given
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenfor an icon for non-graphical browsers.<P>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<EM>Name</EM> is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ for
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainenblank lines (to format the list correctly), a file extension, a wildcard
77af8c68c416179e717fc2d551f72ec50b499c13Timo Sirainenexpression, a partial filename or a complete filename. Examples:
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo SirainenAddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm <BR>
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen<A HREF="#addiconbytype">AddIconByType</A> should be used in preference to
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen<H2><A NAME="addiconbyencoding">AddIconByEncoding</A> directive</H2>
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen<!--%plaintext <?INDEX {\tt AddIconByEncoding} directive> -->
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen><STRONG>Syntax:</STRONG></A> AddIconByEncoding <EM>icon MIME-encoding</em>
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen .htaccess<BR>
16c89b1260c9d07c01c83a9219424d3727069b2eTimo SirainenThis sets the icon to display next to files with
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen<EM>Icon</EM> is either a (%-escaped) relative URL to the icon, or of the
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainenformat (<EM>alttext</EM>,<EM>url</EM>) where <EM>alttext</EM> is the text tag
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainengiven for an icon for non-graphical browsers.<P>
3023fb352cbc2052b156f6d325c2629531a1b5b4Timo Sirainen<EM>Mime-encoding</EM> is a wildcard expression matching required the
3023fb352cbc2052b156f6d325c2629531a1b5b4Timo Sirainencontent-encoding. Examples:
e8a35266a5ceacdfafeeffd6bddae77931ff97ebTimo SirainenAddIconByEncoding /icons/compress.xbm x-compress
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<H2><A NAME="addiconbytype">AddIconByType</A> directive</H2>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<!--%plaintext <?INDEX {\tt AddIconByType} directive> -->
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Syntax:</STRONG></A> AddIconByType <EM>icon MIME-type</em>
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen .htaccess<BR>
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo SirainenThis sets the icon to display next to files of type <EM>MIME-type</EM> for
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>. <EM>Icon</EM>
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainenis either a (%-escaped) relative URL to the icon, or of the format
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen(<EM>alttext</EM>,<EM>url</EM>) where <EM>alttext</EM> is the text tag given
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainenfor an icon for non-graphical browsers.<P>
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen<EM>Mime-type</EM> is a wildcard expression matching required the mime types.
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen<H2><A NAME="defaulticon">DefaultIcon</A> directive</H2>
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen<!--%plaintext <?INDEX {\tt DefaultIcon} directive> -->
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen><STRONG>Syntax:</STRONG></A> DefaultIcon <EM>url</EM><BR>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen .htaccess<BR>
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo SirainenThe DefaultIcon directive sets the icon to display for files when no
3021a062b16ff0138408be6107d6bcd0ced280b9Timo Sirainenspecific icon is known, for
e5c08648676d1989f6e70b95e5990c26b3e8b96bTimo Sirainen<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
e5c08648676d1989f6e70b95e5990c26b3e8b96bTimo Sirainen<EM>Url</EM> is a (%-escaped) relative URL to the icon. Examples:
e5c08648676d1989f6e70b95e5990c26b3e8b96bTimo Sirainen<H2><A NAME="fancyindexing">FancyIndexing</A> directive</H2>
e5c08648676d1989f6e70b95e5990c26b3e8b96bTimo Sirainen<!--%plaintext <?INDEX {\tt FancyIndexing} directive> -->
7797aa2479e99aeb71057b7a2584b2cb72e4d3f8Timo Sirainen HREF="directive-dict.html#Deprecated"
01cbf4ac5d44137ab434791be7f838d98d0fcf3bTimo Sirainen><STRONG>Deprecated:</STRONG></A> See <A HREF="#indexoptions">IndexOptions</A>
01cbf4ac5d44137ab434791be7f838d98d0fcf3bTimo Sirainen <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP><BR>
8907d617ce7c4f390c0f42f6f694db2fecdd5775Timo SirainenThe FancyIndexing directive was replaced by the
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP> option to the
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen<A HREF="#indexoptions">IndexOptions</A> directive, and is no longer supported
4d25408732be27e91f0430f71e87242760c2517cTimo Sirainenin Apache 2.0.
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<H2><A NAME="headername">HeaderName</A> directive</H2>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<!--%plaintext <?INDEX {\tt HeaderName} directive> -->
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Syntax:</STRONG></A> HeaderName <EM>filename</EM><BR>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
b2ecd50bb98c44816cb07c17aa17fae2b425f941Timo Sirainen .htaccess<BR>
7fd72a47d7ddfbd38c8697e228b6951f495dfb61Timo Sirainen HREF="directive-dict.html#Compatibility"
7fd72a47d7ddfbd38c8697e228b6951f495dfb61Timo Sirainen ><STRONG>Compatibility:</STRONG></A> behavior changed in version 1.3.7;
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo SirainenThe HeaderName directive sets the name of the file that will be inserted
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenat the top of the index listing. <EM>Filename</EM> is the name of the file
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<BLOCKQUOTE><STRONG>Changes with Apache 1.3.7:</STRONG>
659fe5d24825b160cae512538088020d97a60239Timo SirainenBoth HeaderName and <A HREF="#readmename">ReadmeName</A> now treat <EM>Filename</EM>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenas a URI path relative to the one used to access the directory being indexed.
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<EM>Filename</EM> must resolve to a document with a major content type of
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen"<SAMP>text/*</SAMP>" (<EM>e.g.</EM>, <SAMP>text/html</SAMP>, <SAMP>text/plain</SAMP>,
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<EM>etc.</EM>). This means that <EM>filename</EM> may refer to a CGI script if the
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenscript's actual file type (as opposed to its output) is marked as
064bfeee2f9156683b191cc0f3f7b242720942f7Timo Sirainen<SAMP>text/html</SAMP> such as with a directive like:
7fd72a47d7ddfbd38c8697e228b6951f495dfb61Timo Sirainen<A HREF="/content-negotiation.html">Content negotiation</A>
7fd72a47d7ddfbd38c8697e228b6951f495dfb61Timo Sirainenwill be performed if the <SAMP>MultiViews</SAMP>
7fd72a47d7ddfbd38c8697e228b6951f495dfb61Timo Sirainen<A HREF="core.html#options">option</A> is enabled.
7fd72a47d7ddfbd38c8697e228b6951f495dfb61Timo SirainenIf <EM>filename</EM> resolves to a static <SAMP>text/html</SAMP> document
b2ecd50bb98c44816cb07c17aa17fae2b425f941Timo Sirainen(not a CGI script) and the
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<SAMP>Includes</SAMP> <A HREF="core.html#options">option</A> is enabled,
345212e8f61ebf14ff4f80df26df9e655eb5121eTimo Sirainenthe file will be processed for server-side includes (see the
345212e8f61ebf14ff4f80df26df9e655eb5121eTimo Sirainen<A HREF="mod_include.html"><SAMP>mod_include</SAMP></A> documentation).
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo SirainenIf the file specified by <SAMP>HeaderName</SAMP> contains the
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainenbeginnings of an HTML document (<HTML>, <HEAD>, etc) then
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainenyou will probably want to set <A
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo SirainenHREF="#indexoptions:suppresshtmlpreamble"><SAMP>IndexOptions
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen+SuppressHTMLPreamble</SAMP></A>, so that these tags are not
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<H2><A NAME="indexignore">IndexIgnore</A> directive</H2>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<!--%plaintext <?INDEX {\tt IndexIgnore} directive> -->
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Syntax:</STRONG></A> IndexIgnore <EM>file</em> [<em>file</em>] ...<BR>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen .htaccess<BR>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo SirainenThe IndexIgnore directive adds to the list of files to hide when listing
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainena directory. <EM>File</EM> is a file extension, partial filename,
313fe89df4d91cd0cd7f3558dc6d7fd21ad39eeeTimo Sirainenwildcard expression or full filename for files to ignore. Multiple
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo SirainenIndexIgnore directives add to the list, rather than the replacing the list
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenof ignored files. By default, the list contains `<CODE>.</CODE>'. Example:
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo SirainenIndexIgnore README .htaccess *~
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<H2><A NAME="indexoptions">IndexOptions</A> directive</H2>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<!--%plaintext <?INDEX {\tt IndexOptions} directive> -->
2cb565cd978aafd5714792b5161889986d49e431Timo Sirainen><STRONG>Syntax:</STRONG></A> IndexOptions [+|-]<em>option</em>
2cb565cd978aafd5714792b5161889986d49e431Timo Sirainen [[+|-]<em>option</em>] ... (Apache 1.3.3 and later)
dc8552739fa29f011ab71ec383ec6d580a5a9661Timo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
dc8552739fa29f011ab71ec383ec6d580a5a9661Timo Sirainen .htaccess<BR>
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo Sirainen HREF="directive-dict.html#Compatibility"
4214b59ac7f3899f8d887d055ef519f5a622d249Timo Sirainen><STRONG>Compatibility:</STRONG></A> '+/-' syntax and merging of multiple
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo Sirainen <SAMP>IndexOptions</SAMP> directives is only available with
930dcf1576f99057ad572420d9c75f3212e46a2eTimo Sirainen Apache 1.3.3 and later; specific options are listed below.
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo SirainenThe IndexOptions directive specifies the behavior of the directory indexing.
829c036d4ddfbd9ea49bd8a7c54e3057177d346eTimo Sirainen<dt><a name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em> | *]
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo Sirainen (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a></dt>
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen<dd>The <samp>DescriptionWidth</samp> keyword allows you to specify the
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainenwidth of the description column in characters.</dd>
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen<dd><samp>-DescriptionWidth</samp> (or unset) allows mod_autoindex to calculate
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo Sirainenthe best width.</dd>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<dd><samp>DescriptionWidth=n</samp> fixes the column width to n bytes wide.</dd>
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo Sirainen<dd><samp>DescriptionWidth=*</samp> grows the column to the width necessary to
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo Sirainenaccommodate the longest description string.</dd>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<dd><b>See the section on <a href="#adddescription"><samp>AddDescription</samp></a>
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainenfor dangers inherent in truncating descriptions.</b></dd>
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo Sirainen<DT><A NAME="indexoptions:fancyindexing">FancyIndexing</A>
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo Sirainen<DD><!--%plaintext <?INDEX {\tt FancyIndexing} index option> -->
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo SirainenThis turns on fancy indexing of directories.
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo Sirainen<dt><a name="indexoptions:foldersfirst">FoldersFirst
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen (<i>Apache 1.3.10 or 2.0.23 and later</i>)</a></dt>
6a1e4eb2c6a267bec1e8704ce9137bebb7792702Timo SirainenIf this option is enabled, subdirectory listings
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainenwill <i>always</i> appear first, followed by normal files in the
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainendirectory. The listing is basically broken into two components,
b2ecd50bb98c44816cb07c17aa17fae2b425f941Timo Sirainenthe files and the subdirectories, and each is sorted separately and
8907d617ce7c4f390c0f42f6f694db2fecdd5775Timo Sirainenthen displayed subdirectories-first. For instance, if the sort order
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenis descending by name, and <samp>FoldersFirst</samp> is enabled,
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainensubdirectory <samp>Zed</samp> will be listed before subdirectory
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<samp>Beta</samp>, which will be listed before normal files
01cbf4ac5d44137ab434791be7f838d98d0fcf3bTimo Sirainen<b>This option only has an effect if
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<a href="#indexoptions:fancyindexing"><samp>FancyIndexing</samp></a>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<DT><A NAME="indexoptions:htmltable">HTMLTable</A>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen <i>(Experimental, Apache 2.0.23 and later)</i>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<DD><!--%plaintext <?INDEX {\tt HTMLTable} index option> -->
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo SirainenThis experimental option with FancyIndexing constructs a simple table for the
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainenfancy directory listing. Note this will confuse older browsers. It is particularly
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainennecessary if file names or description text will alternate between left-to-right
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainenand right-to-left reading order, as can happen on WinNT or other utf-8
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenenabled platforms.
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<DT><A NAME="indexoptions:iconsarelinks">IconsAreLinks</A>
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<!--%plaintext <?INDEX {\tt IconsAreLinks} index option> -->
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo SirainenThis makes the icons part of the anchor for the filename, for
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenfancy indexing.
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<DT><A NAME="indexoptions:iconheight">IconHeight[=pixels] (<EM>Apache 1.3 and later</EM>)</A>
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<!--%plaintext <?INDEX {\tt IconHeight} index option> -->
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenPresence of this option, when used with IconWidth, will cause the server
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainento include <SAMP>HEIGHT</SAMP> and <SAMP>WIDTH</SAMP> attributes in the
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<SAMP>IMG</SAMP> tag for the file icon. This allows browser to
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenprecalculate the page layout without having to wait until all the
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenimages have been loaded. If no value is given for the option, it
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainendefaults to the standard height of the icons supplied with the Apache
6a87059fc7d4e919aa55d0b208ff20708e13e2d7Timo Sirainen<DT><A NAME="indexoptions:iconwidth">IconWidth[=pixels] (<EM>Apache 1.3 and later</EM>)</A>
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen<!--%plaintext <?INDEX {\tt IconWidth} index option> -->
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenPresence of this option, when used with IconHeight, will cause the server
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainento include <SAMP>HEIGHT</SAMP> and <SAMP>WIDTH</SAMP> attributes in the
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<SAMP>IMG</SAMP> tag for the file icon. This allows browser to
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenprecalculate the page layout without having to wait until all the
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenimages have been loaded. If no value is given for the option, it
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainendefaults to the standard width of the icons supplied with the Apache
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<DT><A NAME="indexoptions:ignoreclient">IgnoreClient</A>
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<!--%plaintext <?INDEX {\tt IgnoreClient} index option> -->
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenThis option causes mod_autoindex to ignore all query variables from the
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen HREF="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</A></SAMP>.)
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainen<DT><A NAME="indexoptions:namewidth">NameWidth=[<EM>n</EM> | *] (<EM>Apache 1.3.2 and later</EM>)</A>
319944c0f35b311c998854e96d6463a084fd90aeTimo SirainenThe NameWidth keyword allows you to specify the width of the
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainenfilename column in bytes.
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainen<dd><samp>-NameWidth</samp> (or unset) allows mod_autoindex to calculate
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainenthe best width.</dd>
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainen<dd><samp>NameWidth=n</samp> fixes the column width to n bytes wide.</dd>
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainen<dd><samp>NameWidth=*</samp> grows the column to the necessary width.</dd>
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainen<DT><A NAME="indexoptions:scanhtmltitles">ScanHTMLTitles</A>
a393d9d6dabdc46cf724f8cb004a652b4036d53dTimo Sirainen<DD><!--%plaintext <?INDEX {\tt ScanHTMLTitles} index option> -->
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenThis enables the extraction of the title from HTML documents for fancy
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenindexing. If the file does not have a description given by
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<A HREF="#adddescription">AddDescription</A> then httpd will read the
cece2b9cd692c06025cc0a7a0ff54d996a8c90efTimo Sirainendocument for the value of the TITLE tag. This is CPU and disk intensive.
cece2b9cd692c06025cc0a7a0ff54d996a8c90efTimo Sirainen<DT><A NAME="indexoptions:suppresscolumnsorting">SuppressColumnSorting</A>
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<!--%plaintext <?INDEX {\tt SuppressColumnSorting} index option> -->
f0569d9fbb25c8437760be69f194595a841ad711Timo SirainenIf specified, Apache will not make the column headings in a FancyIndexed
db7c9201c88e3d9bee10485194ee5b0c67249916Timo Sirainendirectory listing into links for sorting. The default behavior is
755fe6da51ab7f54aa1d86913cb344bffef60e79Timo Sirainenfor them to be links; selecting the column heading will sort the directory
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainenlisting by the values in that column. <STRONG>Prior to Apache 2.0.23, this
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainenalso disabled parsing the Query Arguments for the sort string.</STRONG>
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenThat behavior is now controlled by <A HREF="#indexoptions:ignoreclient"
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen >IndexOptions IgnoreClient</A> in Apache 2.0.23.
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<DT><A NAME="indexoptions:suppressdescription">SuppressDescription</A>
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<!--%plaintext <?INDEX {\tt SuppressDescription} index option> -->
0a6f8311541ae59381171620b77f82be58be562eTimo SirainenThis will suppress the file description in fancy indexing listings.
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenBy default, no file descriptions are defined, and so the use of this option
a10e5606a9e93f49cf13b3a35c8dc3f5d6ab5909Timo Sirainenwill regain 23 characters of screen space to use for something else.
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenSee <A HREF="#adddescription"><samp>AddDescription</samp></A>
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenfor information about setting the file description. See also the
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenHREF="#indexoptions:descriptionwidth"><samp>DescriptionWidth</samp></A>
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenindex option to limit the size of the description column.
0a6f8311541ae59381171620b77f82be58be562eTimo Sirainen<DT><A NAME="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</A>
0a6f8311541ae59381171620b77f82be58be562eTimo Sirainen<!--%plaintext <?INDEX {\tt SuppressHTMLPreamble} index option> -->
0a6f8311541ae59381171620b77f82be58be562eTimo SirainenIf the directory actually contains a file specified by the
0a6f8311541ae59381171620b77f82be58be562eTimo Sirainen HREF="#headername"
0a6f8311541ae59381171620b77f82be58be562eTimo Sirainen>HeaderName</A>
0a6f8311541ae59381171620b77f82be58be562eTimo Sirainendirective, the module usually includes the contents of the file
a10e5606a9e93f49cf13b3a35c8dc3f5d6ab5909Timo Sirainenafter a standard HTML preamble (<HTML>, <HEAD>, <EM>et
df4018ae2f0a95be602f724ca70df7e0e3bd6a7dTimo Sirainencetera</EM>). The SuppressHTMLPreamble option disables this behaviour,
0a6f8311541ae59381171620b77f82be58be562eTimo Sirainencausing the module to start the display with the header file contents.
0a6f8311541ae59381171620b77f82be58be562eTimo SirainenThe header file must contain appropriate HTML instructions in this case.
0a6f8311541ae59381171620b77f82be58be562eTimo SirainenIf there is no header file, the preamble is generated as usual.
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainen<DT><A NAME="indexoptions:suppressicon">SuppressIcon</A>
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen<!--%plaintext <?INDEX {\tt SuppressIcon} index option> -->
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo SirainenThis will suppress the icon in fancy indexing listings. Combining
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenboth <EM>SuppressIcon</EM> and <EM>SuppressRules</EM> yields proper
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo SirainenHTML 3.2 output, which by the final specification prohibits IMG and HR
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainentags from the PRE block (used to format FancyIndexed listings.)
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<DT><A NAME="indexoptions:suppresslastmodified">SuppressLastModified</A>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<!--%plaintext <?INDEX {\tt SuppressLastModified} index option> -->
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo SirainenThis will suppress the display of the last modification date, in fancy
df4018ae2f0a95be602f724ca70df7e0e3bd6a7dTimo Sirainenindexing listings.
df4018ae2f0a95be602f724ca70df7e0e3bd6a7dTimo Sirainen<DT><A NAME="indexoptions:suppressrules">SuppressRules</A>
974ed9e53724507b99fe02e715e4b6153d2be92bTimo Sirainen<!--%plaintext <?INDEX {\tt SuppressRules} index option> -->
3343a61404603b21c246783a7963b77833095f31Timo SirainenThis will suppress the horizontal rule lines (HR tags) in directory listings.
3343a61404603b21c246783a7963b77833095f31Timo SirainenCombining both <EM>SuppressIcon</EM> and <EM>SuppressRules</EM> yeilds proper
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenHTML 3.2 output, which by the final specification prohibits IMG and HR tags
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainenfrom the PRE block (used to format FancyIndexed listings.)
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen<DT><A NAME="indexoptions:suppresssize">SuppressSize</A>
f0569d9fbb25c8437760be69f194595a841ad711Timo Sirainen<!--%plaintext <?INDEX {\tt SuppressSize} index option> -->
f1b7a02a05fbca580934c7312aae63ea9542aa79Timo SirainenThis will suppress the file size in fancy indexing listings.
f0569d9fbb25c8437760be69f194595a841ad711Timo Sirainen<DT><A NAME="indexoptions:trackmodified">TrackModified
f0569d9fbb25c8437760be69f194595a841ad711Timo Sirainen(<EM>Apache 1.3.15 or 2.0.23 and later</EM>)</A>
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen<!--%plaintext <?INDEX {\tt TrackModified} index option> -->
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo SirainenThis returns the Last-Modified and ETag values for the listed directory
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainenin the HTTP header. It is only valid if the operating system and file
f0569d9fbb25c8437760be69f194595a841ad711Timo Sirainensystem return appropriate stat() results. Some Unix systems do so, as
f0569d9fbb25c8437760be69f194595a841ad711Timo Sirainendo OS2's JFS and Win32's NTFS volumes. OS2 and Win32 FAT volumes,
f1b7a02a05fbca580934c7312aae63ea9542aa79Timo Sirainenfor example, do not. Once this feature is enabled, the client or proxy
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainencan track changes to the list of files when they perform a HEAD request.
f1b7a02a05fbca580934c7312aae63ea9542aa79Timo SirainenNote some operating systems correctly track new and removed files, but
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainendo not track changes for sizes or dates of the files within the directory.
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen<STRONG>Changes to the size or date stamp of an existing file will not
f0569d9fbb25c8437760be69f194595a841ad711Timo Sirainenupdate the Last-Modified header on all Unix platforms.</STRONG> If this
f0569d9fbb25c8437760be69f194595a841ad711Timo Sirainenis a concern, leave this option disabled.
f0569d9fbb25c8437760be69f194595a841ad711Timo Sirainen<DT><A NAME="indexoptions:versionsort">VersionSort (<EM>Apache 2.0a3 and later</EM>)</A>
755fe6da51ab7f54aa1d86913cb344bffef60e79Timo SirainenThe VersionSort keyword causes files containing version numbers to
755fe6da51ab7f54aa1d86913cb344bffef60e79Timo Sirainensort in a natural way. Strings are sorted as usual, except that
755fe6da51ab7f54aa1d86913cb344bffef60e79Timo Sirainensubstrings of digits in the name and description are compared
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainenaccording to their numeric value.
319944c0f35b311c998854e96d6463a084fd90aeTimo SirainenIf the number starts with a zero, then it is considered to be a
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainen<DD>Apache 1.3.3 introduced some significant changes in the handling of
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainen<SAMP>IndexOptions</SAMP> directives. In particular,
319944c0f35b311c998854e96d6463a084fd90aeTimo Sirainen <LI>Multiple <SAMP>IndexOptions</SAMP> directives for a single
907723f35f4d3dfc774ca42d00a8a7b8ef90dd5dTimo Sirainen directory are now merged together. The result of the example above
907723f35f4d3dfc774ca42d00a8a7b8ef90dd5dTimo Sirainen will now be the equivalent of
907723f35f4d3dfc774ca42d00a8a7b8ef90dd5dTimo Sirainen <CODE>IndexOptions FancyIndexing ScanHTMLTitles</CODE>.
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen <LI>The addition of the incremental syntax (<EM>i.e.</EM>, prefixing
6843896c40bee4f9b6680ca7ced598c446e9f999Timo Sirainen keywords with '+' or '-').
7f3be7d885c75cdd77f536929a45bc9764595960Timo SirainenWhenever a '+' or '-' prefixed keyword is encountered, it is applied
2ae575a66f2a302f047f6de062a70b75f8bebc7bTimo Sirainento the current <SAMP>IndexOptions</SAMP> settings (which may have been
2ae575a66f2a302f047f6de062a70b75f8bebc7bTimo Siraineninherited from an upper-level directory). However, whenever an unprefixed
2ae575a66f2a302f047f6de062a70b75f8bebc7bTimo Sirainenkeyword is processed, it clears all inherited options and any incremental
2ae575a66f2a302f047f6de062a70b75f8bebc7bTimo Sirainensettings encountered so far. Consider the following example:
2ae575a66f2a302f047f6de062a70b75f8bebc7bTimo Sirainen<BLOCKQUOTE><CODE>IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo SirainenIndexOptions +SuppressSize
6e71799ee07bfd2289beae77c9bb5d7f1d30dccaTimo SirainenThe net effect is equivalent to
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen<CODE>IndexOptions FancyIndexing +SuppressSize</CODE>, because
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainenthe unprefixed <CODE>FancyIndexing</CODE> discarded the incremental
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainenkeywords before it, but allowed them to start accumulating again
7f3be7d885c75cdd77f536929a45bc9764595960Timo SirainenTo unconditionally set the <CODE>IndexOptions</CODE> for a
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainenparticular directory, clearing the inherited settings, specify
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainenkeywords without any '+' or '-' prefixes.
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen<H2><A NAME="indexorderdefault">IndexOrderDefault</A> directive</H2>
7a6b45405fb1544ac476e6eb1402a70cc1ddcdcfTimo Sirainen<!--%plaintext <?INDEX {\tt IndexOrderDefault} directive> -->
7f3be7d885c75cdd77f536929a45bc9764595960Timo Sirainen><STRONG>Syntax:</STRONG></A> IndexOrderDefault
907723f35f4d3dfc774ca42d00a8a7b8ef90dd5dTimo Sirainen Ascending|Descending Name|Date|Size|Description
71a74e26cf070a205d31cf6c6fae003f90027b63Timo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
907723f35f4d3dfc774ca42d00a8a7b8ef90dd5dTimo Sirainen HREF="directive-dict.html#Compatibility"
907723f35f4d3dfc774ca42d00a8a7b8ef90dd5dTimo Sirainen><STRONG>Compatibility:</STRONG></A> IndexOrderDefault is only available in
907723f35f4d3dfc774ca42d00a8a7b8ef90dd5dTimo SirainenApache 1.3.4 and later.
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo SirainenThe <SAMP>IndexOrderDefault</SAMP> directive is used in combination with
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainenthe <A HREF="#indexoptions:fancyindexing"><SAMP>FancyIndexing</SAMP></A>
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenindex option. By default, fancyindexed directory listings are displayed
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenin ascending order by filename; the <SAMP>IndexOrderDefault</SAMP> allows
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainenyou to change this initial display order.
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<SAMP>IndexOrderDefault</SAMP> takes two arguments. The first must be either
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<SAMP>Ascending</SAMP> or <SAMP>Descending</SAMP>, indicating the direction
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainenof the sort. The second argument must be one of the keywords
02b79f9c2636da1829eee5b92753602bba8b67edTimo Sirainen<SAMP>Name</SAMP>, <SAMP>Date</SAMP>, <SAMP>Size</SAMP>, or
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen<SAMP>Description</SAMP>, and identifies the primary key. The secondary
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo SirainenYou can force a directory listing to only be displayed in a particular
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainenorder by combining this directive with the
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen><SAMP>SuppressColumnSorting</SAMP></A> index option; this will prevent
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainenthe client from requesting the directory listing in a different order.
b0349bc8041abfca33feba16a5fd72ef2238289dTimo Sirainen<H2><A NAME="readmename">ReadmeName</A> directive</H2>
b0349bc8041abfca33feba16a5fd72ef2238289dTimo Sirainen<!--%plaintext <?INDEX {\tt ReadmeName} directive> -->
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen><STRONG>Syntax:</STRONG></A> ReadmeName <EM>filename</EM><BR>
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen><STRONG>Context:</STRONG></A> server config, virtual host, directory,
268fe0fe3e748ae313e08b0918aa114815cf9d7cTimo Sirainen .htaccess<BR>
a393d9d6dabdc46cf724f8cb004a652b4036d53dTimo Sirainen HREF="directive-dict.html#Compatibility"
abe8230dd1dd37d7ccf0163100e934bb5e658c20Timo Sirainen ><STRONG>Compatibility:</STRONG></A> some features only available after
e68309fcfa2eaa88217fd51e7b4900fc9c20ef5dTimo Sirainen 1.3.6; see <A HREF="#headername">HeaderName</A>
f1901fd21906911f7be075c965ac882f6a87b4c3Timo SirainenThe ReadmeName directive sets the name of the file that will be appended
f1901fd21906911f7be075c965ac882f6a87b4c3Timo Sirainento the end of the index listing. <EM>Filename</EM> is the name of the file
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainento include, and is taken to be relative to the location being indexed.
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainen<P>See also <A HREF="#headername">HeaderName</A>, where this behavior is
dda2c506c8fc8ac2f88272de4523ded42baa0aa0Timo Sirainendescribed in greater detail.<P>
33ae95df45c9b5ec51332a6b39eb5322038686b9Timo Sirainen<!--#include virtual="footer.html" -->