mod_autoindex.html revision dff77f20d3ca0296e740d4369989e57949a06e92
280a8a0544b4aeb52414d20e8c6e6c5b1108562eTinderbox User<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
1f9754245cbd5eec2d2a667bb292f62f72386d4bMark Andrews<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews BGCOLOR="#FFFFFF"
1f9754245cbd5eec2d2a667bb292f62f72386d4bMark Andrews TEXT="#000000"
59663800d2ec04777dae2791dd92aa563faf94c8Evan Hunt LINK="#0000FF"
1ca2cf024391992fe14b2df7d3ae0f575d074452Evan Hunt VLINK="#000080"
0726d872f6f36901ea09321df57084614e5bb6faTinderbox User ALINK="#FF0000"
a2c370ca12bb0360ff7e969474ead3f788c65fffTinderbox User<!--#include virtual="header.html" -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThe module mod_autoindex generates directory indexes, automatically, similar to
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox Userthe Unix <em>ls</em> command or the Win32 <em>dir</em> shell command.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsAutomatic index generation must be enabled with by the <CODE>Options</CODE>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrewsdirective's <CODE><I>[+]</I>Indexes</CODE> option. See the
b91d11bfcc30b96f2c80f3a76d12e3dcc8597a68Mark Andrews<A HREF="core.html#options"><CODE>Options</CODE></a> directive for
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsmore details.
415d630b6309922caee8469384a6fab75cf05032Mark AndrewsHREF="module-dict.html#SourceFile"
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User><STRONG>Source File:</STRONG></A> mod_autoindex.c
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark AndrewsHREF="module-dict.html#ModuleIdentifier"
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User><STRONG>Module Identifier:</STRONG></A> autoindex_module
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark AndrewsThe index of a directory can come from one of two sources:
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox User<LI>A file written by the user, typically called <CODE>index.html</CODE>.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThe <A HREF="mod_dir.html#directoryindex">DirectoryIndex</A> directive sets
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Huntthe name of this file.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThis is controlled by <A HREF="mod_dir.html"><CODE>mod_dir</CODE></A>.
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt<LI>Otherwise, a listing generated by the server. The other directives
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewscontrol the format of this listing. The <A HREF="#addicon">AddIcon</A>,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<A HREF="#addiconbyencoding">AddIconByEncoding</A> and
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<A HREF="#addiconbytype">AddIconByType</A> are used to set a list of
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunticons to display for various file types; for each file listed, the
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsfirst icon listed that matches the file is displayed. These
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThe two functions are separated so that you can completely remove
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews(or replace) automatic index generation should you want to.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsAutomatic index generation is enabled with using
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater<A HREF="core.html#options"><CODE>Options</CODE></a> directive for
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrewsmore details.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark AndrewsIf the <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewsoption is given with the <A HREF="#indexoptions"><SAMP>IndexOptions</SAMP></A>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updaterdirective, the column headers are links that control the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewsorder of the display. If you select a header link, the
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrewslisting will be regenerated, sorted by the values in that
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox Usercolumn. Selecting the same header repeatedly toggles
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewsbetween ascending and descending order. These column header links are
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewssuppressed with <A HREF="#indexoptions">IndexOptions</A> directive's
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark AndrewsNote that when the display is sorted by "Size",
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox Userit's the <EM>actual</EM> size of the files that's used,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewsnot the displayed value - so a 1010-byte file will
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox Useralways be displayed before a 1011-byte file (if in ascending
3ccf87473f7cf6d9faac156df38a935a238f96fdTinderbox Userorder) even though they both are shown as "1K".
415d630b6309922caee8469384a6fab75cf05032Mark Andrews<LI><A HREF="#addaltbyencoding">AddAltByEncoding</A>
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User<LI><A HREF="#adddescription">AddDescription</A>
7cc0a5d21ef046bfd630c4769943d896a7d7472cTinderbox User<LI><A HREF="#addiconbyencoding">AddIconByEncoding</A>
3ccf87473f7cf6d9faac156df38a935a238f96fdTinderbox User<LI><A HREF="#addiconbytype">AddIconByType</A>
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User<LI><A HREF="#indexorderdefault">IndexOrderDefault</A>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<p>See also: <A HREF="core.html#options">Options</A> and <A
51aeb0ae19596e99b029cfa933e73b76ebec480aTinderbox UserHREF="mod_dir.html#directoryindex">DirectoryIndex</A>.</p>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<P>Apache 2.0.23 reorganized the Query Arguments for Column Sorting, and introduced
415d630b6309922caee8469384a6fab75cf05032Mark Andrewsan entire group of new query options. To effectively eliminate all client control
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafssonover the output, the <SAMP><A HREF="#indexoptions:ignoreclient">IndexOptions
415d630b6309922caee8469384a6fab75cf05032Mark AndrewsIgnoreClient</A></SAMP> option was introduced.</P>
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User<P>The column sorting headers themselves are self-referencing hyperlinks that add the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewssort query options shown below. Any option below may be added to any request for the
415d630b6309922caee8469384a6fab75cf05032Mark Andrewsdirectory resource.
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User<li><SAMP>C=N</SAMP> sorts the directory by file name
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<li><SAMP>C=M</SAMP> sorts the directory by last-modified date, then file name
415d630b6309922caee8469384a6fab75cf05032Mark Andrews<li><SAMP>C=S</SAMP> sorts the directory by size, then file name
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<li><SAMP>C=D</SAMP> sorts the directory by description, then file name<br />
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews<li><SAMP>O=A</SAMP> sorts the listing in Ascending Order
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User<li><SAMP>O=D</SAMP> sorts the listing in Descending Order<br />
415d630b6309922caee8469384a6fab75cf05032Mark Andrews<li><SAMP>F=0</SAMP> formats the listing as a simple list (not FancyIndexed)
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<li><SAMP>F=1</SAMP> formats the listing as a FancyIndexed list
415d630b6309922caee8469384a6fab75cf05032Mark Andrews<li><SAMP>F=2</SAMP> formats the listing as an HTMLTable FancyIndexed list<br />
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<li><SAMP>V=1</SAMP> enables version sorting<br />
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<li><SAMP>P=<EM>pattern</EM></SAMP> lists only files matching the given <EM>pattern</EM>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<P>Note that the 'P'attern query argument is tested <em>after</em> the usual IndexIgnore
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrewsdirectives are processed, and all file names are still subjected to the same criteria
fec6e13f2d1e69fe1c2b8fac36f732f124cf5398Mark Andrewsas any other autoindex listing. The Query Arguments parser in mod_autoindex will stop
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsabruptly when an unrecognized option is encountered. The Query Arguments must be well
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsformed, according to the table above.</P>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<P>The simple example below, which can be clipped and saved in a header.html file,
51aeb0ae19596e99b029cfa933e73b76ebec480aTinderbox Userillustrates these query options. Note that the unknown "X" argument, for the
baeaed18341c015e9ad54ffa21973184c1bc432bMark Andrewssubmit button, is listed last to assure the arguments are all parsed before
2a31bd531072824ef252c18303859d6af7451b00Francis Dupontmod_autoindex encounters the X=Go input.</P>
51aeb0ae19596e99b029cfa933e73b76ebec480aTinderbox User<pre><FORM METHOD="GET">
baeaed18341c015e9ad54ffa21973184c1bc432bMark Andrews Show me a <SELECT NAME="F">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <OPTION VALUE="0"> Plain list
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <OPTION VALUE="1" SELECTED> Fancy list
33b0d10552ea5f7716385b2cedff64daa1486c50Tinderbox User <OPTION VALUE="2"> Table list
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </SELECT>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews Sorted by <SELECT NAME="C">
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <OPTION VALUE="N" SELECTED> Name
33b0d10552ea5f7716385b2cedff64daa1486c50Tinderbox User <OPTION VALUE="M"> Date Modified
b378314925e78f21853a98cec924788ce1822c6cTinderbox User <OPTION VALUE="S"> Size
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <OPTION VALUE="D"> Description
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </SELECT>
2b7254075b883d70852a2757210793603085a0f1Tinderbox User <SELECT NAME="O">
66317da170ed35b08f5847db2d48b225826327cbTinderbox User <OPTION VALUE="A" SELECTED> Ascending
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <OPTION VALUE="D"> Descending
fec6e13f2d1e69fe1c2b8fac36f732f124cf5398Mark Andrews </SELECT>
b625bdae12277225b076a002dd4af80902529181Tinderbox User <SELECT NAME="V">
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <OPTION VALUE="0" SELECTED> in Normal order
01a5c5503482fb3ba52088bf0178a7213273bf96Mark Andrews <OPTION VALUE="1"> in Version order
2b7254075b883d70852a2757210793603085a0f1Tinderbox User </SELECT>
33b0d10552ea5f7716385b2cedff64daa1486c50Tinderbox User Matching <INPUT TYPE="text" NAME="P" VALUE="*">
415d630b6309922caee8469384a6fab75cf05032Mark Andrews <INPUT TYPE="submit" NAME="X" VALUE="Go">
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater<H2><A NAME="addalt">AddAlt</A> directive</H2>
415d630b6309922caee8469384a6fab75cf05032Mark Andrews<!--%plaintext <?INDEX {\tt AddAlt} directive> -->
415d630b6309922caee8469384a6fab75cf05032Mark Andrews><STRONG>Syntax:</STRONG></A> AddAlt <EM>string file</em>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
415d630b6309922caee8469384a6fab75cf05032Mark Andrews .htaccess<BR>
415d630b6309922caee8469384a6fab75cf05032Mark Andrews<EM>AddAlt</EM> provides the alternate text to display for a file, instead of an icon,
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrewsfor <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>. <EM>File</EM>
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox Useris a file extension, partial filename, wild-card expression or full filename for
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewsfiles to describe. <EM>String</EM> is enclosed in double quotes (<CODE>"</CODE>).
415d630b6309922caee8469384a6fab75cf05032Mark AndrewsThis alternate text is displayed if the client is image-incapable, has image loading
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updaterdisabled, or fails to retrieve the icon.
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User<H2><A NAME="addaltbyencoding">AddAltByEncoding</A> directive</H2>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<!--%plaintext <?INDEX {\tt AddAltByEncoding} directive> -->
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews><STRONG>Syntax:</STRONG></A> AddAltByEncoding <EM>string MIME-encoding</em>
415d630b6309922caee8469384a6fab75cf05032Mark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews .htaccess<BR>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<EM>AddAltByEncoding</EM> provides the alternate text to display for a file, instead
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox Userof an icon, for <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<EM>MIME-encoding</EM> is a valid content-encoding, such as <SAMP>x-compress</SAMP>.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<EM>String</EM> is enclosed in double quotes (<CODE>"</CODE>). This alternate
689fb19ba11ed40363cbc031d0396befdb409b89Tinderbox Usertext is displayed if the client is image-incapable, has image loading disabled, or
6c2a76b3e2ccd32c35814b6e0f54da00190749d7Evan Huntfails to retrieve the icon.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<H2><A NAME="addaltbytype">AddAltByType</A> directive</H2>
361967ea970ea8f0ef8875e769505ecdac74bfb0Tinderbox User<!--%plaintext <?INDEX {\tt AddAltByType} directive> -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><STRONG>Syntax:</STRONG></A> AddAltByType <EM>string MIME-type</em>
361967ea970ea8f0ef8875e769505ecdac74bfb0Tinderbox User><STRONG>Context:</STRONG></A> server config, virtual host, directory,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews .htaccess<BR>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<EM>AddAltByType</EM> sets the alternate text to display for a file, instead of
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsan icon, for <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<EM>MIME-type</EM> is a valid content-type, such as <SAMP>text/html</SAMP>.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<EM>String</EM> is enclosed in double quotes (<CODE>"</CODE>). This
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsalternate text is displayed if the client is image-incapable, has image loading
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsdisabled, or fails to retrieve the icon.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<H2><A NAME="adddescription">AddDescription</A> directive</H2>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<!--%plaintext <?INDEX {\tt AddDescription} directive> -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><STRONG>Syntax:</STRONG></A> AddDescription <EM>string file</em>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
e5c7ef08d1bf9f8388de8174a47da78b9eeb7e5cTinderbox User .htaccess<BR>
076e51f1ff9497ae61a99994189ed8bf5a0d3472Tinderbox User><STRONG>Module:</STRONG></A> mod_autoindex<P>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThis sets the description to display for a file, for
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
076e51f1ff9497ae61a99994189ed8bf5a0d3472Tinderbox User<EM>File</EM> is a file extension, partial filename, wild-card expression
5affecff6e148a8e124d03f5dbac0da11e30dcc5Tinderbox Useror full filename for files to describe. <EM>String</EM> is enclosed in double
a2c370ca12bb0360ff7e969474ead3f788c65fffTinderbox User<BLOCKQUOTE><CODE>AddDescription "The planet Mars" /web/pics/mars.gif
0eb371ca0dab50ae3462e98794a6126198c52f4bMark AndrewsThe typical, default description field is 23 bytes wide. 6 more bytes are
8ac5ddf659a81ed668579818981fc1a5f28405d1Tinderbox Useradded by the <CODE>IndexOptions SuppressIcon</CODE> option, 7 bytes are
076e51f1ff9497ae61a99994189ed8bf5a0d3472Tinderbox Useradded by the <CODE>IndexOptions SuppressSize</CODE> option, and 19 bytes
c4a35623959c143db02800584b8116d5b9cd72adTinderbox Userare added by the <CODE>IndexOptions SuppressLastModified</CODE> option.
6c2a76b3e2ccd32c35814b6e0f54da00190749d7Evan HuntTherefore, the widest default the description column is ever assigned is 55 bytes.
3ccf87473f7cf6d9faac156df38a935a238f96fdTinderbox UserSee the <a href="#indexoptions:descriptionwidth">DescriptionWidth</a>
3857cb6fcabeb79d85de4b3e3e4ab99912b701f8Mark Andrews<samp>IndexOptions</samp> keyword for details on overriding the size of this
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox Usercolumn, or allowing descriptions of unlimited length.
415d630b6309922caee8469384a6fab75cf05032Mark Andrews<b>Caution:</b> Descriptive text defined with <samp>AddDescription</samp>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafssonmay contain HTML markup, such as tags and character entities. If the
415d630b6309922caee8469384a6fab75cf05032Mark Andrewswidth of the description column should happen to truncate a tagged
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrewselement (such as cutting off the end of a bolded phrase), the results
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox Usermay affect the rest of the directory listing.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews</blockquote>
8292deab031e7599cd7622aa7675fbe139ca6095Mark Andrews<H2><A NAME="addicon">AddIcon</A> directive</H2>
c1e2310a3725eeed45e5e7c86750c64c5a02e993Francis Dupont<!--%plaintext <?INDEX {\tt AddIcon} directive> -->
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews><STRONG>Syntax:</STRONG></A> AddIcon <EM>icon name</em>
baeaed18341c015e9ad54ffa21973184c1bc432bMark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
baeaed18341c015e9ad54ffa21973184c1bc432bMark Andrews .htaccess<BR>
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox UserThis sets the icon to display next to a file ending in <EM>name</EM> for
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>. <EM>Icon</EM>
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrewsis either a (%-escaped) relative URL to the icon, or of the format
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater(<EM>alttext</EM>,<EM>url</EM>) where <EM>alttext</EM> is the text tag given
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrewsfor an icon for non-graphical browsers.<P>
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User<EM>Name</EM> is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ for
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewsblank lines (to format the list correctly), a file extension, a wildcard
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrewsexpression, a partial filename or a complete filename. Examples:
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark AndrewsAddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm <BR>
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews<A HREF="#addiconbytype">AddIconByType</A> should be used in preference to
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews<H2><A NAME="addiconbyencoding">AddIconByEncoding</A> directive</H2>
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User<!--%plaintext <?INDEX {\tt AddIconByEncoding} directive> -->
fec6e13f2d1e69fe1c2b8fac36f732f124cf5398Mark Andrews><STRONG>Syntax:</STRONG></A> AddIconByEncoding <EM>icon MIME-encoding</em>
ab833877278ad5535eef57e4f62291becaea5bc5Mark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
fec6e13f2d1e69fe1c2b8fac36f732f124cf5398Mark Andrews .htaccess<BR>
4840ef4581a577a29a18d180b6bc2e7355378ed7Mark AndrewsThis sets the icon to display next to files with
4840ef4581a577a29a18d180b6bc2e7355378ed7Mark Andrews<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
8927a982bde7e4b665966b55f0fa57c5cf21b9d8Mark Andrews<EM>Icon</EM> is either a (%-escaped) relative URL to the icon, or of the
4840ef4581a577a29a18d180b6bc2e7355378ed7Mark Andrewsformat (<EM>alttext</EM>,<EM>url</EM>) where <EM>alttext</EM> is the text tag
baeaed18341c015e9ad54ffa21973184c1bc432bMark Andrewsgiven for an icon for non-graphical browsers.<P>
bcfc5188be220e1334218dfe638dffce4744e792Tinderbox User<EM>Mime-encoding</EM> is a wildcard expression matching required the
ab833877278ad5535eef57e4f62291becaea5bc5Mark Andrewscontent-encoding. Examples:
baeaed18341c015e9ad54ffa21973184c1bc432bMark AndrewsAddIconByEncoding /icons/compress.xbm x-compress
ab833877278ad5535eef57e4f62291becaea5bc5Mark Andrews<H2><A NAME="addiconbytype">AddIconByType</A> directive</H2>
ab833877278ad5535eef57e4f62291becaea5bc5Mark Andrews<!--%plaintext <?INDEX {\tt AddIconByType} directive> -->
ab833877278ad5535eef57e4f62291becaea5bc5Mark Andrews><STRONG>Syntax:</STRONG></A> AddIconByType <EM>icon MIME-type</em>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
fab54780409846f7c71f6026d665f18c77c649efTinderbox User .htaccess<BR>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark AndrewsThis sets the icon to display next to files of type <EM>MIME-type</EM> for
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>. <EM>Icon</EM>
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrewsis either a (%-escaped) relative URL to the icon, or of the format
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews(<EM>alttext</EM>,<EM>url</EM>) where <EM>alttext</EM> is the text tag given
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox Userfor an icon for non-graphical browsers.<P>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<EM>Mime-type</EM> is a wildcard expression matching required the mime types.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian WellingtonAddIconByType (IMG,/icons/image.xbm) image/*
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<H2><A NAME="defaulticon">DefaultIcon</A> directive</H2>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!--%plaintext <?INDEX {\tt DefaultIcon} directive> -->
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews><STRONG>Syntax:</STRONG></A> DefaultIcon <EM>url</EM><BR>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews .htaccess<BR>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington><STRONG>Module:</STRONG></A> mod_autoindex<P>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian WellingtonThe DefaultIcon directive sets the icon to display for files when no
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonspecific icon is known, for
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<EM>Url</EM> is a (%-escaped) relative URL to the icon. Examples:
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<H2><A NAME="fancyindexing">FancyIndexing</A> directive</H2>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<!--%plaintext <?INDEX {\tt FancyIndexing} directive> -->
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington HREF="directive-dict.html#Deprecated"
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington><STRONG>Deprecated:</STRONG></A> See <A HREF="#indexoptions">IndexOptions</A>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP><BR>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian WellingtonThe FancyIndexing directive was replaced by the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<SAMP><A HREF="#indexoptions:fancyindexing">FancyIndexing</A></SAMP> option to the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<A HREF="#indexoptions">IndexOptions</A> directive, and is no longer supported
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonin Apache 2.0.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<H2><A NAME="headername">HeaderName</A> directive</H2>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<!--%plaintext <?INDEX {\tt HeaderName} directive> -->
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington><STRONG>Syntax:</STRONG></A> HeaderName <EM>filename</EM><BR>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington><STRONG>Context:</STRONG></A> server config, virtual host, directory,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington .htaccess<BR>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews HREF="directive-dict.html#Compatibility"
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews ><STRONG>Compatibility:</STRONG></A> behavior changed in version 1.3.7;
ae7e54b14c946e0984c191554db9abb4893f9349Automatic UpdaterThe HeaderName directive sets the name of the file that will be inserted
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updaterat the top of the index listing. <EM>Filename</EM> is the name of the file
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater<BLOCKQUOTE><STRONG>Changes with Apache 1.3.7:</STRONG>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic UpdaterBoth HeaderName and <A HREF="#readmename">ReadmeName</A> now treat <EM>Filename</EM>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsas a URI path relative to the one used to access the directory being indexed.
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater<EM>Filename</EM> must resolve to a document with a major content type of
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater"<SAMP>text/*</SAMP>" (<EM>e.g.</EM>, <SAMP>text/html</SAMP>, <SAMP>text/plain</SAMP>,
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater<EM>etc.</EM>). This means that <EM>filename</EM> may refer to a CGI script if the
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updaterscript's actual file type (as opposed to its output) is marked as
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater<SAMP>text/html</SAMP> such as with a directive like:
b30ec46fec40a1b246f7965fbcd341fc6cfd1cc1Mark Andrews<A HREF="/content-negotiation.html">Content negotiation</A>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox Userwill be performed if the <SAMP>MultiViews</SAMP>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User<A HREF="core.html#options">option</A> is enabled.
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox UserIf <EM>filename</EM> resolves to a static <SAMP>text/html</SAMP> document
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User(not a CGI script) and the
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User<SAMP>Includes</SAMP> <A HREF="core.html#options">option</A> is enabled,
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox Userthe file will be processed for server-side includes (see the
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User<A HREF="mod_include.html"><SAMP>mod_include</SAMP></A> documentation).
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox UserIf the file specified by <SAMP>HeaderName</SAMP> contains the
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsbeginnings of an HTML document (<HTML>, <HEAD>, etc) then
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox Useryou will probably want to set <A
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsHREF="#indexoptions:suppresshtmlpreamble"><SAMP>IndexOptions
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews+SuppressHTMLPreamble</SAMP></A>, so that these tags are not
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox UserSee also <A HREF="#readmename">ReadmeName</A>.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<H2><A NAME="indexignore">IndexIgnore</A> directive</H2>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<!--%plaintext <?INDEX {\tt IndexIgnore} directive> -->
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User><STRONG>Syntax:</STRONG></A> IndexIgnore <EM>file</em> [<em>file</em>] ...<BR>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews .htaccess<BR>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThe IndexIgnore directive adds to the list of files to hide when listing
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsa directory. <EM>File</EM> is a file extension, partial filename,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewswildcard expression or full filename for files to ignore. Multiple
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsIndexIgnore directives add to the list, rather than the replacing the list
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsof ignored files. By default, the list contains `<CODE>.</CODE>'. Example:
51aeb0ae19596e99b029cfa933e73b76ebec480aTinderbox UserIndexIgnore README .htaccess *~
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<H2><A NAME="indexoptions">IndexOptions</A> directive</H2>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<!--%plaintext <?INDEX {\tt IndexOptions} directive> -->
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington><STRONG>Syntax:</STRONG></A> IndexOptions [+|-]<em>option</em>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington [[+|-]<em>option</em>] ... (Apache 1.3.3 and later)
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington><STRONG>Context:</STRONG></A> server config, virtual host, directory,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington .htaccess<BR>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews HREF="directive-dict.html#Compatibility"
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><STRONG>Compatibility:</STRONG></A> '+/-' syntax and merging of multiple
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <SAMP>IndexOptions</SAMP> directives is only available with
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews Apache 1.3.3 and later; specific options are listed below.
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark AndrewsThe IndexOptions directive specifies the behavior of the directory indexing.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<dt><a name="indexoptions:descriptionwidth">DescriptionWidth=[<em>n</em> | *]
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews (<em>Apache 1.3.10 or 2.0.23 and later</em>)</a></dt>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<dd>The <samp>DescriptionWidth</samp> keyword allows you to specify the
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewswidth of the description column in characters.</dd>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<dd><samp>-DescriptionWidth</samp> (or unset) allows mod_autoindex to calculate
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrewsthe best width.</dd>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews<dd><samp>DescriptionWidth=n</samp> fixes the column width to n bytes wide.</dd>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<dd><samp>DescriptionWidth=*</samp> grows the column to the width necessary to
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonaccommodate the longest description string.</dd>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<dd><b>See the section on <a href="#adddescription"><samp>AddDescription</samp></a>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonfor dangers inherent in truncating descriptions.</b></dd>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<DT><A NAME="indexoptions:fancyindexing">FancyIndexing</A>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<DD><!--%plaintext <?INDEX {\tt FancyIndexing} index option> -->
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian WellingtonThis turns on fancy indexing of directories.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<dt><a name="indexoptions:foldersfirst">FoldersFirst
b7aab05edae933e169d5f83c653935b17c7f0a8bMark Andrews (<i>Apache 1.3.10 or 2.0.23 and later</i>)</a></dt>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian WellingtonIf this option is enabled, subdirectory listings
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonwill <i>always</i> appear first, followed by normal files in the
409ba95e573b40cf36acf97dd62ee7e9c7775851Tinderbox Userdirectory. The listing is basically broken into two components,
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrewsthe files and the subdirectories, and each is sorted separately and
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonthen displayed subdirectories-first. For instance, if the sort order
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonis descending by name, and <samp>FoldersFirst</samp> is enabled,
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrewssubdirectory <samp>Zed</samp> will be listed before subdirectory
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<samp>Beta</samp>, which will be listed before normal files
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<b>This option only has an effect if
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<a href="#indexoptions:fancyindexing"><samp>FancyIndexing</samp></a>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<DT><A NAME="indexoptions:htmltable">HTMLTable</A>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews<DD><!--%plaintext <?INDEX {\tt HTMLTable} index option> -->
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox UserThis experimental option with FancyIndexing constructs a simple table for the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewsfancy directory listing. Note this will confuse older browsers. It is particularly
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonnecessary if file names or description text will alternate between left-to-right
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonand right-to-left reading order, as can happen on WinNT or other utf-8
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonenabled platforms.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<DT><A NAME="indexoptions:iconsarelinks">IconsAreLinks</A>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<!--%plaintext <?INDEX {\tt IconsAreLinks} index option> -->
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian WellingtonThis makes the icons part of the anchor for the filename, for
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonfancy indexing.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<DT><A NAME="indexoptions:iconheight">IconHeight[=pixels] (<EM>Apache 1.3 and later</EM>)</A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!--%plaintext <?INDEX {\tt IconHeight} index option> -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsPresence of this option, when used with IconWidth, will cause the server
5835beb229e17d583fb4b6fd4246bd014a68ddf6Tinderbox Userto include <SAMP>HEIGHT</SAMP> and <SAMP>WIDTH</SAMP> attributes in the
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<SAMP>IMG</SAMP> tag for the file icon. This allows browser to
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsprecalculate the page layout without having to wait until all the
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsimages have been loaded. If no value is given for the option, it
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsdefaults to the standard height of the icons supplied with the Apache
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox User<DT><A NAME="indexoptions:iconwidth">IconWidth[=pixels] (<EM>Apache 1.3 and later</EM>)</A>
77997fab4b6b2d2c36ec66ace387447e8bc5c18eMark Andrews<!--%plaintext <?INDEX {\tt IconWidth} index option> -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsPresence of this option, when used with IconHeight, will cause the server
872e1437295dce8162ac7374317d593320ac2dd6Tinderbox Userto include <SAMP>HEIGHT</SAMP> and <SAMP>WIDTH</SAMP> attributes in the
872e1437295dce8162ac7374317d593320ac2dd6Tinderbox User<SAMP>IMG</SAMP> tag for the file icon. This allows browser to
872e1437295dce8162ac7374317d593320ac2dd6Tinderbox Userprecalculate the page layout without having to wait until all the
872e1437295dce8162ac7374317d593320ac2dd6Tinderbox Userimages have been loaded. If no value is given for the option, it
872e1437295dce8162ac7374317d593320ac2dd6Tinderbox Userdefaults to the standard width of the icons supplied with the Apache
872e1437295dce8162ac7374317d593320ac2dd6Tinderbox User<DT><A NAME="indexoptions:ignoreclient">IgnoreClient</A>
872e1437295dce8162ac7374317d593320ac2dd6Tinderbox User<!--%plaintext <?INDEX {\tt IgnoreClient} index option> -->
872e1437295dce8162ac7374317d593320ac2dd6Tinderbox UserThis option causes mod_autoindex to ignore all query variables from the
872e1437295dce8162ac7374317d593320ac2dd6Tinderbox Userclient, including sort order (implies <SAMP><A
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews HREF="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</A></SAMP>.)
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<DT><A NAME="indexoptions:namewidth">NameWidth=[<EM>n</EM> | *] (<EM>Apache 1.3.2 and later</EM>)</A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThe NameWidth keyword allows you to specify the width of the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonfilename column in bytes.
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews<dd><samp>-NameWidth</samp> (or unset) allows mod_autoindex to calculate
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonthe best width.</dd>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews<dd><samp>NameWidth=n</samp> fixes the column width to n bytes wide.</dd>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<dd><samp>NameWidth=*</samp> grows the column to the necessary width.</dd>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews<DT><A NAME="indexoptions:scanhtmltitles">ScanHTMLTitles</A>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews<DD><!--%plaintext <?INDEX {\tt ScanHTMLTitles} index option> -->
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark AndrewsThis enables the extraction of the title from HTML documents for fancy
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrewsindexing. If the file does not have a description given by
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews<A HREF="#adddescription">AddDescription</A> then httpd will read the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtondocument for the value of the TITLE tag. This is CPU and disk intensive.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<DT><A NAME="indexoptions:suppresscolumnsorting">SuppressColumnSorting</A>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<!--%plaintext <?INDEX {\tt SuppressColumnSorting} index option> -->
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian WellingtonIf specified, Apache will not make the column headings in a FancyIndexed
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtondirectory listing into links for sorting. The default behavior is
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonfor them to be links; selecting the column heading will sort the directory
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonlisting by the values in that column. <STRONG>Prior to Apache 2.0.23, this
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellingtonalso disabled parsing the Query Arguments for the sort string.</STRONG>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian WellingtonThat behavior is now controlled by <A HREF="#indexoptions:ignoreclient"
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington >IndexOptions IgnoreClient</A> in Apache 2.0.23.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<DT><A NAME="indexoptions:suppressdescription">SuppressDescription</A>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<!--%plaintext <?INDEX {\tt SuppressDescription} index option> -->
0eb371ca0dab50ae3462e98794a6126198c52f4bMark AndrewsThis will suppress the file description in fancy indexing listings.
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark AndrewsBy default, no file descriptions are defined, and so the use of this option
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox Userwill regain 23 characters of screen space to use for something else.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark AndrewsSee <A HREF="#adddescription"><samp>AddDescription</samp></A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsfor information about setting the file description. See also the
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsHREF="#indexoptions:descriptionwidth"><samp>DescriptionWidth</samp></A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsindex option to limit the size of the description column.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<DT><A NAME="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</A>
415d630b6309922caee8469384a6fab75cf05032Mark Andrews<!--%plaintext <?INDEX {\tt SuppressHTMLPreamble} index option> -->
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark AndrewsIf the directory actually contains a file specified by the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews HREF="#headername"
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews>HeaderName</A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsdirective, the module usually includes the contents of the file
2b7254075b883d70852a2757210793603085a0f1Tinderbox Userafter a standard HTML preamble (<HTML>, <HEAD>, <EM>et
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewscetera</EM>). The SuppressHTMLPreamble option disables this behaviour,
2b7254075b883d70852a2757210793603085a0f1Tinderbox Usercausing the module to start the display with the header file contents.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThe header file must contain appropriate HTML instructions in this case.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsIf there is no header file, the preamble is generated as usual.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<DT><A NAME="indexoptions:suppressicon">SuppressIcon</A>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews<!--%plaintext <?INDEX {\tt SuppressIcon} index option> -->
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox UserThis will suppress the icon in fancy indexing listings. Combining
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrewsboth <EM>SuppressIcon</EM> and <EM>SuppressRules</EM> yields proper
1fdd58445074579ee3b65c871137a7a1740eb542Mark AndrewsHTML 3.2 output, which by the final specification prohibits IMG and HR
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewstags from the PRE block (used to format FancyIndexed listings.)
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<DT><A NAME="indexoptions:suppresslastmodified">SuppressLastModified</A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!--%plaintext <?INDEX {\tt SuppressLastModified} index option> -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThis will suppress the display of the last modification date, in fancy
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsindexing listings.
620745a4c70077221fdeecaafd3252e9d3f944f3Tinderbox User<DT><A NAME="indexoptions:suppressrules">SuppressRules</A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!--%plaintext <?INDEX {\tt SuppressRules} index option> -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThis will suppress the horizontal rule lines (HR tags) in directory listings.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsCombining both <EM>SuppressIcon</EM> and <EM>SuppressRules</EM> yeilds proper
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsHTML 3.2 output, which by the final specification prohibits IMG and HR tags
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsfrom the PRE block (used to format FancyIndexed listings.)
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<DT><A NAME="indexoptions:suppresssize">SuppressSize</A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!--%plaintext <?INDEX {\tt SuppressSize} index option> -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThis will suppress the file size in fancy indexing listings.
dda78c0f84895c174ef7206dca6082939c030792Tinderbox User<DT><A NAME="indexoptions:trackmodified">TrackModified
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews(<EM>Apache 1.3.15 or 2.0.23 and later</EM>)</A>
ae454ec746d1d4db8d04e107d4d25ff13158c37fMark Andrews<!--%plaintext <?INDEX {\tt TrackModified} index option> -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThis returns the Last-Modified and ETag values for the listed directory
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsin the HTTP header. It is only valid if the operating system and file
34d1f3b65324f8fcf358fa2f47891441d4b1d2f0Tinderbox Usersystem return appropriate stat() results. Some Unix systems do so, as
dde130e859339194eebd7184eaf440981838a7f0Mark Andrewsdo OS2's JFS and Win32's NTFS volumes. OS2 and Win32 FAT volumes,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsfor example, do not. Once this feature is enabled, the client or proxy
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewscan track changes to the list of files when they perform a HEAD request.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsNote some operating systems correctly track new and removed files, but
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsdo not track changes for sizes or dates of the files within the directory.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<STRONG>Changes to the size or date stamp of an existing file will not
dde130e859339194eebd7184eaf440981838a7f0Mark Andrewsupdate the Last-Modified header on all Unix platforms.</STRONG> If this
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsis a concern, leave this option disabled.
9218b940febade3085fd6d95a15e67d5f94833f0Tinderbox User<DT><A NAME="indexoptions:versionsort">VersionSort (<EM>Apache 2.0a3 and later</EM>)</A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThe VersionSort keyword causes files containing version numbers to
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewssort in a natural way. Strings are sorted as usual, except that
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewssubstrings of digits in the name and description are compared
e8c17c74535be290abaaa160a434ed80bf0ad2feMark Andrewsaccording to their numeric value.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsIf the number starts with a zero, then it is considered to be a
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<DD>Apache 1.3.3 introduced some significant changes in the handling of
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<SAMP>IndexOptions</SAMP> directives. In particular,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <LI>Multiple <SAMP>IndexOptions</SAMP> directives for a single
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews directory are now merged together. The result of the example above
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews will now be the equivalent of
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <CODE>IndexOptions FancyIndexing ScanHTMLTitles</CODE>.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <LI>The addition of the incremental syntax (<EM>i.e.</EM>, prefixing
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews keywords with '+' or '-').
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsWhenever a '+' or '-' prefixed keyword is encountered, it is applied
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsto the current <SAMP>IndexOptions</SAMP> settings (which may have been
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsinherited from an upper-level directory). However, whenever an unprefixed
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewskeyword is processed, it clears all inherited options and any incremental
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewssettings encountered so far. Consider the following example:
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<BLOCKQUOTE><CODE>IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsIndexOptions +SuppressSize
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThe net effect is equivalent to
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<CODE>IndexOptions FancyIndexing +SuppressSize</CODE>, because
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsthe unprefixed <CODE>FancyIndexing</CODE> discarded the incremental
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewskeywords before it, but allowed them to start accumulating again
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsTo unconditionally set the <CODE>IndexOptions</CODE> for a
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsparticular directory, clearing the inherited settings, specify
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewskeywords without any '+' or '-' prefixes.
7f9e2fff07b9c17e0d7a0ea7abc9304ce9d01b61Tinderbox User<H2><A NAME="indexorderdefault">IndexOrderDefault</A> directive</H2>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!--%plaintext <?INDEX {\tt IndexOrderDefault} directive> -->
bf8c3776f1bf1a1270e5e0443ae5a8df022632a8Mark Andrews Ascending|Descending Name|Date|Size|Description
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews HREF="directive-dict.html#Compatibility"
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><STRONG>Compatibility:</STRONG></A> IndexOrderDefault is only available in
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsApache 1.3.4 and later.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsThe <SAMP>IndexOrderDefault</SAMP> directive is used in combination with
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsthe <A HREF="#indexoptions:fancyindexing"><SAMP>FancyIndexing</SAMP></A>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsindex option. By default, fancyindexed directory listings are displayed
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsin ascending order by filename; the <SAMP>IndexOrderDefault</SAMP> allows
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsyou to change this initial display order.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<SAMP>IndexOrderDefault</SAMP> takes two arguments. The first must be either
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<SAMP>Ascending</SAMP> or <SAMP>Descending</SAMP>, indicating the direction
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsof the sort. The second argument must be one of the keywords
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<SAMP>Name</SAMP>, <SAMP>Date</SAMP>, <SAMP>Size</SAMP>, or
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<SAMP>Description</SAMP>, and identifies the primary key. The secondary
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsYou can force a directory listing to only be displayed in a particular
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrewsorder by combining this directive with the
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><SAMP>SuppressColumnSorting</SAMP></A> index option; this will prevent
73537e8418e0c030063dbd863cf57feec026030aTinderbox Userthe client from requesting the directory listing in a different order.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<H2><A NAME="readmename">ReadmeName</A> directive</H2>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!--%plaintext <?INDEX {\tt ReadmeName} directive> -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><STRONG>Syntax:</STRONG></A> ReadmeName <EM>filename</EM><BR>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews><STRONG>Context:</STRONG></A> server config, virtual host, directory,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews .htaccess<BR>
d786bb0f8beee4425dc5ba21ea19f8f353c85a65Evan Hunt HREF="directive-dict.html#Compatibility"
d786bb0f8beee4425dc5ba21ea19f8f353c85a65Evan Hunt ><STRONG>Compatibility:</STRONG></A> some features only available after
d786bb0f8beee4425dc5ba21ea19f8f353c85a65Evan HuntThe ReadmeName directive sets the name of the file that will be appended
d786bb0f8beee4425dc5ba21ea19f8f353c85a65Evan Huntto the end of the index listing. <EM>Filename</EM> is the name of the file
d786bb0f8beee4425dc5ba21ea19f8f353c85a65Evan Huntto include, and is taken to be relative to the location being indexed.
d786bb0f8beee4425dc5ba21ea19f8f353c85a65Evan Hunt<P>See also <A HREF="#headername">HeaderName</A>, where this behavior is
d786bb0f8beee4425dc5ba21ea19f8f353c85a65Evan Huntdescribed in greater detail.<P>
d786bb0f8beee4425dc5ba21ea19f8f353c85a65Evan Hunt<!--#include virtual="footer.html" -->