From: Joshua Slive Date: Sat, 9 Mar 2002 18:31:23 +0000 (+0000) Subject: Update transformations. X-Git-Tag: CHANGES~162 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2c8b203d042a286f1d72ff7f22c8bf60801dc0e0;p=thirdparty%2Fapache%2Fhttpd.git Update transformations. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@93815 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_include.html b/docs/manual/mod/mod_include.html index 8ada13b557c..113a44f4ca9 100644 --- a/docs/manual/mod/mod_include.html +++ b/docs/manual/mod/mod_include.html @@ -2,8 +2,7 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --->mod_include - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_include

Description:This module provides for server-parsed html -documents.
Status:Base
Module Identifier:include_module
Compatibility:

Summary

+-->mod_include - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_include

Description:Server-parsed html documents (Server Side Includes)
Status:Base
Module Identifier:include_module

Summary

This module provides a filter which will process files before they are sent to the client. The processing is @@ -12,12 +11,7 @@ documents. - See also: - Options, - SetOutputFilter - and AcceptPathInfo. - -

Directives

Enabling Server-Side Includes

+

See also

Directives

Enabling Server-Side Includes

Server Side Includes are implemented by the @@ -50,8 +44,8 @@ documents.text/x-server-parsed-html3 (and the resulting output will have the mime type text/html).

- For more information, see our Tutorial on Server Side - Includes. +

For more information, see our Tutorial on Server Side + Includes.

Basic Elements

The document is parsed as an HTML document, with special @@ -64,7 +58,7 @@ documents.The value will often be enclosed in double quotes; many commands only allow a single attribute-value pair. Note that - the comment terminator (-->) should be preceded + the comment terminator (-->) should be preceded by whitespace to ensure that it isn't considered part of an SSI token.

@@ -99,7 +93,7 @@ documents. -
echo
+
echo

This command prints one of the include @@ -352,10 +346,10 @@ documents.Include Variables - In addition to the variables in the standard CGI environment, +

In addition to the variables in the standard CGI environment, these are available for the echo command, for if and elif, and to any program - invoked by the document. + invoked by the document.

DATE_GMT
@@ -387,9 +381,9 @@ documents.Variable substitution is done within quoted strings in most cases where they may reasonably occur as an argument to an SSI - directive. This includes the config, - exec, flastmod, fsize, - include, and set directives, as well + directive. This includes the config, + exec, flastmod, fsize, + include, and set directives, as well as the arguments to conditional operators. You can insert a literal dollar sign into the string using backslash quoting:

@@ -407,10 +401,10 @@ documents.
-

This will result in the Zed variable being set - to "X_Y" if REMOTE_HOST is - "X" and REQUEST_METHOD is - "Y".

+

This will result in the Zed variable being set + to "X_Y" if REMOTE_HOST is + "X" and REQUEST_METHOD is + "Y".

EXAMPLE: the below example will print "in foo" if the DOCUMENT_URI is /foo/file.html, "in bar" if it is @@ -425,11 +419,11 @@ documents. <!--#endif --> -

Flow Control Elements

+

Flow Control Elements

- These are available in Apache 1.2 and above. The basic flow - control elements are: +

These are available in Apache 1.2 and above. The basic flow + control elements are:

<!--#if expr="test_condition" -->
@@ -471,7 +465,7 @@ documents.
Compare string1 with string 2. If string2 has the form /string/ then it is compared as a regular expression. Regular expressions have the same syntax as those - found in the Unix egrep command. + found in the Unix egrep command.
( test_condition )
@@ -517,11 +511,11 @@ documents.
Using Server Side Includes for ErrorDocuments - There is a document +

There is a document which describes how to use the features of mod_include to offer - internationalized customized server error documents. + internationalized customized server error documents.

-

PATH_INFO with Server Side Includes

+

PATH_INFO with Server Side Includes

Files processed for server-side includes no longer accept requests with PATH_INFO (trailing pathname information) by @@ -534,8 +528,7 @@ include command.

SSIStartTag. -

SSIErrorMsg Directive

Description: Changes the error message displayed when there is an error
Syntax:SSIErrorMsg message
Default:SSIErrorMsg +

See also

  • SSIStartTag

SSIErrorMsg Directive

Description: Changes the error message displayed when there is an error
Syntax:SSIErrorMsg message
Default:SSIErrorMsg "[an error occurred while processing this directive]"
Context:server config, virtual host, directory, .htaccess
Override:
Status:Base
Module:mod_include
Compatibility:Available in version 2.0.30 and later.

The SSIErrorMsg directive changes the error message displayed when mod_include encounters an error. For production servers you @@ -556,9 +549,7 @@ include element

- See also: SSIEndTag - -

SSITimeFormat Directive

Description: Configures the format in which date strings are +

See also

  • SSIEndTag

SSITimeFormat Directive

Description: Configures the format in which date strings are displayed
Syntax:SSITimeFormat formatstring
Default:SSITimeFormat "%A, %d-%b-%Y %H:%M:%S %Z"
Context:server config, virtual host, directory, .htaccess
Override:
Status:Base
Module:mod_include
Compatibility:Available in version 2.0.30 and later.

This directive changes the format in which date strings are displayed when echoing DATE environment variables. The formatstring @@ -566,6 +557,11 @@ displayed

Syn

This directive has the same effect as the <--#config timefmt=formatstring --> element.

+

SSIUndefinedEcho Directive

Description: Changes the string that mod_include displays when +a variable isn't set.
Syntax:SSIUndefinedEcho tag
Default:SSIUndefinedEcho "<-- undef -->"
Context:server config, virtual host
Override:FileInfo
Status:Base
Module:mod_include
Compatibility:Available in version 2.0.34 and later. +
+

This directive changes the string that mod_include displays + when a variable is not set and "echoed".


XBitHack Directive

Description: Parse SSI directives in files with the execute bit set
Syntax:XBitHack on|off|full
Default:XBitHack off
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Base
Module:mod_include
Compatibility:

The XBitHack directives controls the parsing of ordinary diff --git a/docs/manual/mod/mod_info.html b/docs/manual/mod/mod_info.html index ebf870ea19f..0a350e01b66 100644 --- a/docs/manual/mod/mod_info.html +++ b/docs/manual/mod/mod_info.html @@ -2,13 +2,10 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --->mod_info - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_info

Description:This module provides a comprehensive overview of the server -configuration including all installed modules and directives in the -configuration files.
Status:Extension
Module Identifier:info_module
Compatibility:Available in Apache 1.1 and later

Summary

+-->mod_info - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_info

Description:Provides a comprehensive overview of the server +configuration
Status:Extension
Module Identifier:info_module

Summary

-

Using mod_info

- -

To configure it, add the following to your +

To configure mod_info, add the following to your httpd.conf file.

@@ -17,12 +14,12 @@ SetHandler server-info
</Location>
- You may wish to add a +

You may wish to add a <Limit> clause inside the <location> directive to limit access to your server configuration - information. + information.

Once configured, the server information is obtained by accessing http://your.host.dom/server-info

@@ -45,7 +42,7 @@ SetHandler server-info
ramifications for your site.

Directives


AddModuleInfo Directive

Description: Allows additional information to be added to the module -information displayed by the server-info handler
Syntax:AddModuleInfo module-name string
Default:none
Context:server config, virtual +information displayed by the server-info handler
Syntax:AddModuleInfo module-name string
Context:server config, virtual host
Status:Extension
Module:mod_info
Compatibility:Apache 1.3 and above

