X-Git-Url: https://granicus.if.org/sourcecode?a=blobdiff_plain;f=docs%2Fmanual%2Fmod%2Fmod_autoindex.html.en;h=0e7634944ead467c7203ae0afecd8bb183e4f275;hb=0ae5b1af6b6bf3048d2a124e84905f63d6507dea;hp=687f3f010b0e3de28137acac0133abd00bc1d7ec;hpb=a015503f65d8f80993fd129b871a0453d78b6331;p=apache diff --git a/docs/manual/mod/mod_autoindex.html.en b/docs/manual/mod/mod_autoindex.html.en index 687f3f010b..0e7634944e 100644 --- a/docs/manual/mod/mod_autoindex.html.en +++ b/docs/manual/mod/mod_autoindex.html.en @@ -1,23 +1,25 @@ - -mod_autoindex - Apache HTTP Server +mod_autoindex - Apache HTTP Server Version 2.5 -
-

Modules | Directives | FAQ | Glossary | Sitemap

+

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.5

-
+
<-
Apache > HTTP Server > Documentation > Version 2.5 > Modules
@@ -71,7 +73,7 @@ same header repeatedly toggles between ascending and descending order. These column header links are suppressed with the IndexOptions directive's - SuppressColumnSorting + SuppressColumnSorting option.

Note that when the display is sorted by "Size", it's the @@ -80,7 +82,10 @@ before a 1011-byte file (if in ascending order) even though they both are shown as "1K".

-

Directives

+

Topics

+

Directives

-

Topics

-
+

Bugfix checklist

See also

+
top

Autoindex Request Query Arguments

@@ -225,10 +229,9 @@ icon selected by filename is displayed if the client is image-incapable, has image loading disabled, or fails to retrieve the icon.

-

Examples

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

+ 
AddAlt "PDF file" *.pdf
+AddAlt Compressed *.gz *.zip *.Z
+
top
@@ -251,9 +254,8 @@ selected by MIME-encoding This alternate text is displayed if the client is image-incapable, has image loading disabled, or fails to retrieve the icon.

-

Example

- AddAltByEncoding gzip x-gzip -

+ 
AddAltByEncoding gzip x-gzip
+
top
@@ -276,9 +278,8 @@ icon selected by MIME content-type This alternate text is displayed if the client is image-incapable, has image loading disabled, or fails to retrieve the icon.

-

Example

- AddAltByType 'plain text' text/plain -

