<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
+<!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
-<title>mod_autoindex - Apache HTTP Server</title>
+<title>mod_autoindex - Apache HTTP Server Version 2.5</title>
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
-<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
+<script src="../style/scripts/prettify.min.js" type="text/javascript">
+</script>
+
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
<body>
<div id="page-header">
-<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>
-<p class="apache">Apache HTTP Server Version 2.3</p>
-<img alt="" src="../images/feather.gif" /></div>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/
quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.5</p>
+<img alt="" src="../images/feather.png" /></div>
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
<div id="path">
-<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.
3</a> > <a href="./">Modules</a></div>
+<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.
5</a> > <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Apache Module mod_autoindex</h1>
<div class="toplang">
sources:</p>
<ul>
- <li>A file written by the user, typically called
+ <li>A file located in that directory, typically called
<code>index.html</code>. The <code class="directive"><a href="../mod/mod_dir.html#directoryindex">DirectoryIndex</a></code> directive sets the
- name of this file. This is controlled by
+ name of the file or files to be used. This is controlled by
<code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code>.</li>
<li>Otherwise, a listing generated by the server. The other
same header repeatedly toggles between ascending and descending
order. These column header links are suppressed with the
<code class="directive"><a href="#indexoptions">IndexOptions</a></code> directive's
- <code>SuppressColumnSorting</code> option.</p>
+ <code><a href="#indexoptions.suppresscolumnsorting">SuppressColumnSorting</a></code>
+ option.</p>
<p>Note that when the display is sorted by "Size", it's the
<em>actual</em> size of the files that's used, not the
before a 1011-byte file (if in ascending order) even though
they both are shown as "1K".</p>
</div>
-<div id="quickview"><h3 class="directives">Directives</h3>
+<div id="quickview"><h3>Topics</h3>
+<ul id="topics">
+<li><img alt="" src="../images/down.gif" /> <a href="#query">Autoindex Request Query Arguments</a></li>
+</ul><h3 class="directives">Directives</h3>
<ul id="toc">
<li><img alt="" src="../images/down.gif" /> <a href="#addalt">AddAlt</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#addaltbyencoding">AddAltByEncoding</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#headername">HeaderName</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#indexheadinsert">IndexHeadInsert</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#indexignore">IndexIgnore</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#indexignorereset">IndexIgnoreReset</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#indexoptions">IndexOptions</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#indexorderdefault">IndexOrderDefault</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#indexstylesheet">IndexStyleSheet</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#readmename">ReadmeName</a></li>
</ul>
-<h3>Topics</h3>
-<ul id="topics">
-<li><img alt="" src="../images/down.gif" /> <a href="#query">Autoindex Request Query Arguments</a></li>
-</ul></div>
+<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_autoindex">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_autoindex">Report a bug</a></li></ul><h3>See also</h3>
+<ul class="seealso">
+<li><a href="#comments_section">Comments</a></li></ul></div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="query" id="query">Autoindex Request Query Arguments</a></h2>
- <p>Apache HTTP Server 2.0.23 reorganized the Query Arguments for Column
- Sorting, and introduced an entire group of new query options.
- To effectively eliminate all client control over the output,
- the <code><a href="#indexoptions.ignoreclient">IndexOptions
- IgnoreClient</a></code> option was introduced.</p>
+ <p>Various query string arguments are available to give the client
+ some control over the ordering of the directory listing, as well as
+ what files are listed. If you do not wish to give the client this
+
control, the <code><a href="#indexoptions.ignoreclient">IndexOptions
+ IgnoreClient</a></code> option disables that functionality.</p>
<p>The column sorting headers themselves are self-referencing
hyperlinks that add the sort query options shown below. Any
is displayed if the client is image-incapable, has image loading
disabled, or fails to retrieve the icon.</p>
- <div class="example"><h3>Examples</h3><p><code>
- AddAlt "PDF file" *.pdf<br />
- AddAlt Compressed *.gz *.zip *.Z
- </code></p></div>
+ <pre class="prettyprint lang-config">AddAlt "PDF file" *.pdf
+AddAlt Compressed *.gz *.zip *.Z</pre>
+
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
This alternate text is displayed if the client is image-incapable,
has image loading disabled, or fails to retrieve the icon.</p>
- <div class="example"><h3>Example</h3><p><code>
- AddAltByEncoding gzip x-gzip
- </code></p></div>
+ <pre class="prettyprint lang-config">AddAltByEncoding gzip x-gzip</pre>
+
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
This alternate text is displayed if the client is image-incapable,
has image loading disabled, or fails to retrieve the icon.</p>
- <div class="example"><h3>Example</h3><p><code>
- AddAltByType 'plain text' text/plain
- </code></p></div>
+ <pre class="prettyprint lang-config">AddAltByType 'plain text' text/plain</pre>
+
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
expression or full filename for files to describe.
<var>String</var> is enclosed in double quotes (<code>"</code>).</p>
- <div class="example"><h3>Example</h3><p><code>
- AddDescription "The planet Mars" /web/pics/mars.gif
- </code></p></div>
+ <pre class="prettyprint lang-config">AddDescription "The planet Mars" mars.gif
+AddDescription "My friend Marshall" friends/mars.gif</pre>
+
<p>The typical, default description field is 23 bytes wide. 6
more bytes are added by the <code><a href="#indexoptions.suppressicon">IndexOptions SuppressIcon</a></code> option, 7 bytes are
results may affect the rest of the directory listing.</p>
</div>
+ <div class="note"><h3>Arguments with path information</h3>
+ <p>Absolute paths are not currently supported and do not match
+ anything at runtime. Arguments with relative path information,
+ which would normally only be used in htaccess context, are implicitly
+ prefixed with '*/' to avoid matching partial directory names.</p>
+ </div>
+
+
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="AddIcon" id="AddIcon">AddIcon</a> <a name="addicon" id="addicon">Directive</a></h2>
</table>
<p>This sets the icon to display next to a file ending in
<var>name</var> for <code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>. <var>Icon</var> is either a (%-escaped)
- relative URL to the icon, or of the format <code>
+ relative URL to the icon, a fully qualified remote URL, or of the format <code>
(<var>alttext</var>,<var>url</var>)</code> where <var>alttext</var>
is the text tag given for an icon for non-graphical browsers.</p>
correctly), a file extension, a wildcard expression, a partial
filename or a complete filename.</p>
- <div class="example"><h3>Examples</h3><p><code>
- AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm<br />
- AddIcon /icons/dir.xbm ^^DIRECTORY^^<br />
- AddIcon /icons/backup.xbm *~
- </code></p></div>
+ <p><code>^^BLANKICON^^</code> is only used for formatting, and so
+ is unnecessary if you're using <code>IndexOptions
+ HTMLTable</code>.</p>
+
+ <pre class="prettyprint lang-config">#Examples
+AddIcon (IMG,/icons/image.png) .gif .jpg .png
+AddIcon /icons/dir.png ^^DIRECTORY^^
+AddIcon /icons/backup.png *~</pre>
+
<p><code class="directive"><a href="#addiconbytype">AddIconByType</a></code>
should be used in preference to <code class="directive">AddIcon</code>,
</table>
<p>This sets the icon to display next to files with <code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>.
<var>Icon</var> is either a (%-escaped) relative URL to the icon,
+ a fully qualified remote URL,
or of the format <code>(<var>alttext</var>,<var>url</var>)</code>
where <var>alttext</var> is the text tag given for an icon for
non-graphical browsers.</p>
<p><var>MIME-encoding</var> is a valid content-encoding, such as
<code>x-compress</code>.</p>
- <div class="example"><h3>Example</h3><p><code>
- AddIconByEncoding /icons/compress.xbm x-compress
- </code></p></div>
+ <pre class="prettyprint lang-config">AddIconByEncoding /icons/compress.png x-compress</pre>
+
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<p>This sets the icon to display next to files of type
<var>MIME-type</var> for <code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>.
<var>Icon</var> is either a (%-escaped) relative URL to the icon,
+ a fully qualified remote URL,
or of the format <code>(<var>alttext</var>,<var>url</var>)</code>
where <var>alttext</var> is the text tag given for an icon for
non-graphical browsers.</p>
<p><var>MIME-type</var> is a wildcard expression matching
required the mime types.</p>
- <div class="example"><h3>Example</h3><p><code>
- AddIconByType (IMG,/icons/image.xbm) image/*
- </code></p></div>
+ <pre class="prettyprint lang-config">AddIconByType (IMG,/icons/image.png) image/*</pre>
+
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
</table>
<p>The <code class="directive">DefaultIcon</code> directive sets the icon
to display for files when no specific icon is known, for <code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>.
- <var>Url-path</var> is a (%-escaped) relative URL to the icon.</p>
+ <var>Url-path</var> is a (%-escaped) relative URL to the icon,
+ or a fully qualified remote URL.</p>
+
+ <pre class="prettyprint lang-config">DefaultIcon /icon/unknown.png</pre>
- <div class="example"><h3>Example</h3><p><code>
- DefaultIcon /icon/unknown.xbm
- </code></p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
of the file that will be inserted at the top of the index
listing. <var>Filename</var> is the name of the file to include.</p>
- <div class="example"><h3>Example</h3><p><code>
- HeaderName HEADER.html
- </code></p></div>
+ <pre class="prettyprint lang-config">HeaderName HEADER.html</pre>
+
<div class="note">
<p>Both HeaderName and <code class="directive"><a href="#readmename">ReadmeName</a></code> now treat
access the directory being indexed. If <var>Filename</var> begins
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>
- <div class="example"><h3>Example</h3><p><code>
- HeaderName /include/HEADER.html
- </code></p></div>
+ <pre class="prettyprint lang-config">HeaderName /include/HEADER.html</pre>
+
<p><var>Filename</var> must resolve to a document with a major
content type of <code>text/*</code> (<em>e.g.</em>,
actual file type (as opposed to its output) is marked as
<code>text/html</code> such as with a directive like:</p>
- <div class="example"><p><code>
- AddType text/html .cgi
- </code></p></div>
+ <pre class="prettyprint lang-config">AddType text/html .cgi</pre>
+
<p><a href="../content-negotiation.html">Content negotiation</a>
will be performed if <code class="directive"><a href="../mod/core.html#options">Options</a></code>
+SuppressHTMLPreamble</code></a>, so that these tags are not
repeated.</p>
+<h3>See also</h3>
+<ul>
+<li><code class="directive"><a href="#readmename">ReadmeName</a></code></li>
+</ul>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="IndexHeadInsert" id="IndexHeadInsert">IndexHeadInsert</a> <a name="indexheadinsert" id="indexheadinsert">Directive</a></h2>
<p>The <code class="directive">IndexHeadInsert</code> directive specifies a
string to insert in the <var><head></var> section of the HTML
generated for the index page.</p>
- <div class="example"><h3>Example</h3><p><code>
-
- IndexHeadInsert "<link rel=\"sitemap\" href=\"/sitemap.html\">"
- </code></p></div>
+ <pre class="prettyprint lang-config">IndexHeadInsert "<link rel=\"sitemap\" href=\"/sitemap.html\">"</pre>
+
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Adds to the list of files to hide when listing
a directory</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>IndexIgnore <var>file</var> [<var>file</var>] ...</code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>IndexIgnore "."</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
list of files to hide when listing a directory. <var>File</var> is a
shell-style wildcard expression or full
filename. Multiple IndexIgnore directives add
- to the list, rather than the replacing the list of ignored
+ to the list, rather than replacing the list of ignored
files. By default, the list contains <code>.</code> (the current
directory).</p>
- <div class="example"><p><code>
- IndexIgnore README .htaccess *.bak *~
- </code></p></div>
+ <pre class="prettyprint lang-config">IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t</pre>
+
+
+ <div class="note"><h3>Regular Expressions</h3>
+ <p>This directive does not currently work in configuration sections
+ that have regular expression arguments, such as <code class="directive"><a href="../mod/core.html#directorymatch"><DirectoryMatch></a></code>
+ </p>
+ </div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="IndexIgnoreReset" id="IndexIgnoreReset">IndexIgnoreReset</a> <a name="indexignorereset" id="indexignorereset">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Empties the list of files to hide when listing
+a directory</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>IndexIgnoreReset ON|OFF</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
+<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autoindex</td></tr>
+<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.3.10 and later</td></tr>
+</table>
+ <p>The <code class="directive">IndexIgnoreReset</code> directive removes
+ any files ignored by <code class="directive">IndexIgnore</code> otherwise
+ inherited from other configuration sections. </p>
+
+ <pre class="prettyprint lang-config"><Directory "/var/www">
+ IndexIgnore *.bak .??* *~ *# HEADER* README* RCS CVS *,v *,t
+</Directory>
+<Directory "/var/www/backups">
+ IndexIgnoreReset ON
+ IndexIgnore .??* *# HEADER* README* RCS CVS *,v *,t
+</Directory></pre>
+
+
+ <div class="warning"><p> Review the default configuration for a list of
+ patterns that you might want to explicitly ignore after using this
+ directive.</p></div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
indexing</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>IndexOptions [+|-]<var>option</var> [[+|-]<var>option</var>]
...</code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>By default, no options are enabled.</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Indexes</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
<dl>
<dt><a name="indexoptions.addaltclass" id="indexoptions.addaltclass">AddAltClass</a></dt>
<dd>Adds an additional CSS class declaration to each row of the
- directory listing table when <code>IndexOptions HTMLTable</code>
+ directory listing table when <code>IndexOptions HTMLTable</code>
is in effect and an <code>IndexStyleSheet</code> is defined.
Rather than the standard <code>even</code> and <code>odd</code>
classes that would otherwise be applied to each row of the table,
<dd>The <code>Charset</code> keyword allows you to
specify the character set of the generated page. The
- default is either <var>ISO-8859-1</var> or <var>UTF-8</var>,
- depending on whether the underlying file system is unicode
- or not.
+ default is <code>UTF-8</code> on Windows and Mac OS X,
+ and <code>ISO-8859-1</code> elsewhere.
+ (It depends on whether the underlying file system
+ uses Unicode filenames or not.)
+
+ <pre class="prettyprint lang-config">IndexOptions Charset=UTF-8</pre>
- <div class="example"><h3>Example:</h3><p><code>
- IndexOptions Charset=UTF-8
- </code></p></div>
</dd>
- <dt><a name="indexoptions.descriptionwidth" id="indexoptions.descriptionwidth">DescriptionWidth=[<var>n</var> | *]</a> (<em>Apache HTTP Server 2.0.23 and
- later</em>)</dt>
+ <dt><a name="indexoptions.descriptionwidth" id="indexoptions.descriptionwidth">DescriptionWidth=[<var>n</var> | *]</a></dt>
<dd>The <code>DescriptionWidth</code> keyword allows you to
specify the width of the description column in
characters.</dd>
- <dd><code>-DescriptionWidth</code> (or unset) allows
- <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> to calculate the best width.</dd>
+ <dt><code>-DescriptionWidth</code> (or unset) allows
+ <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> to calculate the best width.</dt>
<dd><code>DescriptionWidth=<var>n</var></code> fixes the column width to
<var>n</var> bytes wide.</dd>
<dd><code>DescriptionWidth=*</code> grows the column to the
width necessary to accommodate the longest description
- string.</dd>
+ string.
- <
dd><strong>See the section on <code class="directive"><a href="#adddescription">AddDescription</a></code> for dangers
+ <strong>See the section on <code class="directive"><a href="#adddescription">AddDescription</a></code> for dangers
inherent in truncating descriptions.</strong></dd>
<dt><a name="indexoptions.fancyindexing" id="indexoptions.fancyindexing">FancyIndexing</a></dt>
<dd>This turns on fancy indexing of directories.</dd>
- <dt><a name="indexoptions.foldersfirst" id="indexoptions.foldersfirst">FoldersFirst</a> (<em>Apache HTTP Server
- 2.0.23 and later</em>)</dt>
+ <dt><a name="indexoptions.foldersfirst" id="indexoptions.foldersfirst">FoldersFirst</a></dt>
<dd>If this option is enabled, subdirectory listings will
<em>always</em> appear first, followed by normal files in the
<code>FoldersFirst</code> is enabled, subdirectory
<code>Zed</code> will be listed before subdirectory
<code>Beta</code>, which will be listed before normal files
- <code>Gamma</code> and <code>Alpha</code>. <strong>This option
- only has an effect if <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a> is also enabled.</strong></dd>
+ <code>Gamma</code> and <code>Alpha</code>.
+ <strong>This option only has an effect if <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a>
+ is also enabled.</strong>
+ </dd>
- <dt><a name="indexoptions.htmltable" id="indexoptions.htmltable">HTMLTable</a> (<em>Experimental,
- Apache HTTP Server 2.0.23 and later</em>)</dt>
+ <dt><a name="indexoptions.htmltable" id="indexoptions.htmltable">HTMLTable</a></dt>
- <dd>This experimental option with <code>FancyIndexing</code> constructs
- a simple table for the fancy directory listing. Note this will
- confuse older browsers. It is particularly necessary if file
+ <dd>This option with <code>FancyIndexing</code> constructs
+ a simple table for the fancy directory listing.
+ It is necessary for utf-8 enabled platforms or if file
names or description text will alternate between
- left-to-right and right-to-left reading order, as can happen
- on WinNT or other utf-8 enabled platforms.</dd>
+ left-to-right and right-to-left reading order.</dd>
<dt><a name="indexoptions.iconsarelinks" id="indexoptions.iconsarelinks">IconsAreLinks</a></dt>
icon. This allows browser to precalculate the page layout without having
to wait until all the images have been loaded. If no value is given for
the option, it defaults to the standard height of the icons supplied
- with the Apache httpd software.</dd>
+ with the Apache httpd software.
+
+ <strong>This option
+ only has an effect if <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a> is also enabled.</strong>
+
+ </dd>
<dt><a name="indexoptions.iconwidth" id="indexoptions.iconwidth">IconWidth[=<var>pixels</var>]</a></dt>
FancyIndexed directory listing into links for sorting. The
default behavior is for them to be links; selecting the
column heading will sort the directory listing by the values
- in that column. <strong>Prior to Apache HTTP Server 2.0.23, this also
- disabled parsing the Query Arguments for the sort
- string.</strong> That behavior is now controlled by <a href="#indexoptions.ignoreclient"><code>IndexOptions
- IgnoreClient</code></a> in Apache HTTP Server 2.0.23.</dd>
+ in that column. However, query string arguments which are appended
+ to the URL will still be honored. That behavior is controlled by <a href="#indexoptions.ignoreclient"><code>IndexOptions
+ IgnoreClient</code></a>.</dd>
<dt><a name="indexoptions.suppressdescription" id="indexoptions.suppressdescription">SuppressDescription</a></dt>
so the use of this option will regain 23 characters of screen
space to use for something else. See <code class="directive"><a href="#adddescription">AddDescription</a></code> for information about setting the file
description. See also the <code><a href="#indexoptions.descriptionwidth">DescriptionWidth</a></code>
- index option to limit the size of the description column.</dd>
+ index option to limit the size of the description column.
+
+ <strong>This option
+ only has an effect if <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a> is also enabled.</strong>
+ </dd>
<dt><a name="indexoptions.suppresshtmlpreamble" id="indexoptions.suppresshtmlpreamble">SuppressHTMLPreamble</a></dt>
causing the module to start the display with the header file
contents. The header file must contain appropriate HTML instructions
in this case. If there is no header file, the preamble is generated
- as usual.</dd>
+ as usual. If you also specify a <code class="directive"><a href="#readmename">ReadmeName</a></code>, and if that file
+ exists, The closing </body></html> tags are also
+ ommitted from the output, under the assumption that you'll likely
+ put those closing tags in that file.</dd>
- <dt><a name="indexoptions.suppressicon" id="indexoptions.suppressicon">SuppressIcon</a> (<em>Apache HTTP Server
- 2.0.23 and later</em>)</dt>
+ <dt><a name="indexoptions.suppressicon" id="indexoptions.suppressicon">SuppressIcon</a></dt>
<dd>This will suppress the icon in fancy indexing listings.
Combining both <code>SuppressIcon</code> and
<dt><a name="indexoptions.suppresslastmodified" id="indexoptions.suppresslastmodified">SuppressLastModified</a></dt>
<dd>This will suppress the display of the last modification date,
- in fancy indexing listings.</dd>
+ in fancy indexing listings.
+
+ <strong>This option
+ only has an effect if <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a> is also enabled.</strong>
+ </dd>
<dt><a name="indexoptions.suppressrules" id="indexoptions.suppressrules">SuppressRules</a>
- (<em>Apache HTTP Server 2.0.23 and later</em>)</dt>
+ </dt>
<dd>This will suppress the horizontal rule lines (<code>hr</code>
elements) in directory listings. Combining both <code>SuppressIcon</code> and
<code>SuppressRules</code> yields proper HTML 3.2 output, which
by the final specification prohibits <code>img</code> and
<code>hr</code> elements from the <code>pre</code> block (used to
- format FancyIndexed listings.)</dd>
+ format FancyIndexed listings.)
+
+ <strong>This option
+ only has an effect if <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a> is also enabled.</strong>
+
+ </dd>
<dt><a name="indexoptions.suppresssize" id="indexoptions.suppresssize">SuppressSize</a></dt>
- <dd>This will suppress the file size in fancy indexing listings.</dd>
+ <dd>This will suppress the file size in fancy indexing listings.
+
+ <strong>This option
+ only has an effect if <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a> is also enabled.</strong>
+ </dd>
- <dt><a name="indexoptions.trackmodified" id="indexoptions.trackmodified">TrackModified</a> (<em>Apache HTTP Server
- 2.0.23 and later</em>)</dt>
+ <dt><a name="indexoptions.trackmodified" id="indexoptions.trackmodified">TrackModified</a></dt>
<dd>This returns the <code>Last-Modified</code> and <code>ETag</code>
values for the listed directory in the HTTP header. It is only valid
specify the MIME content-type of the generated page. The default
is <var>text/html</var>.
- <div class="example"><h3>Example:</h3><p><code>
- IndexOptions Type=text/plain
- </code></p></div>
+ <pre class="prettyprint lang-config">IndexOptions Type=text/plain</pre>
+
</dd>
<dt><a name="indexoptions.versionsort" id="indexoptions.versionsort">VersionSort</a>
(<em>Apache HTTP Server 2.0.49 and later</em>)</dt>
<dd>The <code>XHTML</code> keyword forces <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code>
- to emit XHTML 1.0 code instead of HTML 3.2.</dd>
+ to emit XHTML 1.0 code instead of HTML 3.2.
+ <strong>This option
+ only has an effect if <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a> is also enabled.</strong>
+ </dd>
</dl>
+
<dl><dt>Incremental IndexOptions</dt>
<dd>
- <p>Apache httpd 1.3.3 introduced some significant changes in the
- handling of <code class="directive">IndexOptions</code> directives. In
- particular:</p>
+ <p>Be aware of how multiple <code class="directive">IndexOptions</code> are
+ handled.</p>
<ul>
<li>Multiple <code class="directive">IndexOptions</code> directives for a
single directory are now merged together. The result of:
- <div class="example"><p><code>
- <Directory /foo>
- <span class="indent">
- IndexOptions HTMLTable<br />
- IndexOptions SuppressColumnsorting
- </span>
- </Directory>
- </code></p></div>
+ <pre class="prettyprint lang-config"><Directory "/foo">
+ IndexOptions HTMLTable
+ IndexOptions SuppressColumnsorting
+</Directory></pre>
+
<p>will be the equivalent of</p>
- <div class="example"><p><code>
- IndexOptions HTMLTable SuppressColumnsorting
- </code></p></div>
+ <pre class="prettyprint lang-config">IndexOptions HTMLTable SuppressColumnsorting</pre>
+
</li>
<li>The addition of the incremental syntax (<em>i.e.</em>, prefixing
clears all inherited options and any incremental settings encountered
so far. Consider the following example:</p>
- <div class="example"><p><code>
- IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing<br />
- IndexOptions +SuppressSize
- </code></p></div>
+ <pre class="prettyprint lang-config">IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing<br />
+IndexOptions +SuppressSize</pre>
+
<p>The net effect is equivalent to <code>IndexOptions FancyIndexing
+SuppressSize</code>, because the unprefixed <code>FancyIndexing</code>
and identifies the primary key. The secondary key is
<em>always</em> the ascending filename.</p>
- <p>You can force a directory listing to only be displayed in a
- particular order by combining this directive with the <code><a href="#indexoptions.suppresscolumnsorting">SuppressColumnSorting</a></code> index option; this will prevent
- the client from requesting the directory listing in a different
- order.</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>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<p>The <code class="directive">IndexStyleSheet</code> directive sets the name of
the file that will be used as the CSS for the index listing.
</p>
- <div class="example"><h3>Example</h3><p><code>
-
- IndexStyleSheet "/css/style.css"
- </code></p></div>
+ <pre class="prettyprint lang-config">IndexStyleSheet "/css/style.css"</pre>
+
<p>Using this directive in conjunction with <code>IndexOptions
HTMLTable</code> adds a number of CSS classes to the resulting HTML.
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>
+ <table class="bordered"><tr class="header"><th>Class</th><th>Definition</th></tr>
+<tr><td>tr.indexhead</td><td>Header row of listing</td></tr>
+<tr class="odd"><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 class="odd"><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 class="odd"><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 class="odd"><td>tr.odd and tr.even</td> <td>Alternating even and odd rows</td></tr>
+</table>
</div>
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
+ <var>Filename</var> begins with a slash, as in example 2, it will be taken to be
relative to the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>.
</p>
- <div class="example"><h3>Example</h3><p><code>
- ReadmeName FOOTER.html
- </code></p></div>
+ <pre class="prettyprint lang-config"># Example 1
+ReadmeName FOOTER.html</pre>
+
+
+ <pre class="prettyprint lang-config"># Example 2
+ReadmeName /include/FOOTER.html</pre>
- <div class="example"><h3>Example 2</h3><p><code>
- ReadmeName /include/FOOTER.html
- </code></p></div>
<p>See also <code class="directive"><a href="#headername">HeaderName</a></code>, where this behavior is described in greater
detail.</p>
<a href="../ja/mod/mod_autoindex.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="../ko/mod/mod_autoindex.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
<a href="../tr/mod/mod_autoindex.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
-</div><div id="footer">
-<p class="apache">Copyright 2010 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
-<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>
+</div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
+<script type="text/javascript"><!--//--><![CDATA[//><!--
+var comments_shortname = 'httpd';
+var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_autoindex.html';
+(function(w, d) {
+ if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
+ d.write('<div id="comments_thread"><\/div>');
+ var s = d.createElement('script');
+ s.type = 'text/javascript';
+ s.async = true;
+ s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
+ (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
+ }
+ else {
+ d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
+ }
+})(window, document);
+//--><!]]></script></div><div id="footer">
+<p class="apache">Copyright 2016 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
+if (typeof(prettyPrint) !== 'undefined') {
+ prettyPrint();
+}
+//--><!]]></script>
</body></html>
\ No newline at end of file
projects / apache / blobdiff