From 3e9b9f48ee92f7917355e5b85d03e189f9fe1ef0 Mon Sep 17 00:00:00 2001 From: Andre Malo Date: Wed, 11 Dec 2002 21:11:15 +0000 Subject: [PATCH] update transformation: part III git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97865 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/directive-dict.html.en | 62 ++++- docs/manual/mod/directives.html.en | 28 ++- docs/manual/mod/index.html.en | 19 +- docs/manual/mod/mod_dav.html.en | 114 ++++++--- docs/manual/mod/mod_dav_fs.html.en | 61 +++-- docs/manual/mod/mod_deflate.html.en | 141 +++++++++--- docs/manual/mod/mod_dir.html.en | 68 ++++-- docs/manual/mod/mod_disk_cache.html.en | 306 ++++++++++++++++--------- docs/manual/mod/mod_echo.html.en | 66 ++++-- docs/manual/mod/mod_env.html.en | 107 ++++++--- docs/manual/mod/mod_example.html.en | 72 ++++-- docs/manual/mod/mod_expires.html.en | 113 ++++++--- docs/manual/mod/mod_ext_filter.html.en | 89 +++++-- docs/manual/mod/mod_file_cache.html.en | 82 +++++-- docs/manual/mod/mod_headers.html.en | 101 +++++--- docs/manual/mod/mod_imap.html.en | 132 ++++++++--- docs/manual/mod/mod_include.html.en | 232 +++++++++++++------ docs/manual/mod/mod_info.html.en | 64 ++++-- docs/manual/mod/mod_isapi.html.en | 192 +++++++++++----- 19 files changed, 1475 insertions(+), 574 deletions(-) diff --git a/docs/manual/mod/directive-dict.html.en b/docs/manual/mod/directive-dict.html.en index a3220fc365..397215a6e9 100644 --- a/docs/manual/mod/directive-dict.html.en +++ b/docs/manual/mod/directive-dict.html.en @@ -4,14 +4,40 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->Terms Used to Describe Directives - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-
Apache > HTTP Server > Documentation > Version 2.1

Terms Used to Describe Directives

+ --> +Terms Used to Describe Directives - Apache HTTP Server + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+

Terms Used to Describe Directives

This document describes the terms that are used to describe each Apache configuration directive.

-
top

Description

+
+ +
top
+
+

Description

A brief description of the purpose of the directive.

-
top

Syntax

+
top
+
+

Syntax

This indicates the format of the directive as it would appear in a configuration file. This syntax is extremely @@ -97,7 +123,9 @@ environment variable. See the environment variable documentation for more details. -

top

Default

+
top
+
+

Default

