mod_autoindex.xml revision f6ece164c2e1055a3d02b10928e1623d18b1d625
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<?xml version="1.0"?>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<!-- $LastChangedRevision$ -->
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<!--
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Licensed to the Apache Software Foundation (ASF) under one or more
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers contributor license agreements. See the NOTICE file distributed with
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers this work for additional information regarding copyright ownership.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers The ASF licenses this file to You under the Apache License, Version 2.0
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers (the "License"); you may not use this file except in compliance with
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the License. You may obtain a copy of the License at
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers http://www.apache.org/licenses/LICENSE-2.0
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Unless required by applicable law or agreed to in writing, software
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers distributed under the License is distributed on an "AS IS" BASIS,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers See the License for the specific language governing permissions and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers limitations under the License.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers-->
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<modulesynopsis metafile="mod_autoindex.xml.meta">
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>mod_autoindex</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Generates directory indexes,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers automatically, similar to the Unix <code>ls</code> command or the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Win32 <code>dir</code> shell command</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<status>Base</status>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<sourcefile>mod_autoindex.c</sourcefile>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<identifier>autoindex_module</identifier>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<summary>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The index of a directory can come from one of two
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers sources:</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <ul>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li>A file written by the user, typically called
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>index.html</code>. The <directive
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers module="mod_dir">DirectoryIndex</directive> directive sets the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers name of this file. This is controlled by
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <module>mod_dir</module>.</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li>Otherwise, a listing generated by the server. The other
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers directives control the format of this listing. The <directive
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers module="mod_autoindex">AddIcon</directive>, <directive
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers module="mod_autoindex">AddIconByEncoding</directive> and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <directive module="mod_autoindex">AddIconByType</directive> are
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers used to set a list of icons to display for various file types;
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers for each file listed, the first icon listed that matches the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers file is displayed. These are controlled by
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <module>mod_autoindex</module>.</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </ul>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The two functions are separated so that you can completely
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers remove (or replace) automatic index generation should you want
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers to.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>Automatic index generation is enabled with using
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>Options +Indexes</code>. See the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <directive module="core">Options</directive> directive for
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers more details.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>If the <code><a href="#indexoptions.fancyindexing"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >FancyIndexing</a></code> option is given with the <directive
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers module="mod_autoindex">IndexOptions</directive> directive,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the column headers are links that control the order of the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers display. If you select a header link, the listing will be
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers regenerated, sorted by the values in that column. Selecting the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers same header repeatedly toggles between ascending and descending
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers order. These column header links are suppressed with the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <directive module="mod_autoindex">IndexOptions</directive> directive's
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>SuppressColumnSorting</code> option.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>Note that when the display is sorted by "Size", it's the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <em>actual</em> size of the files that's used, not the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers displayed value - so a 1010-byte file will always be displayed
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers before a 1011-byte file (if in ascending order) even though
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers they both are shown as "1K".</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</summary>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<section id="query">
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <title>Autoindex Request Query Arguments</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>Apache HTTP Server 2.0.23 reorganized the Query Arguments for Column
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Sorting, and introduced an entire group of new query options.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers To effectively eliminate all client control over the output,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the <code><a href="#indexoptions.ignoreclient">IndexOptions
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IgnoreClient</a></code> option was introduced.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The column sorting headers themselves are self-referencing
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers hyperlinks that add the sort query options shown below. Any
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers option below may be added to any request for the directory
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers resource.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <ul>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li><code>C=N</code> sorts the directory by file name</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li><code>C=M</code> sorts the directory by last-modified
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers date, then file name</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li><code>C=S</code> sorts the directory by size, then file
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers name</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li class="separate"><code>C=D</code> sorts the directory by description, then
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers file name</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li><code>O=A</code> sorts the listing in Ascending
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Order</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li class="separate"><code>O=D</code> sorts the listing in Descending
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Order</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li><code>F=0</code> formats the listing as a simple list
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers (not FancyIndexed)</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li><code>F=1</code> formats the listing as a FancyIndexed
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers list</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li class="separate"><code>F=2</code> formats the listing as an
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers HTMLTable FancyIndexed list</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li><code>V=0</code> disables version sorting</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li class="separate"><code>V=1</code> enables version sorting</li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li><code>P=<var>pattern</var></code> lists only files matching
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the given <var>pattern</var></li>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </ul>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>Note that the 'P'attern query argument is tested
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <em>after</em> the usual <directive module="mod_autoindex"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >IndexIgnore</directive> directives are processed,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers and all file names are still subjected to the same criteria as
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers any other autoindex listing. The Query Arguments parser in
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <module>mod_autoindex</module> will stop abruptly when an unrecognized
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers option is encountered. The Query Arguments must be well formed,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers according to the table above.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The simple example below, which can be clipped and saved in
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers a header.html file, illustrates these query options. Note that
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the unknown "X" argument, for the submit button, is listed last
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers to assure the arguments are all parsed before mod_autoindex
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers encounters the X=Go input.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;form action="" method="get"&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Show me a &lt;select name="F"&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="0"&gt; Plain list&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="1" selected="selected"&gt; Fancy list&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="2"&gt; Table list&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;/select&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Sorted by &lt;select name="C"&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="N" selected="selected"&gt; Name&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="M"&gt; Date Modified&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="S"&gt; Size&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="D"&gt; Description&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;/select&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;select name="O"&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="A" selected="selected"&gt; Ascending&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="D"&gt; Descending&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;/select&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;select name="V"&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="0" selected="selected"&gt; in Normal order&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;option value="1"&gt; in Version order&lt;/option&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;/select&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Matching &lt;input type="text" name="P" value="*" /&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;input type="submit" name="X" value="Go" /&gt;<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;/form&gt;
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</section>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>AddAlt</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Alternate text to display for a file, instead of an
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieversicon selected by filename</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>AddAlt <var>string</var> <var>file</var> [<var>file</var>] ...</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><directive>AddAlt</directive> provides the alternate text to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers display for a file, instead of an icon, for <code><a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers href="#indexoptions.fancyindexing">FancyIndexing</a></code>.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>File</var> is a file extension, partial filename, wild-card
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers expression or full filename for files to describe.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers If <var>String</var> contains any whitespace, you have to enclose it
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers in quotes (<code>"</code> or <code>'</code>). This alternate text
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers is displayed if the client is image-incapable, has image loading
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers disabled, or fails to retrieve the icon.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Examples</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddAlt "PDF file" *.pdf<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddAlt Compressed *.gz *.zip *.Z
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>AddAltByEncoding</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Alternate text to display for a file instead of an icon
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieversselected by MIME-encoding</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>AddAltByEncoding <var>string</var> <var>MIME-encoding</var>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers[<var>MIME-encoding</var>] ...</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><directive>AddAltByEncoding</directive> provides the alternate
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers text to display for a file, instead of an icon, for <code><a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers href="#indexoptions.fancyindexing">FancyIndexing</a></code>.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>MIME-encoding</var> is a valid content-encoding, such as
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>x-compress</code>. If <var>String</var> contains any whitespace,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers you have to enclose it in quotes (<code>"</code> or <code>'</code>).
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers This alternate text is displayed if the client is image-incapable,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers has image loading disabled, or fails to retrieve the icon.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddAltByEncoding gzip x-gzip
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>AddAltByType</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Alternate text to display for a file, instead of an
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieversicon selected by MIME content-type</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>AddAltByType <var>string</var> <var>MIME-type</var>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers[<var>MIME-type</var>] ...</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><directive>AddAltByType</directive> sets the alternate text to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers display for a file, instead of an icon, for <code><a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers href="#indexoptions.fancyindexing">FancyIndexing</a></code>.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>MIME-type</var> is a valid content-type, such as
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>text/html</code>. If <var>String</var> contains any whitespace,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers you have to enclose it in quotes (<code>"</code> or <code>'</code>).
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers This alternate text is displayed if the client is image-incapable,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers has image loading disabled, or fails to retrieve the icon.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddAltByType 'plain text' text/plain
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>AddDescription</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Description to display for a file</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>AddDescription <var>string file</var> [<var>file</var>] ...</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>This sets the description to display for a file, for
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code><a href="#indexoptions.fancyindexing"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >FancyIndexing</a></code>.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>File</var> is a file extension, partial filename, wild-card
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers expression or full filename for files to describe.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>String</var> is enclosed in double quotes (<code>"</code>).</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddDescription "The planet Mars" /web/pics/mars.gif
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The typical, default description field is 23 bytes wide. 6
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers more bytes are added by the <code><a href="#indexoptions.suppressicon"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >IndexOptions SuppressIcon</a></code> option, 7 bytes are
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers added by the <code><a href="#indexoptions.suppresssize"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >IndexOptions SuppressSize</a></code> option, and 19 bytes are
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers added by the <code><a href="#indexoptions.suppresslastmodified"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >IndexOptions SuppressLastModified</a></code> option.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Therefore, the widest default the description column is ever
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers assigned is 55 bytes.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>Since the <var>File</var> argument may be a partial file name,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers please remember that a too-short partial filename may match
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers unintended files. For example, <code>le.html</code> will match the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers file <code>le.html</code> but will also match the file
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>example.html</code>. In the event that there may be ambiguity,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers use as complete a filename as you can, but keep in mind that the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers first match encountered will be used, and order your list of
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>AddDescription</code> directives accordingly.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>See the <a href="#indexoptions.descriptionwidth"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >DescriptionWidth</a> <directive module="mod_autoindex"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >IndexOptions</directive> keyword for details on overriding the size
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers of this column, or allowing descriptions of unlimited length.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <note><title>Caution</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>Descriptive text defined with <directive>AddDescription</directive>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers may contain HTML markup, such as tags and character entities. If the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers width of the description column should happen to truncate a tagged
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers element (such as cutting off the end of a bolded phrase), the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers results may affect the rest of the directory listing.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </note>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>AddIcon</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Icon to display for a file selected by name</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>AddIcon <var>icon</var> <var>name</var> [<var>name</var>]
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers...</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>This sets the icon to display next to a file ending in
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>name</var> for <code><a href="#indexoptions.fancyindexing"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >FancyIndexing</a></code>. <var>Icon</var> is either a (%-escaped)
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers relative URL to the icon, a fully qualified remote URL, or of the format <code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers (<var>alttext</var>,<var>url</var>)</code> where <var>alttext</var>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers is the text tag given for an icon for non-graphical browsers.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><var>Name</var> is either <code>^^DIRECTORY^^</code> for directories,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>^^BLANKICON^^</code> for blank lines (to format the list
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers correctly), a file extension, a wildcard expression, a partial
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers filename or a complete filename.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><code>^^BLANKICON^^</code> is only used for formatting, and so
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers is unnecessary if you're using <code>IndexOptions
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers HTMLTable</code>.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Examples</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddIcon (IMG,/icons/image.png) .gif .jpg .png<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddIcon /icons/dir.png ^^DIRECTORY^^<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddIcon /icons/backup.png *~
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><directive module="mod_autoindex">AddIconByType</directive>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers should be used in preference to <directive>AddIcon</directive>,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers when possible.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>AddIconByEncoding</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Icon to display next to files selected by MIME
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieverscontent-encoding</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>AddIconByEncoding <var>icon</var> <var>MIME-encoding</var>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers[<var>MIME-encoding</var>] ...</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>This sets the icon to display next to files with <code><a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers href="#indexoptions.fancyindexing">FancyIndexing</a></code>.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>Icon</var> is either a (%-escaped) relative URL to the icon,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers a fully qualified remote URL,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers or of the format <code>(<var>alttext</var>,<var>url</var>)</code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers where <var>alttext</var> is the text tag given for an icon for
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers non-graphical browsers.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><var>MIME-encoding</var> is a valid content-encoding, such as
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>x-compress</code>.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddIconByEncoding /icons/compress.png x-compress
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>AddIconByType</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Icon to display next to files selected by MIME
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieverscontent-type</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>AddIconByType <var>icon</var> <var>MIME-type</var>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers[<var>MIME-type</var>] ...</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>This sets the icon to display next to files of type
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>MIME-type</var> for <code><a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers href="#indexoptions.fancyindexing">FancyIndexing</a></code>.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>Icon</var> is either a (%-escaped) relative URL to the icon,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers a fully qualified remote URL,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers or of the format <code>(<var>alttext</var>,<var>url</var>)</code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers where <var>alttext</var> is the text tag given for an icon for
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers non-graphical browsers.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><var>MIME-type</var> is a wildcard expression matching
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers required the mime types.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers AddIconByType (IMG,/icons/image.png) image/*
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>DefaultIcon</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Icon to display for files when no specific icon is
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieversconfigured</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>DefaultIcon <var>url-path</var></syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The <directive>DefaultIcon</directive> directive sets the icon
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers to display for files when no specific icon is known, for <code><a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers href="#indexoptions.fancyindexing">FancyIndexing</a></code>.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>Url-path</var> is a (%-escaped) relative URL to the icon,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers or a fully qualified remote URL.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers DefaultIcon /icon/unknown.png
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>HeaderName</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Name of the file that will be inserted at the top
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieversof the index listing</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>HeaderName <var>filename</var></syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The <directive>HeaderName</directive> directive sets the name
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers of the file that will be inserted at the top of the index
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers listing. <var>Filename</var> is the name of the file to include.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers HeaderName HEADER.html
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <note>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>Both HeaderName and <directive
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers module="mod_autoindex">ReadmeName</directive> now treat
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>Filename</var> as a URI path relative to the one used to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers access the directory being indexed. If <var>Filename</var> begins
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers with a slash, it will be taken to be relative to the <directive
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers module="core">DocumentRoot</directive>.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers HeaderName /include/HEADER.html
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><var>Filename</var> must resolve to a document with a major
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers content type of <code>text/*</code> (<em>e.g.</em>,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>text/html</code>, <code>text/plain</code>, etc.). This means
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers that <var>filename</var> may refer to a CGI script if the script's
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers actual file type (as opposed to its output) is marked as
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>text/html</code> such as with a directive like:</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <example>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers AddType text/html .cgi
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers </example>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p><a href="/content-negotiation.html">Content negotiation</a>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers will be performed if <directive module="core">Options</directive>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>MultiViews</code> is in effect. If <var>filename</var> resolves
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers to a static <code>text/html</code> document (not a CGI script) and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers either one of the <directive module="core">options</directive>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>Includes</code> or <code>IncludesNOEXEC</code> is enabled,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the file will be processed for server-side includes (see the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <module>mod_include</module> documentation).</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </note>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>If the file specified by <directive>HeaderName</directive> contains
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the beginnings of an HTML document (&lt;html&gt;, &lt;head&gt;, etc.)
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers then you will probably want to set <a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers href="#indexoptions.suppresshtmlpreamble"><code>IndexOptions
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers +SuppressHTMLPreamble</code></a>, so that these tags are not
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers repeated.</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>IndexIgnore</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Adds to the list of files to hide when listing
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieversa directory</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>IndexIgnore <var>file</var> [<var>file</var>] ...</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The <directive>IndexIgnore</directive> directive adds to the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers list of files to hide when listing a directory. <var>File</var> is a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers shell-style wildcard expression or full
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers filename. Multiple IndexIgnore directives add
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers to the list, rather than the replacing the list of ignored
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers files. By default, the list contains <code>.</code> (the current
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers directory).</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>IndexIgnoreReset</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Empties the list of files to hide when listing
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieversa directory</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>IndexIgnoreReset ON|OFF</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<compatibility>2.3.10 and later</compatibility>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The <directive>IndexIgnoreReset</directive> directive removes
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers any files ignored by <directive>IndexIgnore</directive> otherwise
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers inherited from other configuration sections. </p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;Directory /var/www&gt;
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IndexIgnore *.bak .??* *~ *# HEADER* README* RCS CVS *,v *,t
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;/Directory&gt;
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;Directory /var/www/backups&gt;
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IndexIgnoreReset ON
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IndexIgnore .??* *# HEADER* README* RCS CVS *,v *,t
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;/Directory&gt;
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <note type="warning"><p> Review the default configuration for a list of
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers patterns that you might want to explicitly ignore after using this
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers directive.</p></note>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<directivesynopsis>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<name>IndexOptions</name>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<description>Various configuration settings for directory
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sieversindexing</description>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<syntax>IndexOptions [+|-]<var>option</var> [[+|-]<var>option</var>]
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers...</syntax>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<contextlist><context>server config</context><context>virtual host</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<context>directory</context><context>.htaccess</context>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers</contextlist>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<override>Indexes</override>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers<usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The <directive>IndexOptions</directive> directive specifies the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers behavior of the directory indexing. <var>Option</var> can be one
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers of</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dl>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.addaltclass"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.addaltclass">AddAltClass</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>Adds an additional CSS class declaration to each row of the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers directory listing table when <code>IndexOptions HTMLTable</code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers is in effect and an <code>IndexStyleSheet</code> is defined.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Rather than the standard <code>even</code> and <code>odd</code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers classes that would otherwise be applied to each row of the table,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers a class of <code>even-<em>ALT</em></code> or
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>odd-<em>ALT</em></code> where <em>ALT</em> is either the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers standard alt text associated with the file style (eg. <em>snd</em>,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <em>txt</em>, <em>img</em>, etc) or the alt text defined by one of
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the various <code>AddAlt*</code> directives.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.charset"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.charset"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >Charset=<var>character-set</var></a> (<em>Apache HTTP Server 2.0.61 and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers later</em>)</dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>The <code>Charset</code> keyword allows you to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers specify the character set of the generated page. The
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers default is <code>UTF-8</code> on Windows and Mac OS X,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers and <code>ISO-8859-1</code> elsewhere.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers (It depends on whether the underlying file system
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers uses Unicode filenames or not.)
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example:</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IndexOptions Charset=UTF-8
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.descriptionwidth"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.descriptionwidth"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >DescriptionWidth=[<var>n</var> | *]</a> (<em>Apache HTTP Server 2.0.23 and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers later</em>)</dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>The <code>DescriptionWidth</code> keyword allows you to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers specify the width of the description column in
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers characters.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd><code>-DescriptionWidth</code> (or unset) allows
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <module>mod_autoindex</module> to calculate the best width.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd><code>DescriptionWidth=<var>n</var></code> fixes the column width to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>n</var> bytes wide.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd><code>DescriptionWidth=*</code> grows the column to the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers width necessary to accommodate the longest description
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers string.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd><strong>See the section on <directive
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers module="mod_autoindex">AddDescription</directive> for dangers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers inherent in truncating descriptions.</strong></dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.fancyindexing"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.fancyindexing">FancyIndexing</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This turns on fancy indexing of directories.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.foldersfirst"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.foldersfirst">FoldersFirst</a> (<em>Apache HTTP Server
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers 2.0.23 and later</em>)</dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>If this option is enabled, subdirectory listings will
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <em>always</em> appear first, followed by normal files in the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers directory. The listing is basically broken into two
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers components, the files and the subdirectories, and each is
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers sorted separately and then displayed subdirectories-first.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers For instance, if the sort order is descending by name, and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>FoldersFirst</code> is enabled, subdirectory
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>Zed</code> will be listed before subdirectory
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>Beta</code>, which will be listed before normal files
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>Gamma</code> and <code>Alpha</code>. <strong>This option
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers only has an effect if <a href="#indexoptions.fancyindexing"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers ><code>FancyIndexing</code></a> is also enabled.</strong></dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.htmltable"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.htmltable">HTMLTable</a> (<em>Apache
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers HTTP Server 2.0.23 and later</em>)</dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This option with <code>FancyIndexing</code> constructs
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers a simple table for the fancy directory listing.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers It is necessary for utf-8 enabled platforms or if file
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers names or description text will alternate between
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers left-to-right and right-to-left reading order.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.iconsarelinks"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.iconsarelinks">IconsAreLinks</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This makes the icons part of the anchor for the filename, for
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers fancy indexing.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.iconheight"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.iconheight">IconHeight[=<var
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >pixels</var>]</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>Presence of this option, when used with <code>IconWidth</code>,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers will cause the server to include <code>height</code> and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>width</code> attributes in the <code>img</code> tag for the file
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers icon. This allows browser to precalculate the page layout without having
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers to wait until all the images have been loaded. If no value is given for
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the option, it defaults to the standard height of the icons supplied
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers with the Apache httpd software.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.iconwidth"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.iconwidth">IconWidth[=<var
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >pixels</var>]</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>Presence of this option, when used with <code>IconHeight</code>,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers will cause the server to include <code>height</code> and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>width</code> attributes in the <code>img</code> tag for
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the file icon. This allows browser to precalculate the page
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers layout without having to wait until all the images have been
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers loaded. If no value is given for the option, it defaults to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the standard width of the icons supplied with the Apache httpd
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers software.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.ignorecase"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.ignorecase">IgnoreCase</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>If this option is enabled, names are sorted in a case-insensitive
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers manner. For instance, if the sort order is ascending by name, and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>IgnoreCase</code> is enabled, file Zeta will be listed after
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers file alfa (Note: file GAMMA will always be listed before file gamma).
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <dt><a name="indexoptions.ignoreclient"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.ignoreclient">IgnoreClient</a></dt>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <dd>This option causes <module>mod_autoindex</module> to ignore all
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers query variables from the client, including sort order (implies
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <code><a href="#indexoptions.suppresscolumnsorting"
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers >SuppressColumnSorting</a></code>.)</dd>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <dt><a name="indexoptions.namewidth"
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers id="indexoptions.namewidth">NameWidth=[<var>n</var>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers | *]</a></dt>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <dd>The <code>NameWidth</code> keyword allows you to specify the width
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers of the filename column in bytes.</dd>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <dd><code>-NameWidth</code> (or unset) allows <module
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers >mod_autoindex</module> to calculate the best width, but only up
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers to 20 bytes wide.</dd>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd><code>NameWidth=<var>n</var></code> fixes the column width to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <var>n</var> bytes wide.</dd>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd><code>NameWidth=*</code> grows the column to the necessary
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers width.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.scanhtmltitles"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.scanhtmltitles">ScanHTMLTitles</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This enables the extraction of the title from HTML documents
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers for fancy indexing. If the file does not have a description
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers given by <directive module="mod_autoindex">AddDescription</directive>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers then httpd will read the document for the value of the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>title</code> element. This is CPU and disk intensive.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.showforbidden"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.showforbidden">ShowForbidden</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>If specified, Apache httpd will show files normally hidden because
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers the subrequest returned <code>HTTP_UNAUTHORIZED</code> or
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>HTTP_FORBIDDEN</code></dd>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <dt><a name="indexoptions.suppresscolumnsorting"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.suppresscolumnsorting"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >SuppressColumnSorting</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>If specified, Apache httpd will not make the column headings in a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers FancyIndexed directory listing into links for sorting. The
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers default behavior is for them to be links; selecting the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers column heading will sort the directory listing by the values
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers in that column. <strong>Prior to Apache HTTP Server 2.0.23, this also
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers disabled parsing the Query Arguments for the sort
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers string.</strong> That behavior is now controlled by <a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers href="#indexoptions.ignoreclient"><code>IndexOptions
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IgnoreClient</code></a> in Apache HTTP Server 2.0.23.</dd>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.suppressdescription"
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers id="indexoptions.suppressdescription"
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers >SuppressDescription</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This will suppress the file description in fancy indexing
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers listings. By default, no file descriptions are defined, and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers so the use of this option will regain 23 characters of screen
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers space to use for something else. See <directive module="mod_autoindex"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >AddDescription</directive> for information about setting the file
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers description. See also the <code><a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers href="#indexoptions.descriptionwidth">DescriptionWidth</a></code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers index option to limit the size of the description column.</dd>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.suppresshtmlpreamble"
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers id="indexoptions.suppresshtmlpreamble"
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers >SuppressHTMLPreamble</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>If the directory actually contains a file specified by the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <directive module="mod_autoindex">HeaderName</directive>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers directive, the module usually includes the contents of the file
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers after a standard HTML preamble (<code>&lt;html&gt;</code>,
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <code>&lt;head&gt;</code>, <em>et cetera</em>). The
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <code>SuppressHTMLPreamble</code> option disables this behaviour,
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers causing the module to start the display with the header file
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers contents. The header file must contain appropriate HTML instructions
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers in this case. If there is no header file, the preamble is generated
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers as usual. If you also specify a <directive
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers module="mod_autoindex">ReadmeName</directive>, and if that file
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers exists, The closing &lt;/body&gt;&lt;/html&gt; tags are also
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers ommitted from the output, under the assumption that you'll likely
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers put those closing tags in that file.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.suppressicon"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.suppressicon">SuppressIcon</a> (<em>Apache HTTP Server
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers 2.0.23 and later</em>)</dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This will suppress the icon in fancy indexing listings.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Combining both <code>SuppressIcon</code> and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>SuppressRules</code> yields proper HTML 3.2 output, which
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers by the final specification prohibits <code>img</code> and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>hr</code> elements from the <code>pre</code> block (used to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers format FancyIndexed listings.)</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.suppresslastmodified"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.suppresslastmodified"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >SuppressLastModified</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This will suppress the display of the last modification date,
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers in fancy indexing listings.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.suppressrules"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.suppressrules">SuppressRules</a>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers (<em>Apache HTTP Server 2.0.23 and later</em>)</dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This will suppress the horizontal rule lines (<code>hr</code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers elements) in directory listings. Combining both <code>SuppressIcon</code> and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>SuppressRules</code> yields proper HTML 3.2 output, which
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers by the final specification prohibits <code>img</code> and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>hr</code> elements from the <code>pre</code> block (used to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers format FancyIndexed listings.)</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.suppresssize"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.suppresssize">SuppressSize</a></dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This will suppress the file size in fancy indexing listings.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.trackmodified"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.trackmodified">TrackModified</a> (<em>Apache HTTP Server
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers 2.0.23 and later</em>)</dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>This returns the <code>Last-Modified</code> and <code>ETag</code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers values for the listed directory in the HTTP header. It is only valid
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers if the operating system and file system return appropriate stat()
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers results. Some Unix systems do so, as do OS2's JFS and Win32's
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers NTFS volumes. OS2 and Win32 FAT volumes, for example, do not.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers Once this feature is enabled, the client or proxy can track
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers changes to the list of files when they perform a <code>HEAD</code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers request. Note some operating systems correctly track new and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers removed files, but do not track changes for sizes or dates of
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers the files within the directory. <strong>Changes to the size
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers or date stamp of an existing file will not update the
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <code>Last-Modified</code> header on all Unix platforms.</strong>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers If this is a concern, leave this option disabled.</dd>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.type"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.type"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers >Type=<var>MIME content-type</var></a> (<em>Apache HTTP Server 2.0.61 and
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers later</em>)</dt>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <dd>The <code>Type</code> keyword allows you to
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers specify the MIME content-type of the generated page. The default
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers is <var>text/html</var>.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example:</title>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IndexOptions Type=text/plain
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.versionsort"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.versionsort">VersionSort</a>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers (<em>Apache HTTP Server 2.0a3 and later</em>)</dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>The <code>VersionSort</code> keyword causes files containing
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers version numbers to sort in a natural way. Strings are sorted as
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers usual, except that substrings of digits in the name and
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers description are compared according to their numeric value.
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example><title>Example:</title>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers foo-1.7<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers foo-1.7.2<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers foo-1.7.12<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers foo-1.8.2<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers foo-1.8.2a<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers foo-1.12
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <p>If the number starts with a zero, then it is considered to
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers be a fraction:</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers foo-1.001<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers foo-1.002<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers foo-1.030<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers foo-1.04
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dt><a name="indexoptions.xhtml"
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers id="indexoptions.xhtml">XHTML</a>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers (<em>Apache HTTP Server 2.0.49 and later</em>)</dt>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dd>The <code>XHTML</code> keyword forces <module>mod_autoindex</module>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers to emit XHTML 1.0 code instead of HTML 3.2.</dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers </dl>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <!--
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers XXX: we should consider to allow sections inside <usage>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers this would require some xslt changes...
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers -->
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <dl><dt>Incremental IndexOptions</dt>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <dd>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>Be aware of how multiple <directive>IndexOptions</directive> are
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers handled.</p>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <ul>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <li>Multiple <directive>IndexOptions</directive> directives for a
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers single directory are now merged together. The result of:
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <example>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers &lt;Directory /foo&gt;
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <indent>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers IndexOptions HTMLTable<br />
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IndexOptions SuppressColumnsorting
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </indent>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers &lt;/Directory&gt;
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>will be the equivalent of</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers IndexOptions HTMLTable SuppressColumnsorting
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </example>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers </li>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <li>The addition of the incremental syntax (<em>i.e.</em>, prefixing
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers keywords with <code>+</code> or <code>-</code>).</li>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers </ul>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>Whenever a '+' or '-' prefixed keyword is encountered, it
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers is applied to the current <directive>IndexOptions</directive>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers settings (which may have been inherited from an upper-level
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers directory). However, whenever an unprefixed keyword is processed, it
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers clears all inherited options and any incremental settings encountered
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers so far. Consider the following example:</p>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <example>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing<br />
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers IndexOptions +SuppressSize
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers </example>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers <p>The net effect is equivalent to <code>IndexOptions FancyIndexing
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers +SuppressSize</code>, because the unprefixed <code>FancyIndexing</code>
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers discarded the incremental keywords before it, but allowed them to
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers start accumulating again afterward.</p>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <p>To unconditionally set the <directive>IndexOptions</directive> for
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers a particular directory, clearing the inherited settings, specify
0c959b39175b126fdb70ae00de37ca6d9c8ca3a1Kay Sievers keywords without any <code>+</code> or <code>-</code> prefixes.</p>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers </dd>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers </dl>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers</usage>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers</directivesynopsis>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers<directivesynopsis>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers<name>IndexOrderDefault</name>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers<description>Sets the default ordering of the directory index</description>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers<syntax>IndexOrderDefault Ascending|Descending
e8193554925a22b63bef0e77b8397b56d63a91ffKay SieversName|Date|Size|Description</syntax>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers<default>IndexOrderDefault Ascending Name</default>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers<contextlist><context>server config</context><context>virtual host</context>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers<context>directory</context><context>.htaccess</context>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers</contextlist>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers<override>Indexes</override>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers<usage>
e8193554925a22b63bef0e77b8397b56d63a91ffKay Sievers <p>The <directive>IndexOrderDefault</directive> directive is used
in combination with the <code><a href="#indexoptions.fancyindexing"
>FancyIndexing</a></code> index option. By default, fancyindexed
directory listings are displayed in ascending order by filename; the
<directive>IndexOrderDefault</directive> allows you to change this
initial display order.</p>
<p><directive>IndexOrderDefault</directive> takes two
arguments. The first must be either <code>Ascending</code> or
<code>Descending</code>, indicating the direction of the sort.
The second argument must be one of the keywords <code>Name</code>,
<code>Date</code>, <code>Size</code>, or <code>Description</code>,
and identifies the primary key. The secondary key is
<em>always</em> the ascending filename.</p>
<p>You can, if desired, prevent the client from reordering the list
by also adding the <code><a
href="#indexoptions.suppresscolumnsorting">SuppressColumnSorting</a></code>
index option to remove the sort link from the top of the column,
along with the <code><a
href="#indexoptions.ignoreclient">IgnoreClient</a></code> index
option to prevent them from manually adding sort options to the
query string in order to override your ordering preferences.</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>IndexStyleSheet</name>
<description>Adds a CSS stylesheet to the directory index</description>
<syntax>IndexStyleSheet <var>url-path</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>Indexes</override>
<usage>
<p>The <directive>IndexStyleSheet</directive> directive sets the name of
the file that will be used as the CSS for the index listing.
</p>
<example>
<title>Example</title>
IndexStyleSheet "/css/style.css"
</example>
<p>Using this directive in conjunction with <code>IndexOptions
HTMLTable</code> adds a number of CSS classes to the resulting HTML.
The entire table is given a CSS id of <code>indexlist</code> and the
following classes are associated with the various parts of the
listing:</p>
<table>
<tr><th>Class</th><th>Definition</th></tr>
<tr><td>tr.indexhead</td><td>Header row of listing</td></tr>
<tr><td>th.indexcolicon and td.indexcolicon</td> <td>Icon column</td></tr>
<tr><td>th.indexcolname and td.indexcolname</td> <td>File name column</td></tr>
<tr><td>th.indexcollastmod and td.indexcollastmod</td> <td>Last modified column</td></tr>
<tr><td>th.indexcolsize and td.indexcolsize</td> <td>File size column</td></tr>
<tr><td>th.indexcoldesc and td.indexcoldesc</td> <td>Description column</td></tr>
<tr><td>tr.breakrow</td> <td>Horizontal rule at the bottom of the table</td></tr>
<tr><td>tr.odd and tr.even</td> <td>Alternating even and odd rows</td></tr>
</table>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>IndexHeadInsert</name>
<description>Inserts text in the HEAD section of an index page.</description>
<syntax>IndexHeadInsert <var>"markup ..."</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>Indexes</override>
<usage>
<p>The <directive>IndexHeadInsert</directive> directive specifies a
string to insert in the <var>&lt;head&gt;</var> section of the HTML
generated for the index page.</p>
<example>
<title>Example</title>
IndexHeadInsert "&lt;link rel=\"sitemap\" href=\"/sitemap.html\"&gt;"
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>ReadmeName</name>
<description>Name of the file that will be inserted at the end
of the index listing</description>
<syntax>ReadmeName <var>filename</var></syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>Indexes</override>
<usage>
<p>The <directive>ReadmeName</directive> directive sets the name
of the file that will be appended to the end of the index
listing. <var>Filename</var> is the name of the file to include, and
is taken to be relative to the location being indexed. If
<var>Filename</var> begins with a slash, it will be taken to be
relative to the <directive module="core">DocumentRoot</directive>.
</p>
<example><title>Example</title>
ReadmeName FOOTER.html
</example>
<example><title>Example 2</title>
ReadmeName /include/FOOTER.html
</example>
<p>See also <directive module="mod_autoindex"
>HeaderName</directive>, where this behavior is described in greater
detail.</p>
</usage>
</directivesynopsis>
</modulesynopsis>