From: dgaudet Date: Tue, 8 Jul 1997 19:50:41 +0000 (+0000) Subject: Automatic indexes moved from mod_dir into mod_autoindex. The mod_autoindex X-Git-Tag: APACHE_1_3a1~23 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4c413a6c9761e1d0572bf981a7a831ef0f1de475;p=thirdparty%2Fapache%2Fhttpd.git Automatic indexes moved from mod_dir into mod_autoindex. The mod_autoindex CVS files are copies of the mod_dir files so that we retain history in both places. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@78566 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/directives.html b/docs/manual/mod/directives.html index 3667159927c..32e7642d610 100644 --- a/docs/manual/mod/directives.html +++ b/docs/manual/mod/directives.html @@ -19,15 +19,15 @@
  • AccessConfig
  • AccessFileName
  • Action -
  • AddAlt -
  • AddAltByEncoding -
  • AddAltByType -
  • AddDescription +
  • AddAlt +
  • AddAltByEncoding +
  • AddAltByType +
  • AddDescription
  • AddEncoding
  • AddHandler -
  • AddIcon -
  • AddIconByEncoding -
  • AddIconByType +
  • AddIcon +
  • AddIconByEncoding +
  • AddIconByType
  • AddLanguage
  • AddModule
  • AddType @@ -73,7 +73,7 @@
  • CookieLog (mod_log_config)
  • CookieTracking
  • CustomLog -
  • DefaultIcon +
  • DefaultIcon
  • DefaultType
  • deny
  • <Directory> @@ -86,21 +86,21 @@
  • ExpiresActive
  • ExpiresByType
  • ExpiresDefault -
  • FancyIndexing +
  • FancyIndexing
  • <Files>
  • <FilesMatch>
  • ForceType
  • Group
  • Header -
  • HeaderName +
  • HeaderName
  • HostNameLookups
  • IdentityCheck
  • <IfModule>
  • ImapBase
  • ImapDefault
  • ImapMenu -
  • IndexIgnore -
  • IndexOptions +
  • IndexIgnore +
  • IndexOptions
  • KeepAlive
  • KeepAliveTimeout
  • LanguagePriority @@ -131,7 +131,7 @@
  • ProxyPass
  • ProxyRemote
  • ProxyRequests -
  • ReadmeName +
  • ReadmeName
  • Redirect
  • RedirectMatch
  • RedirectPermanent diff --git a/docs/manual/mod/index.html b/docs/manual/mod/index.html index 98c48cb03f0..a2ee08f3db5 100644 --- a/docs/manual/mod/index.html +++ b/docs/manual/mod/index.html @@ -44,6 +44,8 @@ Apache distribution. See also the complete alphabetical list of
    User authentication using DBM files.
    mod_auth_msql
    User authentication using mSQL files. +
    mod_autoindex +
    Automatic directory listings.
    mod_browser Apache 1.2 and up
    Set environment variables based on User-Agent strings
    mod_cern_meta @@ -56,7 +58,7 @@ mod_usertrack
    mod_digest
    MD5 authentication
    mod_dir -
    Automatic directory listings. +
    Basic directory handling.
    mod_dld
    Start-time linking with the GNU libdld.
    mod_env diff --git a/docs/manual/mod/mod_autoindex.html b/docs/manual/mod/mod_autoindex.html index bd255fb6c55..82ebd0db09e 100644 --- a/docs/manual/mod/mod_autoindex.html +++ b/docs/manual/mod/mod_autoindex.html @@ -1,7 +1,7 @@ -Apache module mod_dir +Apache module mod_autoindex @@ -13,25 +13,28 @@ ALINK="#FF0000" > -

    Module mod_dir

    +

    Module mod_autoindex

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

    Summary

    -This module controls the directory indexing. The index of a directory -can come from one of two sources: +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. +The DirectoryIndex directive sets +the name of this file. +This is controlled by mod_dir.
    • 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. +first icon listed that matches the file is displayed. These +are controlled by mod_autoindex.
    +The two functions are separated so that you can completely remove +(or replace) automatic index generation should you want to.

    Directives

    @@ -45,7 +48,6 @@ first icon listed that matches the file is displayed.
  • AddIconByEncoding
  • AddIconByType
  • DefaultIcon -
  • DirectoryIndex
  • FancyIndexing
  • HeaderName
  • IndexIgnore @@ -200,41 +202,6 @@ specific icon is known, for FancyIndexing. 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 / -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, in which case the server will return the first one -that it finds. If none of the resources exist and the -Indexes option is set, 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
    diff --git a/docs/manual/mod/mod_dir.html b/docs/manual/mod/mod_dir.html index bd255fb6c55..4d1c461d808 100644 --- a/docs/manual/mod/mod_dir.html +++ b/docs/manual/mod/mod_dir.html @@ -16,190 +16,34 @@

    Module mod_dir

    This module is contained in the mod_dir.c file, and -is compiled in by default. It provides for directory indexing. +is compiled in by default. It provides for "trailing slash" redirects and +serving directory index files.

    Summary

    -This module controls the directory indexing. The index of a directory -can come from one of two sources: +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. +The DirectoryIndex directive sets +the name of this file. +This is controlled by mod_dir. +
    • Otherwise, a listing generated by the server. This is provided by +mod_autoindex.
    - +The two functions are separated so that you can completely remove +(or replace) automatic index generation should you want to. +

    A "trailing slash" redirect is issued when the server receives a +request for a URL http://servername/foo/dirname where +dirname is a directory. Directories require a trailing +slash, so mod_dir issues a redirect to +http://servername/foo/dirname/.

    Directives

    -
  • AddAlt -
  • AddAltByEncoding -
  • AddAltByType -
  • AddDescription -
  • AddIcon -
  • AddIconByEncoding -
  • AddIconByType -
  • DefaultIcon
  • DirectoryIndex -
  • FancyIndexing -
  • HeaderName -
  • IndexIgnore -
  • IndexOptions -
  • ReadmeName
    • -

    AddAlt

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

    - -This sets the alternate text to display for a file, instead of an icon, 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 -("). This alternate text is displayed if the client is -image-incapable or has image loading disabled. - -

    -

    AddAltByEncoding

     - -Syntax: AddAltByEncoding string MIME-encoding - MIME-encoding...
    -Context: server config, virtual host, directory, .htaccess
    -Override: Indexes
    -Status: Base
    -Module: mod_dir

    - -This sets the alternate text to display for a file, instead of an icon, for -FancyIndexing. MIME-encoding is a -valid content-encoding, such as x-compress. -String is enclosed in double quotes -("). This alternate text is displayed if the client is -image-incapable or has image loading disabled. - -

    -

    AddAltByType

     - -Syntax: AddAltByType string MIME-type MIME-type...
    -Context: server config, virtual host, directory, .htaccess
    -Override: Indexes
    -Status: Base
    -Module: mod_dir

    - -This sets the alternate text to display for a file, instead of an icon, for -FancyIndexing. MIME-type is a -valid content-type, such as text/html. -String is enclosed in double quotes -("). This alternate text is displayed if the client is -image-incapable or has image loading disabled. - -

    - -

    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, wild-card 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 ...
    @@ -235,152 +79,6 @@ 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 behavior 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. -
    IconHeight[=pixels] (Apache 1.3 and later) -
    - -Presence of this option, when used with 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 -software. -
    IconWidth[=pixels] (Apache 1.3 and later) -
    - -Presence of this option, when used with 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 -software. -
    -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.

    - -