©
This document usesPHP Chinese website manualRelease
| 说明 | 自动对目录中的内容生成列表,类似于"ls"或"dir"命令 |
|---|---|
| 状态 | 基本(B) |
| 模块名 | autoindex_module |
| 源文件 | mod_autoindex.c |
The index of a directory can come from one of two sources:
index.html. TheDirectoryIndexdirective sets the name of this file. This is controlled bymod_dir.AddIcon,AddIconByEncoding和AddIconByTypeare 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. These are controlled bymod_autoindex.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 usingOptions +Indexes. See theOptionsdirective for more details.
If theFancyIndexingoption is given with theIndexOptionsdirective, the column headers are links that control the order of the display. If you select a header link, the listing will be regenerated, sorted by the values in that column. Selecting the same header repeatedly toggles between ascending and descending order. These column header links are suppressed withIndexOptionsdirective'sSuppressColumnSortingoption.
Note that when the display is sorted by "Size", it's theactualsize 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".
Apache 2.0.23 reorganized the Query Arguments for Column Sorting, and introduced an entire group of new query options. To effectively eliminate all client control over the output, theIndexOptions IgnoreClientoption was introduced.
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=Nsorts the directory by file nameC=Msorts the directory by last-modified date, then file nameC=Ssorts the directory by size, then file nameC=Dsorts the directory by description, then file nameO=Asorts the listing in Ascending OrderO=Dsorts the listing in Descending OrderF=0formats the listing as a simple list (not FancyIndexed)F=1formats the listing as a FancyIndexed listF=2formats the listing as an HTMLTable FancyIndexed listV=0disables version sortingV=1enables version sortingP=patternlists only files matching the givenpatternNote that the 'P'attern query argument is testedafterthe usualIndexIgnoredirectives are processed, and all file names are still subjected to the same criteria as any other autoindex listing. The Query Arguments parser inmod_autoindexwill stop abruptly when an unrecognized option is encountered. The Query Arguments must be well formed, according to the table above.
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.
| 说明 | Alternate text to display for a file, instead of an icon selected by filename |
|---|---|
| 语法 | AddAltstringfile[file] ... |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
AddAltprovides the alternate text to display for a file, instead of an icon, forFancyIndexing.Fileis a file extension, partial filename, wild-card expression or full filename for files to describe. IfStringcontains any whitespace, you have to enclose it in quotes ("或'). This alternate text is displayed if the client is image-incapable, has image loading disabled, or fails to retrieve the icon.
AddAlt "PDF file" *.pdf
AddAlt Compressed *.gz *.zip *.Z
| 说明 | Alternate text to display for a file instead of an icon selected by MIME-encoding |
|---|---|
| 语法 | AddAltByEncodingstringMIME-encoding[MIME-encoding] ... |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
AddAltByEncodingprovides the alternate text to display for a file, instead of an icon, forFancyIndexing.MIME-encodingis a valid content-encoding, such asx-compress. IfStringcontains any whitespace, you have to enclose it in quotes ("或'). This alternate text is displayed if the client is image-incapable, has image loading disabled, or fails to retrieve the icon.
AddAltByEncoding gzip x-gzip
| 说明 | Alternate text to display for a file, instead of an icon selected by MIME content-type |
|---|---|
| 语法 | AddAltByTypestringMIME-type[MIME-type] ... |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
AddAltByTypesets the alternate text to display for a file, instead of an icon, forFancyIndexing.MIME-typeis a valid content-type, such astext/html. IfStringcontains any whitespace, you have to enclose it in quotes ("或'). This alternate text is displayed if the client is image-incapable, has image loading disabled, or fails to retrieve the icon.
AddAltByType 'plain text' text/plain
| 说明 | Description to display for a file |
|---|---|
| 语法 | AddDescriptionstring file[file] ... |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
This sets the description to display for a file, forFancyIndexing.Fileis a file extension, partial filename, wild-card expression or full filename for files to describe.Stringis enclosed in double quotes (").
AddDescription "The planet Mars" /web/pics/mars.gif
The typical, default description field is 23 bytes wide. 6 more bytes are added by theIndexOptions SuppressIconoption, 7 bytes are added by theIndexOptions SuppressSizeoption, and 19 bytes are added by theIndexOptions SuppressLastModifiedoption. Therefore, the widest default the description column is ever assigned is 55 bytes.
See the DescriptionWidthIndexOptionskeyword for details on overriding the size of this column, or allowing descriptions of unlimited length.
Descriptive text defined withAddDescriptionmay contain HTML markup, such as tags and character entities. If the width of the description column should happen to truncate a tagged element (such as cutting off the end of a bolded phrase), the results may affect the rest of the directory listing.
| 说明 | Icon to display for a file selected by name |
|---|---|
| 语法 | AddIconiconname[name] ... |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
This sets the icon to display next to a file ending innameforFancyIndexing.Iconis either a (%-escaped) relative URL to the icon, or of the format(alttext,url)wherealttextis the text tag given for an icon for non-graphical browsers.
Nameis 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.
AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm
AddIcon /icons/dir.xbm ^^DIRECTORY^^
AddIcon /icons/backup.xbm *~
AddIconByTypeshould be used in preference toAddIcon, when possible.
| 说明 | Icon to display next to files selected by MIME content-encoding |
|---|---|
| 语法 | AddIconByEncodingiconMIME-encoding[MIME-encoding] ... |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
This sets the icon to display next to files withFancyIndexing.Iconis either a (%-escaped) relative URL to the icon, or of the format(alttext,url)wherealttextis the text tag given for an icon for non-graphical browsers.
MIME-encodingis a wildcard expression matching required the content-encoding.
AddIconByEncoding /icons/compress.xbm x-compress
| 说明 | Icon to display next to files selected by MIME content-type |
|---|---|
| 语法 | AddIconByTypeiconMIME-type[MIME-type] ... |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
This sets the icon to display next to files of typeMIME-typeforFancyIndexing.Iconis either a (%-escaped) relative URL to the icon, or of the format(alttext,url)wherealttextis the text tag given for an icon for non-graphical browsers.
MIME-typeis a wildcard expression matching required the mime types.
AddIconByType (IMG,/icons/image.xbm) image/*
| 说明 | Icon to display for files when no specific icon is configured |
|---|---|
| 语法 | DefaultIconurl-path |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
DefaultIcondirective sets the icon to display for files when no specific icon is known, forFancyIndexing.Url-pathis a (%-escaped) relative URL to the icon.
DefaultIcon /icon/unknown.xbm
| 说明 | Name of the file that will be inserted at the top of the index listing |
|---|---|
| 语法 | HeaderNamefilename |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
HeaderNamedirective sets the name of the file that will be inserted at the top of the index listing.Filenameis the name of the file to include.
HeaderName HEADER.html
Both HeaderName andReadmeNamenow treatFilenameas a URI path relative to the one used to access the directory being indexed. IfFilenamebegins with a slash, it will be taken to be relative to theDocumentRoot.
HeaderName /include/HEADER.html
Filenamemust resolve to a document with a major content type oftext/*(例如,text/html,text/plain, etc.). This means thatfilenamemay refer to a CGI script if the script's actual file type (as opposed to its output) is marked astext/htmlsuch as with a directive like:
AddType text/html .cgi
Content negotiation will be performed ifOptionsMultiViewsis in effect. Iffilenameresolves to a statictext/htmldocument (not a CGI script) and either one of theoptionsIncludes或IncludesNOEXECis enabled, the file will be processed for server-side includes (see themod_includedocumentation).
If the file specified byHeaderNamecontains the beginnings of an HTML document (,
IndexOptions +SuppressHTMLPreamble, so that these tags are not repeated.
| 说明 | Adds to the list of files to hide when listing a directory |
|---|---|
| 语法 | IndexIgnorefile[file] ... |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
IndexIgnoredirective adds to the list of files to hide when listing a directory.Fileis a shell-style wildcard expression or full filename. Multiple IndexIgnore directives add to the list, rather than the replacing the list of ignored files. By default, the list contains.(the current directory).
IndexIgnore README .htaccess *.bak *~
| 说明 | Various configuration settings for directory indexing |
|---|---|
| 语法 | IndexOptions [+|-]option[[+|-]option] ... |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
IndexOptionsdirective specifies the behavior of the directory indexing.Optioncan be one of
DescriptionWidthkeyword allows you to specify the width of the description column in characters.
-DescriptionWidth(or unset) allows
mod_autoindexto calculate the best width.
DescriptionWidth=nfixes the column width to
nbytes wide.
DescriptionWidth=*grows the column to the width necessary to accommodate the longest description string.
AddDescriptionfor dangers inherent in truncating descriptions.
FoldersFirstis enabled, subdirectory
Zedwill be listed before subdirectory
Beta, which will be listed before normal files
Gamma和
Alpha.
This option only has an effect ifFancyIndexingis also enabled.
height和
widthattributes in the
imgtag 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 software.
IconHeight, will cause the server to include
height和
widthattributes in the
imgtag 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 software.
mod_autoindexto ignore all query variables from the client, including sort order (implies
SuppressColumnSorting.)
NameWidthkeyword allows you to specify the width of the filename column in bytes.
-NameWidth(or unset) allows
mod_autoindexto calculate the best width.
NameWidth=nfixes the column width to
nbytes wide.
NameWidth=*grows the column to the necessary width.
AddDescriptionthen httpd will read the document for the value of the
titleelement. This is CPU and disk intensive.
AddDescriptionfor information about setting the file description. See also the
DescriptionWidthindex option to limit the size of the description column.
HeaderNamedirective, the module usually includes the contents of the file after a standard HTML preamble (
,
,
et cetera). The
SuppressHTMLPreambleoption 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.
SuppressIcon和
SuppressRulesyields proper HTML 3.2 output, which by the final specification prohibits
img和
hrelements from the
preblock (used to format FancyIndexed listings.)
hrelements) in directory listings. Combining both
SuppressIcon和
SuppressRulesyields proper HTML 3.2 output, which by the final specification prohibits
img和
hrelements from the
preblock (used to format FancyIndexed listings.)
HEADrequest. 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.
VersionSortkeyword 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.
foo-1.7
foo-1.7.2
foo-1.7.12
foo-1.8.2
foo-1.8.2a
foo-1.12
If the number starts with a zero, then it is considered to be a fraction:
foo-1.001
foo-1.002
foo-1.030
foo-1.04
XHTMLkeyword forces
mod_autoindexto emit XHTML 1.0 code instead of HTML 3.2.
Apache 1.3.3 introduced some significant changes in the handling ofIndexOptionsdirectives. In particular:
IndexOptionsdirectives for a single directory are now merged together. The result of:
IndexOptions SuppressColumnsorting
will be the equivalent of
IndexOptions HTMLTable SuppressColumnsorting
+或-).Whenever a '+' or '-' prefixed keyword is encountered, it is applied to the currentIndexOptionssettings (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:
IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
IndexOptions +SuppressSize
The net effect is equivalent toIndexOptions FancyIndexing +SuppressSize, because the unprefixedFancyIndexingdiscarded the incremental keywords before it, but allowed them to start accumulating again afterward.
To unconditionally set theIndexOptionsfor a particular directory, clearing the inherited settings, specify keywords without any+或-prefixes.
| 说明 | Sets the default ordering of the directory index |
|---|---|
| 语法 | IndexOrderDefault Ascending|Descending Name|Date|Size|Description |
| 默认值 | IndexOrderDefault Ascending Name |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
IndexOrderDefaultdirective is used in combination with theFancyIndexingindex option. By default, fancyindexed directory listings are displayed in ascending order by filename; theIndexOrderDefaultallows you to change this initial display order.
IndexOrderDefaulttakes two arguments. The first must be eitherAscending或Descending, indicating the direction of the sort. The second argument must be one of the keywordsName,Date,Size, orDescription, and identifies the primary key. The secondary key isalwaysthe ascending filename.
You can force a directory listing to only be displayed in a particular order by combining this directive with theSuppressColumnSortingindex option; this will prevent the client from requesting the directory listing in a different order.
| 说明 | Adds a CSS stylesheet to the directory index |
|---|---|
| 语法 | IndexStyleSheeturl-path |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
IndexStyleSheetdirective sets the name of the file that will be used as the CSS for the index listing.
IndexStyleSheet "/css/style.css"
| 说明 | Name of the file that will be inserted at the end of the index listing |
|---|---|
| 语法 | ReadmeNamefilename |
| 作用域 | server config, virtual host, directory, .htaccess |
| 覆盖项 | Indexes |
| 状态 | 基本(B) |
| 模块 | mod_autoindex |
ReadmeNamedirective sets the name of the file that will be appended to the end of the index listing.Filenameis the name of the file to include, and is taken to be relative to the location being indexed. IfFilenamebegins with a slash, it will be taken to be relative to theDocumentRoot.
ReadmeName FOOTER.html
ReadmeName /include/FOOTER.html
See alsoHeaderName, where this behavior is described in greater detail.