1.1 Format of explanations in the definition reference

Items used in explanations

The items below are used in the explanations in the definition reference. Note that each explanation includes only the relevant items.

Description

Describes the functionality.

Schema

Describes the schemaLocation attribute of the DD file or the DOCTYPE declaration.

Syntax

Describes how to specify a file or an item.

Storage location

Describes the location where a file is to be stored.

Element hierarchy

Describes the hierarchy of elements that can be specified by using the DD file.

Files to which this parameter applies

Describes the files in which a particular parameter can be specified.

Elements to which this parameter applies

Describes the elements for which a particular parameter can be specified.

Specifiable values

Describes the types and range of values that can be specified.

Initial value

Describes the value that was predefined in the system.

Default value

Describes the value that is used by the system when no definition item or value is specified.

Dependencies of elements and attributes

Lists the elements and attributes (if any) that depend on a particular element or attribute in the DD file.

Locations where it can be written

Describes the location where a directive can be written. Such locations include the following:

• httpsd.conf

  VirtualHost block, httpsd.conf file except the Directory block.

• <VirtualHost>

  VirtualHost block of the httpsd.conf file.

• <Directory>

  Directory block, Location block, Files block of the httpsd.conf file.

• .htaccess

  Access control file specified by the AccessFileName directive

• <Location>

  Location block of the httpsd.conf file.

Additionally, a directive is referred to in the following order:

1. VirtualHost block, httpsd.conf file except the Directory block.

2. VirtualHost block of the httpsd.conf file.

3. Directory block of the httpsd.conf file.

4. Access control file.

5. Files block of the httpsd.conf file.

6. Location block of the httpsd.conf file.

By the definition (overwrite permission level) of the AllowOverride directive of a Directory block, the directive defined by the access control file can be made effective or invalid.

Overwrite permission

Describes the permission levels when overwriting by using the AllowOverride directive is enabled. The permission levels are AuthConfig, FileInfo, Indexes, Limit, Options, All, and None. For a directive for which .htaccess can be specified but no overwrite permission level is specified in the explanation of the directive, the permission level is All.

Repetition pattern

Describes whether a definition item can be repeated (specified multiple times) and, if so, how many times.

Specifiable subelements

Describes the subelements that can be specified for an element. The specifiable values, default value, dependencies, and occurrence pattern are explained for each subelement.

Specifiable attributes

Describes the attributes that can be specified for an element. The specifiable values, default value, dependencies, and occurrence pattern are explained for each attribute.

About the name and value attributes of the property element

Specify the name and value attributes of the property element in the following format:

<property name="property_name" value=property_value>

For details on the property name and value, see the description in "Specifiable properties" or the standard specifications for Java EE.

If the same property name is specified more than once, the last specified property value is set as the valid value.

Specifiable properties

Describes the properties that can be specified for an element attribute. The specifiable values, default value, dependencies, and occurrence pattern are explained for each property.

Examples

Provides output examples or examples of how to specify files or items.

Notes

Provides cautionary notes on defining files or items.