Directive term definitions for HTTP Server

This topic provides information about the directive terms used for IBM® HTTP Server for i.

Each configuration directive is described using the following attributes:

Module: directive existence
Syntax: directive_name arguments
Default: directive_name default_value
Context: context_list
Override: directive override activation
Origin: origin
Usage Considerations: important usage considerations required in the server configuration file
Example: example of directive and its arguments

Module

This attribute identifies the module the directive is associated with.

Syntax

This attribute indicates the format of the directive as it would appear in a configuration file. This syntax is directive-specific, so refer to the text of the directive's other attributes for details. Strings should be quoted. The string ("word1 word2") contains spaces. If the strings do not contain spaces they do not need to be quoted.

Default

This attribute specifies if the directive has a default value. For example, if you omit the directive from your configuration entirely, HTTP Server will behave as though you set it to a particular value. If there is no default value, this attribute says "none".

Context

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

server config: The directive is valid in the global server configuration.
virtual host: The directive is valid in <VirtualHost> containers.
directory: The directive is valid in <Directory>, <Location>, and <Files> containers, subject to the restrictions outlined in the "Fundamental directive, context, and server area concepts on HTTP Server" topic.
directory (but not location): The directive is valid in <Directory>, <Files> containers, subject to the restrictions outlined in the "Fundamental directive, context, and server area concepts on HTTP Server" topic, but is not valid in the <Location> container.
.htaccess: The directive is valid in per-directory .htaccess files. It may not be processed, however, depending upon the overrides currently active. For more information on how to use .htaccess files, see the Apache HTTP Server Project Web site.
Not in Limit: The directive is not valid in <Limit> containers, subject to the restrictions outline in the "Fundamental directive, context, and server area concepts on HTTP Server" topic.
All: The directive is valid in all contexts.

Note: The directive is only allowed within its supported context; if you try to use it elsewhere, you will receive a configuration error that will either prevent the server from handling requests, or will keep the server from starting. The valid context for a directive is 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 server configuration file and in .htaccess files, but not within any <Directory> or <VirtualHost> containers.

Override

This 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 does not permit it to appear in .htaccess files, this attribute is none.

Origin

This attribute reveals the origin of an HTTP directive. Possible values for this attribute include:

IBM: A new directive created for the IBM HTTP Server for i Web server.
Modified: An Apache server directive modified to support the IBM HTTP Server for i Web server.
Apache: An unmodified Apache server directive.

Usage Considerations

This attribute specifies if important usage considerations such as a LoadModule are required in the server configuration file prior to using the directive. If this attribute is not available, the directive does not require any usage considerations.

Example

This attribute specifies at least one example for directives that take a file path name as an argument. It will include both a root example and a QSYS.LIB example, if both apply.