This allows the content of string to be shown as HTML interpreted, Additional Information for diff --git a/docs/manual/mod/mod_isapi.html b/docs/manual/mod/mod_isapi.html index a8d55a5b660..c8611137d86 100644 --- a/docs/manual/mod/mod_isapi.html +++ b/docs/manual/mod/mod_isapi.html @@ -1,35 +1,8 @@ - - - - - - - Apache module mod_isapi - - - - - - -

Module mod_isapi

- -

This module supports ISAPI Extensions within Apache for - Windows.

- -

Status: Base
- Source File: mod_isapi.c
- Module Identifier: - isapi_module
- Compatibility: WIN32 only

- -

Summary

- +mod_isapi - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_isapi

Description:ISAPI Extensions within Apache for Windows
Status:Base
Module Identifier:isapi_module
Compatibility:Win32 only

Summary

This module implements the Internet Server extension API. It allows Internet Server extensions (e.g. ISAPI .dll modules) to be served by Apache for Windows, subject to the @@ -41,44 +14,23 @@ directly if you are experiencing problems running their ISAPI extention. Please do not post such problems to Apache's lists or bug reporting pages.

- -

Directives

- - - -

Usage

- -

In the server configuration file, use the AddHandler - directive to associate ISAPI files with the - isapi-isa handler, and map it to the with their - file extensions. To enable any .dll file to be processed as an - ISAPI extention, edit the httpd.conf file and add the following - line:

-
+

Directives

Usage

In the server configuration file, use +the AddHandler directive to +associate ISAPI files with the isapi-isa handler, and map +it to the with their file extensions. To enable any .dll file to be +processed as an ISAPI extention, edit the httpd.conf file and add the +following line:

+
AddHandler isapi-isa .dll - +

There is no capability within the Apache server to leave a requested module loaded. However, you may preload and keep a specific module loaded by using the following syntax in your httpd.conf:

-
+
ISAPICacheFile c:/WebWork/Scripts/ISAPI/mytest.dll - +

Whether or not you have preloaded an ISAPI extension, all ISAPI extensions are governed by the same permissions and @@ -86,12 +38,10 @@ ExecCGI must be set for the directory that contains the ISAPI .dll file.

-

Review the Additional Notes and the Programmer's Journal for additional details +

Review the Additional Notes and the Programmer's Journal for additional details and clarification of the specific ISAPI support offered by mod_isapi.

- -

Additional Notes

+

Additional Notes

Apache's ISAPI implementation conforms to all of the ISAPI 2.0 specification, except for some "Microsoft-specific" @@ -117,29 +67,27 @@ it does not support ISAPI Filters. Support for filters may be added at a later date, but no support is planned at this time.

+

Programmer's Journal

-

Programmer's - Journal

- -

If you are programming Apache 2.0 mod_isapi modules, you - must limit your calls to ServerSupportFunction to the following - directives:

+

If you are programming Apache 2.0 mod_isapi + modules, you must limit your calls to ServerSupportFunction to the + following directives:

HSE_REQ_SEND_URL_REDIRECT_RESP
-
Redirect the user to another location.
+
Redirect the user to another location.
This must be a fully qualified URL (e.g. http://server/location).
HSE_REQ_SEND_URL
-
Redirect the user to another location.
+
Redirect the user to another location.
This cannot be a fully qualified URL, you are not allowed to pass the protocol or a server name (e.g. simply - /location).
+ /location).
This redirection is handled by the server, not the - browser.
+ browser.
Warning: in their recent documentation, Microsoft appears to have abandoned the distinction between the two HSE_REQ_SEND_URL functions. Apache continues to treat @@ -220,146 +168,38 @@ GetServerVariable, as well as the ALL_HTTP and ALL_RAW values.

-

Apache 2.0 mod_isapi supports additional features introduced - in later versions of the ISAPI specification, as well as - limited emulation of async I/O and the TransmitFile semantics. - Apache also supports preloading ISAPI .dlls for performance, - neither of which were not available under Apache 1.3 +

Apache 2.0 mod_isapi supports additional + features introduced in later versions of the ISAPI specification, + as well as limited emulation of async I/O and the TransmitFile + semantics. Apache also supports preloading ISAPI .dlls for + performance, neither of which were not available under Apache 1.3 mod_isapi.

-
- -

ISAPIFileCache - directive

- - Syntax: ISAPIFileCache - file [file] ...
- Context: server config
- Override: None
- Status: Base
- Module: mod_isapi
- Compatibility: Apache 2.0 and - later, Win32 only - +

ISAPIAppendLogToErrors Directive

Description: Record HSE_APPEND_LOG_PARAMETER requests from ISAPI +extensions to the error log
Syntax:ISAPIAppendLogToErrors on|off
Default:ISAPIAppendLogToErrors off
Context:server config
Status:Base
Module:mod_isapi
+

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI + extensions to the server error log.

+

ISAPIAppendLogToQuery Directive

Description: Record HSE_APPEND_LOG_PARAMETER requests from ISAPI +extensions to the query field
Syntax:ISAPIAppendLogToQuery on|off
Default:ISAPIAppendLogToQuery off
Context:server config
Status:Base
Module:mod_isapi
+

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI + extensions to the query field (appended to the CustomLog %q + component).

+

ISAPIFileChache Directive

Description: ISAPI .dll files to be loaded at startup
Syntax:ISAPIFileCache file-path [file-path] ...
Context:server config
Status:Base
Module:mod_isapi

Specifies a space-separated list of file names to be loaded when the Apache server is launched, and remain loaded until the server is shut down. This directive may be repeated for every ISAPI .dll file desired. The full path name of each file should be specified.

-
- -

ISAPIReadAheadBuffer - directive

- - Syntax: ISAPIReadAheadBuffer - size
- Default: 49152
- Context: server config
- Override: None
- Status: Base
- Module: mod_isapi
- Compatibility: Apache 1.3.13 - and later, Win32 only - +

ISAPILogNotSupported Directive

Description: Log unsupported feature requests from ISAPI +extensions
Syntax:ISAPILogNotSupported on|off
Default:ISAPILogNotSupported on
Context:server config
Status:Base
Module:mod_isapi
+

Logs all requests for unsupported features from ISAPI + extensions in the server error log. While this should be turned + off once all desired ISAPI modules are functioning, it defaults + to on to help administrators track down problems.

+

ISAPIReadAheadBuffer Directive

Description: Size of the Read Ahead Buffer sent to ISAPI +extensions
Syntax:ISAPIReadAheadBuffer size
Default:ISAPIReadAheadBuffer 49152
Context:server config
Status:Base
Module:mod_isapi

Defines the maximum size of the Read Ahead Buffer sent to ISAPI extensions when they are initially invoked. All remaining data must be retrieved using the ReadClient callback; some ISAPI extensions may not support the ReadClient function. Refer questions to the ISAPI extension's author.

-
- -

ISAPILogNotSupported - directive

- - Syntax: ISAPILogNotSupported - on|off
- Default: on
- Context: server config
- Override: None
- Status: Base
- Module: mod_isapi
- Compatibility: Apache 1.3.13 - and later, Win32 only - -

Logs all requests for unsupported features from ISAPI - extensions in the server error log. While this should be turned - off once all desired ISAPI modules are functioning, it defaults - to on to help administrators track down problems.

-
- -

ISAPIAppendLogToErrors - directive

- - Syntax: ISAPIAppendLogToErrors - on|off
- Default: off
- Context: server config
- Override: None
- Status: Base
- Module: mod_isapi
- Compatibility: Apache 1.3.13 - and later, Win32 only - -

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI - extensions to the server error log.

-
- -

ISAPIAppendLogToQuery - directive

