granicus.if.org Git - apache/blob - docs/manual/mod/mod_autoindex.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_autoindex - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.1</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_autoindex</h1>
  23 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Generates directory indexes,
  24     automatically, similar to the Unix <code>ls</code> command or the
  25     Win32 <code>dir</code> shell command</td></tr>
  26 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  27 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>autoindex_module</td></tr>
  28 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_autoindex.c</td></tr></table>
  29 <h3>Summary</h3>
  30
  31       <p>The index of a directory can come from one of two
  32       sources:</p>
  33
  34     <ul>
  35       <li>A file written by the user, typically called
  36       <code>index.html</code>. The <code class="directive"><a href="../mod/mod_dir.html#directoryindex">DirectoryIndex</a></code> directive sets the
  37       name of this file. This is controlled by
  38       <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code>.</li>
  39
  40       <li>Otherwise, a listing generated by the server. The other
  41       directives control the format of this listing. The <code class="directive"><a href="#addicon">AddIcon</a></code>, <code class="directive"><a href="#addiconbyencoding">AddIconByEncoding</a></code> and
  42       <code class="directive"><a href="#addiconbytype">AddIconByType</a></code> are
  43       used to set a list of icons to display for various file types;
  44       for each file listed, the first icon listed that matches the
  45       file is displayed. These are controlled by
  46       <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code>.</li>
  47     </ul>
  48     <p>The two functions are separated so that you can completely
  49     remove (or replace) automatic index generation should you want
  50     to.</p>
  51
  52     <p>Automatic index generation is enabled with using
  53     <code>Options +Indexes</code>. See the
  54     <code class="directive"><a href="../mod/core.html#options">Options</a></code> directive for
  55     more details.</p>
  56
  57     <p>If the <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code> option is given with the <code class="directive"><a href="#indexoptions">IndexOptions</a></code> directive,
  58     the column headers are links that control the order of the
  59     display. If you select a header link, the listing will be
  60     regenerated, sorted by the values in that column. Selecting the
  61     same header repeatedly toggles between ascending and descending
  62     order. These column header links are suppressed with
  63     <code class="directive"><a href="#indexoptions">IndexOptions</a></code> directive's
  64     <code>SuppressColumnSorting</code> option.</p>
  65
  66     <p>Note that when the display is sorted by "Size", it's the
  67     <em>actual</em> size of the files that's used, not the
  68     displayed value - so a 1010-byte file will always be displayed
  69     before a 1011-byte file (if in ascending order) even though
  70     they both are shown as "1K".</p>
  71 </div>
  72 <div id="quickview"><h3 class="directives">Directives</h3>
  73 <ul id="toc">
  74 <li><img alt="" src="../images/down.gif" /> <a href="#addalt">AddAlt</a></li>
  75 <li><img alt="" src="../images/down.gif" /> <a href="#addaltbyencoding">AddAltByEncoding</a></li>
  76 <li><img alt="" src="../images/down.gif" /> <a href="#addaltbytype">AddAltByType</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#adddescription">AddDescription</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#addicon">AddIcon</a></li>
  79 <li><img alt="" src="../images/down.gif" /> <a href="#addiconbyencoding">AddIconByEncoding</a></li>
  80 <li><img alt="" src="../images/down.gif" /> <a href="#addiconbytype">AddIconByType</a></li>
  81 <li><img alt="" src="../images/down.gif" /> <a href="#defaulticon">DefaultIcon</a></li>
  82 <li><img alt="" src="../images/down.gif" /> <a href="#headername">HeaderName</a></li>
  83 <li><img alt="" src="../images/down.gif" /> <a href="#indexignore">IndexIgnore</a></li>
  84 <li><img alt="" src="../images/down.gif" /> <a href="#indexoptions">IndexOptions</a></li>
  85 <li><img alt="" src="../images/down.gif" /> <a href="#indexorderdefault">IndexOrderDefault</a></li>
  86 <li><img alt="" src="../images/down.gif" /> <a href="#readmename">ReadmeName</a></li>
  87 </ul>
  88 <h3>Topics</h3>
  89 <ul id="topics">
  90 <li><img alt="" src="../images/down.gif" /> <a href="#query">Autoindex Request Query Arguments</a></li>
  91 </ul></div>
  92 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  93 <div class="section">
  94 <h2><a name="query" id="query">Autoindex Request Query Arguments</a></h2>
  95
  96
  97     <p>Apache 2.0.23 reorganized the Query Arguments for Column
  98     Sorting, and introduced an entire group of new query options.
  99     To effectively eliminate all client control over the output,
 100     the <code><a href="#indexoptions:ignoreclient">IndexOptions
 101     IgnoreClient</a></code> option was introduced.</p>
 102
 103     <p>The column sorting headers themselves are self-referencing
 104     hyperlinks that add the sort query options shown below. Any
 105     option below may be added to any request for the directory
 106     resource.</p>
 107
 108     <ul>
 109       <li><code>C=N</code> sorts the directory by file name</li>
 110
 111       <li><code>C=M</code> sorts the directory by last-modified
 112       date, then file name</li>
 113
 114       <li><code>C=S</code> sorts the directory by size, then file
 115       name</li>
 116
 117       <li class="separate"><code>C=D</code> sorts the directory by description, then
 118       file name</li>
 119
 120       <li><code>O=A</code> sorts the listing in Ascending
 121       Order</li>
 122
 123       <li class="separate"><code>O=D</code> sorts the listing in Descending
 124       Order</li>
 125
 126       <li><code>F=0</code> formats the listing as a simple list
 127       (not FancyIndexed)</li>
 128
 129       <li><code>F=1</code> formats the listing as a FancyIndexed
 130       list</li>
 131
 132       <li class="separate"><code>F=2</code> formats the listing as an
 133       HTMLTable FancyIndexed list</li>
 134
 135       <li><code>V=0</code> disables version sorting</li>
 136
 137       <li class="separate"><code>V=1</code> enables version sorting</li>
 138
 139       <li><code>P=<var>pattern</var></code> lists only files matching
 140       the given <var>pattern</var></li>
 141     </ul>
 142
 143     <p>Note that the 'P'attern query argument is tested
 144     <em>after</em> the usual <code class="directive"><a href="#indexignore">IndexIgnore</a></code> directives are processed,
 145     and all file names are still subjected to the same criteria as
 146     any other autoindex listing. The Query Arguments parser in
 147     <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> will stop abruptly when an unrecognized
 148     option is encountered. The Query Arguments must be well formed,
 149     according to the table above.</p>
 150
 151     <p>The simple example below, which can be clipped and saved in
 152     a header.html file, illustrates these query options. Note that
 153     the unknown "X" argument, for the submit button, is listed last
 154     to assure the arguments are all parsed before mod_autoindex
 155     encounters the X=Go input.</p>
 156
 157     <div class="example"><p><code>
 158       &lt;form action="" method="get"&gt;<br />
 159       <span class="indent">
 160         Show me a &lt;select name="F"&gt;<br />
 161         <span class="indent">
 162           &lt;option value="0"&gt; Plain list&lt;/option&gt;<br />
 163           &lt;option value="1" selected="selected"&gt; Fancy list&lt;/option&gt;<br />
 164           &lt;option value="2"&gt; Table list&lt;/option&gt;<br />
 165         </span>
 166         &lt;/select&gt;<br />
 167         Sorted by &lt;select name="C"&gt;<br />
 168         <span class="indent">
 169           &lt;option value="N" selected="selected"&gt; Name&lt;/option&gt;<br />
 170           &lt;option value="M"&gt; Date Modified&lt;/option&gt;<br />
 171           &lt;option value="S"&gt; Size&lt;/option&gt;<br />
 172           &lt;option value="D"&gt; Description&lt;/option&gt;<br />
 173         </span>
 174         &lt;/select&gt;<br />
 175         &lt;select name="O"&gt;<br />
 176         <span class="indent">
 177           &lt;option value="A" selected="selected"&gt; Ascending&lt;/option&gt;<br />
 178           &lt;option value="D"&gt; Descending&lt;/option&gt;<br />
 179         </span>
 180         &lt;/select&gt;<br />
 181         &lt;select name="V"&gt;<br />
 182         <span class="indent">
 183           &lt;option value="0" selected="selected"&gt; in Normal order&lt;/option&gt;<br />
 184           &lt;option value="1"&gt; in Version order&lt;/option&gt;<br />
 185         </span>
 186         &lt;/select&gt;<br />
 187         Matching &lt;input type="text" name="P" value="*" /&gt;<br />
 188         &lt;input type="submit" name="X" value="Go" /&gt;<br />
 189       </span>
 190       &lt;/form&gt;
 191     </code></p></div>
 192
 193 </div>
 194 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 195 <div class="directive-section"><h2><a name="AddAlt" id="AddAlt">AddAlt</a> <a name="addalt" id="addalt">Directive</a></h2>
 196 <table class="directive">
 197 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Alternate text to display for a file, instead of an
 198 icon selected by filename</td></tr>
 199 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddAlt <var>string</var> <var>file</var> [<var>file</var>] ...</code></td></tr>
 200 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 201 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 202 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 203 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 204 </table>
 205     <p><code class="directive">AddAlt</code> provides the alternate text to
 206     display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
 207     <var>File</var> is a file extension, partial filename, wild-card
 208     expression or full filename for files to describe.
 209     If <var>String</var> contains any whitespace, you have to enclose it
 210     in quotes (<code>"</code> or <code>'</code>). This alternate text
 211     is displayed if the client is image-incapable, has image loading
 212     disabled, or fails to retrieve the icon.</p>
 213
 214     <div class="example"><h3>Examples</h3><p><code>
 215       AddAlt "PDF file" *.pdf<br />
 216       AddAlt Compressed *.gz *.zip *.Z
 217     </code></p></div>
 218
 219 </div>
 220 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 221 <div class="directive-section"><h2><a name="AddAltByEncoding" id="AddAltByEncoding">AddAltByEncoding</a> <a name="addaltbyencoding" id="addaltbyencoding">Directive</a></h2>
 222 <table class="directive">
 223 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Alternate text to display for a file instead of an icon
 224 selected by MIME-encoding</td></tr>
 225 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddAltByEncoding <var>string</var> <var>MIME-encoding</var>
 226 [<var>MIME-encoding</var>] ...</code></td></tr>
 227 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 228 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 229 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 230 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 231 </table>
 232     <p><code class="directive">AddAltByEncoding</code> provides the alternate
 233     text to display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
 234     <var>MIME-encoding</var> is a valid content-encoding, such as
 235     <code>x-compress</code>. If <var>String</var> contains any whitespace,
 236     you have to enclose it in quotes (<code>"</code> or <code>'</code>).
 237     This alternate text is displayed if the client is image-incapable,
 238     has image loading disabled, or fails to retrieve the icon.</p>
 239
 240     <div class="example"><h3>Example</h3><p><code>
 241       AddAltByEncoding gzip x-gzip
 242     </code></p></div>
 243
 244 </div>
 245 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 246 <div class="directive-section"><h2><a name="AddAltByType" id="AddAltByType">AddAltByType</a> <a name="addaltbytype" id="addaltbytype">Directive</a></h2>
 247 <table class="directive">
 248 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Alternate text to display for a file, instead of an
 249 icon selected by MIME content-type</td></tr>
 250 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddAltByType <var>string</var> <var>MIME-type</var>
 251 [<var>MIME-type</var>] ...</code></td></tr>
 252 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 253 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 254 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 255 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 256 </table>
 257     <p><code class="directive">AddAltByType</code> sets the alternate text to
 258     display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
 259     <var>MIME-type</var> is a valid content-type, such as
 260     <code>text/html</code>. If <var>String</var> contains any whitespace,
 261     you have to enclose it in quotes (<code>"</code> or <code>'</code>).
 262     This alternate text is displayed if the client is image-incapable,
 263     has image loading disabled, or fails to retrieve the icon.</p>
 264
 265     <div class="example"><h3>Example</h3><p><code>
 266       AddAltByType 'plain text' text/plain
 267     </code></p></div>
 268
 269 </div>
 270 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 271 <div class="directive-section"><h2><a name="AddDescription" id="AddDescription">AddDescription</a> <a name="adddescription" id="adddescription">Directive</a></h2>
 272 <table class="directive">
 273 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Description to display for a file</td></tr>
 274 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddDescription <var>string file</var> [<var>file</var>] ...</code></td></tr>
 275 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 276 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 277 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 278 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 279 </table>
 280     <p>This sets the description to display for a file, for
 281     <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
 282     <var>File</var> is a file extension, partial filename, wild-card
 283     expression or full filename for files to describe.
 284     <var>String</var> is enclosed in double quotes (<code>"</code>).</p>
 285
 286     <div class="example"><h3>Example</h3><p><code>
 287       AddDescription "The planet Mars" /web/pics/mars.gif
 288     </code></p></div>
 289
 290     <p>The typical, default description field is 23 bytes wide. 6
 291     more bytes are added by the <code><a href="#indexoptions:suppressicon">IndexOptions SuppressIcon</a></code> option, 7 bytes are
 292     added by the <code><a href="#indexoptions:suppresssize">IndexOptions SuppressSize</a></code> option, and 19 bytes are
 293     added by the <code><a href="#indexoptions:suppresslastmodified">IndexOptions SuppressLastModified</a></code> option.
 294     Therefore, the widest default the description column is ever
 295     assigned is 55 bytes.</p>
 296
 297     <p>See the <a href="#indexoptions:descriptionwidth">DescriptionWidth</a> <code class="directive"><a href="#indexoptions">IndexOptions</a></code> keyword for details on overriding the size
 298     of this column, or allowing descriptions of unlimited length.</p>
 299
 300     <div class="note"><h3>Caution</h3>
 301       <p>Descriptive text defined with <code class="directive">AddDescription</code>
 302       may contain HTML markup, such as tags and character entities. If the
 303       width of the description column should happen to truncate a tagged
 304       element (such as cutting off the end of a bolded phrase), the
 305       results may affect the rest of the directory listing.</p>
 306     </div>
 307
 308 </div>
 309 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 310 <div class="directive-section"><h2><a name="AddIcon" id="AddIcon">AddIcon</a> <a name="addicon" id="addicon">Directive</a></h2>
 311 <table class="directive">
 312 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Icon to display for a file selected by name</td></tr>
 313 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddIcon <var>icon</var> <var>name</var> [<var>name</var>]
 314 ...</code></td></tr>
 315 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 316 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 317 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 318 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 319 </table>
 320     <p>This sets the icon to display next to a file ending in
 321     <var>name</var> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>. <var>Icon</var> is either a (%-escaped)
 322     relative URL to the icon, or of the format <code>
 323     (<var>alttext</var>,<var>url</var>)</code> where <var>alttext</var>
 324     is the text tag given for an icon for non-graphical browsers.</p>
 325
 326     <p><var>Name</var> is either <code>^^DIRECTORY^^</code> for directories,
 327     <code>^^BLANKICON^^</code> for blank lines (to format the list
 328     correctly), a file extension, a wildcard expression, a partial
 329     filename or a complete filename.</p>
 330
 331     <div class="example"><h3>Examples</h3><p><code>
 332       AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm<br />
 333       AddIcon /icons/dir.xbm ^^DIRECTORY^^<br />
 334       AddIcon /icons/backup.xbm *~
 335     </code></p></div>
 336
 337     <p><code class="directive"><a href="#addiconbytype">AddIconByType</a></code>
 338     should be used in preference to <code class="directive">AddIcon</code>,
 339     when possible.</p>
 340
 341 </div>
 342 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 343 <div class="directive-section"><h2><a name="AddIconByEncoding" id="AddIconByEncoding">AddIconByEncoding</a> <a name="addiconbyencoding" id="addiconbyencoding">Directive</a></h2>
 344 <table class="directive">
 345 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Icon to display next to files selected by MIME
 346 content-encoding</td></tr>
 347 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddIconByEncoding <var>icon</var> <var>MIME-encoding</var>
 348 [<var>MIME-encoding</var>] ...</code></td></tr>
 349 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 350 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 351 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 352 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 353 </table>
 354     <p>This sets the icon to display next to files with <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
 355     <var>Icon</var> is either a (%-escaped) relative URL to the icon,
 356     or of the format <code>(<var>alttext</var>,<var>url</var>)</code>
 357     where <var>alttext</var> is the text tag given for an icon for
 358     non-graphical browsers.</p>
 359
 360     <p><var>MIME-encoding</var> is a wildcard expression matching
 361     required the content-encoding.</p>
 362
 363     <div class="example"><h3>Example</h3><p><code>
 364       AddIconByEncoding /icons/compress.xbm x-compress
 365     </code></p></div>
 366
 367 </div>
 368 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 369 <div class="directive-section"><h2><a name="AddIconByType" id="AddIconByType">AddIconByType</a> <a name="addiconbytype" id="addiconbytype">Directive</a></h2>
 370 <table class="directive">
 371 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Icon to display next to files selected by MIME
 372 content-type</td></tr>
 373 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AddIconByType <var>icon</var> <var>MIME-type</var>
 374 [<var>MIME-type</var>] ...</code></td></tr>
 375 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 376 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 377 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 378 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 379 </table>
 380     <p>This sets the icon to display next to files of type
 381     <var>MIME-type</var> for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
 382     <var>Icon</var> is either a (%-escaped) relative URL to the icon,
 383     or of the format <code>(<var>alttext</var>,<var>url</var>)</code>
 384     where <var>alttext</var> is the text tag given for an icon for
 385     non-graphical browsers.</p>
 386
 387     <p><var>MIME-type</var> is a wildcard expression matching
 388     required the mime types.</p>
 389
 390     <div class="example"><h3>Example</h3><p><code>
 391       AddIconByType (IMG,/icons/image.xbm) image/*
 392     </code></p></div>
 393
 394 </div>
 395 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 396 <div class="directive-section"><h2><a name="DefaultIcon" id="DefaultIcon">DefaultIcon</a> <a name="defaulticon" id="defaulticon">Directive</a></h2>
 397 <table class="directive">
 398 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Icon to display for files when no specific icon is
 399 configured</td></tr>
 400 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DefaultIcon <var>url-path</var></code></td></tr>
 401 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 402 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 403 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 404 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 405 </table>
 406     <p>The <code class="directive">DefaultIcon</code> directive sets the icon
 407     to display for files when no specific icon is known, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
 408     <var>Url-path</var> is a (%-escaped) relative URL to the icon.</p>
 409
 410     <div class="example"><h3>Example</h3><p><code>
 411       DefaultIcon /icon/unknown.xbm
 412     </code></p></div>
 413
 414 </div>
 415 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 416 <div class="directive-section"><h2><a name="HeaderName" id="HeaderName">HeaderName</a> <a name="headername" id="headername">Directive</a></h2>
 417 <table class="directive">
 418 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the file that will be inserted at the top
 419 of the index listing</td></tr>
 420 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>HeaderName <var>filename</var></code></td></tr>
 421 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 422 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 423 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 424 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 425 </table>
 426     <p>The <code class="directive">HeaderName</code> directive sets the name
 427     of the file that will be inserted at the top of the index
 428     listing. <var>Filename</var> is the name of the file to include.</p>
 429
 430     <div class="example"><h3>Example</h3><p><code>
 431       HeaderName HEADER.html
 432     </code></p></div>
 433
 434     <div class="note">
 435       <p>Both HeaderName and <code class="directive"><a href="#readmename">ReadmeName</a></code> now treat
 436       <var>Filename</var> as a URI path relative to the one used to
 437       access the directory being indexed. If <var>Filename</var> begins
 438       with a slash, it will be taken to be relative to the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>.</p>
 439
 440       <div class="example"><h3>Example</h3><p><code>
 441         HeaderName /include/HEADER.html
 442       </code></p></div>
 443
 444       <p><var>Filename</var> must resolve to a document with a major
 445       content type of <code>text/*</code> (<em>e.g.</em>,
 446       <code>text/html</code>, <code>text/plain</code>, etc.). This means
 447       that <var>filename</var> may refer to a CGI script if the script's
 448       actual file type (as opposed to its output) is marked as
 449       <code>text/html</code> such as with a directive like:</p>
 450
 451       <div class="example"><p><code>
 452         AddType text/html .cgi
 453       </code></p></div>
 454
 455       <p><a href="../content-negotiation.html">Content negotiation</a>
 456       will be performed if <code class="directive"><a href="../mod/core.html#options">Options</a></code>
 457       <code>MultiViews</code> is in effect. If <var>filename</var> resolves
 458       to a static <code>text/html</code> document (not a CGI script) and
 459       either one of the <code class="directive"><a href="../mod/core.html#options">options</a></code>
 460       <code>Includes</code> or <code>IncludesNOEXEC</code> is enabled,
 461       the file will be processed for server-side includes (see the
 462       <code class="module"><a href="../mod/mod_include.html">mod_include</a></code> documentation).</p>
 463     </div>
 464
 465     <p>If the file specified by <code class="directive">HeaderName</code> contains
 466     the beginnings of an HTML document (&lt;html&gt;, &lt;head&gt;, etc.)
 467     then you will probably want to set <a href="#indexoptions:suppresshtmlpreamble"><code>IndexOptions
 468     +SuppressHTMLPreamble</code></a>, so that these tags are not
 469     repeated.</p>
 470
 471 </div>
 472 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 473 <div class="directive-section"><h2><a name="IndexIgnore" id="IndexIgnore">IndexIgnore</a> <a name="indexignore" id="indexignore">Directive</a></h2>
 474 <table class="directive">
 475 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds to the list of files to hide when listing
 476 a directory</td></tr>
 477 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>IndexIgnore <var>file</var> [<var>file</var>] ...</code></td></tr>
 478 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 479 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 480 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 481 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 482 </table>
 483     <p>The <code class="directive">IndexIgnore</code> directive adds to the
 484     list of files to hide when listing a directory. <var>File</var> is a
 485     file extension, partial filename, wildcard expression or full
 486     filename for files to ignore. Multiple IndexIgnore directives add
 487     to the list, rather than the replacing the list of ignored
 488     files. By default, the list contains <code>.</code> (the current
 489     directory).</p>
 490
 491     <div class="example"><p><code>
 492       IndexIgnore README .htaccess *~
 493     </code></p></div>
 494
 495 </div>
 496 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 497 <div class="directive-section"><h2><a name="IndexOptions" id="IndexOptions">IndexOptions</a> <a name="indexoptions" id="indexoptions">Directive</a></h2>
 498 <table class="directive">
 499 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Various configuration settings for directory
 500 indexing</td></tr>
 501 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>IndexOptions  [+|-]<var>option</var> [[+|-]<var>option</var>]
 502 ...</code></td></tr>
 503 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 504 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 505 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 506 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 507 </table>
 508     <p>The <code class="directive">IndexOptions</code> directive specifies the
 509     behavior of the directory indexing. <var>Option</var> can be one
 510     of</p>
 511
 512     <dl>
 513       <dt><a name="indexoptions:descriptionwidth" id="indexoptions:descriptionwidth">DescriptionWidth=[<var>n</var> | *]</a> (<em>Apache 2.0.23 and
 514       later</em>)</dt>
 515
 516       <dd>The <code>DescriptionWidth</code> keyword allows you to
 517       specify the width of the description column in
 518       characters.</dd>
 519
 520       <dd><code>-DescriptionWidth</code> (or unset) allows
 521       <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> to calculate the best width.</dd>
 522
 523       <dd><code>DescriptionWidth=<var>n</var></code> fixes the column width to
 524       <var>n</var> bytes wide.</dd>
 525
 526       <dd><code>DescriptionWidth=*</code> grows the column to the
 527       width necessary to accommodate the longest description
 528       string.</dd>
 529
 530       <dd><strong>See the section on <code class="directive"><a href="#adddescription">AddDescription</a></code> for dangers
 531       inherent in truncating descriptions.</strong></dd>
 532
 533       <dt><a name="indexoptions:fancyindexing" id="indexoptions:fancyindexing">FancyIndexing</a></dt>
 534
 535       <dd>This turns on fancy indexing of directories.</dd>
 536
 537       <dt><a name="indexoptions:foldersfirst" id="indexoptions:foldersfirst">FoldersFirst</a> (<em>Apache
 538       2.0.23 and later</em>)</dt>
 539
 540       <dd>If this option is enabled, subdirectory listings will
 541       <em>always</em> appear first, followed by normal files in the
 542       directory. The listing is basically broken into two
 543       components, the files and the subdirectories, and each is
 544       sorted separately and then displayed subdirectories-first.
 545       For instance, if the sort order is descending by name, and
 546       <code>FoldersFirst</code> is enabled, subdirectory
 547       <code>Zed</code> will be listed before subdirectory
 548       <code>Beta</code>, which will be listed before normal files
 549       <code>Gamma</code> and <code>Alpha</code>. <strong>This option
 550       only has an effect if <a href="#indexoptions:fancyindexing"><code>FancyIndexing</code></a> is also enabled.</strong></dd>
 551
 552       <dt><a name="indexoptions:htmltable" id="indexoptions:htmltable">HTMLTable</a> (<em>Experimental,
 553       Apache 2.0.23 and later</em>)</dt>
 554
 555       <dd>This experimental option with FancyIndexing constructs a
 556       simple table for the fancy directory listing. Note this will
 557       confuse older browsers. It is particularly necessary if file
 558       names or description text will alternate between
 559       left-to-right and right-to-left reading order, as can happen
 560       on WinNT or other utf-8 enabled platforms.</dd>
 561
 562       <dt><a name="indexoptions:iconsarelinks" id="indexoptions:iconsarelinks">IconsAreLinks</a></dt>
 563
 564       <dd>This makes the icons part of the anchor for the filename, for
 565       fancy indexing.</dd>
 566
 567       <dt><a name="indexoptions:iconheight" id="indexoptions:iconheight">IconHeight[=<var>pixels</var>]</a></dt>
 568
 569       <dd>Presence of this option, when used with IconWidth, will cause
 570       the server to include <code>height</code> and <code>width</code>
 571       attributes in the <code>img</code> tag for the file icon. This allows
 572       browser to precalculate the page layout without having to wait until
 573       all the images have been loaded. If no value is given for the option,
 574       it defaults to the standard height of the icons supplied with the Apache
 575       software.</dd>
 576
 577       <dt><a name="indexoptions:iconwidth" id="indexoptions:iconwidth">IconWidth[=<var>pixels</var>]</a></dt>
 578
 579       <dd>Presence of this option, when used with <code>IconHeight</code>,
 580       will cause the server to include <code>height</code> and
 581       <code>width</code> attributes in the <code>img</code> tag for
 582       the file icon. This allows browser to precalculate the page
 583       layout without having to wait until all the images have been
 584       loaded. If no value is given for the option, it defaults to
 585       the standard width of the icons supplied with the Apache
 586       software.</dd>
 587
 588       <dt><a name="indexoptions:ignorecase" id="indexoptions:ignorecase">IgnoreCase</a></dt>
 589
 590       <dd>If this option is enabled, names are sorted in a case-insensitive
 591       manner.  For instance, if the sort order is ascending by name, and
 592       IgnoreCase is enabled, file Zeta  will be listed after file alfa
 593       (Note: file GAMMA will always be listed before file gamma). </dd>
 594
 595       <dt><a name="indexoptions:ignoreclient" id="indexoptions:ignoreclient">IgnoreClient</a></dt>
 596
 597       <dd>This option causes <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> to ignore all
 598       query variables from the client, including sort order (implies
 599       <code><a href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></code>.)</dd>
 600
 601       <dt><a name="indexoptions:namewidth" id="indexoptions:namewidth">NameWidth=[<var>n</var>
 602                | *]</a></dt>
 603
 604       <dd>The <code>NameWidth</code> keyword allows you to specify the width
 605       of the filename column in bytes.</dd>
 606
 607       <dd><code>-NameWidth</code> (or unset) allows <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> to calculate the best width.</dd>
 608
 609       <dd><code>NameWidth=<var>n</var></code> fixes the column width to
 610       <var>n</var> bytes wide.</dd>
 611
 612       <dd><code>NameWidth=*</code> grows the column to the necessary
 613       width.</dd>
 614
 615       <dt><a name="indexoptions:scanhtmltitles" id="indexoptions:scanhtmltitles">ScanHTMLTitles</a></dt>
 616
 617       <dd>This enables the extraction of the title from HTML documents
 618       for fancy indexing. If the file does not have a description
 619       given by <code class="directive"><a href="#adddescription">AddDescription</a></code>
 620       then httpd will read the document for the value of the
 621       <code>title</code> element. This is CPU and disk intensive.</dd>
 622
 623       <dt><a name="indexoptions:suppresscolumnsorting" id="indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></dt>
 624
 625       <dd>If specified, Apache will not make the column headings in a
 626       FancyIndexed directory listing into links for sorting. The
 627       default behavior is for them to be links; selecting the
 628       column heading will sort the directory listing by the values
 629       in that column. <strong>Prior to Apache 2.0.23, this also
 630       disabled parsing the Query Arguments for the sort
 631       string.</strong> That behavior is now controlled by <a href="#indexoptions:ignoreclient">IndexOptions
 632       IgnoreClient</a> in Apache 2.0.23.</dd>
 633
 634       <dt><a name="indexoptions:suppressdescription" id="indexoptions:suppressdescription">SuppressDescription</a></dt>
 635
 636       <dd>This will suppress the file description in fancy indexing
 637       listings. By default, no file descriptions are defined, and
 638       so the use of this option will regain 23 characters of screen
 639       space to use for something else. See <code class="directive"><a href="#adddescription">AddDescription</a></code> for information about setting the file
 640       description. See also the <code><a href="#indexoptions:descriptionwidth">DescriptionWidth</a></code>
 641       index option to limit the size of the description column.</dd>
 642
 643       <dt><a name="indexoptions:suppresshtmlpreamble" id="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</a></dt>
 644
 645       <dd>If the directory actually contains a file specified by the
 646       <code class="directive"><a href="#headername">HeaderName</a></code>
 647       directive, the module usually includes the contents of the file
 648       after a standard HTML preamble (<code>&lt;html&gt;</code>,
 649       <code>&lt;head&gt;</code>, <em>et cetera</em>). The
 650       <code>SuppressHTMLPreamble</code> option disables this behaviour,
 651       causing the module to start the display with the header file
 652       contents. The header file must contain appropriate HTML instructions
 653       in this case. If there is no header file, the preamble is generated
 654       as usual.</dd>
 655
 656       <dt><a name="indexoptions:suppressicon" id="indexoptions:suppressicon">SuppressIcon</a> (<em>Apache
 657       2.0.23 and later</em>)</dt>
 658
 659       <dd>This will suppress the icon in fancy indexing listings.
 660       Combining both <code>SuppressIcon</code> and
 661       <code>SuppressRules</code> yields proper HTML 3.2 output, which
 662       by the final specification prohibits <code>img</code> and
 663       <code>hr</code> elements from the <code>pre</code> block (used to
 664       format FancyIndexed listings.)</dd>
 665
 666       <dt><a name="indexoptions:suppresslastmodified" id="indexoptions:suppresslastmodified">SuppressLastModified</a></dt>
 667
 668       <dd>This will suppress the display of the last modification date,
 669       in fancy indexing listings.</dd>
 670
 671       <dt><a name="indexoptions:suppressrules" id="indexoptions:suppressrules">SuppressRules</a>
 672       (<em>Apache 2.0.23 and later</em>)</dt>
 673
 674       <dd>This will suppress the horizontal rule lines (<code>hr</code>
 675       elements) in directory listings. Combining both <code>SuppressIcon</code> and
 676       <code>SuppressRules</code> yields proper HTML 3.2 output, which
 677       by the final specification prohibits <code>img</code> and
 678       <code>hr</code> elements from the <code>pre</code> block (used to
 679       format FancyIndexed listings.)</dd>
 680
 681       <dt><a name="indexoptions:suppresssize" id="indexoptions:suppresssize">SuppressSize</a></dt>
 682
 683       <dd>This will suppress the file size in fancy indexing listings.</dd>
 684
 685       <dt><a name="indexoptions:trackmodified" id="indexoptions:trackmodified">TrackModified</a> (<em>Apache
 686       2.0.23 and later</em>)</dt>
 687
 688       <dd>This returns the Last-Modified and ETag values for the listed
 689       directory in the HTTP header. It is only valid if the
 690       operating system and file system return appropriate stat()
 691       results. Some Unix systems do so, as do OS2's JFS and Win32's
 692       NTFS volumes. OS2 and Win32 FAT volumes, for example, do not.
 693       Once this feature is enabled, the client or proxy can track
 694       changes to the list of files when they perform a <code>HEAD</code>
 695       request. Note some operating systems correctly track new and
 696       removed files, but do not track changes for sizes or dates of
 697       the files within the directory. <strong>Changes to the size
 698       or date stamp of an existing file will not update the
 699       Last-Modified header on all Unix platforms.</strong> If this
 700       is a concern, leave this option disabled.</dd>
 701
 702       <dt><a name="indexoptions:versionsort" id="indexoptions:versionsort">VersionSort</a>
 703       (<em>Apache 2.0a3 and later</em>)</dt>
 704
 705       <dd>The <code>VersionSort</code> keyword causes files containing
 706       version numbers to sort in a natural way. Strings are sorted as
 707       usual, except that substrings of digits in the name and
 708       description are compared according to their numeric value.
 709
 710       <div class="example"><h3>Example:</h3><p><code>
 711         foo-1.7<br />
 712         foo-1.7.2<br />
 713         foo-1.7.12<br />
 714         foo-1.8.2<br />
 715         foo-1.8.2a<br />
 716         foo-1.12
 717       </code></p></div>
 718
 719       <p>If the number starts with a zero, then it is considered to
 720       be a fraction:</p>
 721
 722       <div class="example"><p><code>
 723         foo-1.001<br />
 724         foo-1.002<br />
 725         foo-1.030<br />
 726         foo-1.04
 727       </code></p></div>
 728       </dd>
 729     </dl>
 730
 731
 732    <dl><dt>Incremental IndexOptions</dt>
 733    <dd>
 734      <p>Apache 1.3.3 introduced some significant changes in the
 735      handling of <code class="directive">IndexOptions</code> directives. In
 736      particular:</p>
 737
 738      <ul>
 739      <li>Multiple <code class="directive">IndexOptions</code> directives for a
 740      single directory are now merged together. The result of:
 741
 742      <div class="example"><p><code>
 743        &lt;Directory /foo&gt;
 744        <span class="indent">
 745          IndexOptions HTMLTable<br />
 746          IndexOptions SuppressColumnsorting
 747        </span>
 748        &lt;/Directory&gt;
 749      </code></p></div>
 750
 751      <p>will be the equivalent of</p>
 752
 753      <div class="example"><p><code>
 754        IndexOptions HTMLTable SuppressColumnsorting
 755      </code></p></div>
 756      </li>
 757
 758      <li>The addition of the incremental syntax (<em>i.e.</em>, prefixing
 759      keywords with <code>+</code> or <code>-</code>).</li>
 760      </ul>
 761
 762      <p>Whenever a '+' or '-' prefixed keyword is encountered, it
 763      is applied to the current <code class="directive">IndexOptions</code>
 764      settings (which may have been inherited from an upper-level
 765      directory). However, whenever an unprefixed keyword is processed, it
 766      clears all inherited options and any incremental settings encountered
 767      so far. Consider the following example:</p>
 768
 769      <div class="example"><p><code>
 770        IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing<br />
 771        IndexOptions +SuppressSize
 772      </code></p></div>
 773
 774      <p>The net effect is equivalent to <code>IndexOptions FancyIndexing
 775      +SuppressSize</code>, because the unprefixed <code>FancyIndexing</code>
 776      discarded the incremental keywords before it, but allowed them to
 777      start accumulating again afterward.</p>
 778
 779      <p>To unconditionally set the <code class="directive">IndexOptions</code> for
 780      a particular directory, clearing the inherited settings, specify
 781      keywords without any <code>+</code> or <code>-</code> prefixes.</p>
 782    </dd>
 783    </dl>
 784
 785 </div>
 786 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 787 <div class="directive-section"><h2><a name="IndexOrderDefault" id="IndexOrderDefault">IndexOrderDefault</a> <a name="indexorderdefault" id="indexorderdefault">Directive</a></h2>
 788 <table class="directive">
 789 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the default ordering of the directory index</td></tr>
 790 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>IndexOrderDefault Ascending|Descending
 791 Name|Date|Size|Description</code></td></tr>
 792 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>IndexOrderDefault Ascending Name</code></td></tr>
 793 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 794 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 795 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 796 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 797 </table>
 798     <p>The <code class="directive">IndexOrderDefault</code> directive is used
 799     in combination with the <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code> index option. By default, fancyindexed
 800     directory listings are displayed in ascending order by filename; the
 801     <code class="directive">IndexOrderDefault</code> allows you to change this
 802     initial display order.</p>
 803
 804     <p><code class="directive">IndexOrderDefault</code> takes two
 805     arguments. The first must be either <code>Ascending</code> or
 806     <code>Descending</code>, indicating the direction of the sort.
 807     The second argument must be one of the keywords <code>Name</code>,
 808     <code>Date</code>, <code>Size</code>, or <code>Description</code>,
 809     and identifies the primary key. The secondary key is
 810     <em>always</em> the ascending filename.</p>
 811
 812     <p>You can force a directory listing to only be displayed in a
 813     particular order by combining this directive with the <code><a href="#indexoptions:suppresscolumnsorting">SuppressColumnSorting</a></code> index option; this will prevent
 814     the client from requesting the directory listing in a different
 815     order.</p>
 816
 817 </div>
 818 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 819 <div class="directive-section"><h2><a name="ReadmeName" id="ReadmeName">ReadmeName</a> <a name="readmename" id="readmename">Directive</a></h2>
 820 <table class="directive">
 821 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Name of the file that will be inserted at the end
 822 of the index listing</td></tr>
 823 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ReadmeName <var>filename</var></code></td></tr>
 824 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 825 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
 826 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 827 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
 828 </table>
 829     <p>The <code class="directive">ReadmeName</code> directive sets the name
 830     of the file that will be appended to the end of the index
 831     listing. <var>Filename</var> is the name of the file to include, and
 832     is taken to be relative to the location being indexed. If
 833     <var>Filename</var> begins with a slash, it will be taken to be
 834     relative to the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>.
 835     </p>
 836
 837     <div class="example"><h3>Example</h3><p><code>
 838       ReadmeName FOOTER.html
 839     </code></p></div>
 840
 841     <div class="example"><h3>Example 2</h3><p><code>
 842       ReadmeName /include/FOOTER.html
 843     </code></p></div>
 844
 845     <p>See also <code class="directive"><a href="#headername">HeaderName</a></code>, where this behavior is described in greater
 846     detail.</p>
 847
 848 </div>
 849 </div>
 850 <div id="footer">
 851 <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
 852 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 853 </body></html>