From 774d3fc35cfa5d41acd1b52bb7feaec76440cc77 Mon Sep 17 00:00:00 2001 From: Joshua Slive Date: Fri, 6 Sep 2002 23:04:35 +0000 Subject: [PATCH] Convert directive-dict and module-dict to xml (and sneak in a few small content changes). git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96697 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/directive-dict.html.en | 208 ++++++------------- docs/manual/mod/directive-dict.xml | 271 +++++++++++++++++++++++++ docs/manual/mod/module-dict.html.en | 103 +++------- docs/manual/mod/module-dict.xml | 90 ++++++++ 4 files changed, 449 insertions(+), 223 deletions(-) create mode 100644 docs/manual/mod/directive-dict.xml create mode 100644 docs/manual/mod/module-dict.xml diff --git a/docs/manual/mod/directive-dict.html.en b/docs/manual/mod/directive-dict.html.en index 1f539b1b28..5021e81aee 100644 --- a/docs/manual/mod/directive-dict.html.en +++ b/docs/manual/mod/directive-dict.html.en @@ -1,72 +1,17 @@ - - - - - - - Definitions of terms used to describe Apache - directives - - - - - - -

Terms Used to Describe Apache - Directives

- -

Each Apache configuration directive is described using a - common format that looks like this:

- -
-
Syntax: - directive-name some args
- Default: - directive-name default-value
- Context: - context-list
- Override: - override
- Status: - status
- Module: - module-name
- Compatibility: - compatibility notes
- Deprecated: see - other
-
- -

Each of the directive's attributes, complete with possible - values where possible, are described in this document.

- -

Directive Terms

- - -
- -

Syntax

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

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.0

<-
Apache > HTTP Server > Documentation > Version 2.0

Terms Used to Describe Directives

+

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

+
top

Description

+ +

A brief description of the purpose of the directive.

+
top

Syntax

This indicates the format of the directive as it would appear in a configuration file. This syntax is extremely @@ -106,8 +51,7 @@ with the root directory as in /usr/local/apache/htdocs/path/to/file.html. Unless otherwise specified, a file-path which does - not begin with a slash will be treated as relative to the ServerRoot. + not begin with a slash will be treated as relative to the ServerRoot.

directory-path
@@ -150,13 +94,10 @@
The name of an environment variable defined in the Apache configuration process. Note this is not necessarily the same as an operating system - environment variable. See the environment variable documentation for + environment variable. See the environment variable documentation for more details.
-
- -

Default

+
top

Default