- - Syntax: ISAPIAppendLogToQuery - on|off
- Default: off
- Context: server config
- Override: None
- Status: Base
- Module: mod_isapi
- Compatibility: Apache 1.3.13 - and later, Win32 only - -

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI - extensions to the query field (appended to the CustomLog %q - component).

- -

-

- - - +

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_log_config.html b/docs/manual/mod/mod_log_config.html index 53be79d9f5d..50e0ff82031 100644 --- a/docs/manual/mod/mod_log_config.html +++ b/docs/manual/mod/mod_log_config.html @@ -2,9 +2,7 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --->mod_log_config - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_log_config

Description:This module provides for logging of the requests -made to the server, using the Common Log Format or a -user-specified format.
Status:Base
Module Identifier:log_config_module
Compatibility:

Summary

+-->mod_log_config - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_log_config

Description:Logging of the requests made to the server
Status:Base
Module Identifier:log_config_module

Summary

This module provides for flexible logging of client requests. Logs are written in a customizable format, and may be @@ -20,11 +18,7 @@ user-specified format.

Apache Log Files. - -

Custom Log Formats

+

See also

Directives

Custom Log Formats

The format argument to the LogFormat and @@ -187,8 +181,6 @@ this conflicted with the historical ssl %...{var}c syntax.)

- -

Security Considerations

@@ -198,9 +190,7 @@ this conflicted with the historical ssl %...{var}c syntax.)
- - -

Directives


CookieLog Directive

Description: Sets filename for the logging of cookies
Syntax:CookieLog filename
Default:none
Context:server config, virtual +

CookieLog Directive

Description: Sets filename for the logging of cookies
Syntax:CookieLog filename
Context:server config, virtual host
Status:Base
Module:mod_log_config
Compatibility:Only available in Apache 1.2 and above

The CookieLog directive sets the @@ -210,7 +200,7 @@ host

Status:< and is deprecated.


CustomLog Directive

Description: Sets filename and format of log file
Syntax:CustomLog file|pipe format|nickname - [env=[!]environment-variable]
Default:none
Context:server config, virtual + [env=[!]environment-variable]
Context:server config, virtual host
Status:Base
Module:mod_log_config
Compatibility:Nickname only available in Apache 1.3 or later. Conditional logging available in 1.3.5 or later.

The CustomLog directive is used to @@ -276,7 +266,7 @@ Conditional logging available in 1.3.5 or later.


LogFormat Directive

Description: Describes a format for use in a log file
Syntax:LogFormat - format|nickname [nickname]
Default:none
Context:server config, virtual + format|nickname [nickname]
Context:server config, virtual host
Status:Base
Module:mod_log_config
Compatibility:Nickname only available in Apache 1.3 or later.

This directive specifies the format of the access log @@ -306,7 +296,7 @@ host

Status:< default. Therefore, it will not affect subsequent TransferLog directives.

-

TransferLog Directive

- @@ -176,6 +137,7 @@

For example, the following magic file lines would recognize some audio formats.

+
Description: Specifly location of a log file
Syntax:TransferLog file|pipe
Default:none
Context:server config, virtual +

TransferLog Directive

Description: Specifly location of a log file
Syntax:TransferLog file|pipe
Context:server config, virtual host
Status:Base
Module:mod_log_config
Compatibility:

This directive has exactly the same arguments and effect as diff --git a/docs/manual/mod/mod_mime.html b/docs/manual/mod/mod_mime.html index 85c89e29169..59bb42687d6 100644 --- a/docs/manual/mod/mod_mime.html +++ b/docs/manual/mod/mod_mime.html @@ -1,48 +1,25 @@ - - - - - - - Apache module mod_mime - - - - - - -

Module mod_mime

- -

This module associates the request filename's extensions +mod_mime - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_mime

Description:Associates the request filename's extensions (e.g. .html) with the file's behavior (handlers and filters) and content (mime-type, language, character set and - encoding.)

- -

Status: Base
- Source File: mod_mime.c
- Module Identifier: - mime_module

- -

Summary

- This module is used to associate various bits of "meta + encoding)
Status:Base
Module Identifier:mime_module

Summary

+

This module is used to associate various bits of "meta information" with files by their filename extensions. This information relates the filename of the document to it's mime-type, language, character set and encoding. This information is sent to the browser, and participates in content negotiation, so the user's preferences are respected when - choosing one of several possible files to serve. See mod_negotiation for more information - about content negotiation. - -

The directives AddCharset, AddEncoding, AddLanguage and AddType are all used to map file extensions + choosing one of several possible files to serve. See + mod_negotiation for more information + about content negotiation.

+ +

The directives AddCharset, + AddEncoding, + AddLanguage and + AddType all used to map file extensions onto the meta-information for that file. Respectively they set the character set, content-encoding, content-language, and MIME-type (content-type) of documents.

@@ -56,15 +33,15 @@ and POST content should be processed through (the input filters.)

-

The directives AddHandler, AddOutputFilter, and AddInputFilter control the modules +

The directives AddHandler, + AddOutputFilter, and + AddInputFilter control the modules or scripts that serve the document. The - MultiviewsMatch directive allows - mod_negotiation to consider these + MultiviewsMatch directive allows + mod_negotiation to consider these file extensions to included when testing Multiviews matches.

-

The directive TypesConfig is used +

The directive TypesConfig is used to specify a file which also maps extensions onto MIME types. Most administrators use the provided mime.types file which associates common filename extensions with IANA registered @@ -72,21 +49,20 @@ http://www.isi.edu/in-notes/iana/assignments/media-types/media-types although it may be mirrored elsewhere). This simplifies the httpd.conf file by providing the majority of media-type - definitions, and they may be overridden by AddType directives as needed.

+ definitions, and they may be overridden by + AddType directives as needed.

-

Please do not send requests to the Apache httpd Project +

Please do not send requests to the Apache httpd Project to add any new entries in the distributed mime.types file unless (1) they are already registered with IANA, and (2) they use widely accepted, non-conflicting filename extensions across platforms. category/x-subtype requests will be automatically rejected, as will any new two-letter extensions as they will likely conflict later with the already crowded language and - character set namespace.

+ character set namespace.
-

The core directives ForceType and SetHandler are used to +

The core directives ForceType and + SetHandler are used to associate all the files in a given container (e.g., <location>, <directory>, or <Files>) with a particular MIME-type or handler. These settings override any @@ -100,50 +76,8 @@ encoding) you may need to 'touch' affected files (updating their last modified date) to ensure that all visitors are receive the corrected content headers.

+

See also

Directives

Files with Multiple Extensions

-

Directives

- - - -

See also: MimeMagicFile.

- -

Files with Multiple - Extensions

Files can have more than one extension, and the order of the extensions is normally irrelevant. For example, if the @@ -168,20 +102,19 @@ MIME-type. When it is processed, the "imap-file" handler will be used, and so it will be treated as a mod_imap imagemap file.

- -

Content encoding

+

Content encoding

A file of a particular MIME type can additionally be encoded a particular way to simplify transmission over the Internet. While this usually will refer to compression, such as - gzip, it can also refer to encryption, such a - pgp or to an encoding such as UUencoding, which is + gzip, it can also refer to encryption, such a + pgp or to an encoding such as UUencoding, which is designed for transmitting a binary file in an ASCII (text) format.

The MIME RFC puts it this way:

