ls command or the
Win32 dir shell commandThe index of a directory can come from one of two sources:
index.html. The The two functions are separated so that you can completely remove (or replace) automatic index generation should you want to.
Automatic index generation is enabled with using
Options +Indexes. See the
If the FancyIndexing option is given with the SuppressColumnSorting
option.
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 will always be displayed before a 1011-byte file (if in ascending order) even though they both are shown as "1K".
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 IndexOptions
IgnoreClient option disables that functionality.
The column sorting headers themselves are self-referencing hyperlinks that add the sort query options shown below. Any option below may be added to any request for the directory resource.
C=N sorts the directory by file nameC=M sorts the directory by last-modified
date, then file nameC=S sorts the directory by size, then file
nameC=D sorts the directory by description, then
file nameO=A sorts the listing in Ascending
OrderO=D sorts the listing in Descending
OrderF=0 formats the listing as a simple list
(not FancyIndexed)F=1 formats the listing as a FancyIndexed
listF=2 formats the listing as an
HTMLTable FancyIndexed listV=0 disables version sortingV=1 enables version sortingP=pattern lists only files matching
the given patternNote that the 'P'attern query argument is tested
after the usual
The simple example below, which can be clipped and saved in a header.html file, illustrates these query options. Note that the unknown "X" argument, for the submit button, is listed last to assure the arguments are all parsed before mod_autoindex encounters the X=Go input.
FancyIndexing.
File is a file extension, partial filename, wild-card
expression or full filename for files to describe.
If String contains any whitespace, you have to enclose it
in quotes (" or '). This alternate text
is displayed if the client is image-incapable, has image loading
disabled, or fails to retrieve the icon.
FancyIndexing.
MIME-encoding is a valid content-encoding, such as
x-compress. If String contains any whitespace,
you have to enclose it in quotes (" or ').
This alternate text is displayed if the client is image-incapable,
has image loading disabled, or fails to retrieve the icon.
FancyIndexing.
MIME-type is a valid content-type, such as
text/html. If String contains any whitespace,
you have to enclose it in quotes (" or ').
This alternate text is displayed if the client is image-incapable,
has image loading disabled, or fails to retrieve the icon.
This sets the description to display for a file, for
FancyIndexing.
File is a file extension, partial filename, wild-card
expression or full filename for files to describe.
String is enclosed in double quotes (").
The typical, default description field is 23 bytes wide. 6
more bytes are added by the IndexOptions SuppressIcon option, 7 bytes are
added by the IndexOptions SuppressSize option, and 19 bytes are
added by the IndexOptions SuppressLastModified option.
Therefore, the widest default the description column is ever
assigned is 55 bytes.
Since the File argument may be a partial file name,
please remember that a too-short partial filename may match
unintended files. For example, le.html will match the
file le.html but will also match the file
example.html. In the event that there may be ambiguity,
use as complete a filename as you can, but keep in mind that the
first match encountered will be used, and order your list of
AddDescription directives accordingly.
See the DescriptionWidth
Descriptive text defined with
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.
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, a fully qualified remote URL, 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.
^^BLANKICON^^ is only used for formatting, and so
is unnecessary if you're using IndexOptions
HTMLTable.
This sets the icon to display next to files with FancyIndexing.
Icon is either a (%-escaped) relative URL to the icon,
a fully qualified remote URL,
or of the format (alttext,url)
where alttext is the text tag given for an icon for
non-graphical browsers.
MIME-encoding is a valid content-encoding, such as
x-compress.
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,
a fully qualified remote URL,
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.
The FancyIndexing.
Url-path is a (%-escaped) relative URL to the icon,
or a fully qualified remote URL.
The
Both HeaderName and
Filename must resolve to a document with a major
content type of text/* (e.g.,
text/html, text/plain, etc.). This means
that filename may refer to a CGI script if the script's
actual file type (as opposed to its output) is marked as
text/html such as with a directive like:
Content negotiation
will be performed if MultiViews is in effect. If filename resolves
to a static text/html document (not a CGI script) and
either one of the Includes or IncludesNOEXEC is enabled,
the file will be processed for server-side includes (see the
If the file specified by IndexOptions
+SuppressHTMLPreamble, so that these tags are not
repeated.
The . (the current
directory).
This directive does not currently work in configuration sections
that have regular expression arguments, such as
The
Review the default configuration for a list of patterns that you might want to explicitly ignore after using this directive.
The
IndexOptions HTMLTable
is in effect and an IndexStyleSheet is defined.
Rather than the standard even and odd
classes that would otherwise be applied to each row of the table,
a class of even-ALT or
odd-ALT where ALT is either the
standard alt text associated with the file style (eg. snd,
txt, img, etc) or the alt text defined by one of
the various AddAlt* directives.
Charset keyword allows you to
specify the character set of the generated page. The
default is UTF-8 on Windows and Mac OS X,
and ISO-8859-1 elsewhere.
(It depends on whether the underlying file system
uses Unicode filenames or not.)
DescriptionWidth keyword allows you to
specify the width of the description column in
characters.-DescriptionWidth (or unset) allows
DescriptionWidth=n fixes the column width to
n bytes wide.DescriptionWidth=* grows the column to the
width necessary to accommodate the longest description
string.
See the section on FoldersFirst is enabled, subdirectory
Zed will be listed before subdirectory
Beta, which will be listed before normal files
Gamma and Alpha.
This option only has an effect if FancyIndexing
is also enabled.
FancyIndexing 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.IconWidth,
will cause the server to include height and
width attributes in the img 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 httpd software.
This option
only has an effect if FancyIndexing is also enabled.
IconHeight,
will cause the server to include height and
width attributes in the img 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 httpd
software.IgnoreCase is enabled, file Zeta will be listed after
file alfa (Note: file GAMMA will always be listed before file gamma).
SuppressColumnSorting.)NameWidth keyword allows you to specify the width
of the filename column in bytes.-NameWidth (or unset) allows NameWidth=n fixes the column width to
n bytes wide.NameWidth=* grows the column to the necessary
width.title element. This is CPU and disk intensive.HTTP_UNAUTHORIZED or
HTTP_FORBIDDENIndexOptions
IgnoreClient.DescriptionWidth
index option to limit the size of the description column.
This option
only has an effect if FancyIndexing is also enabled.
<html>,
<head>, et cetera). 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. If you also specify a SuppressIcon and
SuppressRules yields proper HTML 3.2 output, which
by the final specification prohibits img and
hr elements from the pre block (used to
format FancyIndexed listings.)FancyIndexing is also enabled.
hr
elements) in directory listings. Combining both SuppressIcon and
SuppressRules yields proper HTML 3.2 output, which
by the final specification prohibits img and
hr elements from the pre block (used to
format FancyIndexed listings.)
This option
only has an effect if FancyIndexing is also enabled.
FancyIndexing is also enabled.
Last-Modified and ETag
values for the listed directory in the HTTP header. It is only valid
if the operating system and file system return appropriate stat()
results. Some Unix systems do so, as do OS2's JFS and Win32's
NTFS volumes. OS2 and Win32 FAT volumes, for example, do not.
Once this feature is enabled, the client or proxy can track
changes to the list of files when they perform a HEAD
request. Note some operating systems correctly track new and
removed files, but do not track changes for sizes or dates of
the files within the directory. Changes to the size
or date stamp of an existing file will not update the
Last-Modified header on all Unix platforms.
If this is a concern, leave this option disabled.Type keyword allows you to
specify the MIME content-type of the generated page. The default
is text/html.
VersionSort keyword causes files containing
version numbers to sort in a natural way. Strings are sorted as
usual, except that substrings of digits in the name and
description are compared according to their numeric value.
If the number starts with a zero, then it is considered to be a fraction:
XHTML keyword forces FancyIndexing is also enabled.
Be aware of how multiple
will be the equivalent of
+ or -).Whenever a '+' or '-' prefixed keyword is encountered, it
is applied to the current
The net effect is equivalent to IndexOptions FancyIndexing
+SuppressSize, because the unprefixed FancyIndexing
discarded the incremental keywords before it, but allowed them to
start accumulating again afterward.
To unconditionally set the + or - prefixes.
The FancyIndexing index option. By default, fancyindexed
directory listings are displayed in ascending order by filename; the
Ascending or
Descending, indicating the direction of the sort.
The second argument must be one of the keywords Name,
Date, Size, or Description,
and identifies the primary key. The secondary key is
always the ascending filename.
You can, if desired, prevent the client from reordering the list
by also adding the SuppressColumnSorting
index option to remove the sort link from the top of the column,
along with the IgnoreClient index
option to prevent them from manually adding sort options to the
query string in order to override your ordering preferences.
The
Using this directive in conjunction with IndexOptions
HTMLTable adds a number of CSS classes to the resulting HTML.
The entire table is given a CSS id of indexlist and the
following classes are associated with the various parts of the
listing:
| Class | Definition |
|---|---|
| tr.indexhead | Header row of listing |
| th.indexcolicon and td.indexcolicon | Icon column |
| th.indexcolname and td.indexcolname | File name column |
| th.indexcollastmod and td.indexcollastmod | Last modified column |
| th.indexcolsize and td.indexcolsize | File size column |
| th.indexcoldesc and td.indexcoldesc | Description column |
| tr.breakrow | Horizontal rule at the bottom of the table |
| tr.odd and tr.even | Alternating even and odd rows |
The
The
See also