+ 
AddAltByType 'plain text' text/plain
+
top
@@ -297,10 +298,9 @@ icon selected by MIME content-type expression or full filename for files to describe. String is enclosed in double quotes (").

-

Example

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

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

The typical, default description field is 23 bytes wide. 6 more bytes are added by the IndexOptions SuppressIcon option, 7 bytes are @@ -332,7 +332,7 @@ icon selected by MIME content-type

Arguments with path information

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 + which would normally only be used in htaccess context, are implicitly prefixed with '*/' to avoid matching partial directory names.

@@ -364,11 +364,11 @@ icon selected by MIME content-type is unnecessary if you're using IndexOptions HTMLTable.

-

Examples

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

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

AddIconByType should be used in preference to AddIcon, @@ -397,9 +397,8 @@ content-encoding

MIME-encoding is a valid content-encoding, such as x-compress.

-

Example

- AddIconByEncoding /icons/compress.png x-compress -

+ 
AddIconByEncoding /icons/compress.png x-compress
+
top
@@ -425,9 +424,8 @@ content-type

MIME-type is a wildcard expression matching required the mime types.

-

Example

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

+ 
AddIconByType (IMG,/icons/image.png) image/*
+
top
@@ -446,9 +444,8 @@ configured Url-path is a (%-escaped) relative URL to the icon, or a fully qualified remote URL.

-

Example

- DefaultIcon /icon/unknown.png -

+ 
DefaultIcon /icon/unknown.png
+
top
@@ -466,9 +463,8 @@ of the index listing of the file that will be inserted at the top of the index listing. Filename is the name of the file to include.

-

Example

- HeaderName HEADER.html -

+ 
HeaderName HEADER.html
+

Both HeaderName and ReadmeName now treat @@ -476,9 +472,8 @@ of the index listing access the directory being indexed. If Filename begins with a slash, it will be taken to be relative to the DocumentRoot.

-

Example

- HeaderName /include/HEADER.html -

+ 
HeaderName /include/HEADER.html
+

Filename must resolve to a document with a major content type of text/* (e.g., @@ -487,9 +482,8 @@ of the index listing actual file type (as opposed to its output) is marked as text/html such as with a directive like:

-

- AddType text/html .cgi -

+ 
AddType text/html .cgi
+

Content negotiation will be performed if Options @@ -525,10 +519,8 @@ of the index listing

The IndexHeadInsert directive specifies a string to insert in the <head> section of the HTML generated for the index page.

-

Example

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

+ 
IndexHeadInsert "<link rel=\"sitemap\" href=\"/sitemap.html\">"
+
top
@@ -547,13 +539,12 @@ a directory list of files to hide when listing a directory. File is a shell-style wildcard expression or full filename. Multiple IndexIgnore directives add - to the list, rather than the replacing the list of ignored + to the list, rather than replacing the list of ignored files. By default, the list contains . (the current directory).

-

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

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

Regular Expressions

This directive does not currently work in configuration sections @@ -578,15 +569,14 @@ a directory any files ignored by IndexIgnore otherwise inherited from other configuration sections.

-

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

+ 
<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>
+

Review the default configuration for a list of patterns that you might want to explicitly ignore after using this @@ -634,9 +624,8 @@ indexing (It depends on whether the underlying file system uses Unicode filenames or not.) -

Example:

- IndexOptions Charset=UTF-8 -

+ 
IndexOptions Charset=UTF-8
+
DescriptionWidth=[n | *]
@@ -645,17 +634,17 @@ indexing specify the width of the description column in characters. -
-DescriptionWidth (or unset) allows - mod_autoindex to calculate the best width.
+
-DescriptionWidth (or unset) allows + mod_autoindex to calculate the best width.
DescriptionWidth=n fixes the column width to n bytes wide.
DescriptionWidth=* grows the column to the width necessary to accommodate the longest description - string.
+ string. -
See the section on AddDescription for dangers + See the section on AddDescription for dangers inherent in truncating descriptions.
FancyIndexing
@@ -673,8 +662,10 @@ indexing 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. + Gamma and Alpha. + This option only has an effect if FancyIndexing + is also enabled. +
HTMLTable
@@ -697,7 +688,12 @@ indexing 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. + with the Apache httpd software. + + This option + only has an effect if FancyIndexing is also enabled. + +
IconWidth[=pixels]
@@ -770,7 +766,11 @@ indexing so the use of this option will regain 23 characters of screen space to use for something else. See AddDescription for information about setting the file description. See also the DescriptionWidth - index option to limit the size of the description column. + index option to limit the size of the description column. + + This option + only has an effect if FancyIndexing is also enabled. +
SuppressHTMLPreamble
@@ -800,7 +800,11 @@ indexing
SuppressLastModified
This will suppress the display of the last modification date, - in fancy indexing listings.
+ in fancy indexing listings. + + This option + only has an effect if FancyIndexing is also enabled. +
SuppressRules
@@ -810,11 +814,20 @@ indexing 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.) + format FancyIndexed listings.) + + This option + only has an effect if FancyIndexing is also enabled. + +
SuppressSize
-
This will suppress the file size in fancy indexing listings.
+
This will suppress the file size in fancy indexing listings. + + This option + only has an effect if FancyIndexing is also enabled. +
TrackModified
@@ -839,9 +852,8 @@ indexing specify the MIME content-type of the generated page. The default is text/html. -

Example:

- IndexOptions Type=text/plain -

+ 
IndexOptions Type=text/plain
+
VersionSort @@ -876,10 +888,14 @@ indexing (Apache HTTP Server 2.0.49 and later)
The XHTML keyword forces mod_autoindex - to emit XHTML 1.0 code instead of HTML 3.2.
+ to emit XHTML 1.0 code instead of HTML 3.2. + This option + only has an effect if FancyIndexing is also enabled. + +
Incremental IndexOptions
@@ -890,20 +906,16 @@ indexing
  • Multiple IndexOptions directives for a single directory are now merged together. The result of: -

    - <Directory /foo> - - IndexOptions HTMLTable
    - IndexOptions SuppressColumnsorting -     - </Directory> -

    + 
    <Directory "/foo">
+    IndexOptions HTMLTable
+    IndexOptions SuppressColumnsorting
+</Directory>
    +

    will be the equivalent of

    -

    - IndexOptions HTMLTable SuppressColumnsorting -

    + 
    IndexOptions HTMLTable SuppressColumnsorting
    +
  • The addition of the incremental syntax (i.e., prefixing @@ -917,10 +929,9 @@ indexing clears all inherited options and any incremental settings encountered so far. Consider the following example:

    -

    - IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
    - IndexOptions +SuppressSize -

    + 
    IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
    
+IndexOptions +SuppressSize
    +

    The net effect is equivalent to IndexOptions FancyIndexing +SuppressSize, because the unprefixed FancyIndexing @@ -981,10 +992,8 @@ Name|Date|Size|Description

    The IndexStyleSheet directive sets the name of the file that will be used as the CSS for the index listing.

    -

    Example

    - - IndexStyleSheet "/css/style.css" -

    + 
    IndexStyleSheet "/css/style.css"
    +

    Using this directive in conjunction with IndexOptions HTMLTable adds a number of CSS classes to the resulting HTML. @@ -1024,13 +1033,13 @@ of the index listing relative to the DocumentRoot.

    -

    Example 1

    - ReadmeName FOOTER.html -

    + 
    # Example 1
+ReadmeName FOOTER.html
    + + + 
    # Example 2
+ReadmeName /include/FOOTER.html
    -

    Example 2

    - ReadmeName /include/FOOTER.html -

    See also HeaderName, where this behavior is described in greater detail.

    @@ -1043,11 +1052,28 @@ of the index listing  ja  |  ko  |  tr 

    -
    • + else { + d.write('
    Comments are disabled for this page at the moment.<\/div>'); + } +})(window, document); +//-->
    \ No newline at end of file