-
+
The Content-Encoding entity-header field is used as a modifier to the media-type. When present, its value indicates what additional content coding has been applied to the @@ -190,29 +123,31 @@ header field. The Content-Encoding is primarily used to allow a document to be compressed without losing the identity of its underlying media type. - - By using more than one file extension (see section above about multiple file +
+ +

By using more than one file extension (see section above about multiple file extensions), you can indicate that a file is of a particular type, and also has a particular - encoding. + encoding.

For example, you may have a file which is a Microsoft Word document, which is pkzipped to reduce its size. If the - .doc extension is associated with the Microsoft - Word file type, and the .zip extension is + .doc extension is associated with the Microsoft + Word file type, and the .zip extension is associated with the pkzip file encoding, then the file - Resume.doc.zipwould be known to be a pkzip'ed Word + Resume.doc.zipwould be known to be a pkzip'ed Word document.

-

Apache send a Content-encoding header with the +

Apache send a Content-encoding header with the resource, in order to tell the client browser about the encoding method.

-

Content-encoding: pkzip

+
Content-encoding: pkzip

Character sets and languages

+ +

In addition to file type and the file encoding, another important piece of information is what language a particular document is in, and in what character set the file @@ -222,101 +157,73 @@ HTTP headers.

The character set, language encoding and mime type are all - used in the process of content negotiation (See mod_negotiation) to determine + used in the process of content negotiation (See + mod_negotiation) to determine which document to give to the client, when there are alternative documents in more than one character set, language, encoding or mime type. All filename extensions associations - created with AddCharset, AddEncoding, - AddLanguage and AddType directives - (and extensions listed in the MimeMagicFile) + created with AddCharset, AddEncoding, + AddLanguage and AddType directives + (and extensions listed in the MimeMagicFile) participate in this select process. Filename extensions that - are only associated using the AddHandler, - AddInputFilter or AddOutputFilter + are only associated using the AddHandler, + AddInputFilter or AddOutputFilter directives may be included or excluded from matching by using - the MultiviewsMatch directive.

+ the MultiviewsMatch directive.

+ +

Charset

-Charset

To convey this further information, Apache optionally sends - a Content-Language header, to specify the language + a Content-Language header, to specify the language that the document is in, and can append additional information - onto the Content-Type header to indicate the + onto the Content-Type header to indicate the particular character set that should be used to correctly render the information.

-
-Content-Language: en, fr
+
+
+Content-Language: en, fr
Content-Type: text/plain; charset=ISO-8859-2 - +

The language specification is the two-letter abbreviation - for the language. The charset is the name of the + for the language. The charset is the name of the particular character set which should be used.

-
- -

AddCharset - directive

- Syntax: AddCharset charset - extension [extension] ...
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_mime
- Compatibility: AddCharset is - only available in Apache 1.3.10 and later +

AddCharset Directive

Description: Maps the given filename extensions + to the specified content charset
Syntax:AddCharset charset extension +[extension] ...
Default:None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_mime
Compatibility:AddCharset is only available in Apache +1.3.10 and later
+

The AddCharset directive maps the given filename extensions - to the specified content charset. charset is the MIME - charset parameter of filenames containing extension. + to the specified content charset. charset is the MIME + charset parameter of filenames containing extension. This mapping is added to any already in force, overriding any - mappings that already exist for the same extension.

+ mappings that already exist for the same extension.

Example:

-
-    AddLanguage ja .ja
-    AddCharset EUC-JP .euc
-    AddCharset ISO-2022-JP .jis
+
+ AddLanguage ja .ja
+ AddCharset EUC-JP .euc
+ AddCharset ISO-2022-JP .jis
AddCharset SHIFT_JIS .sjis - +

Then the document xxxx.ja.jis will be treated as being a Japanese document whose charset is ISO-2022-JP (as will the document xxxx.jis.ja). The AddCharset directive is useful for both to inform the client about the character encoding of the document so that the document can be - interpreted and displayed appropriately, and for content negotiation, + interpreted and displayed appropriately, and for content negotiation, where the server returns one from several documents based on the client's charset preference.

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-

See also: mod_negotiation

-
- -

AddEncoding - directive

- Syntax: AddEncoding - MIME-enc extension [extension] ...
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_mime +

See also


AddEncoding Directive

Description: Maps the given filename extensions + to the specified encoding type
Syntax:AddEncoding + MIME-enc extension [extension] ...
Default:None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_mime

The AddEncoding directive maps the given filename extensions to the specified encoding type. MIME-enc is the MIME @@ -325,14 +232,15 @@ Content-Type: text/plain; charset=ISO-8859-2 force, overriding any mappings that already exist for the same extension. Example:

-
- AddEncoding x-gzip .gz
- AddEncoding x-compress .Z
-
- This will cause filenames containing the .gz extension to be +
+ AddEncoding x-gzip .gz
+ AddEncoding x-compress .Z +
+ +

This will cause filenames containing the .gz extension to be marked as encoded using the x-gzip encoding, and filenames containing the .Z extension to be marked as encoded with - x-compress. + x-compress.

Old clients expect x-gzip and x-compress, however the standard dictates that @@ -352,37 +260,19 @@ Content-Type: text/plain; charset=ISO-8859-2

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-

See also: Files with - multiple extensions

-
- -

AddHandler - directive

- Syntax: AddHandler - handler-name extension [extension] ...
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_mime
- Compatibility: AddHandler is - only available in Apache 1.1 and later - -

AddHandler maps the filename extensions extension - to the handler - handler-name. This mapping is added to any already in +

See also


AddHandler Directive

Description: AddHandler maps the filename extensions +to the handler +handler-name
Syntax:AddHandler + handler-name extension [extension] ...
Default:None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_mime
Compatibility:
+

This mapping is added to any already in force, overriding any mappings that already exist for the same extension. For example, to activate CGI scripts with the file extension ".cgi", you might use:

-
+
+
AddHandler cgi-script .cgi - +

Once that has been put into your srm.conf or httpd.conf file, any file containing the ".cgi" extension @@ -391,34 +281,19 @@ Content-Type: text/plain; charset=ISO-8859-2

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-

See also: Files with - multiple extensions

-
- -

AddInputFilter - directive

- -

Syntax: AddInputFilter +

See also


AddInputFilter Directive

Description: Maps the filename extensions + to the filter or filters which will process + client requests
Syntax:AddInputFilter filter[;filter...] extension - [extension ...]
- Default: none
- Context: directory, files, - location, .htaccess
- Status: mod_mime
- Compatibility: AddInputFilter - is only available in Apache 2.0.26 and later.

+ [extension ...]
Default:None
Context:server config, virtual host, directory, .htaccess
Status:Base
Module:mod_mime
Compatibility:AddInputFilter + is only available in Apache 2.0.26 and later.

AddInputFilter maps the filename extensions extension to the filter or filters which will process client requests and POST input when they are received by the server. This is in addition to any filters defined elsewhere, - including the SetInputFilter directive. + including the SetInputFilter directive. This mapping is merged over any already in force, overriding any mappings that already exist for the same extension.

@@ -429,24 +304,10 @@ Content-Type: text/plain; charset=ISO-8859-2 case-insensitive, and the extension may be specified with or without a leading dot.

-

See also the Filters - documentation.

-
- -

AddLanguage - directive

- Syntax: AddLanguage - MIME-lang extension [extension] ...
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_mime +

See also


AddLanguage Directive

Description: Maps the given filename extension +to the specified content language
Syntax:AddLanguage + MIME-lang extension [extension] ...
Default:None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_mime

The AddLanguage directive maps the given filename extension to the specified content language. MIME-lang is the @@ -457,30 +318,29 @@ Content-Type: text/plain; charset=ISO-8859-2

Example:

-
- AddEncoding x-compress .Z
- AddLanguage en .en
- AddLanguage fr .fr
-
-
+
+ AddEncoding x-compress .Z
+ AddLanguage en .en
+ AddLanguage fr .fr +

Then the document xxxx.en.Z will be treated as being a compressed English document (as will the document xxxx.Z.en). Although the content language is reported to the client, the browser is unlikely to use this - information. The AddLanguage directive is more useful for content negotiation, + information. The AddLanguage directive is more useful for content negotiation, where the server returns one from several documents based on the client's language preference.

If multiple language assignments are made for the same extension, the last one encountered is the one that is used. That is, for the case of:

-
-    AddLanguage en .en
-    AddLanguage en-uk .en
+
+
+ AddLanguage en .en
+ AddLanguage en-uk .en
AddLanguage en-us .en - +

documents with the extension ".en" would be treated as being "en-us".

@@ -488,46 +348,30 @@ Content-Type: text/plain; charset=ISO-8859-2

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-

See also: Files with - multiple extensions, mod_negotiation

-
- -

AddOutputFilter directive

- -

Syntax: AddOutputFilter +

See also


AddOutputFilter Directive

Description: maps the filename +extensions to the filters that will process +responses from the server
Syntax:AddOutputFilter filter[;filter...] extension - [extension ...]
- Default: none
- Context: directory, files, - location, .htaccess
- Status: mod_mime
- Compatibility: AddOutputFilter - is only available in Apache 2.0.26 and later.

- -

The AddOutputFilter directive maps the filename + [extension ...]

Default:None
Context:server config, virtual host, directory, .htaccess
Override:
Status:Base
Module:mod_mime
Compatibility:AddOutputFilter + is only available in Apache 2.0.26 and later.
+ +

The AddOutputFilter directive maps the filename extensions extension to the filters which will process responses from the server before they are sent to the client. This is in addition to any filters defined elsewhere, including - the SetOutputFilter + the SetOutputFilter directive. This mapping is merged over any already in force, overriding any mappings that already exist for the same extension.

- For example, the following configuration will process all - .shtml files for server-side includes.
-
+ +

For example, the following configuration will process all + .shtml files for server-side includes.

-
-   AddOutputFilter INCLUDES shtml
-
-
+
+   AddOutputFilter INCLUDES shtml +

If more than one filter is specified, they must be separated by semicolons in the order in which they should process the @@ -535,23 +379,9 @@ Content-Type: text/plain; charset=ISO-8859-2 case-insensitive, and the extension may be specified with or without a leading dot.

-

See also the Filters - documentation.

-
- -

AddType directive

- Syntax: AddType MIME-type - extension [extension] ...
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_mime +

See also


AddType Directive

Description: Maps the given filename extensions +onto the specified content type
Syntax:AddType MIME-type + extension [extension] ...
Default:None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_mime

The AddType directive maps the given filename extensions onto the specified content type. MIME-type is the MIME @@ -559,44 +389,52 @@ Content-Type: text/plain; charset=ISO-8859-2 mapping is added to any already in force, overriding any mappings that already exist for the same extension. This directive can be used to add mappings not listed in the - MIME types file (see the TypesConfig directive). - Example:

+ MIME types file (see the TypesConfig + directive).

+ +

Example:

+ +
+ AddType image/gif .gif +
-
- AddType image/gif .gif -
- It is recommended that new MIME types be added using the - AddType directive rather than changing the TypesConfig file. +
It is recommended that new MIME types be added using the + AddType directive rather than changing the + TypesConfig file.
-

Note that, unlike the NCSA httpd, this directive cannot be - used to set the type of particular files.

+
Note that, unlike the NCSA httpd, this directive cannot be + used to set the type of particular files.

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-

See also: Files with - multiple extensions

-
- -

MultiviewsMatch directive

- Syntax: MultiviewsMatch - [NegotiatedOnly] [Handlers] [Filters] [Any]
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_mime
- Compatibility: only available - in Apache 2.0.26 and later. +

See also


DefaultLanguage Directive

Description: Sets all files in the given scope to the +specified language
Syntax:DefaultLanguage + MIME-lang
Default:None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_mime
Compatibility:DefaultLanguage + is only available in Apache 1.3.4 and later.
+ +

The DefaultLanguage directive tells Apache that all files in + the directive's scope (e.g., all files covered by the + current <Directory> container) that don't + have an explicit language extension (such as .fr + or .de as configured by AddLanguage) + should be considered to be in the specified MIME-lang + language. This allows entire directories to be marked as + containing Dutch content, for instance, without having to + rename each file. Note that unlike using extensions to specify + languages, DefaultLanguage can only specify a + single language.

+ +

If no DefaultLanguage directive is in force, + and a file does not have any language extensions as configured + by AddLanguage, then that file will be considered + to have no language attribute.

+ +

See also


MultiviewsMatch Directive

Description:
Syntax:MultiviewsMatch + [NegotiatedOnly] [Handlers] [Filters] [Any]
Default:None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_mime
Compatibility:only available + in Apache 2.0.26 and later.

MultiviewsMatch permits three different behaviors for mod_negotiation's Multiviews @@ -622,65 +460,10 @@ Content-Type: text/plain; charset=ISO-8859-2 doesn't recognize the extension. This was the behavior in Apache 1.3, and can cause unpredicatable results, such as serving .old or .bak files the webmaster never expected to be served.

-
- -

DefaultLanguage directive

- Syntax: DefaultLanguage - MIME-lang
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_mime
- Compatibility: DefaultLanguage - is only available in Apache 1.3.4 and later. - -

The DefaultLanguage directive tells Apache that all files in - the directive's scope (e.g., all files covered by the - current <Directory> container) that don't - have an explicit language extension (such as .fr - or .de as configured by AddLanguage) - should be considered to be in the specified MIME-lang - language. This allows entire directories to be marked as - containing Dutch content, for instance, without having to - rename each file. Note that unlike using extensions to specify - languages, DefaultLanguage can only specify a - single language.

- -

If no DefaultLanguage directive is in force, - and a file does not have any language extensions as configured - by AddLanguage, then that file will be considered - to have no language attribute.

- -

See also: Files with - multiple extensions, mod_negotiation

-
- -

RemoveCharset directive

- Syntax: RemoveCharset - extension [extension] ...
- Context: directory, - .htaccess
- Status: Base
- Module: mod_mime
- Compatibility: RemoveCharset is - only available in Apache 2.0.24 and later. - -

The RemoveCharset directive removes any +


RemoveCharset Directive

Description:
Syntax:RemoveCharset + extension [extension] ...
Default:None
Context:directory, .htaccess
Status:Base
Module:mod_mime
Compatibility:RemoveCharset is + only available in Apache 2.0.24 and later.
+

The RemoveCharset directive removes any character set associations for files with the given extensions. This allows .htaccess files in subdirectories to undo any associations inherited from parent directories or the @@ -688,76 +471,51 @@ Content-Type: text/plain; charset=ISO-8859-2

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-
- -

RemoveEncoding directive

- Syntax: RemoveEncoding - extension [extension] ...
- Context: directory, - .htaccess
- Status: Base
- Module: mod_mime
- Compatibility: RemoveEncoding - is only available in Apache 1.3.13 and later. - -

The RemoveEncoding directive removes any +


RemoveEncoding Directive

Description:
Syntax:RemoveEncoding + extension [extension] ...
Default:None
Context:directory, .htaccess
Status:Base
Module:mod_mime
Compatibility:RemoveEncoding + is only available in Apache 1.3.13 and later.
+ +

The RemoveEncoding directive removes any encoding associations for files with the given extensions. This allows .htaccess files in subdirectories to undo any associations inherited from parent directories or the server config files. An example of its use might be:

+ +
/foo/.htaccess:
- -
AddEncoding x-gzip .gz
- AddType text/plain .asc
- <Files *.gz.asc>
+
AddEncoding x-gzip .gz
+ AddType text/plain .asc
+ <Files *.gz.asc>
    RemoveEncoding - .gz
+ .gz

</Files>
+

This will cause foo.gz to be marked as being encoded with the gzip method, but foo.gz.asc as an unencoded plaintext file.

-

Note:RemoveEncoding directives are processed - after any AddEncoding directives, so it is possible they +

Note:RemoveEncoding directives are processed + after any AddEncoding directives, so it is possible they may undo the effects of the latter if both occur within the same directory configuration.

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-
- -

RemoveHandler directive

- Syntax: RemoveHandler - extension [extension] ...
- Context: directory, - .htaccess
- Status: Base
- Module: mod_mime
- Compatibility: RemoveHandler is - only available in Apache 1.3.4 and later. - -

The RemoveHandler directive removes any handler +


RemoveHandler Directive

Description:
Syntax:RemoveHandler + extension [extension] ...
Default:None
Context:directory, .htaccess
Status:Base
Module:mod_mime
Compatibility:RemoveHandler is + only available in Apache 1.3.4 and later.
+ +

The RemoveHandler directive removes any handler associations for files with the given extensions. This allows .htaccess files in subdirectories to undo any associations inherited from parent directories or the server config files. An example of its use might be:

+
/foo/.htaccess:
@@ -767,35 +525,20 @@ Content-Type: text/plain; charset=ISO-8859-2
RemoveHandler .html
+
-

This has the effect of returning .html files in - the /foo/bar directory to being treated as normal - files, rather than as candidates for parsing (see the mod_include +

This has the effect of returning .html files in + the /foo/bar directory to being treated as normal + files, rather than as candidates for parsing (see the mod_include module).

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-
- -

RemoveInputFilter directive

- Syntax: RemoveInputFilter - extension [extension] ...
- Context: directory, - .htaccess
- Status: Base
- Module: mod_mime
- Compatibility: - RemoveInputFilter is only available in Apache 2.0.26 and later. - +

RemoveInputFilter Directive

Description:
Syntax:RemoveInputFilter + extension [extension] ...
Default:None
Context:directory, .htaccess
Status:Base
Module:mod_mime
Compatibility:RemoveInputFilter is only available in Apache +2.0.26 and later.
-

The RemoveInputFilter directive removes any +

The RemoveInputFilter directive removes any input filter associations for files with the given extensions. This allows .htaccess files in subdirectories to undo any associations inherited from parent directories or the @@ -803,25 +546,11 @@ Content-Type: text/plain; charset=ISO-8859-2

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-
- -

RemoveLanguage directive

- Syntax: RemoveLanguage - extension [extension] ...
- Context: directory, - .htaccess
- Status: Base
- Module: mod_mime
- Compatibility: RemoveLanguage - is only available in Apache 2.0.24 and later. - -

The RemoveLanguage directive removes any +


RemoveLanguage Directive

Description:
Syntax:RemoveLanguage + extension [extension] ...
Default:None
Context:directory, .htaccess
Status:Base
Module:mod_mime
Compatibility:RemoveLanguage + is only available in Apache 2.0.24 and later.
+ +

The RemoveLanguage directive removes any language associations for files with the given extensions. This allows .htaccess files in subdirectories to undo any associations inherited from parent directories or the @@ -829,26 +558,11 @@ Content-Type: text/plain; charset=ISO-8859-2

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-
- -

RemoveOutputFilter directive

- Syntax: RemoveOutputFilter - extension [extension] ...
- Context: directory, - .htaccess
- Status: Base
- Module: mod_mime
- Compatibility: - RemoveOutputFilter is only available in Apache 2.0.26 and - later. - -

The RemoveOutputFilter directive removes any +


RemoveOutputFilter Directive

Description:
Syntax:RemoveOutputFilter + extension [extension] ...
Default:
Context:directory, .htaccess
Override:
Status:Base
Module:mod_mime
Compatibility:RemoveOutputFilter is only available in Apache +2.0.26 and later.
+ +

The RemoveOutputFilter directive removes any output filter associations for files with the given extensions. This allows .htaccess files in subdirectories to undo any associations inherited from parent directories or the @@ -856,64 +570,36 @@ Content-Type: text/plain; charset=ISO-8859-2

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-
- -

RemoveType - directive

- Syntax: RemoveType - extension [extension] ...
- Context: directory, - .htaccess
- Status: Base
- Module: mod_mime
- Compatibility: RemoveType is - only available in Apache 1.3.13 and later. - -

The RemoveType directive removes any MIME type +


RemoveType Directive

Description:
Syntax:RemoveType + extension [extension] ...
Default:
Context:directory, .htaccess
Override:
Status:Base
Module:mod_mime
Compatibility:RemoveType is + only available in Apache 1.3.13 and later.
+

The RemoveType directive removes any MIME type associations for files with the given extensions. This allows .htaccess files in subdirectories to undo any associations inherited from parent directories or the server config files. An example of its use might be:

+
/foo/.htaccess:
RemoveType .cgi
+

This will remove any special handling of .cgi files in the /foo/ directory and any beneath it, - causing the files to be treated as being of the default type.

+ causing the files to be treated as being of the default type.

-

Note:RemoveType directives are processed - after any AddType directives, so it is - possible they may undo the effects of the latter if both occur - within the same directory configuration.

+
Note:RemoveType directives + are processed after any AddType + directives, so it is possible they may undo the effects of the + latter if both occur within the same directory + configuration.

The extension argument is case-insensitive, and can be specified with or without a leading dot.

-
- -

TypesConfig - directive

- Syntax: TypesConfig - file-path
- Default: TypesConfig - conf/mime.types
- Context: server config
- Status: Base
- Module: mod_mime +

TypesConfig Directive

Description:
Syntax:TypesConfig file-path
Default:TypesConfig conf/mime.types
Context:server config
Status:Base
Module:mod_mime

The TypesConfig directive sets the location of the MIME types configuration file. Filename is relative to the @@ -924,14 +610,11 @@ Content-Type: text/plain; charset=ISO-8859-2 contains lines in the format of the arguments to an AddType command:

-
- MIME-type extension extension ... -
- The extensions are lower-cased. Blank lines, and lines - beginning with a hash character (`#') are ignored. - -

-

- - +
+ MIME-type extension extension ... +
+

+ The extensions are lower-cased. Blank lines, and lines + beginning with a hash character (`#') are ignored.

+

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_mime_magic.html b/docs/manual/mod/mod_mime_magic.html index 893b2205b46..01969e64278 100644 --- a/docs/manual/mod/mod_mime_magic.html +++ b/docs/manual/mod/mod_mime_magic.html @@ -1,40 +1,13 @@ - - - - - - - Apache module mod_mime_magic - - - - -
- [APACHE DOCUMENTATION] -
- -

Module mod_mime_magic

- -

This module provides for determining the MIME type of a file - by looking at a few bytes of its contents.

- -

Status: Extension
- Source File: - mod_mime_magic.c
- Module Identifier: - mime_magic_module

- -

Summary

- +mod_mime_magic - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_mime_magic

Description:Determines the MIME type of a file + by looking at a few bytes of its contents
Status:Extension
Module Identifier:mime_magic_module

Summary

This module determines the MIME type of files in the same way the Unix file(1) command works: it looks at the first few bytes of the file. It is intended as a "second line of defense" - for cases that mod_mime can't + for cases that mod_mime can't resolve. To assure that mod_mime gets first try at determining a file's MIME type, be sure to list mod_mime_magic before mod_mime in the configuration.

@@ -43,20 +16,8 @@ file(1) command for Unix, which uses "magic numbers" and other hints from a file's contents to figure out what the contents are. This module is active only if the magic - file is specified by the MimeMagicFile - directive.

- -

Directives

- - -
-
- - -

Format of the Magic File

+ file is specified by the MimeMagicFile directive.

+

Directives

Format of the Magic File

The contents of the file are plain ASCII text in 4-5 columns. Blank lines are allowed but ignored. Commented lines @@ -73,7 +34,7 @@

1byte number to begin checking from
+
byte number to begin checking from
">" indicates a dependency upon the previous non-">" line
 # Sun/NeXT audio data
 0       string          .snd
@@ -188,9 +150,11 @@
 >12     belong          7               audio/basic
 >12     belong          23              audio/x-adpcm
 
- Or these would recognize the difference between "*.doc" files +
+

Or these would recognize the difference between "*.doc" files containing Microsoft Word or FrameMaker documents. (These are - incompatible file formats which use the same file suffix.) + incompatible file formats which use the same file suffix.)

+
 # Frame
 0       string          \<MakerFile     application/x-frame
@@ -206,19 +170,21 @@
 0       string          \320\317\021\340\241\261        application/msword
 0       string          \333\245-\0\0\0                 application/msword
 
- An optional MIME encoding can be included as a fifth column. +
+

An optional MIME encoding can be included as a fifth column. For example, this can recognize gzipped files and set the - encoding for them. + encoding for them.

+
 # gzip (GNU zip, not to be confused with [Info-ZIP/PKWARE] zip archiver)
 0       string          \037\213        application/octet-stream        x-gzip
 
- -

Performance Issues

- This module is not for every system. If your system is barely +
+

Performance Issues

+

This module is not for every system. If your system is barely keeping up with its load or if you're performing a web server benchmark, you may not want to enable this because the - processing is not free. + processing is not free.

However, an effort was made to improve the performance of the original file(1) code to make it fit in a busy web server. @@ -237,10 +203,11 @@ this one is used only as a last resort, just like it was designed to.

-

Notes

- The following notes apply to the mod_mime_magic module and are +

Notes

+ +

The following notes apply to the mod_mime_magic module and are included here for compliance with contributors' copyright - restrictions that require their acknowledgment. + restrictions that require their acknowledgment.

 /*
  * mod_mime_magic: MIME type lookup via file magic numbers
@@ -300,30 +267,12 @@
  *
  */
 
-
- -

MimeMagicFile

- -

Syntax: MimeMagicFile - file-path
- Default: none
- Context: server config, virtual - host
- Status: Extension
- Module: mod_mime_magic

- -

The MimeMagicFile directive can be used to +


MimeMagicFile Directive

Description: Enable MIME-type determination based on file contents +using the specified magic file
Syntax:MimeMagicFile file-path
Context:server config, virtual host
Status:Extension
Module:mod_mime_magic
+

The MimeMagicFile directive can be used to enable this module, the default file is distributed at conf/magic. Non-rooted paths are relative to the ServerRoot. Virtual hosts will use the same file as the main server unless a more specific setting is used, in which case the more specific setting overrides the main server's file.

- - - +

Apache HTTP Server Version 2.0

IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_negotiation.html b/docs/manual/mod/mod_negotiation.html index b9d48743496..b7031ba3f29 100644 --- a/docs/manual/mod/mod_negotiation.html +++ b/docs/manual/mod/mod_negotiation.html @@ -1,65 +1,24 @@ - - - - - - - Apache module mod_negotiation - - - - - - -

Module mod_negotiation

- -

This module provides for content negotiation.

- -

Status: Base
- Source File: - mod_negotiation.c
- Module Identifier: - negotiation_module

- -

Summary

- Content negotiation, or more accurately content selection, is +mod_negotiation - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_negotiation

Description:Provides for content negotiation
Status:Base
Module Identifier:negotiation_module

Summary

+

Content negotiation, or more accurately content selection, is the selection of the document that best matches the clients capabilities, from one of several available documents. There - are two implementations of this. + are two implementations of this.

  • A type map (a file with the handler type-map) which explicitly lists the files containing the variants.
  • -
  • A MultiViews search (enabled by the MultiViews Option, where the server does an +
  • A MultiViews search (enabled by the MultiViews Options, where the server does an implicit filename pattern match, and choose from amongst the results.
- -

Directives

- - - See also: DefaultLanguage, AddEncoding, AddLanguage, AddType, and Options. - -

Type maps

- A type map has the same format as RFC822 mail headers. It +

See also

Directives

Type maps

+

A type map has the same format as RFC822 mail headers. It contains document descriptions separated by blank lines, with lines beginning with a hash character ('#') treated as comments. A document description consists of several header @@ -68,14 +27,13 @@ deleted and the lines concatenated. A header record consists of a keyword name, which always ends in a colon, followed by a value. Whitespace is allowed between the header name and value, - and between the tokens of value. The headers allowed are: + and between the tokens of value. The headers allowed are:

Content-Encoding:
The encoding of the file. Apache only recognizes - encodings that are defined by an AddEncoding directive. + encodings that are defined by an AddEncoding directive. This normally includes the encodings x-compress for compress'd files, and x-gzip for gzip'd files. The x- prefix is ignored for encoding @@ -132,10 +90,9 @@
The path to the file containing this variant, relative to the map file.
+

MultiViews

-

MultiViews

- A MultiViews search is enabled by the MultiViews Option. If the server receives a +

A MultiViews search is enabled by the MultiViews Options. If the server receives a request for /some/dir/foo and /some/dir/foo does not exist, then the server reads the directory looking for all files named @@ -143,29 +100,9 @@ names all those files, assigning them the same media types and content-encodings it would have if the client had asked for one of them by name. It then chooses the best match to the client's - requirements, and returns that document. -


- -

CacheNegotiatedDocs - directive

- Syntax: CacheNegotiatedDocs - on|off
- Default: - CacheNegotiatedDocs off
- Context: server config
- Status: Base
- Module: mod_negotiation
- Compatibility: - CacheNegotiatedDocs is only available in Apache 1.1 and later. - The syntax changed in version 2.0. - + requirements, and returns that document.

+

CacheNegotiatedDocs Directive

Description: Allows content-negotiated documents to be +cached by proxy servers
Syntax:CacheNegotiatedDocs on|off
Default:CacheNegotiatedDocs off
Context:server config
Status:Base
Module:mod_negotiation
Compatibility:The syntax changed in version 2.0.

If set, this directive allows content-negotiated documents to be cached by proxy servers. This could mean that clients behind those proxys could retrieve versions of the documents @@ -177,34 +114,14 @@ the caching of negotiated documents, and this directive has no effect in responses to HTTP/1.1 requests.

-

Prior to version 2.0, CacheNegotiatedDocs did not take an +

Prior to version 2.0, + CacheNegotiatedDocs did not take an argument; it was turned on by the presence of the directive by itself.

-
- -

ForceLanguagePriority directive

-

Syntax: ForceLanguagePriority - None|Prefer|Fallback [Prefer|Fallback]
- Default: - ForceLanguagePriority None
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_negotiation
- Compatibility: - Available in version 2.0.30 and later.

- -

The ForceLanguagePriority directive uses the given - LanguagePriority to satisfy +


ForceLangaugePriority Directive

Description: Action to take if a single acceptable document is not +found
Syntax:ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback]
Default:ForceLangaugePriority None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_negotiation
Compatibility:Available in version 2.0.30 and later
+

The ForceLanguagePriority directive uses + the given LanguagePriority to satisfy negotation where the server could otherwise not return a single matching document.

@@ -216,10 +133,10 @@ each as quality .500 (equally acceptable) then then first matching variant, en, will be served.

-
- LanguagePriority en fr de
+
+ LanguagePriority en fr de
ForceLanguagePriority Prefer -
+

ForceLanguagePriority Fallback uses LanguagePriority to serve a valid result, rather than @@ -229,61 +146,33 @@ first variant from the LanguagePriority list below will be served.

-
- LanguagePriority en fr de
+
+ LanguagePriority en fr de
ForceLanguagePriority Fallback -
+

Both options, Prefer and Fallback, may be specified, so either the first matching variant from LanguagePriority will be served if more that one variant is acceptable, or first available document will be served if none of the variants matched the client's acceptable list of languages.

- -
- -

LanguagePriority directive

- - Syntax: LanguagePriority - MIME-lang [MIME-lang] ...
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_negotiation - -

The LanguagePriority sets the precedence of language - variants for the case where the client does not express a - preference, when handling a MultiViews request. The list of - MIME-lang are in order of decreasing preference. +


LanguagePriority Directive

Description: The precendence of language variants for cases where +the client does not express a preference
Syntax:LanguagePriority MIME-lang [MIME-lang] ...
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_negotiation
+

The LanguagePriority sets the precedence + of language variants for the case where the client does not + express a preference, when handling a MultiViews request. The list + of MIME-lang are in order of decreasing preference. Example:

-
- LanguagePriority en fr de -
- For a request for foo.html, where +
LanguagePriority en fr de
+ +

For a request for foo.html, where foo.html.fr and foo.html.de both existed, but the browser did not express a language preference, - then foo.html.fr would be returned. + then foo.html.fr would be returned.

Note that this directive only has an effect if a 'best' - language cannot be determined by any other means or the ForceLanguagePriority directive + language cannot be determined by any other means or the ForceLanguagePriority directive is not None. Correctly implemented HTTP/1.1 requests will mean this directive has no effect.

- -

See also: DefaultLanguage, - AddLanguage and - ForceLanguagePriority. - -

- - - +

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_usertrack.html b/docs/manual/mod/mod_usertrack.html index 22d46b3cfee..5e94c5c1172 100644 --- a/docs/manual/mod/mod_usertrack.html +++ b/docs/manual/mod/mod_usertrack.html @@ -1,34 +1,11 @@ - - - - - - - Apache module mod_usertrack - - - - - - -

Module mod_usertrack

- -

This module uses cookies to provide for a - clickstream log of user activity on a site.

- -

Status: Extension
- Source File: - mod_usertrack.c
- Module Identifier: - usertrack_module
- Compatibility: Known as - mod_cookies prior to Apache 1.3.

+mod_usertrack - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_usertrack

Description: + This module uses cookies to provide for a + clickstream log of user activity on a site. +
Status:Extension
Module Identifier:usertrack_module
Compatibility:Known as mod_cookies prior to Apache 1.3.

Summary

Summary

@@ -38,22 +15,8 @@ Apache 1.2 and later this module has been renamed the "user tracking" module, mod_usertrack. This module has been simplified and new directives added.

+

Directives

Logging

-

Directives

- - - -

Logging

Previously, the cookies module (now the user tracking module) did its own logging, using the CookieLog @@ -63,15 +26,17 @@ now allows multiple log files. The cookie itself is logged by using the text %{cookie}n in the log file format. For example:

-
+
CustomLog logs/clickstream "%{cookie}n %r %t" - - For backward compatibility the configurable log module +
+ +

For backward compatibility the configurable log module implements the old CookieLog directive, but this - should be upgraded to the above CustomLog directive. + should be upgraded to the above CustomLog directive.

+

2-digit or 4-digit dates for cookies?

+ -

2-digit or 4-digit dates for cookies?

- (the following is from message +

(the following is from message <022701bda43d$9d32bbb0$1201a8c0@christian.office.sane.com> in the new-httpd archives)

@@ -106,19 +71,9 @@ form, but also understands 4-digit years, which can probably reach up until
 9999.  Your best bet for sending a long-life cookie is to send it for some
 time late in the year "37".
 
-
- -

CookieDomain - directive

- Syntax: CookieDomain domain
- Context: server config, virtual host, - directory, .htaccess
- Status: optional
- Module: mod_usertrack +

+

CookieDomain Directive

Description: controls the setting of the domain to which + the tracking cookie applies.
Syntax:CookieDomain domain
Default:None
Context:server config, virtual host, directory, .htaccess
Status:Extension
Module:mod_usertrack

This directive controls the setting of the domain to which the tracking cookie applies. If not present, no domain is @@ -127,23 +82,8 @@ time late in the year "37".

The domain string must begin with a dot, and must include at least one embedded dot. That is, ".foo.com" is legal, but "foo.bar.com" and ".com" are not.

-
- -

CookieExpires directive

- Syntax: CookieExpires - expiry-period
- Context: 1.3.20 and - earlier: server config, virtual host; 1.3.21 and - later: server config, virtual host, directory, - .htaccess
- Status: optional
- Module: mod_usertrack - +

CookieExpires Directive

Description:
Syntax:CookieExpires expiry-period
Default:
Context:server config, virtual host, directory, .htaccess
Override:
Status:Extension
Module:mod_usertrack
Compatibility:In 1.3.20 and earlier, not usable in directory and +.htaccess

When used, this directive sets an expiry time on the cookie generated by the usertrack module. The expiry-period can be given either as a number of seconds, or in the format @@ -154,26 +94,7 @@ time late in the year "37".

If this directive is not used, cookies last only for the current browser session.

-
- -

CookieName - directive

- Syntax: CookieName - token
- Default: Apache
- Context: server config, virtual - host, directory, .htaccess
- Status: optional
- Module: mod_usertrack
- Compatibility: Apache 1.3.7 and - later - +

CookieName Directive

Description:
Syntax:CookieName token
Default:Apache
Context:server config, virtual host, directory, .htaccess
Status:Extension
Module:mod_usertrack

This directive allows you to change the name of the cookie this module uses for its tracking purposes. By default the cookie is named "Apache".

@@ -181,21 +102,9 @@ time late in the year "37".

You must specify a valid cookie name; results are unpredictable if you use a name containing unusual characters. Valid characters include A-Z, a-z, 0-9, "_", and "-".

-
- -

CookieStyle - directive

- Syntax: CookieStyle - Netscape|Cookie|Cookie2|RFC2109|RFC2965
- Context: server config, virtual host, - directory, .htaccess
- Status: optional
- Module: mod_usertrack - +

CookieStyle Directive

Description: Controls the format of the cookie header + field
Syntax:CookieStyle + Netscape|Cookie|Cookie2|RFC2109|RFC2965
Default:
Context:server config, virtual host, directory, .htaccess
Status:Extension
Module:mod_usertrack

This directive controls the format of the cookie header field. The three formats allowed are:

@@ -214,30 +123,12 @@ time late in the year "37".

Not all clients can understand all of these formats. but you should use the newest one that is generally acceptable to your users' browsers.

-
- -

CookieTracking directive

- Syntax: CookieTracking - on|off
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: optional
- Module: mod_usertrack - +

CookieTracking Directive

Description:
Syntax:CookieTracking on|off
Default:
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Extension
Module:mod_usertrack

When the user track module is compiled in, and "CookieTracking on" is set, Apache will start sending a user-tracking cookie for all new requests. This directive can be used to turn this behavior on or off on a per-server or per-directory basis. By default, compiling mod_usertrack will - not activate cookies. -

- - + not activate cookies.

+

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file