If the directive has a default value (i.e., if you omit it from your configuration entirely, the Apache Web server @@ -106,7 +134,9 @@ should say "None". Note that the default listed here is not necessarily the same as the value the directive takes in the default httpd.conf distributed with the server.

-
top

Context

+
top
+
+

Context

This indicates where in the server's configuration files the directive is legal. It's a comma-separated list of one or more @@ -163,7 +193,9 @@ files, but not within any <Directory> or <VirtualHost> containers.

-
top

Override

+
top
+
+

Override

This directive attribute indicates which configuration override must be active in order for the directive to be @@ -178,7 +210,9 @@ AllowOverride directives at lower levels. The documentation for that directive also lists the possible override names available.

-
top

Status

+
top
+
+

Status

This indicates how tightly bound into the Apache Web server the directive is; in other words, you may need to recompile the @@ -228,14 +262,22 @@ directive and its module to see if it remarks on the availability. -

top

Module

+
top
+
+

Module

This quite simply lists the name of the source module which defines the directive.

-
top

Compatibility

+
top
+
+

Compatibility

If the directive wasn't part of the original Apache version 2 distribution, the version in which it was introduced should be listed here. In addition, if the directive is available only on certain platforms, it will be noted here.

-
\ No newline at end of file +
+ + \ No newline at end of file diff --git a/docs/manual/mod/directives.html.en b/docs/manual/mod/directives.html.en index 28fdf53603..4e36e15ae2 100644 --- a/docs/manual/mod/directives.html.en +++ b/docs/manual/mod/directives.html.en @@ -4,7 +4,20 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->Directive Index - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-
Apache > HTTP Server > Documentation > Version 2.1 > Modules

Directive Index

+ --> +Directive Index - Apache HTTP Server + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+

Directive Index

+

Each Apache directive available in the standard Apache distribution is listed here. They are described using a @@ -17,8 +30,11 @@ is also available giving details about each directive in a summary form.

-

 A  |  B  |  C  |  D  |  E  |  F  |  G  |  H  |  I  |  K  |  L  |  M  |  N  |  O  |  P  |  R  |  S  |  T  |  U  |  V  |  X 

-
+ \ No newline at end of file +
+ + \ No newline at end of file diff --git a/docs/manual/mod/index.html.en b/docs/manual/mod/index.html.en index b092a3697b..7bfbf6734b 100644 --- a/docs/manual/mod/index.html.en +++ b/docs/manual/mod/index.html.en @@ -4,7 +4,20 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->Module Index - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-
Apache > HTTP Server > Documentation > Version 2.1

Module Index

+ --> +Module Index - Apache HTTP Server + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+

Module Index

+

Below is a list of all of the modules that come as part of the Apache distribution. See also the complete @@ -126,5 +139,7 @@ identifier for each request

mod_vhost_alias
Provides for dynamically configured mass virtual hosting
- + \ No newline at end of file diff --git a/docs/manual/mod/mod_dav.html.en b/docs/manual/mod/mod_dav.html.en index 8a2867399e..18275cfc28 100644 --- a/docs/manual/mod/mod_dav.html.en +++ b/docs/manual/mod/mod_dav.html.en @@ -4,21 +4,53 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_dav - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-

Apache Module mod_dav

Description: - Distributed Authoring and Versioning -(WebDAV) functionality
Status: - Extension
Module Identifier: - dav_module
Source File: - mod_dav.c

Summary

+ --> +mod_dav - Apache HTTP Server + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+ +
+

Apache Module mod_dav

+ + + +
Description:Distributed Authoring and Versioning +(WebDAV) functionality
Status:Extension
Module Identifier:dav_module
Source File:mod_dav.c
+

Summary

+

This module provides class 1 and class 2 WebDAV ('Web-based Distributed Authoring and Versioning') functionality for Apache. This extension to the HTTP protocol allows creating, moving, copying, and deleting resources and collections on a remote web server.

-

Directives

+
top

Enabling WebDAV

+ +

Topics

+

See also

+
+
top
+
+

Enabling WebDAV

To enable mod_dav, add the following to a container in your httpd.conf file:

@@ -72,13 +104,17 @@ over an SSL enabled connection is secure, too.

-
top

Dav Directive

Description: - Enable WebDAV HTTP methods
Syntax: - Dav On|Off|provider-name
Default: - Dav Off
Context: - directory
Status: - Extension
Module: - mod_dav
+
+
top
+

Dav Directive

+ + + + + + + +
Description:Enable WebDAV HTTP methods
Syntax:Dav On|Off|provider-name
Default:Dav Off
Context:directory
Status:Extension
Module:mod_dav

Use the Dav directive to enable the WebDAV HTTP methods for the given container:

@@ -99,25 +135,35 @@ Do not enable WebDAV until you have secured your server. Otherwise everyone will be able to distribute files on your system.
-
top

DavDepthInfinity Directive

Description: - Allow PROPFIND, Depth: Infinity requests
Syntax: - DavDepthInfinity on|off
Default: - DavDepthInfinity off
Context: - server config, virtual host, directory
Status: - Extension
Module: - mod_dav
+ +
+
top
+

DavDepthInfinity Directive

+ + + + + + + +
Description:Allow PROPFIND, Depth: Infinity requests
Syntax:DavDepthInfinity on|off
Default:DavDepthInfinity off
Context:server config, virtual host, directory
Status:Extension
Module:mod_dav

Use the DavDepthInfinity directive to allow the processing of PROPFIND requests containing the header 'Depth: Infinity'. Because this type of request could constitute a denial-of-service attack, by default it is not allowed.

-
top

DavMinTimeout Directive

Description: - Minimum amount of time the server holds a lock on -a DAV resource
Syntax: - DavMinTimeout seconds
Default: - DavMinTimeout 0
Context: - server config, virtual host, directory
Status: - Extension
Module: - mod_dav
+ +
+
top
+

DavMinTimeout Directive

+ + + + + + + +
Description:Minimum amount of time the server holds a lock on +a DAV resource
Syntax:DavMinTimeout seconds
Default:DavMinTimeout 0
Context:server config, virtual host, directory
Status:Extension
Module:mod_dav

When a client requests a DAV resource lock, it can also specify a time when the lock will be automatically removed by the server. This value is only a request, and the server can @@ -137,4 +183,10 @@ a DAV resourceSyntax: </Location>

-
\ No newline at end of file + + + + + \ No newline at end of file diff --git a/docs/manual/mod/mod_dav_fs.html.en b/docs/manual/mod/mod_dav_fs.html.en index a906f2bf06..98ce88a69c 100644 --- a/docs/manual/mod/mod_dav_fs.html.en +++ b/docs/manual/mod/mod_dav_fs.html.en @@ -4,11 +4,28 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_dav_fs - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-
Apache > HTTP Server > Documentation > Version 2.1 > Modules

Apache Module mod_dav_fs

Description: - filesystem provider for mod_dav
Status: - Extension
Module Identifier: - dav_fs_module
Source File: - mod_dav_fs.c

Summary

+ --> +mod_dav_fs - Apache HTTP Server + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+ +
+

Apache Module mod_dav_fs

+ + + +
Description:filesystem provider for mod_dav
Status:Extension
Module Identifier:dav_fs_module
Source File:mod_dav_fs.c
+

Summary

+

This module requires the service of mod_dav. It acts as a support module for mod_dav and provides access to resources located in the server's file system. The formal name of this provider is filesystem. mod_dav backend providers @@ -22,13 +39,25 @@

Since filesystem is the default provider for mod_dav, you may simply use the value On instead.

-

Directives

See also

top

DavLockDB Directive

Description: - Location of the DAV lock database
Syntax: - DavLockDB file-path
Context: - server config, virtual host
Status: - Extension
Module: - mod_dav_fs
+
+

Directives

+ +

See also

+
+ +
top
+

DavLockDB Directive

+ + + + + + +
Description:Location of the DAV lock database
Syntax:DavLockDB file-path
Context:server config, virtual host
Status:Extension
Module:mod_dav_fs

Use the DavLockDB directive to specify the full path to the lock database, excluding an extension. If the path is not absolute, it will be taken relative to ServerRoot. The implementation of @@ -40,4 +69,10 @@

Example

DavLockDB logs/DavLock

-
\ No newline at end of file + +
+
+ + \ No newline at end of file diff --git a/docs/manual/mod/mod_deflate.html.en b/docs/manual/mod/mod_deflate.html.en index fbdb23dfea..d0b3b3b31c 100644 --- a/docs/manual/mod/mod_deflate.html.en +++ b/docs/manual/mod/mod_deflate.html.en @@ -4,21 +4,53 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_deflate - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-
Apache > HTTP Server > Documentation > Version 2.1 > Modules

Apache Module mod_deflate

Description: - Compress content before it is delivered to the -client
Status: - Extension
Module Identifier: - deflate_module
Source File: - mod_deflate.c

Summary

+ --> +mod_deflate - Apache HTTP Server + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+ +
+

Apache Module mod_deflate

+ + + +
Description:Compress content before it is delivered to the +client
Status:Extension
Module Identifier:deflate_module
Source File:mod_deflate.c
+

Summary

+

The mod_deflate module provides the DEFLATE output filter that allows output from your server to be compressed before being sent to the client over the network.

-

Directives

+
top

Recommended Configuration

+ +

Topics

+

See also

+
+
top
+
+

Recommended Configuration

This is a sample configuration for the impatient. But please take the time and read the sections below for a detailed description!

@@ -53,7 +85,9 @@ clientStatus: </Location>

-
top

Enabling Compression

+
top
+
+

Enabling Compression

Output Compression

Compression is implemented by the DEFLATE @@ -147,7 +181,9 @@ clientStatus: the decompressed data stream.

-
top

Dealing with proxy servers

+
top
+
+

Dealing with proxy servers

The mod_deflate module sends a Vary: Accept-Encoding HTTP response header to alert proxies that @@ -175,22 +211,31 @@ clientStatus:

Example

Header set Vary *

-
top

DeflateBufferSize Directive

Description: - Fragment size to be compressed at one time by zlib
Syntax: - DeflateBufferSize value
Default: - DeflateBufferSize 8096
Context: - server config, virtual host
Status: - Extension
Module: - mod_deflate
+
+
top
+

DeflateBufferSize Directive

+ + + + + + + +
Description:Fragment size to be compressed at one time by zlib
Syntax:DeflateBufferSize value
Default:DeflateBufferSize 8096
Context:server config, virtual host
Status:Extension
Module:mod_deflate

The DeflateBufferSize directive specifies the size in bytes of the fragments that zlib should compress at one time.

-
top

DeflateFilterNote Directive

Description: - Places the compression ratio in a note for logging
Syntax: - DeflateFilterNote notename
Context: - server config, virtual host
Status: - Extension
Module: - mod_deflate
+ +
+
top
+

DeflateFilterNote Directive

+ + + + + + +
Description:Places the compression ratio in a note for logging
Syntax:DeflateFilterNote notename
Context:server config, virtual host
Status:Extension
Module:mod_deflate

The DeflateFilterNote directive specifies that a note about compression ratios should be attached to the request. The name of the note is the value specified for @@ -203,24 +248,44 @@ clientStatus: LogFormat '"%r" %b (%{ratio}n) "%{User-agent}i"' deflate
CustomLog logs/deflate_log deflate

-

See also

top

DeflateMemLevel Directive

Description: - How much memory should be used by zlib for compression
Syntax: - DeflateMemLevel value
Default: - DeflateMemLevel 9
Context: - server config, virtual host
Status: - Extension
Module: - mod_deflate
+ +

See also

+ +
+
top
+

DeflateMemLevel Directive

+ + + + + + + +
Description:How much memory should be used by zlib for compression
Syntax:DeflateMemLevel value
Default:DeflateMemLevel 9
Context:server config, virtual host
Status:Extension
Module:mod_deflate

The DeflateMemLevel directive specifies how much memory should be used by zlib for compression (a value between 1 and 9).

-
top

DeflateWindowSize Directive

Description: - Zlib compression window size
Syntax: - DeflateWindowSize value
Default: - DeflateWindowSize 15
Context: - server config, virtual host
Status: - Extension
Module: - mod_deflate
+ +
+
top
+

DeflateWindowSize Directive

+ + + + + + + +
Description:Zlib compression window size
Syntax:DeflateWindowSize value
Default:DeflateWindowSize 15
Context:server config, virtual host
Status:Extension
Module:mod_deflate

The DeflateWindowSize directive specifies the zlib compression window size (a value between 1 and 15). Generally, the higher the window size, the higher can the compression ratio be expected.

-
\ No newline at end of file + + + + + \ No newline at end of file diff --git a/docs/manual/mod/mod_dir.html.en b/docs/manual/mod/mod_dir.html.en index 9338c7c70b..2a0bccdbce 100644 --- a/docs/manual/mod/mod_dir.html.en +++ b/docs/manual/mod/mod_dir.html.en @@ -4,12 +4,29 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_dir - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-
Apache > HTTP Server > Documentation > Version 2.1 > Modules

Apache Module mod_dir

Description: - Provides for "trailing slash" redirects and - serving directory index files
Status: - Base
Module Identifier: - dir_module
Source File: - mod_dir.c

Summary

+ --> +mod_dir - Apache HTTP Server + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+ +
+

Apache Module mod_dir

+ + + +
Description:Provides for "trailing slash" redirects and + serving directory index files
Status:Base
Module Identifier:dir_module
Source File:mod_dir.c
+

Summary

+

The index of a directory can come from one of two sources:

    @@ -31,17 +48,26 @@ dirname is a directory. Directories require a trailing slash, so mod_dir issues a redirect to http://servername/foo/dirname/.

    -

Directives

top

DirectoryIndex Directive

Description: - List of resources to look for when the client requests -a directory
Syntax: - DirectoryIndex - local-url [local-url] ...
Default: - DirectoryIndex index.html
Context: - server config, virtual host, directory, .htaccess
Override: - Indexes
Status: - Base
Module: - mod_dir
+
+

Directives

+ +
+ +
top
+

DirectoryIndex Directive

+ + + + + + + + +
Description:List of resources to look for when the client requests +a directory
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 @@ -71,4 +97,10 @@ a directorySyntax:

would cause the CGI script /cgi-bin/index.pl to be executed if neither index.html or index.txt existed in a directory.

-
\ No newline at end of file + +
+
+ + \ No newline at end of file diff --git a/docs/manual/mod/mod_disk_cache.html.en b/docs/manual/mod/mod_disk_cache.html.en index 2137d2aa94..7c3297a3bd 100644 --- a/docs/manual/mod/mod_disk_cache.html.en +++ b/docs/manual/mod/mod_disk_cache.html.en @@ -4,11 +4,28 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_disk_cache - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-
Apache > HTTP Server > Documentation > Version 2.1 > Modules

Apache Module mod_disk_cache

Description: - Content cache storage manager keyed to URIs
Status: - Experimental
Module Identifier: - disk_cache_module
Source File: - mod_disk_cache.c

Summary

+ --> +mod_disk_cache - Apache HTTP Server + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+ +
+

Apache Module mod_disk_cache

+ + + +
Description:Content cache storage manager keyed to URIs
Status:Experimental
Module Identifier:disk_cache_module
Source File:mod_disk_cache.c
+

Summary

+
This module is experimental. Documentation is still under development...
@@ -24,7 +41,10 @@

mod_disk_cache requires the services of mod_cache.

-

Directives

+
top

CacheDirLength Directive

Description: - The number of characters in subdirectory names
Syntax: - CacheDirLength length
Default: - CacheDirLength 2
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+ +
top
+

CacheDirLength Directive

+ + + + + + + +
Description:The number of characters in subdirectory names
Syntax:CacheDirLength length
Default:CacheDirLength 2
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

The CacheDirLength directive sets the number of characters for each subdirectory name in the cache hierarchy.

@@ -55,14 +81,19 @@

CacheDirLength 4

-
top

CacheDirLevels Directive

Description: - The number of levels of subdirectories in the -cache.
Syntax: - CacheDirLevels levels
Default: - CacheDirLevels 3
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheDirLevels Directive

+ + + + + + + +
Description:The number of levels of subdirectories in the +cache.
Syntax:CacheDirLevels levels
Default:CacheDirLevels 3
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

The CacheDirLevels directive sets the number of subdirectory levels in the cache. Cached data will be saved this many directory levels below the CacheRoot directory.

@@ -76,14 +107,19 @@ cache.Syntax:

CacheDirLevels 5

-
top

CacheExpiryCheck Directive

Description: - Indicates if the cache observes Expires dates when seeking -files
Syntax: - CacheExpiryCheck On|Off
Default: - CacheExpiryCheck On
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheExpiryCheck Directive

+ + + + + + + +
Description:Indicates if the cache observes Expires dates when seeking +files
Syntax:CacheExpiryCheck On|Off
Default:CacheExpiryCheck On
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

More detail will be added here, when the function is implemented.

@@ -94,14 +130,19 @@ filesSyntax: The CacheExpiryCheck directive is currently not implemented.

-
top

CacheGcClean Directive

Description: - The time to retain unchanged cached files that match a -URL
Syntax: - CacheGcClean hours url-string
Default: - CacheGcClean ?
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheGcClean Directive

+ + + + + + + +
Description:The time to retain unchanged cached files that match a +URL
Syntax:CacheGcClean hours url-string
Default:CacheGcClean ?
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

More detail will be added here, when the function is implemented.

@@ -112,14 +153,19 @@ URLSyntax: The CacheGcClean directive is currently not implemented.

-
top

CacheGcDaily Directive

Description: - The recurring time each day for garbage collection to be run. -(24 hour clock)
Syntax: - CacheGcDaily time
Default: - CacheGcDaily ?
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheGcDaily Directive

+ + + + + + + +
Description:The recurring time each day for garbage collection to be run. +(24 hour clock)
Syntax:CacheGcDaily time
Default:CacheGcDaily ?
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

More detail will be added here, when the function is implemented.

@@ -130,12 +176,17 @@ URLSyntax: The CacheGcDaily directive is currently not implemented.

-
top

CacheGcInterval Directive

Description: - The interval between garbage collection attempts.
Syntax: - CacheGcInterval hours
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheGcInterval Directive

+ + + + + + +
Description:The interval between garbage collection attempts.
Syntax:CacheGcInterval hours
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

The CacheGcInterval directive specifies the number of hours to wait between attempts to free up disk space.

More detail will be added here, when the function is implemented.

@@ -148,14 +199,19 @@ URLSyntax: The CacheGcInterval directive is currently not implemented.
-
top

CacheGcMemUsage Directive

Description: - The maximum kilobytes of memory used for garbage -collection
Syntax: - CacheGcMemUsage KBytes
Default: - CacheGcMemUsage ?
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheGcMemUsage Directive

+ + + + + + + +
Description:The maximum kilobytes of memory used for garbage +collection
Syntax:CacheGcMemUsage KBytes
Default:CacheGcMemUsage ?
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

More detail will be added here, when the function is implemented.

@@ -166,14 +222,19 @@ collectionSyntax: The CacheGcMemUsage directive is currently not implemented.

-
top

CacheGcUnused Directive

Description: - The time to retain unreferenced cached files that match a -URL.
Syntax: - CacheGcUnused hours url-string
Default: - CacheGcUnused ?
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheGcUnused Directive

+ + + + + + + +
Description:The time to retain unreferenced cached files that match a +URL.
Syntax:CacheGcUnused hours url-string
Default:CacheGcUnused ?
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

More detail will be added here, when the function is implemented.

@@ -184,14 +245,19 @@ URL.Syntax: The CacheGcUnused directive is currently not implemented.

-
top

CacheMaxFileSize Directive

Description: - The maximum size (in bytes) of a document to be placed in the -cache
Syntax: - CacheMaxFileSize bytes
Default: - CacheMaxFileSize 1000000
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheMaxFileSize Directive

+ + + + + + + +
Description:The maximum size (in bytes) of a document to be placed in the +cache
Syntax:CacheMaxFileSize bytes
Default:CacheMaxFileSize 1000000
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

The CacheMaxFileSize directive sets the maximum size, in bytes, for a document to be considered for storage in the cache.

@@ -199,14 +265,19 @@ cacheSyntax:

CacheMaxFileSize 64000

-
top

CacheMinFileSize Directive

Description: - The minimum size (in bytes) of a document to be placed in the -cache
Syntax: - CacheMinFileSize bytes
Default: - CacheMinFileSize 1
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheMinFileSize Directive

+ + + + + + + +
Description:The minimum size (in bytes) of a document to be placed in the +cache
Syntax:CacheMinFileSize bytes
Default:CacheMinFileSize 1
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

The CacheMinFileSize directive sets the minimum size, in bytes, for a document to be considered for storage in the cache.

@@ -214,14 +285,19 @@ cacheSyntax:

CacheMinFileSize 64

-
top

CacheRoot Directive

Description: - The directory root under which cache files are -stored
Syntax: - CacheRoot directory
Default: - none
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheRoot Directive

+ + + + + + + +
Description:The directory root under which cache files are +stored
Syntax:CacheRoot directory
Default:none
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

The CacheRoot directive defines the name of the directory on the disk to contain cache files. If the mod_disk_cache module has been loaded or compiled in to the Apache server, this directive must be defined. Failing to @@ -232,14 +308,19 @@ storedSyntax:

CacheRoot c:/cacheroot

-
top

CacheSize Directive

Description: - The maximum amount of disk space that will be used by the -cache in KBytes
Syntax: - CacheSize KBytes
Default: - CacheSize 1000000
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheSize Directive

+ + + + + + + +
Description:The maximum amount of disk space that will be used by the +cache in KBytes
Syntax:CacheSize KBytes
Default:CacheSize 1000000
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

The CacheSize directive sets the desired disk space usage of the cache, in KBytes (1024-byte units). This directive does not put a hard limit on the size of the cache. The @@ -250,13 +331,18 @@ cache in KBytesSyntax:

CacheSize 5000000

-
top

CacheTimeMargin Directive

Description: - The minimum time margin to cache a document
Syntax: - CacheTimeMargin ?
Default: - CacheTimeMargin ?
Context: - server config, virtual host
Status: - Experimental
Module: - mod_disk_cache
+ +
+
top
+

CacheTimeMargin Directive

+ + + + + + + +
Description:The minimum time margin to cache a document
Syntax:CacheTimeMargin ?
Default:CacheTimeMargin ?
Context:server config, virtual host
Status:Experimental
Module:mod_disk_cache

More detail will be added here, when the function is implemented.

@@ -267,4 +353,10 @@ cache in KBytesSyntax: The CacheTimeMargin directive is currently not implemented.

-
\ No newline at end of file + + + + + \ No newline at end of file diff --git a/docs/manual/mod/mod_echo.html.en b/docs/manual/mod/mod_echo.html.en index 8eae907917..860a765e3e 100644 --- a/docs/manual/mod/mod_echo.html.en +++ b/docs/manual/mod/mod_echo.html.en @@ -4,29 +4,61 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_echo - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-

Apache Module mod_echo

Description: - A simple echo server to illustrate protocol -modules
Status: - Experimental
Module Identifier: - echo_module
Source File: - mod_echo.c
Compatibility: - Available in Apache 2.0 and later

Summary

+ --> +mod_echo - Apache HTTP Server + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+ +
+

Apache Module mod_echo

+ + + + +
Description:A simple echo server to illustrate protocol +modules
Status:Experimental
Module Identifier:echo_module
Source File:mod_echo.c
Compatibility:Available in Apache 2.0 and later
+

Summary

+

This module provides an example protocol module to illustrate the concept. It provides a simple echo server. Telnet to it and type stuff, and it will echo it.

-

Directives

top

ProtocolEcho Directive

Description: - Turn the echo server on or off
Syntax: - ProtocolEcho On|Off
Context: - server config, virtual host
Status: - Experimental
Module: - mod_echo
Compatibility: - ProtocolEcho is only available in 2.0 and -later.
+
+

Directives

+ +
+ +
top
+

ProtocolEcho Directive

+ + + + + + + +
Description:Turn the echo server on or off
Syntax:ProtocolEcho On|Off
Context:server config, virtual host
Status:Experimental
Module:mod_echo
Compatibility:ProtocolEcho is only available in 2.0 and +later.

The ProtocolEcho directive enables or disables the echo server.

Example

ProtocolEcho On

-
\ No newline at end of file + +
+
+ + \ No newline at end of file diff --git a/docs/manual/mod/mod_env.html.en b/docs/manual/mod/mod_env.html.en index 1536aa1954..3c4e36e05d 100644 --- a/docs/manual/mod/mod_env.html.en +++ b/docs/manual/mod/mod_env.html.en @@ -4,28 +4,57 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_env - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-

Apache Module mod_env

Description: - Modifies the environment which is passed to CGI scripts and -SSI pages
Status: - Base
Module Identifier: - env_module
Source File: - mod_env.c

Summary

+ --> +mod_env - Apache HTTP Server + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+ +
+

Apache Module mod_env

+ + + +
Description:Modifies the environment which is passed to CGI scripts and +SSI pages
Status:Base
Module Identifier:env_module
Source File:mod_env.c
+

Summary

+

This module allows for control of the environment that will be provided to CGI scripts and SSI pages. Environment variables may be passed from the shell which invoked the httpd process. Alternatively, environment variables may be set or unset within the configuration process.

-

Directives

+
top

PassEnv Directive

Description: - Passes environment variables from the shell
Syntax: - PassEnv env-variable [env-variable] -...
Context: - server config, virtual host, directory, .htaccess
Override: - FileInfo
Status: - Base
Module: - mod_env
+ +

See also

+
+ +
top
+

PassEnv Directive

+ + + + + + + +
Description:Passes environment variables from the shell
Syntax:PassEnv env-variable [env-variable] +...
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_env

Specifies one or more environment variables to pass to CGI scripts and SSI pages from the environment of the shell which invoked the httpd process.

@@ -33,31 +62,47 @@ SSI pagesStatus:

Example

PassEnv LD_LIBRARY_PATH

-
top

SetEnv Directive

Description: - Sets environment variables
Syntax: - SetEnv env-variable value
Context: - server config, virtual host, directory, .htaccess
Override: - FileInfo
Status: - Base
Module: - mod_env
+ +
+
top
+

SetEnv Directive

+ + + + + + + +
Description:Sets environment variables
Syntax:SetEnv env-variable value
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_env

Sets an environment variable, which is then passed on to CGI scripts and SSI pages.

Example

SetEnv SPECIAL_PATH /foo/bin

-
top

UnsetEnv Directive

Description: - Removes variables from the environment
Syntax: - UnsetEnv env-variable [env-variable] -...
Context: - server config, virtual host, directory, .htaccess
Override: - FileInfo
Status: - Base
Module: - mod_env
+ +
+
top
+

UnsetEnv Directive

+ + + + + + + +
Description:Removes variables from the environment
Syntax:UnsetEnv env-variable [env-variable] +...
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_env

Removes one or more environment variables from those passed on to CGI scripts and SSI pages.

Example

UnsetEnv LD_LIBRARY_PATH

-
\ No newline at end of file + +
+
+ + \ No newline at end of file diff --git a/docs/manual/mod/mod_example.html.en b/docs/manual/mod/mod_example.html.en index d75ca49a3d..84d4b1a7a6 100644 --- a/docs/manual/mod/mod_example.html.en +++ b/docs/manual/mod/mod_example.html.en @@ -4,11 +4,28 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_example - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.1

<-

Apache Module mod_example

Description: - Illustrates the Apache module API
Status: - Experimental
Module Identifier: - example_module
Source File: - mod_example.c

Summary

+ --> +mod_example - Apache HTTP Server + + + + + +
+

Modules | Directives | FAQ | Glossary | Sitemap

+

Apache HTTP Server Version 2.1

+
+
<-
+ +
+

Apache Module mod_example

+ + + +
Description:Illustrates the Apache module API
Status:Experimental
Module Identifier:example_module
Source File:mod_example.c
+

Summary

+
This document has not been updated to take into account changes made in the 2.0 version of the @@ -31,8 +48,19 @@ location, and then browse to that location, you will see a display of some of the tracing the example module did as the various callbacks were made.

-

Directives

Topics

  • Compiling the example module
  • Using the mod_example Module
top

Compiling the example module

+
+

Directives

+ +

Topics

+
    +
  • Compiling the example module
    • +
  • Using the mod_example Module
    • +
+
top
+
+

Compiling the example module

To include the example module in your server, follow the steps below:

@@ -70,7 +98,9 @@
  • Follow steps [1] through [3] above, with appropriate changes.
    • -
    top

    Using the mod_example Module

    +
    top
    +
    +

    Using the mod_example Module

    To activate the example module, include a block similar to the following in your srm.conf file:

    @@ -89,13 +119,17 @@

    After reloading/restarting your server, you should be able to browse to this location and see the brief display mentioned earlier.

    -
    top

    Example Directive

    Description: - Demonstration directive to illustrate the Apache module -API
    Syntax: - Example
    Context: - server config, virtual host, directory, .htaccess
    Status: - Experimental
    Module: - mod_example
    +
    +
    top
    +

    Example Directive

    + + + + + + +
    Description:Demonstration directive to illustrate the Apache module +API
    Syntax:Example
    Context:server config, virtual host, directory, .htaccess
    Status:Experimental
    Module:mod_example

    The Example directive just sets a demonstration flag which the example module's content handler displays. It takes no arguments. If you browse to an URL to which the @@ -104,4 +138,10 @@ APISyntax: called to service the document request. The effect of this directive one can observe under the point "Example directive declared here: YES/NO".

    -
    \ No newline at end of file + +
    +
    + + \ No newline at end of file diff --git a/docs/manual/mod/mod_expires.html.en b/docs/manual/mod/mod_expires.html.en index d788700490..c3ca8421e6 100644 --- a/docs/manual/mod/mod_expires.html.en +++ b/docs/manual/mod/mod_expires.html.en @@ -4,12 +4,29 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_expires - Apache HTTP Server

    Modules | Directives | FAQ | Glossary | Sitemap

    Apache HTTP Server Version 2.1

    <-

    Apache Module mod_expires

    Description: - Generation of Expires HTTP headers according to -user-specified criteria
    Status: - Extension
    Module Identifier: - expires_module
    Source File: - mod_expires.c

    Summary

    + --> +mod_expires - Apache HTTP Server + + + + + +
    +

    Modules | Directives | FAQ | Glossary | Sitemap

    +

    Apache HTTP Server Version 2.1

    +
    +
    <-
    + +
    +

    Apache Module mod_expires

    + + + +
    Description:Generation of Expires HTTP headers according to +user-specified criteria
    Status:Extension
    Module Identifier:expires_module
    Source File:mod_expires.c
    +

    Summary

    +

    This module controls the setting of the Expires HTTP header in server responses. The expiration date can set to be relative to either the time the source file was last @@ -21,10 +38,20 @@ user-specified criteriaStatu from the source until this time has passed. After that, the cache copy is considered "expired" and invalid, and a new copy must be obtained from the source.

    -
    +
    top

    Alternate Interval Syntax

    + +

    Topics

    +
    +
    top
    +
    +

    Alternate Interval Syntax

    The ExpiresDefault and ExpiresByType directives can also be defined in a more readable syntax of the form:

    @@ -85,14 +112,18 @@ user-specified criteriaStatu Expires header will not be added to content that does not come from a file on disk. This is due to the fact that there is no modification time for such content.

    -
    top

    ExpiresActive Directive

    Description: - Enables generation of Expires -headers
    Syntax: - ExpiresActive On|Off
    Context: - server config, virtual host, directory, .htaccess
    Override: - Indexes
    Status: - Extension
    Module: - mod_expires
    +
    +
    top
    +

    ExpiresActive Directive

    + + + + + + + +
    Description:Enables generation of Expires +headers
    Syntax:ExpiresActive On|Off
    Context:server config, virtual host, directory, .htaccess
    Override:Indexes
    Status:Extension
    Module:mod_expires

    This directive enables or disables the generation of the Expires header for the document realm in question. (That is, if found in an .htaccess file, for @@ -110,15 +141,20 @@ headersSyntax: Expires header will be generated. If the criteria aren't met, no header will be sent, and the effect will be as though this directive wasn't even specified.

    -
    top

    ExpiresByType Directive

    Description: - Value of the Expires header configured -by MIME type
    Syntax: - ExpiresByType MIME-type -<code>seconds
    Context: - server config, virtual host, directory, .htaccess
    Override: - Indexes
    Status: - Extension
    Module: - mod_expires
    + +
    +
    top
    +

    ExpiresByType Directive

    + + + + + + + +
    Description:Value of the Expires header configured +by MIME type
    Syntax:ExpiresByType MIME-type +<code>seconds
    Context:server config, virtual host, directory, .htaccess
    Override:Indexes
    Status:Extension
    Module:mod_expires

    This directive defines the value of the Expires header generated for documents of the specified type (e.g., text/html). The second argument sets the number of @@ -162,17 +198,28 @@ by MIME typeSyntax:

    You can also specify the expiration time calculation using an alternate syntax, described earlier in this document.

    -
    top

    ExpiresDefault Directive

    Description: - Default algorithm for calculating expiration time
    Syntax: - ExpiresDefault <code>seconds
    Context: - server config, virtual host, directory, .htaccess
    Override: - Indexes
    Status: - Extension
    Module: - mod_expires
    + +
    +
    top
    +

    ExpiresDefault Directive

    + + + + + + + +
    Description:Default algorithm for calculating expiration time
    Syntax:ExpiresDefault <code>seconds
    Context:server config, virtual host, directory, .htaccess
    Override:Indexes
    Status:Extension
    Module:mod_expires

    This directive sets the default algorithm for calculating the expiration time for all documents in the affected realm. It can be overridden on a type-by-type basis by the ExpiresByType directive. See the description of that directive for details about the syntax of the argument, and the alternate syntax description as well.

    -
    \ No newline at end of file + +
    +
    + + \ No newline at end of file diff --git a/docs/manual/mod/mod_ext_filter.html.en b/docs/manual/mod/mod_ext_filter.html.en index 9d354cbd4f..e1beafc571 100644 --- a/docs/manual/mod/mod_ext_filter.html.en +++ b/docs/manual/mod/mod_ext_filter.html.en @@ -4,12 +4,29 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_ext_filter - Apache HTTP Server

    Modules | Directives | FAQ | Glossary | Sitemap

    Apache HTTP Server Version 2.1

    <-

    Apache Module mod_ext_filter

    Description: - Pass the response body through an external program before -delivery to the client
    Status: - Extension
    Module Identifier: - ext_filter_module
    Source File: - mod_ext_filter.c

    Summary

    + --> +mod_ext_filter - Apache HTTP Server + + + + + +
    +

    Modules | Directives | FAQ | Glossary | Sitemap

    +

    Apache HTTP Server Version 2.1

    +
    +
    <-
    + +
    +

    Apache Module mod_ext_filter

    + + + +
    Description:Pass the response body through an external program before +delivery to the client
    Status:Extension
    Module Identifier:ext_filter_module
    Source File:mod_ext_filter.c
    +

    Summary

    +

    mod_ext_filter presents a simple and familiar programming model for filters. With this module, a program which reads from stdin and writes to stdout @@ -34,9 +51,22 @@ delivery to the clientStatus for production use, mod_ext_filter can be used as a prototype environment for filters.

    -

    Directives

    +

    Directives

    +

    Topics

    See also

    top

    Examples

    + +

    Topics

    +

    See also

    +
    +
    top
    +
    +

    Examples

    Generating HTML from some other type of response

    @@ -186,12 +216,16 @@ delivery to the clientStatus close(SAVE);

    -
    top

    ExtFilterDefine Directive

    Description: - Define an external filter
    Syntax: - ExtFilterDefine filtername parameters
    Context: - server config
    Status: - Extension
    Module: - mod_ext_filter
    +
    +
    top
    +

    ExtFilterDefine Directive

    + + + + + + +
    Description:Define an external filter
    Syntax:ExtFilterDefine filtername parameters
    Context:server config
    Status:Extension
    Module:mod_ext_filter

    The ExtFilterDefine directive defines the characteristics of an external filter, including the program to run and its arguments.

    @@ -274,13 +308,18 @@ delivery to the clientStatus
    This parameter specifies the name of an environment variable which must be set, or the filter will be disabled.
    -
    top

    ExtFilterOptions Directive

    Description: - Configure mod_ext_filter options
    Syntax: - ExtFilterOptions option [option] ...
    Default: - ExtFilterOptions DebugLevel=0 NoLogStderr
    Context: - directory
    Status: - Extension
    Module: - mod_ext_filter
    + +
    +
    top
    +

    ExtFilterOptions Directive

    + + + + + + + +
    Description:Configure mod_ext_filter options
    Syntax:ExtFilterOptions option [option] ...
    Default:ExtFilterOptions DebugLevel=0 NoLogStderr
    Context:directory
    Status:Extension
    Module:mod_ext_filter

    The ExtFilterOptions directive specifies special processing options for mod_ext_filter. Option can be one of

    @@ -318,4 +357,10 @@ delivery to the clientStatus

    Messages written to the filter's standard error will be stored in the Apache error log. No debug messages will be generated by mod_ext_filter.

    -
    \ No newline at end of file + +
    +
    + + \ No newline at end of file diff --git a/docs/manual/mod/mod_file_cache.html.en b/docs/manual/mod/mod_file_cache.html.en index 45876a2e9d..1fcd03b7db 100644 --- a/docs/manual/mod/mod_file_cache.html.en +++ b/docs/manual/mod/mod_file_cache.html.en @@ -4,11 +4,28 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_file_cache - Apache HTTP Server

    Modules | Directives | FAQ | Glossary | Sitemap

    Apache HTTP Server Version 2.1

    <-

    Apache Module mod_file_cache

    Description: - Caches a static list of files in memory
    Status: - Experimental
    Module Identifier: - file_cache_module
    Source File: - mod_file_cache.c

    Summary

    + --> +mod_file_cache - Apache HTTP Server + + + + + +
    +

    Modules | Directives | FAQ | Glossary | Sitemap

    +

    Apache HTTP Server Version 2.1

    +
    +
    <-
    + +
    +

    Apache Module mod_file_cache

    + + + +
    Description:Caches a static list of files in memory
    Status:Experimental
    Module Identifier:file_cache_module
    Source File:mod_file_cache.c
    +

    Summary

    +
    This module should be used with care. You can easily create a broken @@ -34,9 +51,19 @@

    This module is an extension of and borrows heavily from the mod_mmap_static module in Apache 1.3.

    -

    Directives

    +

    Directives

    +

    Topics

    top

    Using mod_file_cache

    + +

    Topics

    +
    +
    top
    +
    +

    Using mod_file_cache

    mod_file_cache caches a list of statically configured files via MMapFile or CacheFile directives in the main server configuration.

    @@ -110,12 +137,16 @@ | sed -e 's/.*/mmapfile &/' > /www/conf/mmap.conf

    -
    top

    CacheFile Directive

    Description: - Cache a list of file handles at startup time
    Syntax: - CacheFile file-path [file-path] ...
    Context: - server config
    Status: - Experimental
    Module: - mod_file_cache
    +
    +
    top
    +

    CacheFile Directive

    + + + + + + +
    Description:Cache a list of file handles at startup time
    Syntax:CacheFile file-path [file-path] ...
    Context:server config
    Status:Experimental
    Module:mod_file_cache

    The CacheFile directive opens handles to one or more files (given as whitespace separated arguments) and places these handles into the cache at server startup @@ -135,12 +166,17 @@

    Example

    CacheFile /usr/local/apache/htdocs/index.html

    -
    top

    MMapFile Directive

    Description: - Map a list of files into memory at startup time
    Syntax: - MMapFile file-path [file-path] ...
    Context: - server config
    Status: - Experimental
    Module: - mod_file_cache
    + +
    +
    top
    +

    MMapFile Directive

    + + + + + + +
    Description:Map a list of files into memory at startup time
    Syntax:MMapFile file-path [file-path] ...
    Context:server config
    Status:Experimental
    Module:mod_file_cache

    The MMapFile directive maps one or more files (given as whitespace separated arguments) into memory at server startup time. They are automatically unmapped on a server @@ -160,4 +196,10 @@

    Example

    MMapFile /usr/local/apache/htdocs/index.html

    -
    \ No newline at end of file + +
    +
    + + \ No newline at end of file diff --git a/docs/manual/mod/mod_headers.html.en b/docs/manual/mod/mod_headers.html.en index c1d1e080d0..7e5bac6a81 100644 --- a/docs/manual/mod/mod_headers.html.en +++ b/docs/manual/mod/mod_headers.html.en @@ -4,20 +4,48 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_headers - Apache HTTP Server

    Modules | Directives | FAQ | Glossary | Sitemap

    Apache HTTP Server Version 2.1

    <-

    Apache Module mod_headers

    Description: - Customization of HTTP request and response -headers
    Status: - Extension
    Module Identifier: - headers_module
    Source File: - mod_headers.c
    Compatibility: - RequestHeader -is available only in Apache 2.0

    Summary

    + --> +mod_headers - Apache HTTP Server + + + + + +
    +

    Modules | Directives | FAQ | Glossary | Sitemap

    +

    Apache HTTP Server Version 2.1

    +
    +
    <-
    + +
    +

    Apache Module mod_headers

    + + + + +
    Description:Customization of HTTP request and response +headers
    Status:Extension
    Module Identifier:headers_module
    Source File:mod_headers.c
    Compatibility:RequestHeader +is available only in Apache 2.0
    +

    Summary

    +

    This module provides directives to control and modify HTTP request and response headers. Headers can be merged, replaced or removed.

    -

    Directives

    +
    top

    Order of Processing

    + +

    Topics

    +
    +
    top
    +
    +

    Order of Processing

    The directives provided by mod_headers can occur almost anywhere within the server configuration. They are valid in the @@ -48,7 +76,9 @@ is available only in Apache 2.0

    Summary

    This way round, the MirrorID header is not set. If reversed, the MirrorID header is set to "mirror 12".

    -
    top

    Examples

    +
    top
    +
    +

    Examples

    1. @@ -114,14 +144,18 @@ is available only in Apache 2.0

      Summary

    -
    top

    Header Directive

    Description: - Configure HTTP response headers
    Syntax: - Header set|append|add|unset|echo header -[value [env=[!]variable]]
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Extension
    Module: - mod_headers
    +
    +
    top
    +

    Header Directive

    + + + + + + + +
    Description:Configure HTTP response headers
    Syntax:Header set|append|add|unset|echo header +[value [env=[!]variable]]
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Extension
    Module:mod_headers

    This directive can replace, merge or remove HTTP response headers. The header is modified just after the content handler and output filters are run, allowing outgoing headers to be @@ -199,14 +233,19 @@ is available only in Apache 2.0

    Summary

    before the response is sent to the network. These means that it is possible to set and/or override most headers, except for those headers added by the header filter.

    -
    top

    RequestHeader Directive

    Description: - Configure HTTP request headers
    Syntax: - RequestHeader set|append|add|unset header -[value]
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Extension
    Module: - mod_headers
    + +
    +
    top
    +

    RequestHeader Directive

    + + + + + + + +
    Description:Configure HTTP request headers
    Syntax:RequestHeader set|append|add|unset header +[value]
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Extension
    Module:mod_headers

    This directive can replace, merge or remove HTTP request headers. The header is modified just before the content handler is run, allowing incoming headers to be modified. The action it @@ -248,4 +287,10 @@ is available only in Apache 2.0

    Summary

    just before the request is run by its handler in the fixup phase. This should allow headers generated by the browser, or by Apache input filters to be overridden or modified.

    -
    \ No newline at end of file + +
    + + + \ No newline at end of file diff --git a/docs/manual/mod/mod_imap.html.en b/docs/manual/mod/mod_imap.html.en index 36149481dd..ba5c584f52 100644 --- a/docs/manual/mod/mod_imap.html.en +++ b/docs/manual/mod/mod_imap.html.en @@ -4,11 +4,28 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_imap - Apache HTTP Server

    Modules | Directives | FAQ | Glossary | Sitemap

    Apache HTTP Server Version 2.1

    <-

    Apache Module mod_imap

    Description: - Server-side imagemap processing
    Status: - Base
    Module Identifier: - imap_module
    Source File: - mod_imap.c

    Summary

    + --> +mod_imap - Apache HTTP Server + + + + + +
    +

    Modules | Directives | FAQ | Glossary | Sitemap

    +

    Apache HTTP Server Version 2.1

    +
    +
    <-
    + +
    +

    Apache Module mod_imap

    + + + +
    Description:Server-side imagemap processing
    Status:Base
    Module Identifier:imap_module
    Source File:mod_imap.c
    +

    Summary

    +

    This module processes .map files, thereby replacing the functionality of the imagemap CGI program. Any directory or document type configured to use the @@ -28,10 +45,23 @@

    However, we are trying to phase out "magic MIME types" so we are deprecating this method.

    -

    Directives

    +
    top

    New Features

    + +

    Topics

    +
    +
    top
    +
    +

    New Features

    The imagemap module adds some new features that were not possible with previously distributed imagemap programs.

    @@ -48,7 +78,9 @@
  • Configurable generation of imagemap menus.
    • -
    top

    Imagemap File

    +
    top
    +
    +

    Imagemap File

    The lines in the imagemap files can have one of several formats:

    @@ -211,7 +243,9 @@ -
    top

    Example Mapfile

    +
    top
    +
    +

    Example Mapfile

    #Comments are printed in a 'formatted' or 'semiformatted' menu.
    @@ -226,7 +260,9 @@ rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"

    -
    top

    Referencing your mapfile

    +
    top
    +
    +

    Referencing your mapfile

    HTML example

    <a href="/maps/imagemap1.map">
    @@ -244,28 +280,41 @@ </a>

    -
    top

    ImapBase Directive

    Description: - Default base for imagemap files
    Syntax: - ImapBase map|referer|URL
    Default: - ImapBase http://servername/
    Context: - server config, virtual host, directory, .htaccess
    Override: - Indexes
    Status: - Base
    Module: - mod_imap
    +
    +
    top
    +

    ImapBase Directive

    + + + + + + + + +
    Description:Default base for imagemap files
    Syntax:ImapBase map|referer|URL
    Default:ImapBase http://servername/
    Context:server config, virtual host, directory, .htaccess
    Override:Indexes
    Status:Base
    Module:mod_imap

    The ImapBase directive sets the default base used in the imagemap files. Its value is overridden by a base directive within the imagemap file. If not present, the base defaults to http://servername/.

    -

    See also

    top

    ImapDefault Directive

    Description: - Default action when an imagemap is called with coordinates -that are not explicitly mapped
    Syntax: - ImapDefault error|nocontent|map|referer|URL
    Default: - ImapDefault nocontent
    Context: - server config, virtual host, directory, .htaccess
    Override: - Indexes
    Status: - Base
    Module: - mod_imap
    + +

    See also

    + +
    +
    top
    +

    ImapDefault Directive

    + + + + + + + + +
    Description:Default action when an imagemap is called with coordinates +that are not explicitly mapped
    Syntax:ImapDefault error|nocontent|map|referer|URL
    Default:ImapDefault nocontent
    Context:server config, virtual host, directory, .htaccess
    Override:Indexes
    Status:Base
    Module:mod_imap

    The ImapDefault directive sets the default default used in the imagemap files. Its value is overridden by a default directive within the @@ -273,14 +322,19 @@ that are not explicitly mappedtop

    ImapMenu Directive

    Description: - Action if no coordinates are given when calling -an imagemap
    Syntax: - ImapMenu none|formatted|semiformatted|unformatted
    Context: - server config, virtual host, directory, .htaccess
    Override: - Indexes
    Status: - Base
    Module: - mod_imap
    + +
    +
    top
    +

    ImapMenu Directive

    + + + + + + + +
    Description:Action if no coordinates are given when calling +an imagemap
    Syntax:ImapMenu none|formatted|semiformatted|unformatted
    Context:server config, virtual host, directory, .htaccess
    Override:Indexes
    Status:Base
    Module:mod_imap

    The ImapMenu directive determines the action taken if an imagemap file is called without valid coordinates.

    @@ -312,4 +366,10 @@ an imagemapSyntax: of your menus, but requires you to treat your map files as HTML instead of plaintext. -
    \ No newline at end of file + +
    +
    + + \ No newline at end of file diff --git a/docs/manual/mod/mod_include.html.en b/docs/manual/mod/mod_include.html.en index f294172854..451f5e4939 100644 --- a/docs/manual/mod/mod_include.html.en +++ b/docs/manual/mod/mod_include.html.en @@ -4,27 +4,66 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_include - Apache HTTP Server

    Modules | Directives | FAQ | Glossary | Sitemap

    Apache HTTP Server Version 2.1

    <-

    Apache Module mod_include

    Description: - Server-parsed html documents (Server Side Includes)
    Status: - Base
    Module Identifier: - include_module
    Source File: - mod_include.c
    Compatibility: - Implemented as an output filter since Apache -2.0

    Summary

    + --> +mod_include - Apache HTTP Server + + + + + +
    +

    Modules | Directives | FAQ | Glossary | Sitemap

    +

    Apache HTTP Server Version 2.1

    +
    +
    <-
    + +
    +

    Apache Module mod_include

    + + + + +
    Description:Server-parsed html documents (Server Side Includes)
    Status:Base
    Module Identifier:include_module
    Source File:mod_include.c
    Compatibility:Implemented as an output filter since Apache +2.0
    +

    Summary

    +

    This module provides a filter which will process files before they are sent to the client. The processing is controlled by specially formatted SGML comments, referred to as elements. These elements allow conditional text, the inclusion of other files or programs, as well as the setting and printing of environment variables.

    -

    Directives

    +
    top

    Enabling Server-Side Includes

    + +

    Topics

    +

    See also

    +
    +
    top
    +
    +

    Enabling Server-Side Includes

    Server Side Includes are implemented by the @@ -59,14 +98,18 @@ Server Error Messages

  • Filters
  • < output will have the mime type text/html).

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

    -
    • top

    PATH_INFO with Server Side Includes

    +
    top
    +
    +

    PATH_INFO with Server Side Includes

    Files processed for server-side includes no longer accept requests with PATH_INFO (trailing pathname information) by default. You can use the AcceptPathInfo directive to configure the server to accept requests with PATH_INFO.

    -
    top

    Basic Elements

    +
    top
    +
    +

    Basic Elements

    The document is parsed as an HTML document, with special commands embedded as SGML comments. A command has the syntax:

    @@ -341,7 +384,9 @@ Server Error Messages
  • Filters
  • < <!--#set var="category" value="help" -->

    • -
    top

    Include Variables

    +
    top
    +
    +

    Include Variables

    In addition to the variables in the standard CGI environment, @@ -375,7 +420,9 @@ Server Error Messages

  • Filters
  • < usage (special characters like & etc. are preceded by backslashes). -
    • top

    Variable Substitution

    +
    top
    +
    +

    Variable Substitution

    Variable substitution is done within quoted strings in most cases where they may reasonably occur as an argument to an SSI @@ -424,7 +471,9 @@ Server Error Messages

  • Filters
  • < <!--#endif -->

    • -
    top

    Flow Control Elements

    +
    top
    +
    +

    Flow Control Elements

    The basic flow control elements are:

    @@ -527,14 +576,18 @@ Server Error Messages
  • Filters
  • < and

    'string1    string2' results in string1    string2.

    • -
    top

    SSIEndTag Directive

    Description: - String that ends an include element
    Syntax: - SSIEndTag tag
    Default: - SSIEndTag "-->"
    Context: - server config, virtual host
    Status: - Base
    Module: - mod_include
    Compatibility: - Available in version 2.0.30 and later.
    +
    +
    top
    +

    SSIEndTag Directive

    + + + + + + + + +
    Description:String that ends an include element
    Syntax:SSIEndTag tag
    Default:SSIEndTag "-->"
    Context:server config, virtual host
    Status:Base
    Module:mod_include
    Compatibility:Available in version 2.0.30 and later.

    This directive changes the string that mod_include looks for to mark the end of an include element.

    @@ -542,17 +595,26 @@ Server Error Messages
  • Filters
  • < SSIEndTag "%>"

    • -

    See also

    top

    SSIErrorMsg Directive

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

    See also

    + +
    +
    top
    +

    SSIErrorMsg Directive

    + + + + + + + + + +
    Description:Error message displayed when there is an SSI +error
    Syntax:SSIErrorMsg message
    Default:SSIErrorMsg "[an error occurred while processing this +directive]"
    Context:server config, virtual host, directory, .htaccess
    Override:All
    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 may consider changing the default @@ -565,14 +627,19 @@ directive]"Contex

    Example

    SSIErrorMsg "<!-- Error -->"

    -
    top

    SSIStartTag Directive

    Description: - String that starts an include element
    Syntax: - SSIStartTag tag
    Default: - SSIStartTag "<!--"
    Context: - server config, virtual host
    Status: - Base
    Module: - mod_include
    Compatibility: - Available in version 2.0.30 and later.
    + +
    +
    top
    +

    SSIStartTag Directive

    + + + + + + + + +
    Description:String that starts an include element
    Syntax:SSIStartTag tag
    Default:SSIStartTag "<!--"
    Context:server config, virtual host
    Status:Base
    Module:mod_include
    Compatibility:Available in version 2.0.30 and later.

    This directive changes the string that mod_include looks for to mark an include element to process.

    @@ -592,16 +659,25 @@ directive]"Contex

    SSI directives with alternate start and end tags

    <%#printenv %>

    -

    See also

    top

    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: - All
    Status: - Base
    Module: - mod_include
    Compatibility: - Available in version 2.0.30 and later.
    + +

    See also

    + +
    +
    top
    +

    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:All
    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 is as in strftime(3) from the @@ -616,29 +692,39 @@ displayedSyntax:

    The above directive would cause times to be displayed in the format "22:26, June 14, 2002".

    -
    top

    SSIUndefinedEcho Directive

    Description: - String displayed when an unset variable is echoed
    Syntax: - SSIUndefinedEcho string
    Default: - SSIUndefinedEcho "(none)"
    Context: - server config, virtual host
    Status: - Base
    Module: - mod_include
    Compatibility: - Available in version 2.0.34 and later.
    + +
    +
    top
    +

    SSIUndefinedEcho Directive

    + + + + + + + + +
    Description:String displayed when an unset variable is echoed
    Syntax:SSIUndefinedEcho string
    Default:SSIUndefinedEcho "(none)"
    Context:server config, virtual host
    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".

    Example

    SSIUndefinedEcho "<!-- undef -->"

    -
    top

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

    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

    The XBitHack directive controls the parsing of ordinary html documents. This directive only affects files associated with the MIME type text/html. XBitHack can take on the following values:

    @@ -667,4 +753,10 @@ setSyntax: -
    \ No newline at end of file + + + + + \ No newline at end of file diff --git a/docs/manual/mod/mod_info.html.en b/docs/manual/mod/mod_info.html.en index d8b433249e..9e720ed5ed 100644 --- a/docs/manual/mod/mod_info.html.en +++ b/docs/manual/mod/mod_info.html.en @@ -4,12 +4,29 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_info - Apache HTTP Server

    Modules | Directives | FAQ | Glossary | Sitemap

    Apache HTTP Server Version 2.1

    <-

    Apache Module mod_info

    Description: - Provides a comprehensive overview of the server -configuration
    Status: - Extension
    Module Identifier: - info_module
    Source File: - mod_info.c

    Summary

    + --> +mod_info - Apache HTTP Server + + + + + +
    +

    Modules | Directives | FAQ | Glossary | Sitemap

    +

    Apache HTTP Server Version 2.1

    +
    +
    <-
    + +
    +

    Apache Module mod_info

    + + + +
    Description:Provides a comprehensive overview of the server +configuration
    Status:Extension
    Module Identifier:info_module
    Source File:mod_info.c
    +

    Summary

    +

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

    @@ -55,15 +72,24 @@ configurationStatus: from it. Therefore, this module should only be used in a controlled environment and always with caution.

    -
    top

    AddModuleInfo Directive

    Description: - Adds additional information to the module -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
    +
    +

    Directives

    + +
    + +
    top
    +

    AddModuleInfo Directive

    + + + + + + + +
    Description:Adds additional information to the module +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 the module module-name. Example:

    @@ -75,4 +101,10 @@ information displayed by the server-info handler

    Maintained by the Apache HTTP Server Documentation Project

    Modules | Directives | FAQ | Glossary | Sitemap

    \ No newline at end of file + +
    +
    + + \ No newline at end of file diff --git a/docs/manual/mod/mod_isapi.html.en b/docs/manual/mod/mod_isapi.html.en index 21905d8295..ba8b670249 100644 --- a/docs/manual/mod/mod_isapi.html.en +++ b/docs/manual/mod/mod_isapi.html.en @@ -4,12 +4,29 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - -->mod_isapi - Apache HTTP Server

    Modules | Directives | FAQ | Glossary | Sitemap

    Apache HTTP Server Version 2.1

    <-

    Apache Module mod_isapi

    Description: - ISAPI Extensions within Apache for Windows
    Status: - Base
    Module Identifier: - isapi_module
    Source File: - mod_isapi.c
    Compatibility: - Win32 only

    Summary

    + --> +mod_isapi - Apache HTTP Server + + + + + +
    +

    Modules | Directives | FAQ | Glossary | Sitemap

    +

    Apache HTTP Server Version 2.1

    +
    +
    <-
    + +
    +

    Apache Module mod_isapi

    + + + + +
    Description:ISAPI Extensions within Apache for Windows
    Status:Base
    Module Identifier:isapi_module
    Source File:mod_isapi.c
    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 @@ -21,13 +38,25 @@ directly if you are experiencing problems running their ISAPI extension. Please do not post such problems to Apache's lists or bug reporting pages.

    -
    +
    top

    Usage

    + +

    Topics

    +
    +
    top
    +
    +

    Usage

    In the server configuration file, use the AddHandler directive to @@ -55,7 +84,9 @@

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

    -
    top

    Additional Notes

    +
    top
    +
    +

    Additional Notes

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

    -
    top

    Programmer's Journal

    +
    top
    +
    +

    Programmer's Journal

    If you are programming Apache 2.0 mod_isapi modules, you must limit your calls to ServerSupportFunction @@ -186,77 +219,112 @@ TransmitFile semantics. Apache also supports preloading ISAPI .dlls for performance, neither of which were not available under Apache 1.3 mod_isapi.

    -
    top

    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, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Base
    Module: - mod_isapi
    +
    +
    top
    +

    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, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_isapi

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

    -
    top

    ISAPIAppendLogToQuery Directive

    Description: - Record HSE_APPEND_LOG_PARAMETER requests from -ISAPI extensions to the query field
    Syntax: - ISAPIAppendLogToQuery on|off
    Default: - ISAPIAppendLogToQuery on
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Base
    Module: - mod_isapi
    + +
    +
    top
    +

    ISAPIAppendLogToQuery Directive

    + + + + + + + + +
    Description:Record HSE_APPEND_LOG_PARAMETER requests from +ISAPI extensions to the query field
    Syntax:ISAPIAppendLogToQuery on|off
    Default:ISAPIAppendLogToQuery on
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_isapi

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

    -
    top

    ISAPICacheFile Directive

    Description: - ISAPI .dll files to be loaded at startup
    Syntax: - ISAPICacheFile file-path [file-path] -...
    Context: - server config, virtual host
    Status: - Base
    Module: - mod_isapi
    + +
    +
    top
    +

    ISAPICacheFile Directive

    + + + + + + +
    Description:ISAPI .dll files to be loaded at startup
    Syntax:ISAPICacheFile file-path [file-path] +...
    Context:server config, virtual host
    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. If the path name is not absolute, it will be treated relative to ServerRoot.

    -
    top

    ISAPIFakeAsync Directive

    Description: - Fake asynchronous support for ISAPI callbacks
    Syntax: - ISAPIFakeAsync on|off
    Default: - ISAPIFakeAsync off
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Base
    Module: - mod_isapi
    + +
    +
    top
    +

    ISAPIFakeAsync Directive

    + + + + + + + + +
    Description:Fake asynchronous support for ISAPI callbacks
    Syntax:ISAPIFakeAsync on|off
    Default:ISAPIFakeAsync off
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_isapi

    While set to on, asynchronous support for ISAPI callbacks is simulated.

    -
    top

    ISAPILogNotSupported Directive

    Description: - Log unsupported feature requests from ISAPI -extensions
    Syntax: - ISAPILogNotSupported on|off
    Default: - ISAPILogNotSupported off
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Base
    Module: - mod_isapi
    + +
    +
    top
    +

    ISAPILogNotSupported Directive

    + + + + + + + + +
    Description:Log unsupported feature requests from ISAPI +extensions
    Syntax:ISAPILogNotSupported on|off
    Default:ISAPILogNotSupported off
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_isapi

    Logs all requests for unsupported features from ISAPI extensions in the server error log. This may help administrators to track down problems. Once set to on and all desired ISAPI modules are functioning, it should be set back to off.

    -
    top

    ISAPIReadAheadBuffer Directive

    Description: - Size of the Read Ahead Buffer sent to ISAPI -extensions
    Syntax: - ISAPIReadAheadBuffer size
    Default: - ISAPIReadAheadBuffer 49152
    Context: - server config, virtual host, directory, .htaccess
    Override: - FileInfo
    Status: - Base
    Module: - mod_isapi
    + +
    +
    top
    +

    ISAPIReadAheadBuffer Directive

    + + + + + + + + +
    Description:Size of the Read Ahead Buffer sent to ISAPI +extensions
    Syntax:ISAPIReadAheadBuffer size
    Default:ISAPIReadAheadBuffer 49152
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    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.

    -
    \ No newline at end of file + +
    +
    + + \ No newline at end of file -- 2.40.0