Apache HTTP Server Version 1.3

Module mod_autoindex

Summary

• A file written by the user, typically called index.html.The DirectoryIndex directive setsthe name of this file.This is controlled by mod_dir.
• Otherwise, a listing generated by the server. The other directivescontrol the format of this listing. The AddIcon,AddIconByEncoding andAddIconByType are used to set a list oficons to display for various file types; for each file listed, thefirst icon listed that matches the file is displayed. Theseare controlled by mod_autoindex.

IfFancyIndexingis enabled, or the FancyIndexing keyword is present on theIndexOptionsdirective, the column headers are links that control theorder of the display. If you select a header link, thelisting will be regenerated, sorted by the values in thatcolumn. Selecting the same header repeatedly togglesbetween ascending and descending order.

Note that when the display is sorted by "Size",it's the actual size of the files that's used,not the displayed value - so a 1010-byte file willalways be displayed before a 1011-byte file (if in ascendingorder) even though they both are shown as "1K".

Directives

AddAlt

This sets the alternate text to display for a file, instead of an icon, forFancyIndexing. File is a fileextension, partial filename, wild-card expression or full filename for filesto describe. String is enclosed in double quotes("). This alternate text is displayed if the client isimage-incapable or has image loading disabled.

AddAltByEncoding

This sets the alternate text to display for a file, instead of an icon, forFancyIndexing. MIME-encoding is avalid content-encoding, such as x-compress.String is enclosed in double quotes("). This alternate text is displayed if the client isimage-incapable or has image loading disabled.

AddAltByType

This sets the alternate text to display for a file, instead of an icon, forFancyIndexing. MIME-type is avalid content-type, such as text/html.String is enclosed in double quotes("). This alternate text is displayed if the client isimage-incapable or has image loading disabled.

AddDescription

This sets the description to display for a file, forFancyIndexing. File is a fileextension, partial filename, wild-card expression or full filename for filesto describe. String is enclosed in double quotes("). Example:

AddDescription "The planet Mars" /web/pics/mars.gif

AddIcon

This sets the icon to display next to a file ending in name forFancyIndexing. Icon is either a(%-escaped) relative URL to the icon, or of the format(alttext,url) where alttext is the text tag givenfor an icon for non-graphical browsers.

Name is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ forblank lines (to format the list correctly), a file extension, a wildcardexpression, a partial filename or a complete filename. Examples:

AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm
AddIcon /icons/dir.xbm ^^DIRECTORY^^
AddIcon /icons/backup.xbm *~

AddIconByEncoding

This sets the icon to display next to files withMIME-encoding for FancyIndexing.Icon is either a (%-escaped) relative URL to the icon, or of theformat (alttext,url) where alttext is the text taggiven for an icon for non-graphical browsers.

Mime-encoding is a wildcard expression matching required thecontent-encoding. Examples:

AddIconByEncoding /icons/compress.xbm x-compress

AddIconByType

This sets the icon to display next to files of type MIME-type forFancyIndexing. Icon is either a(%-escaped) relative URL to the icon, or of the format(alttext,url) where alttext is the text tag givenfor an icon for non-graphical browsers.

Mime-type is a wildcard expression matching required the mime types.Examples:

AddIconByType (IMG,/icons/image.xbm) image/*

DefaultIcon

The DefaultIcon directive sets the icon to display for files when nospecific icon is known, for FancyIndexing.Url is a (%-escaped) relative URL to the icon. Examples:

DefaultIcon /icon/unknown.xbm

FancyIndexing

The FancyIndexing directive sets the FancyIndexing option for a directory.Boolean can be on or off. TheIndexOptions directive should be used inpreference.

Note that in versions of Apache prior to 1.3.2, the FancyIndexing and IndexOptions directives will override each other. You should use IndexOptions FancyIndexing in preference to the standalone FancyIndexing directive. As of Apache 1.3.2, a standalone FancyIndexing directive is combined with any IndexOptions directive already specified for the current scope.

HeaderName

The HeaderName directive sets the name of the file that will be insertedat the top of the index listing. Filename is the name of the fileto include, and is taken to be relative to the directory being indexed.The server first attempts to include filename.htmlas an HTML document, otherwise it will include filename as plaintext. Example:

HeaderName HEADER

See also ReadmeName.

IndexIgnore

The IndexIgnore directive adds to the list of files to hide when listinga directory. File is a file extension, partial filename,wildcard expression or full filename for files to ignore. MultipleIndexIgnore directives add to the list, rather than the replacing the listof ignored files. By default, the list contains `.'. Example:

IndexIgnore README .htaccess *~

IndexOptions

The IndexOptions directive specifies the behavior of the directory indexing.Option can be one of

FancyIndexing

This turns on fancy indexing of directories.

Note that in versions of Apache prior to 1.3.2, the FancyIndexing and IndexOptions directives will override each other. You should use IndexOptions FancyIndexing in preference to the standalone FancyIndexing directive. As of Apache 1.3.2, a standalone FancyIndexing directive is combined with any IndexOptions directive already specified for the current scope.

IconHeight[=pixels] (Apache 1.3 and later)

Presence of this option, when used with IconWidth, will cause the serverto include HEIGHT and WIDTH attributes in theIMG tag for the file icon. This allows browser toprecalculate the page layout without having to wait until all theimages have been loaded. If no value is given for the option, itdefaults to the standard height of the icons supplied with the Apachesoftware.

IconsAreLinks

This makes the icons part of the anchor for the filename, forfancy indexing.

IconWidth[=pixels] (Apache 1.3 and later)

Presence of this option, when used with IconHeight, will cause the serverto include HEIGHT and WIDTH attributes in theIMG tag for the file icon. This allows browser toprecalculate the page layout without having to wait until all theimages have been loaded. If no value is given for the option, itdefaults to the standard width of the icons supplied with the Apachesoftware.

NameWidth=[n | *] (Apache 1.3.2 and later)

The NameWidth keyword allows you to specify the width of thefilename column in bytes. If the keyword value is '*',then the column is automatically sized to the length of the longestfilename in the display.

ScanHTMLTitles

This enables the extraction of the title from HTML documents for fancyindexing. If the file does not have a description given byAddDescription then httpd will read thedocument for the value of the TITLE tag. This is CPU and disk intensive.

SuppressColumnSorting

If specified, Apache will not make the column headings in a FancyIndexeddirectory listing into links for sorting. The default behaviour isfor them to be links; selecting the column heading will sort the directorylisting by the values in that column.Only available in Apache 1.3 and later.

SuppressDescription

This will suppress the file description in fancy indexing listings.

SuppressHTMLPreamble

If the directory actually contains a file specified by theHeaderNamedirective, the module usually includes the contents of the fileafter a standard HTML preamble (<HTML>, <HEAD>, etcetera). 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.

SuppressLastModified

This will suppress the display of the last modification date, in fancyindexing listings.

SuppressSize

This will suppress the file size in fancy indexing listings.

There are some noticeable differences in the behaviour of thisdirective in recent (post-1.3.0) versions of Apache.

Apache 1.3.2 and earlier:

The default is that no options are enabled. If multiple IndexOptionscould apply to a directory, then the most specific one is taken complete;the options are not merged. For example:

<Directory /web/docs>
IndexOptions FancyIndexing
</Directory>
<Directory /web/docs/spec>
IndexOptions ScanHTMLTitles
</Directory>

then only ScanHTMLTitles will be set for the /web/docs/specdirectory.

Apache 1.3.3 and later:

Apache 1.3.3 introduced some significant changes in the handling ofIndexOptions directives. In particular,

• Multiple IndexOptions directives for a single directory are now merged together. The result of the example above will now be the equivalent of IndexOptions FancyIndexing ScanHTMLTitles.
• The addition of the incremental syntax (i.e., prefixing keywords with '+' or '-').

Whenever a '+' or '-' prefixed keyword is encountered, it is appliedto the current IndexOptions settings (which may have beeninherited from an upper-level directory). However, whenever an unprefixedkeyword is processed, it clears all inherited options and any incrementalsettings encountered so far. Consider the following example:

IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
IndexOptions +SuppressSize


The net effect is equivalent toIndexOptions FancyIndexing +SuppressSize, becausethe unprefixed FancyIndexing discarded the incrementalkeywords before it, but allowed them to start accumulating againafterward.

To unconditionally set the IndexOptions for aparticular directory, clearing the inherited settings, specifykeywords without either '+' or '-' prefixes.

ReadmeName

The ReadmeName directive sets the name of the file that will be appendedto the end of the index listing. Filename is the name of the fileto include, and is taken to be relative to the directory being indexed.The server first attempts to include filename.htmlas an HTML document, otherwise it will include filename as plaintext. Example:

ReadmeName README

See also HeaderName.

Apache HTTP Server Version 1.3