><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
This sets the alternate text to display for a file, instead of an icon, for
<
A HREF="#fancyindexing">FancyIndexing</
A>. <
EM>File</
EM> is a file
extension, partial filename, wild-card expression or full filename for files
to describe. <
EM>String</
EM> is enclosed in double quotes
(<
CODE>"</
CODE>). This alternate text is displayed if the client is
image-incapable or has image loading disabled.
<
H2><
A NAME="addaltbyencoding">AddAltByEncoding</
A></
H2>
<!--%plaintext <?INDEX {\tt AddAltByEncoding} directive> --> ><
STRONG>Syntax:</
STRONG></
A> AddAltByEncoding <
EM>string MIME-encoding
MIME-encoding...</
EM><
BR>
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
This sets the alternate text to display for a file, instead of an icon, for
<
A HREF="#fancyindexing">FancyIndexing</
A>. <
EM>MIME-encoding</
EM> is a
valid content-encoding, such as <
SAMP>x-compress</
SAMP>.
<
EM>String</
EM> is enclosed in double quotes
(<
CODE>"</
CODE>). This alternate text is displayed if the client is
image-incapable or has image loading disabled.
<
H2><
A NAME="addaltbytype">AddAltByType</
A></
H2>
<!--%plaintext <?INDEX {\tt AddAltByType} directive> --> ><
STRONG>Syntax:</
STRONG></
A> AddAltByType <
EM>string MIME-type MIME-type
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
This sets the alternate text to display for a file, instead of an icon, for
<
A HREF="#fancyindexing">FancyIndexing</
A>. <
EM>MIME-type</
EM> is a
valid content-type, such as <
SAMP>
text/
html</
SAMP>.
<
EM>String</
EM> is enclosed in double quotes
(<
CODE>"</
CODE>). This alternate text is displayed if the client is
image-incapable or has image loading disabled.
<
H2><
A NAME="adddescription">AddDescription</
A></
H2>
<!--%plaintext <?INDEX {\tt AddDescription} directive> --> ><
STRONG>Syntax:</
STRONG></
A> AddDescription <
EM>string file file...</
EM><
BR>
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
This sets the description to display for a file, for
<
A HREF="#fancyindexing">FancyIndexing</
A>. <
EM>File</
EM> is a file
extension, partial filename, wild-card expression or full filename for files
to describe. <
EM>String</
EM> is enclosed in double quotes
(<
CODE>"</
CODE>). Example:
The description field is 23 bytes wide. 7 more bytes may be
added if the directory is covered by an
<
CODE>IndexOptions SuppressSize</
CODE>, and 19 bytes may be
added if <
CODE>IndexOptions SuppressLastModified</
CODE> is
in effect. The widest this column can be is therefore 49 bytes.
<
H2><
A NAME="addicon">AddIcon</
A></
H2>
<!--%plaintext <?INDEX {\tt AddIcon} directive> --> ><
STRONG>Syntax:</
STRONG></
A> AddIcon <
EM>icon name name ...</
EM><
BR>
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
This sets the icon to display next to a file ending in <
EM>name</
EM> for
<
A HREF="#fancyindexing">FancyIndexing</
A>. <
EM>Icon</
EM> is either a
(%-escaped) relative URL to the icon, or of the format
(<
EM>alttext</
EM>,<
EM>url</
EM>) where <
EM>alttext</
EM> is the text tag given
for an icon for non-graphical browsers.<
P>
<
EM>Name</
EM> is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ for
blank lines (to format the list correctly), a file extension, a wildcard
expression, a partial filename or a complete filename. Examples:
<
A HREF="#addiconbytype">AddIconByType</
A> should be used in preference to
AddIcon, when possible.<
P><
HR>
<
H2><
A NAME="addiconbyencoding">AddIconByEncoding</
A></
H2>
<!--%plaintext <?INDEX {\tt AddIconByEncoding} directive> --> ><
STRONG>Syntax:</
STRONG></
A> AddIconByEncoding <
EM>icon MIME-encoding
MIME-encoding ...</
EM><
BR>
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
This sets the icon to display next to files with
<
EM>MIME-encoding</
EM> for <
A HREF="#fancyindexing">FancyIndexing</
A>.
<
EM>Icon</
EM> is either a (%-escaped) relative URL to the icon, or of the
format (<
EM>alttext</
EM>,<
EM>url</
EM>) where <
EM>alttext</
EM> is the text tag
given for an icon for non-graphical browsers.<
P>
<
EM>Mime-encoding</
EM> is a wildcard expression matching required the
content-encoding. Examples:
</
CODE></
BLOCKQUOTE><
P><
HR>
<
H2><
A NAME="addiconbytype">AddIconByType</
A></
H2>
<!--%plaintext <?INDEX {\tt AddIconByType} directive> --> ><
STRONG>Syntax:</
STRONG></
A> AddIconByType <
EM>icon MIME-type MIME-type
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
This sets the icon to display next to files of type <
EM>MIME-type</
EM> for
<
A HREF="#fancyindexing">FancyIndexing</
A>. <
EM>Icon</
EM> is either a
(%-escaped) relative URL to the icon, or of the format
(<
EM>alttext</
EM>,<
EM>url</
EM>) where <
EM>alttext</
EM> is the text tag given
for an icon for non-graphical browsers.<
P>
<
EM>Mime-type</
EM> is a wildcard expression matching required the mime types.
</
CODE></
BLOCKQUOTE><
P><
HR>
<
H2><
A NAME="defaulticon">DefaultIcon</
A></
H2>
<!--%plaintext <?INDEX {\tt DefaultIcon} directive> --> ><
STRONG>Syntax:</
STRONG></
A> DefaultIcon <
EM>url</
EM><
BR>
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
The DefaultIcon directive sets the icon to display for files when no
specific icon is known, for <
A HREF="#fancyindexing">FancyIndexing</
A>.
<
EM>Url</
EM> is a (%-escaped) relative URL to the icon. Examples:
</
CODE></
BLOCKQUOTE><
P><
HR>
<
H2><
A NAME="fancyindexing">FancyIndexing</
A></
H2>
<!--%plaintext <?INDEX {\tt FancyIndexing} directive> --> ><
STRONG>Syntax:</
STRONG></
A> FancyIndexing <
EM>boolean</
EM><
BR>
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex
The FancyIndexing directive sets the FancyIndexing option for a directory.
<
EM>Boolean</
EM> can be <
CODE>on</
CODE> or <
CODE>off</
CODE>. The
<
A HREF="#indexoptions">IndexOptions</
A> directive should be used in
<
STRONG>Note that in versions of Apache prior to 1.3.2, the
<
SAMP>FancyIndexing</
SAMP> and
<
SAMP>IndexOptions</
SAMP> directives will override each other. You
should use <
SAMP>IndexOptions FancyIndexing</
SAMP> in preference
to the standalone <
SAMP>FancyIndexing</
SAMP> directive.
As of Apache 1.3.2, a standalone <
SAMP>FancyIndexing</
SAMP> directive
is combined with any <
SAMP>IndexOptions</
SAMP> directive already
specified for the current scope.</
STRONG>
<
H2><
A NAME="headername">HeaderName</
A></
H2>
<!--%plaintext <?INDEX {\tt HeaderName} directive> --> ><
STRONG>Syntax:</
STRONG></
A> HeaderName <
EM>filename</
EM><
BR>
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
The HeaderName directive sets the name of the file that will be inserted
at the top of the index listing. <
EM>Filename</
EM> is the name of the file
to include, and is taken to be relative to the directory being indexed.
The server first attempts to include <
EM>filename</
EM><
CODE>.html</
CODE>
as an HTML document, otherwise it will include <
EM>filename</
EM> as plain
<
BLOCKQUOTE><
CODE>HeaderName HEADER</
CODE></
BLOCKQUOTE>
when indexing the directory <
CODE>/web</
CODE>, the server will first look for
the HTML file <
CODE>/
web/
HEADER.html</
CODE> and include it if found, otherwise
it will include the plain text file <
CODE>/
web/
HEADER</
CODE>, if it exists.
<
P>See also <
A HREF="#readmename">ReadmeName</
A>.<
P><
HR>
<
H2><
A NAME="indexignore">IndexIgnore</
A></
H2>
<!--%plaintext <?INDEX {\tt IndexIgnore} directive> --> ><
STRONG>Syntax:</
STRONG></
A> IndexIgnore <
EM>file file ...</
EM><
BR>
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
The IndexIgnore directive adds to the list of files to hide when listing
a directory. <
EM>File</
EM> is a file extension, partial filename,
wildcard expression or full filename for files to ignore. Multiple
IndexIgnore directives add to the list, rather than the replacing the list
of ignored files. By default, the list contains `<
CODE>.</
CODE>'. Example:
IndexIgnore README .htaccess *~
</
CODE></
BLOCKQUOTE><
P><
HR>
<
H2><
A NAME="indexoptions">IndexOptions</
A></
H2>
<!--%plaintext <?INDEX {\tt IndexOptions} directive> --> ><
STRONG>Syntax:</
STRONG></
A> IndexOptions <
EM>option option ...</
EM>
(Apache 1.3.2 and earlier)
><
STRONG>Syntax:</
STRONG></
A> IndexOptions <
EM>[+|-]option [+|-]option
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex
><
STRONG>Compatibility:</
STRONG></
A> '+/-' syntax and merging of multiple
<
SAMP>IndexOptions</
SAMP> directives is only available with
The IndexOptions directive specifies the behavior of the directory indexing.
<
EM>Option</
EM> can be one of
<
DT><
A NAME="indexoptions:fancyindexing">FancyIndexing</
A>
<
DD>
<!--%plaintext <?INDEX {\tt FancyIndexing} index option> -->This turns on fancy indexing of directories.
<
STRONG>Note that in versions of Apache prior to 1.3.2, the
<
SAMP>FancyIndexing</
SAMP> and
<
SAMP>IndexOptions</
SAMP> directives will override each other. You
should use <
SAMP>IndexOptions FancyIndexing</
SAMP> in preference
to the standalone <
SAMP>FancyIndexing</
SAMP> directive.
As of Apache 1.3.2, a standalone <
SAMP>FancyIndexing</
SAMP> directive
is combined with any <
SAMP>IndexOptions</
SAMP> directive already
specified for the current scope.</
STRONG>
<
DT><
A NAME="indexoptions:iconheight">IconHeight[=pixels] (<
EM>Apache 1.3 and later</
EM>)</
A>
<!--%plaintext <?INDEX {\tt IconHeight} index option> --> Presence of this option, when used with IconWidth, will cause the server
to include <
SAMP>HEIGHT</
SAMP> and <
SAMP>WIDTH</
SAMP> attributes in the
<
SAMP>IMG</
SAMP> tag for the file 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
<
DT><
A NAME="indexoptions:iconsarelinks">IconsAreLinks</
A>
<!--%plaintext <?INDEX {\tt IconsAreLinks} index option> --> This makes the icons part of the anchor for the filename, for
<
DT><
A NAME="indexoptions:iconwidth">IconWidth[=pixels] (<
EM>Apache 1.3 and later</
EM>)</
A>
<!--%plaintext <?INDEX {\tt IconWidth} index option> --> Presence of this option, when used with IconHeight, will cause the server
to include <
SAMP>HEIGHT</
SAMP> and <
SAMP>WIDTH</
SAMP> attributes in the
<
SAMP>IMG</
SAMP> tag for the file 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 width of the icons supplied with the Apache
<
DT><
A NAME="indexoptions:namewidth">NameWidth=[<
EM>n</
EM> | *] (<
EM>Apache 1.3.2 and later</
EM>)</
A>
The NameWidth keyword allows you to specify the width of the
filename column in bytes. If the keyword value is '<
SAMP>*</
SAMP>',
then the column is automatically sized to the length of the longest
<
DT><
A NAME="indexoptions:scanhtmltitles">ScanHTMLTitles</
A>
<
DD>
<!--%plaintext <?INDEX {\tt ScanHTMLTitles} index option> -->This enables the extraction of the title from HTML documents for fancy
indexing. If the file does not have a description given by
<
A HREF="#adddescription">AddDescription</
A> then httpd will read the
document for the value of the TITLE tag. This is CPU and disk intensive.
<
DT><
A NAME="indexoptions:suppresscolumnsorting">SuppressColumnSorting</
A>
<!--%plaintext <?INDEX {\tt SuppressColumnSorting} index option> --> If specified, Apache will not make the column headings in a FancyIndexed
directory listing into links for sorting. The default behaviour is
for them to be links; selecting the column heading will sort the directory
listing by the values in that column.
<
STRONG>Only available in Apache 1.3 and later.</
STRONG>
<
DT><
A NAME="indexoptions:suppressdescription">SuppressDescription</
A>
<!--%plaintext <?INDEX {\tt SuppressDescription} index option> --> This will suppress the file description in fancy indexing listings.
<
DT><
A NAME="indexoptions:suppresshtmlpreamble">SuppressHTMLPreamble</
A>
(<
EM>Apache 1.3 and later</
EM>)
<!--%plaintext <?INDEX {\tt SuppressHTMLPreamble} index option> --> If the directory actually contains a file specified by the
directive, the module usually includes the contents of the file
after a standard HTML preamble (<HTML>, <HEAD>, <
EM>et
cetera</
EM>). The SuppressHTMLPreamble option disables this behaviour,
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.
<
DT><
A NAME="indexoptions:suppresslastmodified">SuppressLastModified</
A>
<!--%plaintext <?INDEX {\tt SuppressLastModified} index option> --> This will suppress the display of the last modification date, in fancy
<
DT><
A NAME="indexoptions:suppresssize">SuppressSize</
A>
<!--%plaintext <?INDEX {\tt SuppressSize} index option> --> This will suppress the file size in fancy indexing listings.
There are some noticeable differences in the behaviour of this
directive in recent (post-1.3.0) versions of Apache.
<
DT>Apache 1.3.2 and earlier:</
DT>
The default is that no options are enabled. If multiple IndexOptions
could apply to a directory, then the most specific one is taken complete;
the options are not merged. For example:
IndexOptions FancyIndexing <
BR>
IndexOptions ScanHTMLTitles <
BR>
then only <
CODE>ScanHTMLTitles</
CODE> will be set for the /
web/
docs/
spec<
DT>Apache 1.3.3 and later:</
DT>
Apache 1.3.3 introduced some significant changes in the handling of
<
SAMP>IndexOptions</
SAMP> directives. In particular,
<
LI>Multiple <
SAMP>IndexOptions</
SAMP> directives for a single
directory are now merged together. The result of the example above
will now be the equivalent of
<
CODE>IndexOptions FancyIndexing ScanHTMLTitles</
CODE>.
<
LI>The addition of the incremental syntax (<
EM>
i.e.</
EM>, prefixing
keywords with '+' or '-').
Whenever a '+' or '-' prefixed keyword is encountered, it is applied
to the current <
SAMP>IndexOptions</
SAMP> settings (which may have been
inherited from an upper-level directory). However, whenever an unprefixed
keyword is processed, it clears all inherited options and any incremental
settings encountered so far. Consider the following example:
<
BLOCKQUOTE><
CODE>IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
IndexOptions +SuppressSize
The net effect is equivalent to
<
CODE>IndexOptions FancyIndexing +SuppressSize</
CODE>, because
the unprefixed <
CODE>FancyIndexing</
CODE> discarded the incremental
keywords before it, but allowed them to start accumulating again
To unconditionally set the <
CODE>IndexOptions</
CODE> for a
particular directory, clearing the inherited settings, specify
keywords without either '+' or '-' prefixes.
<
H2><
A NAME="readmename">ReadmeName</
A></
H2>
<!--%plaintext <?INDEX {\tt ReadmeName} directive> --> ><
STRONG>Syntax:</
STRONG></
A> ReadmeName <
EM>filename</
EM><
BR>
><
STRONG>Context:</
STRONG></
A> server config, virtual host, directory,
><
STRONG>Override:</
STRONG></
A> Indexes<
BR>
><
STRONG>Status:</
STRONG></
A> Base<
BR>
><
STRONG>Module:</
STRONG></
A> mod_autoindex<
P>
The ReadmeName directive sets the name of the file that will be appended
to the end of the index listing. <
EM>Filename</
EM> is the name of the file
to include, and is taken to be relative to the directory being indexed.
The server first attempts to include <
EM>filename</
EM><
CODE>.html</
CODE>
as an HTML document, otherwise it will include <
EM>filename</
EM> as plain
<
BLOCKQUOTE><
CODE>ReadmeName README</
CODE></
BLOCKQUOTE>
when indexing the directory <
CODE>/web</
CODE>, the server will first look for
the HTML file <
CODE>/
web/
README.html</
CODE> and include it if found, otherwise
it will include the plain text file <
CODE>/
web/
README</
CODE>, if it exists.
<
P>See also <
A HREF="#headername">HeaderName</
A>.<
P>
