# Module mod_dir

This module is contained in the `mod_dir.c` file, and is compiled in by default. It provides for directory indexing.

## Summary

This module controls the directory indexing. The index of a directory can come from one of two sources:

- A file written by the user, typically called `index.html`. The DirectoryIndex directive sets the name of this file.
- Otherwise, a listing generated by the server. The other directives control the format of this listing. The AddIcon, AddIconByEncoding and AddIconByType are used to set a list of icons to display for various file types; for each file listed, the first icon listed that matches the file is displayed.

## Directives

- AddDescription
- AddIcon
- AddIconByEncoding
- AddIconByType
- DefaultIcon
- DirectoryIndex
- FancyIndexing
- HeaderName
- IndexIgnore
- IndexOptions
- ReadmeName

## AddDescription

Syntax: AddDescription string file file...
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

This sets the description to display for a file, for FancyIndexing. File is a file extension, partial filename, wildcard expression or full filename for files to describe. String is enclosed in double quotes (`"`). Example:

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

## AddIcon

Syntax: AddIcon icon name name ...
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

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

Name 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:

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

AddIconByType should be used in preference to AddIcon, when possible.

## AddIconByEncoding

Syntax: AddIconByEncoding icon mime-encoding mime-encoding ...
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

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

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

> `AddIconByEncoding /icons/compress.xbm x-compress`

## AddIconByType

Syntax: AddIconByType icon mime-type mime-type ...
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

This sets the icon to display next to files of type mime-type for FancyIndexing. Icon is either a (%-escaped) relative URL to the icon, or of the format (alttext,url) where alttext is the text tag given for 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

Syntax: DefaultIcon url
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

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

> `DefaultIcon /icon/unknown.xbm`

## DirectoryIndex

Syntax: DirectoryIndex local-url local-url ...
Default: `DirectoryIndex index.html`
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

The DirectoryIndex directive sets the list of resources to look for, when the client requests an index of the directory by specifying a NULL file at the end of the a directory name. Local-url is the (%-encoded) URL of a document on the server relative to the requested directory; it is usually the name of a file in the directory. Several URLs may be given; the server will return the first one that it finds. If none of the resources exist, then the server will generate its own listing of the directory. Example:

> `DirectoryIndex index.html`

then a request for `http://myserver/docs/` would return `http://myserver/docs/index.html` if it exists, or would list the directory if it did not.

Note that the documents do not need to be relative to the directory;

> `DirectoryIndex index.html index.txt /cgi-bin/index.pl`

would cause the CGI script `/cgi-bin/index.pl` to be executed if neither `index.html` or `index.txt` existed in a directory.

## FancyIndexing

Syntax: FancyIndexing boolean
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

The FancyIndexing directive sets the FancyIndexing option for a directory. Boolean can be `on` or `off`. The IndexOptions directive should be used in preference.

## HeaderName

Syntax: HeaderName filename
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

The HeaderName directive sets the name of the file that will be inserted at the top of the index listing. Filename 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 filename`.html` as an HTML document, otherwise it will include filename as plain text. Example:

> `HeaderName HEADER`

when indexing the directory `/web`, the server will first look for the HTML file `/web/HEADER.html` and include it if found, otherwise it will include the plain text file `/web/HEADER`, if it exists.

See also ReadmeName.

## IndexIgnore

Syntax: IndexIgnore file file ...
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

The IndexIgnore directive adds to the list of files to hide when listing a directory. File 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 ``.`'. Example:

> `IndexIgnore README .htaccess *~`

## IndexOptions

Syntax: IndexOptions option option ...
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

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

FancyIndexing
  This turns on fancy indexing of directories.
IconsAreLinks
  This makes the icons part of the anchor for the filename, for fancy indexing.
ScanHTMLTitles
  This enables the extraction of the title from HTML documents for fancy indexing. If the file does not have a description given by AddDescription then httpd will read the document for the value of the TITLE tag. This is CPU and disk intensive.
SuppressLastModified
  This will suppress the display of the last modification date, in fancy indexing listings.
SuppressSize
  This will suppress the file size in fancy indexing listings.
SuppressDescription
  This will suppress the file description in fancy indexing listings.

This 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:

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

then only `ScanHTMLTitles` will be set for the /web/docs/spec directory.

## ReadmeName

Syntax: ReadmeName filename
Context: server config, virtual host, directory, .htaccess
Override: Indexes
Status: Base
Module: mod_dir

The ReadmeName directive sets the name of the file that will be appended to the end of the index listing. Filename 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 filename`.html` as an HTML document, otherwise it will include filename as plain text. Example:

> `ReadmeName README`

when indexing the directory `/web`, the server will first look for the HTML file `/web/README.html` and include it if found, otherwise it will include the plain text file `/web/README`, if it exists.

See also HeaderName.