<?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 rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
-<script src="../style/scripts/prettify.js" type="text/javascript">
+<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="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.gif" /></div>
+<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.5</a> > <a href="./">Modules</a></div>
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><a href="#indexoptions.suppresscolumnsorting">SuppressColumnSorting</a></code>
+ <code><a href="#indexoptions.suppresscolumnsorting">SuppressColumnSorting</a></code>
option.</p>
<p>Note that when the display is sorted by "Size", it's 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="#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>
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" mars.gif <br />
- AddDescription "My friend Marshall" friends/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
<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
+ which would normally only be used in htaccess context, are implicitly
prefixed with '*/' to avoid matching partial directory names.</p>
</div>
is unnecessary if you're using <code>IndexOptions
HTMLTable</code>.</p>
- <div class="example"><h3>Examples</h3><p><code>
- AddIcon (IMG,/icons/image.png) .gif .jpg .png<br />
- AddIcon /icons/dir.png ^^DIRECTORY^^<br />
- AddIcon /icons/backup.png *~
- </code></p></div>
+ <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>,
<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.png 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><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.png) 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>
<var>Url-path</var> is a (%-escaped) relative URL to the icon,
or a fully qualified remote URL.</p>
- <div class="example"><h3>Example</h3><p><code>
- DefaultIcon /icon/unknown.png
- </code></p></div>
+ <pre class="prettyprint lang-config">DefaultIcon /icon/unknown.png</pre>
+
</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>
<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>
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 .??* *~ *# HEADER* README* RCS CVS *,v *,t
- </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
any files ignored by <code class="directive">IndexIgnore</code> otherwise
inherited from other configuration sections. </p>
- <div class="example"><p><code>
- <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>
- </code></p></div>
+ <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
(It depends on whether the underlying file system
uses Unicode filenames or not.)
- <div class="example"><h3>Example:</h3><p><code>
- IndexOptions Charset=UTF-8
- </code></p></div>
+ <pre class="prettyprint lang-config">IndexOptions Charset=UTF-8</pre>
+
</dd>
<dt><a name="indexoptions.descriptionwidth" id="indexoptions.descriptionwidth">DescriptionWidth=[<var>n</var> | *]</a></dt>
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>
<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></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>
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>
<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>
</dt>
<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></dt>
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>
<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>
<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.
relative to the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>.
</p>
- <div class="example"><h3>Example 1</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 2012 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><script type="text/javascript">
- if (typeof(prettyPrint) !== undefined) {
- prettyPrint();
+</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);
}
-</script>
+ 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