mod_autoindex

摘要

目录索引可以来自以下两个来源之一：

• 位于该目录中的文件，通常称为index.html。DirectoryIndex指令设置要使用的文件或 files 的 name。这由mod_dir控制。
• 否则，由服务器生成的列表。其他指令控制此列表的格式。AddIcon，AddIconByEncoding和AddIconByType用于设置要为各种文件类型显示的图标列表；对于列出的每个文件，将显示列出的与文件匹配的第一个图标。这些由mod_autoindex控制。

这两个函数是分开的，因此您可以根据需要完全删除(或替换)自动索引生成。

使用Options +Indexes启用自动索引生成。有关更多详细信息，请参阅选项指令。

如果使用IndexOptions指令给出FancyIndexing选项，则列 headers 是控制显示的 order 的链接。如果您选择标题链接，则会重新生成列表，并按该列中的值进行排序。重复选择相同的标题可在升序和降序 order 之间切换。使用IndexOptions指令的SuppressColumnSorting选项可以抑制这些列标题链接。

请注意，当显示按“大小”排序时，它是使用的 files 的实际大小，而不是显示的 value -所以 1010-byte 文件将始终显示在 1011-byte 文件之前(如果在升序 order 中)，即使它们都是显示为“1K”。

Autoindex 请求查询 Arguments

各种查询 string arguments 可用于为 client 提供对目录列表的 ordering 的一些控制，以及列出的 files。如果您不希望为此控件提供 client，则IndexOptions IgnoreClient选项会禁用该功能。

列排序 headers 本身是 self-referencing 超链接，它们添加了下面显示的排序查询选项。以下任何选项都可以添加到目录资源的任何请求中。

• C=N按文件 name 对目录进行排序
• C=M按 last-modified date 对目录进行排序，然后对文件 name 进行排序
• C=S按大小对目录进行排序，然后对文件 name 进行排序
• C=D按说明对目录进行排序，然后对文件 name 进行排序
• O=A对 Ascending Order 中的列表进行排序
• O=D对 Descending Order 中的列表进行排序
• F=0将列表格式化为简单列表(不是 FancyIndexed)
• F=1将列表格式化为 FancyIndexed 列表
• F=2将列表格式化为 HTMLTable FancyIndexed 列表
• V=0禁用 version 排序
• V=1启用 version 排序
• P=pattern lists 仅列出与给定 pattern 匹配的 files

请注意，在处理通常的IndexIgnore指令后测试'P'attern 查询参数，并且所有文件名仍然遵循与任何其他自动索引列表相同的条件。当遇到无法识别的选项时，mod_autoindex中的 Query Arguments 解析器将突然停止。根据上面的 table，Query Arguments 必须格式良好。

下面的简单 example(可以剪切并保存在 header.html 文件中)说明了这些查询选项。请注意，最后列出了提交按钮的未知“X”参数，以确保在 mod_autoindex 遇到 X=Go 输入之前 arguments 都被解析。

<form action="" method="get"> Show me a <select name="F"><option value="0"> Plain list</option><option value="1" selected="selected"> Fancy list</option><option value="2"> Table list</option></select> Sorted by <select name="C"><option value="N" selected="selected"> Name</option><option value="M"> Date Modified</option><option value="S"> Size</option><option value="D"> Description</option></select><select name="O"><option value="A" selected="selected"> Ascending</option><option value="D"> Descending</option></select><select name="V"><option value="0" selected="selected"> in Normal order</option><option value="1"> in Version order</option></select> Matching <input type="text" name="P" value="*"/><input type="submit" name="X" value="Go"/></form>

AddAlt 指令