If the directive has a default value (i.e., if you omit it from your configuration entirely, the Apache Web server @@ -165,47 +106,46 @@ 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.

-
- -

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 of the following values:

-
server config
+
server config
This means that the directive may be used in the server - configuration files (e.g., httpd.conf, - srm.conf, and access.conf), but + configuration files (e.g., httpd.conf), but not within any - <VirtualHost> or <Directory> - containers. It is not allowed in .htaccess files + <VirtualHost> + or <Directory> + containers. It is not allowed in .htaccess files at all.
-
virtual host
+
virtual host
This context means that the directive may appear inside - <VirtualHost> containers in the server + <VirtualHost> + containers in the server configuration files.
-
directory
+
directory
A directive marked as being valid in this context may be - used inside <Directory>, - <Location>, and <Files> + used inside <Directory>, + <Location>, + and <Files> containers in the server configuration files, subject to the restrictions outlined in How Directory, Location and Files sections work.
-
.htaccess
+
.htaccess
If a directive is valid in this context, it means that it can appear inside per-directory - .htaccess files. It may not be processed, though - depending upon the overrides currently active.
+ .htaccess files. It may not be processed, though + depending upon the overrides currently active.

The directive is only allowed within the designated @@ -218,32 +158,27 @@

The valid locations for the directive are actually the result of a Boolean OR of all of the listed contexts. In other words, a directive that is marked as being valid in - "server config, .htaccess" can be used in the - httpd.conf file and in .htaccess - files, but not within any <Directory> or - <VirtualHost> containers.

-
- -

Override

+ "server config, .htaccess" can be used in the + httpd.conf file and in .htaccess + files, but not within any <Directory> or + <VirtualHost> + containers.

+
top

Override

This directive attribute indicates which configuration override must be active in order for the directive to be - processed when it appears in a .htaccess file. If - the directive's context - doesn't permit it to appear in .htaccess files, - this attribute should say "Not applicable".

- -

Overrides are activated by the AllowOverride directive, and apply + processed when it appears in a .htaccess file. If + the directive's context + doesn't permit it to appear in .htaccess files, + then no context will be listed.

+ +

Overrides are activated by the AllowOverride directive, and apply to a particular scope (such as a directory) and all descendants, unless further modified by other - AllowOverride directives at lower levels. The - documentation for that directive also lists the possible - override names available.

-
- -

Status

+ AllowOverride directives at + lower levels. The documentation for that directive also lists the + possible override names available.

+
top

Status

This indicates how tightly bound into the Apache Web server the directive is; in other words, you may need to recompile the @@ -252,22 +187,21 @@ this attribute are:

-
Core
+
Core
If a directive is listed as having "Core" status, that means it is part of the innermost portions of the Apache Web server, and is always available.
-
MPM
+
MPM
A directive labeled as having "MPM" status is provided by a Multi-Processing Module. This type of directive will be available if and only if you are - using one of the MPMs listed on the Module line of the directive + using one of the MPMs listed on the Module line of the directive definition.
-
Base
+
Base
A directive labeled as having "Base" status is supported by one of the standard Apache modules which is compiled into @@ -275,7 +209,7 @@ unless you've taken steps to remove the module from your configuration.
-
Extension
+
Extension
A directive with "Extension" status is provided by one of the modules included with the Apache server kit, but the @@ -283,7 +217,7 @@ directive and its functionality, you will need to change the server build configuration files and re-compile Apache.
-
Experimental
+
Experimental
"Experimental" status indicates that the directive is available as part of the Apache kit, but you're on your own @@ -294,34 +228,14 @@ directive and its module to see if it remarks on the availability.
-
- -

Module

+
top

Module

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

-
- -

Compatibility

+
top

Compatibility

If the directive wasn't part of the original Apache version - 1 distribution, the version in which it was introduced should - be listed here. If the directive has the same name as one from - the NCSA HTTPd server, any inconsistencies in behavior between - the two should also be mentioned. Otherwise, this attribute - should say "No compatibility issues."

-
- -

Deprecated

- -

If this directive is eliminated since the Apache version 1 - distribution, the directive or option that replaces the - behavior should be cited here. In general, directives, - features, and options are only deprecated to minimize debugging - of conflicting features, or if the feature can only continue to - be supported in an alternate manner.

- - - - + 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 diff --git a/docs/manual/mod/directive-dict.xml b/docs/manual/mod/directive-dict.xml new file mode 100644 index 0000000000..748b83287e --- /dev/null +++ b/docs/manual/mod/directive-dict.xml @@ -0,0 +1,271 @@ + + + + + + + + Terms Used to Describe Directives + + +

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

+ +Configuration files + +
Description + +

A brief description of the purpose of the directive.

+
+ +
Syntax + +

This indicates the format of the directive as it would + appear in a configuration file. This syntax is extremely + directive-specific, and is described in detail in the + directive's definition. Generally, the directive name is + followed by a series of one or more space-separated arguments. + If an argument contains a space, the argument must be enclosed + in double quotes. Optional arguments are enclosed in square + brackets. Where an argument can take on more than one possible + value, the possible values are separated by vertical bars "|". + Literal text is presented in the default font, while + argument-types for which substitution is necessary are + emphasized. Directives which can take a variable + number of arguments will end in "..." indicating that the last + argument is repeated.

+ +

Directives use a great number of different argument types. A + few common ones are defined below.

+ +
+
URL
+ +
A complete Uniform Resource Locator including a scheme, + hostname, and optional pathname as in + http://www.example.com/path/to/file.html
+ +
URL-path
+ +
The part of a url which follows the scheme and + hostname as in /path/to/file.html. The + url-path represents a web-view of a resource, as + opposed to a file-system view.
+ +
file-path
+ +
The path to a file in the local file-system beginning + with the root directory as in + /usr/local/apache/htdocs/path/to/file.html. + Unless otherwise specified, a file-path which does + not begin with a slash will be treated as relative to the ServerRoot.
+ +
directory-path
+ +
The path to a directory in the local file-system + beginning with the root directory as in + /usr/local/apache/htdocs/path/to/.
+ +
filename
+ +
The name of a file with no accompanying path information + as in file.html.
+ +
regex
+ +
A regular expression, which is a way of describing a + pattern to match in text. The directive definition will + specify what the regex is matching against.
+ +
extension
+ +
In general, this is the part of the filename + which follows the last dot. However, Apache recognizes + multiple filename extensions, so if a filename + contains more than one dot, each dot-separated part of the + filename following the first dot is an extension. + For example, the filename file.html.en + contains two extensions: .html and + .en. For Apache directives, you may specify + extensions with or without the leading dot. In + addition, extensions are not case sensitive.
+ +
MIME-type
+ +
A method of describing the format of a file which + consists of a major format type and a minor format type, + separated by a slash as in text/html.
+ +
env-variable
+ +
The name of an environment + variable defined in the Apache configuration process. + Note this is not necessarily the same as an operating system + environment variable. See the environment variable documentation for + more details.
+
+
+ +
Default + +

If the directive has a default value (i.e., if you + omit it from your configuration entirely, the Apache Web server + will behave as though you set it to a particular value), it is + described here. If there is no default value, this section + 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.

+
+ +
Context + +

This indicates where in the server's configuration files the + directive is legal. It's a comma-separated list of one or more + of the following values:

+ +
+
server config
+ +
This means that the directive may be used in the server + configuration files (e.g., httpd.conf), but + not within any + VirtualHost + or Directory + containers. It is not allowed in .htaccess files + at all.
+ +
virtual host
+ +
This context means that the directive may appear inside + VirtualHost + containers in the server + configuration files.
+ +
directory
+ +
A directive marked as being valid in this context may be + used inside Directory, + Location, + and Files + containers in the server configuration files, subject to the + restrictions outlined in How + Directory, Location and Files sections work.
+ +
.htaccess
+ +
If a directive is valid in this context, it means that it + can appear inside per-directory + .htaccess files. It may not be processed, though + depending upon the overrides currently active.
+
+ +

The directive is only allowed within the designated + context; if you try to use it elsewhere, you'll get a + configuration error that will either prevent the server from + handling requests in that context correctly, or will keep the + server from operating at all -- i.e., the server won't + even start.

+ +

The valid locations for the directive are actually the + result of a Boolean OR of all of the listed contexts. In other + words, a directive that is marked as being valid in + "server config, .htaccess" can be used in the + httpd.conf file and in .htaccess + files, but not within any Directory or + VirtualHost + containers.

+
+ +
Override + +

This directive attribute indicates which configuration + override must be active in order for the directive to be + processed when it appears in a .htaccess file. If + the directive's context + doesn't permit it to appear in .htaccess files, + then no context will be listed.

+ +

Overrides are activated by the AllowOverride directive, and apply + to a particular scope (such as a directory) and all + descendants, unless further modified by other + AllowOverride directives at + lower levels. The documentation for that directive also lists the + possible override names available.

+
+ +
Status + +

This indicates how tightly bound into the Apache Web server + the directive is; in other words, you may need to recompile the + server with an enhanced set of modules in order to gain access + to the directive and its functionality. Possible values for + this attribute are:

+ +
+
Core
+ +
If a directive is listed as having "Core" status, that + means it is part of the innermost portions of the Apache Web + server, and is always available.
+ +
MPM
+ +
A directive labeled as having "MPM" status is provided by + a Multi-Processing Module. This + type of directive will be available if and only if you are + using one of the MPMs listed on the Module line of the directive + definition.
+ +
Base
+ +
A directive labeled as having "Base" status is supported + by one of the standard Apache modules which is compiled into + the server by default, and is therefore normally available + unless you've taken steps to remove the module from your + configuration.
+ +
Extension
+ +
A directive with "Extension" status is provided by one of + the modules included with the Apache server kit, but the + module isn't normally compiled into the server. To enable the + directive and its functionality, you will need to change the + server build configuration files and re-compile Apache.
+ +
Experimental
+ +
"Experimental" status indicates that the directive is + available as part of the Apache kit, but you're on your own + if you try to use it. The directive is being documented for + completeness, and is not necessarily supported. The module + which provides the directive may or may not be compiled in by + default; check the top of the page which describes the + directive and its module to see if it remarks on the + availability.
+
+
+ +
Module + +

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

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

+
+ + + diff --git a/docs/manual/mod/module-dict.html.en b/docs/manual/mod/module-dict.html.en index 5e7cadb821..1ccfe28c2a 100644 --- a/docs/manual/mod/module-dict.html.en +++ b/docs/manual/mod/module-dict.html.en @@ -1,53 +1,16 @@ - - - - - - - Definitions of terms used to describe Apache - modules - - - - - - -

Terms Used to Describe Apache Modules

- -

Each Apache module is described using a common format that - looks like this:

- -
-
Status: - status
- Source - File: source-file
- Module - Identifier: module-identifier
- Compatibility: - compatibility notes
-
- -

Each of the attributes, complete with values where possible, - are described in this document.

- -

Module Terms

- - -
- -

Status

+ + +Terms Used to Describe Modules - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.0

<-
Apache > HTTP Server > Documentation > Version 2.0

Terms Used to Describe Modules

+

This document describes the terms that are used to describe + each Apache module.

+
top

Description

+ +

A brief description of the purpose of the module.

+
top

Status

This indicates how tightly bound into the Apache Web server the module is; in other words, you may need to recompile the @@ -55,69 +18,57 @@ functionality. Possible values for this attribute are:

-
MPM
+
MPM
-
A module with status "MPM" is a Multi-Processing Module. Unlike the +
A module with status "MPM" is a Multi-Processing Module. Unlike the other types of modules, Apache must have one and only one MPM in use at any time. This type of module is responsible for basic request handling and dispatching.
-
Base
+
Base
A module labeled as having "Base" status is compiled and loaded into the server by default, and is therefore normally available unless you have taken steps to remove the module from your configuration.
-
Extension
+
Extension
A module with "Extension" status is not normally compiled and loaded into the server. To enable the module and its functionality, you may need to change the server build configuration files and re-compile Apache.
-
Experimental
+
Experimental
"Experimental" status indicates that the module is available as part of the Apache kit, but you are on your own if you try to use it. The module is being documented for completeness, and is not necessarily supported.
-
External
+
External
Modules which are not included with the base Apache distribution ("third-party modules") may use the "External" status. We are not responsible for, nor do we support such modules.
-
- -

Source File

+
top

Source File

This quite simply lists the name of the source file which contains the code for the module. This is also the name used by - the <IfModule> + the <IfModule> directive.

-
- -

Module - Identifier

+
top

Module Identifier

This is a string which identifies the module for use in the - LoadModule directive when + LoadModule directive when dynamically loading modules. In particular, it is the name of the external variable of type module in the source file.

-
- -

Compatibility

+
top

Compatibility

If the module was not part of the original Apache version 2 distribution, the version in which it was introduced should be - listed here.

- - - - + listed here. In addition, if the module is limited to + particular platforms, the details will be listed here.

+
\ No newline at end of file diff --git a/docs/manual/mod/module-dict.xml b/docs/manual/mod/module-dict.xml new file mode 100644 index 0000000000..e35a473472 --- /dev/null +++ b/docs/manual/mod/module-dict.xml @@ -0,0 +1,90 @@ + + + + + + + + Terms Used to Describe Modules + + +

This document describes the terms that are used to describe + each Apache module.

+ + +
Description + +

A brief description of the purpose of the module.

+
+ +
Status + +

This indicates how tightly bound into the Apache Web server + the module is; in other words, you may need to recompile the + server in order to gain access to the module and its + functionality. Possible values for this attribute are:

+ +
+
MPM
+ +
A module with status "MPM" is a Multi-Processing Module. Unlike the + other types of modules, Apache must have one and only one MPM + in use at any time. This type of module is responsible for + basic request handling and dispatching.
+ +
Base
+ +
A module labeled as having "Base" status is compiled and + loaded into the server by default, and is therefore normally + available unless you have taken steps to remove the module + from your configuration.
+ +
Extension
+ +
A module with "Extension" status is not normally compiled + and loaded into the server. To enable the module and its + functionality, you may need to change the server build + configuration files and re-compile Apache.
+ +
Experimental
+ +
"Experimental" status indicates that the module is + available as part of the Apache kit, but you are on your own + if you try to use it. The module is being documented for + completeness, and is not necessarily supported.
+ +
External
+ +
Modules which are not included with the base Apache + distribution ("third-party modules") may use the "External" + status. We are not responsible for, nor do we support such + modules.
+
+
+ +
Source File + +

This quite simply lists the name of the source file which + contains the code for the module. This is also the name used by + the IfModule + directive.

+
+ +
Module Identifier + +

This is a string which identifies the module for use in the + LoadModule directive when + dynamically loading modules. In particular, it is the name of + the external variable of type module in the source file.

+
+ +
Compatibility + +

If the module was not part of the original Apache version 2 + distribution, the version in which it was introduced should be + listed here. In addition, if the module is limited to + particular platforms, the details will be listed here.

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