AddAlt为FancyIndexing提供了显示文件的替代文本，而不是图标。文件是 files 要描述的文件扩展名，部分文件名，wild-card 表达式或完整文件名。如果 String 包含任何空格，则必须将其括在引号("或')中。如果 client 为 image-incapable，禁用了图像_loading 或无法检索图标，则会显示此备用文本。

AddAlt "PDF file" *.pdf
AddAlt Compressed *.gz *.zip *.Z

AddAltByEncoding 指令

AddAltByEncoding为FancyIndexing提供了显示文件的替代文本，而不是图标。 MIME-encoding 是有效的 content-encoding，例如x-compress。如果 String 包含任何空格，则必须将其括在引号("或')中。如果 client 为 image-incapable，禁用了图像_loading 或无法检索图标，则会显示此备用文本。

AddAltByEncoding gzip x-gzip

AddAltByType 指令

AddAltByType _set 为FancyIndexing设置要显示的文件而不是图标。 MIME-type 是有效的 content-type，例如text/html。如果 String 包含任何空格，则必须将其括在引号("或')中。如果 client 为 image-incapable，禁用了图像_loading 或无法检索图标，则会显示此备用文本。

AddAltByType 'plain text' text/plain

AddDescription 指令

这为FancyIndexing设置了为文件显示的描述。文件是 files 要描述的文件扩展名，部分文件名，wild-card 表达式或完整文件名。 String 包含在 double 引号(")中。

AddDescription "The planet Mars" mars.gif
AddDescription "My friend Marshall" friends/mars.gif

典型的默认描述字段是 23 字节宽。IndexOptions SuppressIcon选项添加 6 个字节，IndexOptions SuppressSize选项添加 7 个字节，IndexOptions SuppressLastModified选项添加 19 个字节。因此，描述列的最大默认值是 55 字节。

由于 File 参数可能是部分文件 name，请记住 too-short 部分文件名可能 match 意外的 files。对于 example，le.html将匹配文件le.html，但也会匹配文件example.html。在 event 中可能存在歧义，尽可能使用完整的文件名，但请记住，将使用遇到的第一个 match，并相应地排序AddDescription指令列表。

有关覆盖此列大小或允许无限长度描述的详细信息，请参阅DescriptionWidthIndexOptions关键字。

警告

使用AddDescription定义的描述性文本可能包含 HTML 标记，例如标记和字符实体。如果描述列的宽度恰好截断标记元素(例如截断粗体短语的结尾)，则结果可能会影响目录列表的 rest。

Arguments with path information

目前不支持绝对 paths，并且在运行时不匹配任何内容。具有相对路径信息的参数(通常仅在 htaccess context 中使用)隐含地带有'*/'前缀，以避免匹配部分目录名。

AddIcon 指令

这将设置图标显示在 name的 name 结尾的文件旁边。图标是图标的(％-escaped)相对 URL，完全限定的 remote URL 或格式(alttext,url)，其中 alttext 是为 non-graphical 浏览器的图标指定的文本标记。

Name 是^^DIRECTORY^^表示目录，^^BLANKICON^^表示空白 lines(正确格式化列表)，文件扩展名，通配符表达式，部分文件名或完整文件名。

^^BLANKICON^^仅用于格式化，因此如果您使用IndexOptions HTMLTable则不需要。

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

在可能的情况下，AddIconByType应优先于AddIcon使用。

AddIconByEncoding 指令

这将图标设置为_f 旁边的 files。图标是图标的(％-escaped)相对 URL，完全限定的 remote URL 或格式(alttext,url)，其中 alttext 是为 non-graphical 浏览器的图标指定的文本标记。

MIME-encoding 是有效的 content-encoding，例如x-compress。

AddIconByEncoding /icons/compress.png x-compress

AddIconByType 指令

这会将图标设置为FancyIndexing的 MIME-type 类型的 files 旁边。图标是图标的(％-escaped)相对 URL，完全限定的 remote URL 或格式(alttext,url)，其中 alttext 是为 non-graphical 浏览器的图标指定的文本标记。

MIME-type 是匹配所需的 mime 类型的通配符表达式。

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

DefaultIcon 指令

对于FancyIndexing，当没有特定图标时，DefaultIcon指令设置为 files 显示的图标。 Url-path 是图标的(％-escaped)相对 URL，或完全限定的 remote URL。

DefaultIcon /icon/unknown.png

HeaderName 指令

HeaderName指令设置将插入索引列表顶部的文件的 name。 Filename 是要包含的文件的 name。

HeaderName HEADER.html

HeaderName 和ReadmeName现在都将 Filename 视为相对于用于访问被索引目录的 URI 路径。如果 Filename 以斜杠开头，则它将被视为相对于DocumentRoot。

HeaderName /include/HEADER.html

文件名必须解析为主 content type 为text/*的文档(e.g.，text/html，text/plain，etc.)。这意味着如果脚本的实际文件类型(与其输出相对)标记为text/html，则文件名可能引用 CGI 脚本例如使用如下指令：

AddType text/html .cgi

如果选项MultiViews生效，将执行内容谈判。如果 filename 解析为静态text/html文档(不是 CGI 脚本)并且启用了选项Includes或IncludesNOEXEC中的任何一个，则将为 server-side includes 处理该文件(请参阅mod_include文档)。

如果HeaderName指定的文件包含 HTML 文档的开头(<html>，<head>，etc.)，那么您可能需要设置IndexOptions SuppressHTMLPreamble，以便不重复这些标记。

参见

• ReadmeName

IndexHeadInsert 指令

IndexHeadInsert指令在为索引页生成的 HTML 的<head>部分中指定 string 以 insert。

IndexHeadInsert "<link rel="sitemap" href="/sitemap.html">"

IndexIgnore 指令

列出目录时，IndexIgnore指令会添加到 files 列表中以隐藏。文件是 shell-style 通配符表达式或完整文件名。多个 IndexIgnore 指令添加到列表中，而不是替换忽略的 files 列表。默认情况下，列表包含.(当前目录)。

IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t

常用表达

该指令当前不适用于具有正则表达式 arguments 的 configuration 节，例如<DirectoryMatch>

IndexIgnoreReset 指令

IndexIgnoreReset指令删除IndexIgnore忽略的所有 files，否则从其他 configuration 部分继承。

<Directory "/var/www">
    IndexIgnore *.bak .??* *~ *# HEADER* README* RCS CVS *,v *,t
</Directory>
<Directory "/var/www/backups">
    IndexIgnoreReset ON
    IndexIgnore .??* *# HEADER* README* RCS CVS *,v *,t
</Directory>

查看默认 configuration 以获取在使用此指令后可能要显式忽略的模式列表。

IndexOptions 指令

IndexOptions指令指定目录索引的行为。选项可以是其中之一

• AddAltClass当 IndexOptions HTMLTable 生效并定义了 IndexStyleSheet 时，向列表 table 的目录的每一行添加一个额外的 CSS class 声明。而不是标准的偶数和奇数 classes，否则将应用于 table 的每一行，class 的 even-ALT 或 odd-ALT，其中 ALT 是与文件样式相关联的标准替代文本(例如，snd，txt，img 等)或者由各种 AddAlt *指令之一定义的 alt 文本。
• Charset=character-set(Apache HTTP Server 2.0.61 及更高版本)
  Charset 关键字允许您指定生成的页面的字符集。 Windows 和 Mac OS X 上的默认值为 UTF-8，其他地方为 ISO-8859-1。(这取决于底层文件系统是使用 Unicode 文件名还是 not.)IndexOptions Charset=UTF-8
• DescriptionWidth =[n |*]
  DescriptionWidth 关键字允许您以字符指定描述列的宽度。
• -DescriptionWidth(或取消设置)允许mod_autoindex计算最佳宽度。
  DescriptionWidth=n 将列宽固定为 n 个字节宽。
  DescriptionWidth =*将列增长到容纳最长描述 string 所需的宽度。有关截断描述中固有的危险，请参阅 AddDescription 部分。
• FancyIndexing
  这打开了目录的花哨索引。
• FoldersFirst
  如果启用此选项，则子目录列表将始终首先出现，然后是目录中的普通 files。列表基本上分为两个组件，files 和子目录，每个组件分别排序，然后显示 subdirectories-first。例如，如果 sort order 按 name 降序，并且启用了 FoldersFirst，则子目录 Zed 将在子目录 Beta 之前列出，它将在普通 files Gamma 和 Alpha 之前列出。如果还启用了 FancyIndexing，则此选项仅起作用。
• HTMLTABLE
  FancyIndexing 的这个选项为花哨的目录列表构造了一个简单的 table。对于启用了 utf-8 的平台，或者文件名或描述文本将在 left-to-right 和 right-to-left 读取 order 之间交替是必要的。
• IconsAreLinks
  这使得图标成为文件名的锚点的一部分，用于花式索引。
• IconHeight[=pixels]
  当与 IconWidth 一起使用时，此选项的存在将使服务器在文件图标的 img 标记中包含 height 和 width 属性。这允许浏览器预先计算页面布局，而不必等到所有图像都已加载。如果没有为该选项提供 value，则默认为 Apache httpd 软件提供的图标的标准高度。如果还启用了 FancyIndexing，则此选项仅起作用。
• IconWidth[=pixels]
  当与 IconHeight 一起使用时，此选项的存在将使服务器在文件图标的 img 标记中包含 height 和 width 属性。这允许浏览器预先计算页面布局，而不必等到所有图像都已加载。如果没有为该选项提供 value，则默认为 Apache httpd 软件提供的图标的标准宽度。
• IGNORECASE
  如果启用此选项，则名称将以 case-insensitive 方式排序。例如，如果 sort order 按 name 升序，并且启用了 IgnoreCase，则文件 Zeta 将在文件 alfa 之后列出(注意：文件 GAMMA 将始终在文件 gamma 之前列出)。
• IgnoreClient
  此选项导致 mod_autoindex 忽略 client 中的所有查询变量，包括 sort order(隐含 SuppressColumnSorting.)
• NameWidth =[n |*]
  NameWidth 关键字允许您以字节为单位指定文件名列的宽度。
  -NameWidth(或取消设置)允许 mod_autoindex 计算最佳宽度，但最多只能宽 20 个字节。
  NameWidth=n 将列宽固定为 n 个字节宽。
  NameWidth =*将列增长到必要的宽度。
• ScanHTMLTitles
  这样就可以从 HTML 文档中提取标题以进行花式索引。如果文件没有 AddDescription 给出的描述，则 httpd 将读取标题元素的 value 的文档。这是 CPU 和磁盘密集型的。
• ShowForbidden
  如果指定，Apache httpd 将显示通常隐藏的 files，因为子请求返回 HTTP_UNAUTHORIZED 或 HTTP_FORBIDDEN
• SuppressColumnSorting
  如果指定，Apache httpd 将不会将 FancyIndexed 目录列中的列标题列入用于排序的链接。默认行为是他们成为链接；选择列标题将按该列中的值对目录列表进行排序。但是，仍然会遵守附加到 URL 的查询 string arguments。该行为由 IndexOptions IgnoreClient 控制。
• SuppressDescription这将抑制花式索引列表中的文件描述。默认情况下，没有定义文件描述，因此使用此选项将重新获得 23 个字符的屏幕空间以用于其他内容。有关设置文件描述的信息，请参阅 AddDescription。另请参阅 DescriptionWidth 索引选项以限制描述列的大小。如果还启用了 FancyIndexing，则此选项仅起作用。
• SuppressHTMLPreamble
  如果目录实际上包含 HeaderName 指令指定的文件，则模块通常在标准 HTML 前导码(<html>，<head>等等)之后包含文件的内容。 SuppressHTMLPreamble 选项禁用此行为，导致模块使用头文件内容启动显示。在这种情况下，头文件必须包含适当的 HTML 指令。如果没有头文件，则像往常一样生成前导码。如果您还指定了 ReadmeName，并且该文件存在，那么在输出中也会忽略关闭</body></html>标记，前提是您可能会将这些结束标记放在该文件中。
• SuppressIcon
  这将取消花式索引列表中的图标。组合 SuppressIcon 和 SuppressRules 会产生正确的 HTML 3.2 输出，最终规范禁止 img 和 hr 元素来自 pre 块(用于格式化 FancyIndexed listings.)
• SuppressLastModified
  这将抑制在花式索引列表中显示最后修改 date。如果还启用了 FancyIndexing，则此选项仅起作用。
• SuppressRules
  这将抑制目录列表中的水平规则 lines(hr 元素)。将 SuppressIcon 和 SuppressRules 组合在一起会产生正确的 HTML 3.2 输出，最终规范禁止来自 pre 块的 img 和 hr 元素(用于格式化 FancyIndexed listings.)此选项仅在启用 FancyIndexing 时才有效。
• SuppressSize
  这将抑制花式索引列表中的文件大小。如果还启用了 FancyIndexing，则此选项仅起作用。
• TrackModified
  这将返回 HTTP 标头中列出的目录的 Last-Modified 和 ETag 值。它仅在操作系统和文件系统 return 适当的 stat()结果时才有效。有些 Unix 系统会这样做，OS2 的 JFS 和 Win32 的 NTFS 卷也是如此。例如，OS2 和 Win32 FAT 卷不是。启用此 feature 后，client 或代理可以在执行 HEAD 请求时跟踪 files 列表的更改。请注意，某些操作系统会正确跟踪新的和已删除的 files，但不会跟踪目录中 files 的大小或日期的更改。对现有文件的大小或 date 标记的更改不会更新所有 Unix 平台上的 Last-Modified 标头。如果这是一个问题，请禁用此选项。
• Type=MIME content-type(Apache HTTP Server 2.0.61 及更高版本)
  Type 关键字允许您指定生成的页面的 MIME content-type。默认值为 text/html。 IndexOptions Type=text/plain
• UseOldDateFormat(Apache HTTP Server 2.4.26 及更高版本)
  用于最后修改字段的 date 格式无意中从 2.4.0 中的“％d-％b-％Y％H：％M”更改为“％Y-％m-％d％H：％M”。设置此选项可从 2.2 及更早版本恢复 date 格式。
• VersionSort(Apache HTTP Server 2.0a3 及更高版本)
  VersionSort 关键字导致包含 version numbers 的 files 以自然方式排序。 Strings 像往常一样排序，除了 name 和 description 中的数字子串根据它们的数字 value 进行比较。例如：foo-1.7 foo-1.7.2 foo-1.7.12 foo-1.8.2 foo-1.8.2a foo-1.12 如果数字以零开头，那么它被认为是一个分数：foo-1.001 foo-1.002 foo-1.030 foo-1.04
• XHTML(Apache HTTP Server 2.0.49 及更高版本)
  XHTML 关键字强制 mod_autoindex 发出 XHTML 1.0 code 而不是 HTML 3.2.如果还启用了 FancyIndexing，则此选项仅起作用。
• 增量 IndexOptions
  请注意如何处理多个 IndexOptions。现在，单个目录的多个 IndexOptions 指令合并在一起。结果：<Directory "/foo ">
  IndexOptions HTMLTable
  IndexOptions SuppressColumnsorting
  </Directory>将等同于 IndexOptions HTMLTable SuppressColumnsorting 添加增量语法(i.e.，前缀关键字或-)。每当遇到''或'-'前缀关键字时，它将应用于当前的 IndexOptions 设置(可能具有从 upper-level 目录继承.)但是，每当处理一个没有前缀的关键字时，它会清除所有继承的选项和到目前为止遇到的任何增量设置。请考虑以下 example：IndexOptions ScanHTMLTitles -IconsAreLinks FancyIndexingIndexOptions SuppressSize 净效果等同于 IndexOptions FancyIndexing SuppressSize，因为未加前缀的 FancyIndexing 丢弃了之前的增量关键字，但允许它们在之后再次开始累积。要无条件地为特定目录设置 IndexOptions，清除继承的设置，请指定不带任何或-前缀的关键字。

IndexOrderDefault 指令

IndexOrderDefault指令与FancyIndexing index 选项结合使用。默认情况下，fancyindexed 目录列表按文件名升序 order 显示;IndexOrderDefault允许您更改此初始显示 order。

IndexOrderDefault需要两个 arguments。第一个必须是Ascending或Descending，表示排序的方向。第二个参数必须是关键字Name，Date，Size或Description之一，并标识主 key。辅助 key 始终是升序文件名。

如果需要，您可以通过添加SuppressColumnSorting索引选项以从列顶部删除排序链接以及IgnoreClient索引选项来阻止 client 重新排序列表，以防止他们手动向查询 string 添加排序选项在 order 中覆盖您的 ordering 首选项。

IndexStyleSheet 指令

IndexStyleSheet指令设置将用作索引列表的 CSS 的文件的 name。

IndexStyleSheet "/css/style.css"

将此指令与IndexOptions HTMLTable结合使用会在生成的 HTML 中添加许多 CSS classes。整个 table 的 CSS id 为indexlist，以下 classes 与列表的各个部分相关联：

ReadmeName 指令

ReadmeName指令设置将附加到索引列表末尾的文件的 name。 Filename 是要包含的文件的 name，并且与被索引的位置相关。如果 Filename 以斜杠开头，如 example 2 中那样，它将被视为相对于DocumentRoot。

# Example 1
ReadmeName FOOTER.html

# Example 2
ReadmeName /include/FOOTER.html

另请参见HeaderName，其中更详细地描述了此行为。