6.2.4 Directives that start with E, F, G, H, and I

(a) Contents

Specify the ErrorDocument directive to customize the error message displayed on the Web browser when an error occurs.

Text: Specifies the character string enclosed in ".

local-URL: Specifies the contents of the local site by adding a / at the beginning.

full-URL: Specifies the contents of another site by using a URL that starts with http:// or https://.

The error status numbers that can be specified in this directive and the possibility to specify text, the local URL, and the full URL is described below:

When you specify this directive, consider the following points:

• When performing multiple specifications of this directive, you cannot specify different specification for the same error number.

• You cannot customize the messages for error status set in the CGI programs.

• You cannot customize the message if error occurs in the specification destinations of the local URL and the full URL.

• Error occurs when content negotiation takes place in the specification destination of the local URL and you cannot customize the message.

• You may not be able to customize the message (depending on the mounting method of the module) even with the error status set in the module that is dynamically connected by the LoadModule directive.

• When specifying a full URL, the status code 302 Found and a response with the new path set in the Location header are returned. Normally, a Web browser that receives status code 302 automatically redirects the request to the address specified in the Location header.

• When specifying a full URL, you can also specify an IPv6 address or the host name corresponding to an IPv6 address. When specifying the IPv6 address, enclose the IPv6 address in square brackets ([ ]).

• To use the reverse proxy function, you must specify ProxyErrorOverride On.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

FileInfo level

(d) Specification example

ErrorDocument 500 "Server Error."
ErrorDocument 404 /missing.html
ErrorDocument 403 http://some.other_server.com/subscription_info.html
ErrorDocument 404 http://[2001::123:4567:89ab:cdef]/missing.html

(a) Contents

The ErrorLog directive specifies the name of the file in which error log is output. You can select the log contents to be output by the LogLevel directive.

In the file name you can specify absolute path, or relative path from the specified value of the ServerRoot directive.

file-name: Specifies the name of the file that stores the error log. You can specify the file name using the relative path from the specified value of the ServerRoot directive.

pipe: Specifies the program that receives error log information from the standard input in the "|Program name" format. For the notes on Windows version, see CustomLog directive.

(b) Location where you can code

httpsd.conf, and <VirtualHost>

(c) Specification example

ErrorLog logs/error.log

(a) Contents

The ExtendedStatus directive specifies whether to display the extended status information of each request in the format for displaying the status by the server-status handler.

On: Displays extended status information. This information is displayed even if the client IP address is an IPv6 address. A maximum of 31 bytes can be displayed.

Off: Does not display the extended status information.

(b) Location where you can code

httpsd.conf

(a) Contents

The ExpiresActive directive specifies whether to add the Expires header and Cache-Control header to the response.

On: Adds the Expires header and Cache-Control header.

Off: Does not add the Expires header and Cache-Control header.

(b) Note

• The mod_expires module must be embedded to use the expiry date settings functionality. For details on the expiry date settings functionality, see 4.11 Functionality to set expiry date.

• In the case the ExpiresDefault directive or the ExpiresByType directive is not specified, the Expires header and Cache-Control header are not added to the response even if On is specified in the ExpiresActive directive.

(c) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(d) Overwrite permission

Indexes level

(a) Contents

The ExpiresByType directive specifies the expiry date for the specified MIME type document when you add Expires header and Cache-Control header to the response. This directive is enabled when the ExpiresActive directive is set to On. The default expiry date set in the ExpiresDefault directive is overwritten by these settings for each MIME type.

Specify the standard time by A or M, and specify the time from the standard time to the expiry date in seconds. Do not enter a space between A or M and the time.

A: The time when client accesses is interpreted as the standard time.

M: The time when the file was last modified is interpreted as the standard time.

(b) Note

• The mod_expires module must be embedded to use the expiry date settings functionality. For details on the expiry date settings functionality, see 4.11 Functionality to set expiry date.

• Set the expiry date such that it is not after January 19, 2038, 03:14:07 of the Greenwich Mean Time (GMT).

(c) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(d) Overwrite permission

Indexes level

(e) Specification example

ExpiresByType text/html A604800

(a) Contents

The ExpiresDefault directive specifies the default expiry date when you add the Expires header and Cache-Control header to the response. This directive is enabled when the ExpiresActive directive is set to On. The ExpiresByType directive overwrites these settings for each MIME type.

Specify the standard time by A or M, and specify the time from the standard time to the expiry date in seconds. Do not enter a blank between A or M and the time.

A: The time when the client accesses is interpreted as the standard time.

M: The time when the file was last modified is interpreted as the standard time.

(b) Note

• The mod_expires module must be embedded to use the expiry date settings functionality. For details on the expiry date settings functionality, see 4.11 Functionality to set expiry date.

• Set the expiry date such that it is not after January 19, 2038, 03:14: 07 of the Greenwich Mean Time (GMT).

(c) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(d) Overwrite permission

Indexes level

(e) Specification example

ExpiresDefault A604800

(a) Contents

The FancyIndexing directive specifies whether to perform the format display (fancy index) when you display the directory index.

On: Performs the format display.

Off: Does not perform the format display.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

Indexes level

(d) Specification example

FancyIndexing On

Use the format display functionality.

(a) Contents

The FileETag directive specifies the file attribute value used for creating Etag response header field. When this directive is not specified, the unique ID assigned to the file, last updated time, and bytes count are set in the Etag response header field.

When you do not specify + - in the option, the attribute value specified in the option is used.

When you specify + - in the option, you can change the attribute value set by the FileETag directive.

+: The attribute value specified in the option is added to the set attribute value.

-: The attribute value specified in the option is deleted from the set attribute value.

The following table lists the options that you can specify:

(b) Notes

• When you enable the Inode option of the FileETag directive, different IDs may be included in the Etag header every time when same contents are requested in the Web server environment where load balancing is performed. Consequently, it may be inconvenient for caching in the browser and the proxy since Etag header is different although the contents are same. You can avoid such a situation by disabling the Inode option with the FileETag directive.

• When performing multiple specifications of this directive without using + - options only the directive specified in the end is enabled.

• When only the attribute value with the - option is specified, the operation is same as the case where the All option is specified.

• For the All option and the None option, you cannot specify + -.

• If the -Inode, -Mtime, and -Size options are specified together, the status is the same as when this directive is not specified. The inode number, the latest update time, and the number of bytes in the file are set in the ETag response header field.

(c) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(d) Overwrite permission

FileInfo level

(e) Specification example

(Example 1)

FileETag Inode Mtime Size
FileETag -Inode

In this specification, the last updated time of the file and the byte count are used as the attribute value.

(Example 2)

FileETag Inode Mtime
FileETag Size

In this specification, byte count of the file is used as the attribute value.

(Example 3)

FileETag All
FileETag -Inode -Mtime -Size

In this specification, unique ID of the file, last updated time, and byte count are used as the attribute value.

(a) Contents

Define the ForceType directive in the <Directory> block or in the access control file. This directive specifies the MIME types to be used for all the contents under the specific directory. If you specify none, the previous ForceType directive specifications are disabled.

(b) Location where you can code

<Directory>, .htaccess

(c) Overwrite permission

FileInfo level

(a) Contents

This directive specifies the group name used when server processes are running.

(b) Location where you can code

httpsd.conf

(c) Specification example

Group nogroup                     Define the group name nogroup

(a) Contents

Specify the 'Header' directive for customizing the response header when the Web server responds with the status code 200. When using this directive as a reverse proxy, the response header is customized regardless of the status code value returned by the backend Web server.

set: Sets the header. If the header is found, rewrite it with the specified header value.

append: Adds the header value to the existing header. A comma delimits the existing header values. Sets the header if it does not exist.

add: Sets a header in another line even if the header exists. Use this directive when setting the same header in multiple lines.

unset: If the specified header exists, deletes it.

env=environment-variable: When the specified environment variable is set, executes the contents specified in the Header directive.

env=!environment-variable: When the specified environment variable is not set, executes the contents specified in the Header directive.

If the header value contains spaces, then you must enclose the value in "(double quotation mark). For the header value you can specify character strings containing only the characters, character string including the format identifiers, or the character string containing both the characters and the format identifiers. The format identifiers are as follows:

(b) Note

The mod_headers module must be embedded to use the header customization functionality. For details on the header customization functionality, see 4.10 Header customization functionality.

(c) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(d) Overwrite permission

FileInfo level

(e) Specification example

Header set Cache-Control no-cache

(a) Contents

The HeaderName directive specifies the file name (without path information) of the file that describes the comments added to the header when displaying the directory index. You can describe the file name in the HTML or the plain text format. However, MIME type must be correctly defined in the file specified with the AddType directive or the TypesConfig directive. When you create comments in the plain text, the <PRE> tag is added to the HTML of the directory index display.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

Indexes level

(d) Specification example

HeaderName HEADER.html

Contents of HEADER.html under each directory are added to the header.

(a) Contents

The HostnameLookups directive specifies whether to reverse the lookup of the host name to convert the IP address of the REMOTE_HOST environment variable of CGI and the client IP address to be output to the log file, into the host name. If you use reverse, response is delayed.

On: Converts the IP address into the host name.

Off: Does not convert the IP address into the host name.

double: Converts the IP address into the host name. After conversion, reconvert and confirm that the IP address is correct.

This directive supports IPv6 addresses.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>

(c) Specification example

HostnameLookups Off

Do not convert the IP address in the host name.

(a) Contents

This directive sets the character set for messages (hereafter called the error document) that are displayed on the Web browser when an error occurs. In the error document, the character set is set as a value of charset= by the META tags. For the error documents customized with the ErrorDocument directive, character set is not set as per the META tags in this directive.

On: Sets the character set ISO-8859-1.

Off: Does not set the character set.

character-set: Sets the specified character set.

(b) Location where you can code

httpsd.conf

(c) Specification example

HWSErrorDocumentMETACharset ISO-2022-JP

(a) Contents

On the back-end server, change the the message text to be output to the error log from "[client client-address]" to "[X-Forwarded-For header-value]".

When the back-end server receives a request through a load balancer or a proxy server, "[client client-address]" to be output to the error log could becomes the IP address of the load balancer or proxy server, instead of the actual client IP address from which the request was sent. However, as because some load balancers and proxy servers can add the original client IP address to the X-Forwarded-For header, change the header settings to the client IP address by changing the output content to the value of the X-Forwarded-For header.

X-Forwarded-For: Change "[client client-address]" to be output to error log to "[X-Forwarded-For header-value]".

(b) Notes

Some types of messages cannot be changed. For example, when an error occurs before the server receives the X-Forwarded-For header.

(c) Location where you can code

httpsd.conf

(a) Contents

The HWSGracefulStopLog directive specifies whether the request information that is forcefully terminated after the waiting time of forced termination elapses, is to be output in the error log file when you execute planned termination.

On: Outputs the forcefully terminated request information to the error log file.

Off: Does not output the forcefully terminated request information to the error log file.

(b) Location where you can code

httpsd.conf

(c) Specification example

HWSGracefulStopLog On

(a) Contents

The HWSGracefulStopTimeout directive specifies the forced termination waiting time until the request being executed is stopped at once during the planned termination. The upper limit of the forced termination waiting time is not set if 0 is specified.

(b) Location where you can code

httpsd.conf

(c) Specification example

HWSGracefulStopTimeout 600

(a) Contents

The HWSImapMenuCharset directive specifies the character set displayed in menus in the following cases:

• When map is specified for the value of the image map file

• When the mouse is used to point to coordinates (0,0) on an image map

• When an image map file is requested without any coordinates specified

The character set is set as the value of charset= in the Content-Type header of the response.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

Indexes level

(d) Specification example

HWSImapMenuCharset SHIFT_JIS

(a) Contents

The HWSKeepStartServers directive specifies whether to maintain only the number of running server processes that are specified in the StartServers directive.

On: Only the number of running server processes that are specified in the StartServers directive are maintained. If the number of server processes is less than the value specified in the StartServers directive, new processes are generated.

prefork MPM

This functionality is valid when the value specified in each directive regarding the number of processes, is related as follows:

MinSpareServers < StartServers ≤ MaxClients

and

MinSpareServers < MaxSpareServers ≤ MaxClients

When the setting value of the StartServers directive is less than the setting value of the MinSpareServers directive, the number of server processes is maintained by the value of the MinSpareServers directive.

worker MPM

This functionality is valid when the values specified in the directives regarding the number of processes and the number of threads are related as follows:

MinSpareThreads < StartServers × ThreadsPerChild ≤ MaxClients

and

MinSpareThreads < MaxSpareThreads ≤ MaxClients

If the value of the StartServers directive × the value of the ThreadsPerChild directive is less than the value of the MinSpareThreads directive, the number of server processes is maintained according to the value of the MinSpareThreads directive.

Off: The running server processes, equivalent to the number specified in the StartServers directive are not maintained.

(b) Location where you can code

httpsd.conf

(a) Contents

The HWSLogSSLVervose directive specifies whether to output detailed information for the info-level and error-level failures among the errors that are output to the log during the SSL handshake process between clients and servers. When SSL is enabled, we recommend that you set this directive to On.

On: Displays detailed information

Off: Does not display detailed information

(b) Location where you can code

httpsd.conf

(a) Contents

The HWSLogTimeVerbose directive specifies whether to display error log^# times, request log times, access times in the access log, the time taken for request processing (%), and request process start times (%t), accurate to the millisecond. Note that even if On is specified in this directive, the time might not be displayed accurate to the millisecond in messages that are output while the server is starting or restarting.

#: This directive targets the error log specified by using the ErrorLog directive. The CGI script error log specified by using the ScriptLog directive is not targeted.

On: Displays the hours and time in Milliseconds.

Off: Displays the hours and time accurate to the second

(b) Location where you can code

httpsd.conf

(a) Contents

The HWSMaxQueueSize directive specifies the maximum number of waiting requests for requests from clients. There is no limit on the number of requests when 0 is specified. The requests from the client that exceed the request queue size specified in this directive are disconnected in the server side.

(b) Location where you can code

httpsd.conf

(a) Contents

The HWSNotModifiedResponseHeaders directive specifies the response header added when the status code 304 Not Modified is sent to the client.

Note that the headers below are added to responses even if they are not specified in this directive. However, the headers are not always added, but are added only when settings for the headers have been performed, such as on external modules or servers.

• Date

• Server

• Connection

• Keep-Alive

• ETag

• Content-Location

• Expires

• Cache-Control

• Vary

• Warning

• WWW-Authenticate

• Proxy-Authenticate

(b) Location where you can code

httpsd.conf

(c) Specification example

HWSNotModifiedResponseHeaders Set-Cookie Set-Cookie2

(a) Contents

The HWSPrfId directive specifies the character string specified in the PRF ID when the PRF daemon starts.

The specification of this directive is invalid if the redirector module is embedded by using the LoadModule directive.

(b) Location where you can code

httpsd.conf

(a) Contents

When using a reverse proxy, the HWSProxyPassReverseCookie directive enables the reverse proxy to convert a Set-Cookie header received from a backend server. This process is required to send the cookie as the return for a request sent to the backend server via the reverse proxy after the Web browser receives the Set-Cookie header.

path-name: Specify the same name as for the ProxyPass directive.

(b) Note

The mod_proxy and mod_proxy_http modules must be embedded to use a reverse proxy. For details on reverse proxies, see the 4.7 Setting the reverse proxy.

(c) Location where you can code

httpsd.conf, <VirtualHost>

(a) Contents

The HWSRequestLog directive specifies the name of the file to which a request log is output. The request log is a generic name for module trace information, request trace information, I/O filter trace information, and proxy trace information. The type of the output request log can be selected by using the HWSRequestLogType directive.

file-name: Specifies the name of the file to which the request log is output. For the file name, you can specify either an absolute path, or a relative path from the specification value of the ServerRoot directive.

pipe: Specifies the program that receives log information from standard input in the format | program-name. For notes on the Windows version, see the CustomLog directive.

(b) Notes

• If you omit this directive, the module trace information is output to the file specified by using the ErrorLog directive. Specify the collection level of the module trace information by using the LogLevel directive. For details on module trace information, see 4.2.6 Collecting the module trace.

• The file specified in the ErrorLog directive cannot be specified as the output destination for request trace information, I/O filter trace information, or proxy trace information.

(c) Location where you can code

httpsd.conf

(a) Contents

The HWSRequestLogType directive specifies the type of trace information to be output to the request log that is set by using the HWSRequestLog directive. The following table shows the types of trace information.

(b) Note

When none is included in the specified trace types, no request logs are collected.

(c) Location where you can code

httpsd.conf

(a) Contents

The HWSSetEnvIfIPV6 directive defines environment variables based on the IPv6 address of the client or the server. Set the specified environment variable when the request value meets the conditions of the IPv6 address. By default, the value is set to 1. When an exclamation mark (!) is added before an environment variable, that environment variable setting is canceled.

The following request values can be specified.

Specify the IPv6 address without enclosing it in square brackets ([ ]). Note that the prefix length can be specified in decimal format after the IPv6 address. The prefix length is specified in the IPv6-address/prefix-length format.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

FileInfo level

(d) Specification example

HWSSetEnvIfIPv6 Remote_Addr 2001:0:0:1230::/64 IPV6_CLIENT

The IPv6 address of the client starts with 2001:0:0:1230, specify the IPV6_CLIENT environment variable.

(a) Contents

The HWSSuppressModuleTrace directive specifies the file name of a module for which trace information is to be suppressed and the type of functions to be suppressed.

all: Suppresses all module trace information output by the specified module.

hook: Of the trace information output by the specified module, suppresses trace information other than that for the handler function. For details on types of functions, see Table 4-4 of 4.2.6 Collecting the module trace.

handler: Of the trace information output by the specified module, suppresses only the trace information for the handler function. For details on types of functions, see Table 4-4 of 4.2.6 Collecting the module trace.

The module file name to be output to either the error log or request log is specified for module-file-name. To suppress the module trace information shown in the following example, mod_example.c is specified for module-file-name:

(Example)

[Mon Dec 18 14:57:14 2006] [info] hws : module --> (mod_example.c[12])(1896)
[Mon Dec 18 14:57:14 2006] [info] hws : module <-- (mod_example.c[12])(1896)(-1)

The following table shows the names of the standard external modules provided by HTTP Server and the corresponding module file names:

When using external modules other than the standard modules provided by HTTP Server, module trace information might be output. In addition, if debug is set by using the LogLevel directive, or if module-debug is set by using the HWSRequestLogType directive, trace information for internal modules is output.

Note that you can specify this directive multiple times. If you specify the directives by using the same module name, only the last directive specified is valid.

(b) Note

Module trace information cannot be suppressed during execution of a CGI program.

(c) Location where you can code

httpsd.conf

(d) Specification example

(Example 1)

HWSSuppressModuleTrace mod_proxy.c all

In this specification, module trace information for all functions in the proxy module is suppressed.

(Example 2)

HWSSuppressModuleTrace mod_proxy.c hook

In this specification, module trace information for all functions other than the handler function in the proxy module is suppressed.

(a) Contents

The HWSTraceIdFile directive specifies the file name that stores the shared memory ID for trace collection. In the file name you can specify the absolute path, or the relative path from the specified value of the ServerRoot directive.

Multiple Web servers cannot share this file. In the case of starting multiple Web servers by specifying the same ServerRoot directives, you need to specify different file names in this directive.

(b) Location where you can code

httpsd.conf

(a) Contents

The HWSTraceLogFile directive specifies the file name that outputs the trace collected in the shared memory when the server process ends abnormally. In the file name you can specify the absolute path, or the relative path from the specified value of the ServerRoot directive.

The trace is output by wrapping around to multiple files.

For the UNIX version, up to 5 files are output. Output file names are specified-file-name.nn, where nn is a number from 01 to 05. When HTTP Server starts, specified-file-name.01 is the current output file name. When trace information is output to the current output file with file name specified-file-name.nn, the next current file name becomes specified-file-name.nn + 1. If the nn portion of specified-file-name.nn is 05, the next current file name becomes specified-file-name.01.

For the Windows version, up to 2 files are output. Output file names are specified-file-name.01 or specified-file-name.02. When HTTP Server starts, specified-file-name.01 is the current output file name. If trace information is output to the current output file with file name specified-file-name.01, the next current file name becomes specified-file-name.02. If trace information is output to the current output file whose name is specified-file-name.02, the next current file name becomes specified-file-name.01.

(b) Location where you can code

httpsd.conf

(a) Contents

The HWSWebSocketLog directive specifies the name of the file to which log information for WebSocket communication is output.

file-name: Specify the name of the file to which log information for WebSocket communication is output. For the file name, you can specify an absolute path or a relative path from the value specified in the ServerRoot directive.

pipe: Specify the program that receives log information for WebSocket communication information from the standard input, by using the |program-name format.

(b) Note

To use the WebSocket proxy functionality, you need to embed the mod_proxy and mod_proxy_wstunnel modules.

In UNIX version

LoadModule proxy_module libexec/mod_proxy.so

LoadModule proxy_wstunnel_module libexec/mod_proxy_wstunnel.so

In Windows version

LoadModule proxy_module modules/mod_proxy.so

LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so

(c) Location where you can code

httpsd.conf

(a) Contents

The IdentityCheck directive specifies whether to use the identd daemon of the client host to check the identity of the client. For details on ident, see RFC 1413.

However, when an IPv6 address is assigned to the client host, the client is not checked by using the identd daemon even if On is specified. If %1 is specified as the log format, unknown is output to REMOTE_IDENT, which is a CGI environment valuable.

On: Checks the client by using the identd daemon

Off: Does not check the client by using the identd daemon

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>

(a) Contents

This directive specifies the default base line of the image map file.

map: Location of map file

referrer: Location of document (Location of HTML file that displays the image map)

URL: Specified URL

For the URL, you can also specify an IPv6 address or the host name corresponding to an IPv6 address.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

Indexes level

(a) Contents

This directive specifies the default values for the default line of the image map file.

error: Displays the standard error message (The web server responds with the status code 500 Server Error).

nocontent: Ignores the request (The web server responds with the status code 204 No Content).

map: Displays the URL of map file in the menu.

referer: The web server responds with the status code 302 Found.

URL: Displays the contents of the specified URL.

For the URL, you can also specify an IPv6 address or the host name corresponding to an IPv6 address.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

Indexes level

(a) Contents

The ImapMenu specifies the menu display when 'map' is provided in the specification value of the image map file or when the coordinates (0,0) on the image map are pointed with the mouse. The operation when an image map file is requested without any specified coordinates is also as per these settings.

none: Does not generate the menu. The operations are as per the default line specifications of the map file.

formatted: Displays the header and link list. The comments in the map file are ignored.

semiformatted: Displays the link list. Also, displays the comments in the map file.

unformatted: You can set the menu format independently by describing HTML in the map file.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

Indexes level

(a) Contents

The 'Include' directive makes the file specified in the file name available as the configuration file.

In the file name, you can specify the absolute path, or the relative path from the specified value of the ServerRoot directive. If there are multiple specifications of this directive, the merged contents are used. When the file contains the same directives, the directive specified later would overwrite the earlier ones.

(b) Location where you can code

httpsd.conf

(a) Contents

The IndexIgnore directive specifies the file name that is not displayed on the Web browser when you display the directory index. You can specify even by the regular expressions.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

Indexes level

(d) Specification example

IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t

(a) Contents

The IndexOptions directive sets the format display functionality options of the directory index. An option is enabled when + is specified before the option, or when +- is omitted. By default, all the options are disabled. The following table describes the list of options that you can specify:

(b) Notes

• When performing multiple specifications of this directory, you cannot specify different character strings for the same file name.

• When =value is specified by the IconHeight, IconWidth, and NameWidth, you cannot specify the - option

• The set options are inherited from the upper directory to the lower directory in the order of httpsd.conf, <VirtualHost>, <Directory>, and .htaccess. Merge the inherited options eventually and determine the format for index display.

• The options are disabled even when you add +- in httpsd.conf and specify the options. However, the options are inherited to the lower directory in the order of httpsd.conf, <VirtualHost>, <Directory>, and .htaccess. The merging process enables the specifications of the inherited options. When the options for which the reference order is in the lower locations are specified or if any of the following directives are specified, the merging process is executed:

  • AddAlt

  • AddAltByEncoding

  • AddAltByType

  • AddDescription

  • AddIcon

  • AddIconByEncoding

  • AddIconByType

  • DefaultIcon

  • HeaderName

  • ReadmeName

  (Example)

  When IndexOptions +FancyIndexing +IconsAreLinks are specified in the httpsd.conf file, and if the index related directives are not specified in the lower specification location, the FancyIndexing and IconsAreLinks are disabled.

  When the IndexOptions +FancyIndexing +IconsAreLinks are specified in the httpsd.conf, and AddDescription "text file" *.txt is specified in the access control file of the lower directory, FancyIndexing and IconsAreLinks are enabled.

• If you specify Charset, IconHeight, IconWidth, and NameWidth directives without +- specifications, the options with +- specification (excluding Charset, IIconHeight, IconWidth, NameWidth ) that are specified before specifying these options in the specified location are disabled.

  (Example)

  IndexOptions FancyIndexing -IconsAreLinks IconHeight IconWidth

  In this case, the FancyIndexing, IconHeight, and the IconWidth directives are enabled. The - specification of IconsAreLinks is not inherited.

• In the merging process where options for the same directory index are specified between the specified locations, if you specify options without +- at the rear location in the reference order, the options specified earlier are disabled. However, IconHeight, IconWidth, and NameWidth are not disabled.

  (Example 1)

  • Specification of the httpsd.conf file

    IndexOptions + FancyIndexing + IconsAreLinks

  • Specification of the access control file

    IndexOptions FancyIndexing SuppressLastModified

    When you specify these options, IconsAreLinks are disabled. FancyIndexing and SuppressLastModified are enabled.

  (Example 2)

  • Specification of the httpsd.conf file

    IndexOptions SuppressColumnSorting + FancyIndexing + IconsAreLinks

  • Specification of the access control file

    IndexOptions FancyIndexing SuppressLastModified

  If you specify these options, SuppressColumnSorting and IconsAreLinks are disabled. FancyIndexing and SuppressLastModified are enabled.

• In the merging process where options for the same directory index are specified between the specified locations, if you specify both the + and - for the same options, - specification is enabled.

  (Example)

  • Specification of the httpsd.conf file

    IndexOptions + FancyIndexing - IconsAreLinks

  • Specification of the access control file

    IndexOptions + IconsAreLinks

  If you specify these options, IconsAreLinks are disabled.

• If you specify the option in which +- is not specified in the same specification location, the options other than the Charset, IconHeight, IconWidth, and the NameWidth directive, specified with +- are disabled.

  (Example 1)

  • Specification of httpsd.conf file

    IndexOptions + IconsAreLinks FancyIndexing + SuppressLastModified

  In this case, IconsAreLinks is disabled.

  (Example 2)

  • Specification of <VirtualHost> block, <Directory> block, or access control file.

    IndexOptions + IconsAreLinks FancyIndexing + SuppressLastModified

  In this case, IconsAreLinks and SuppressLastModified are disabled.

(c) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(d) Overwrite permission

Indexes level

(a) Contents

The IndexOrderDefault directive specifies the default sorting order for the files in the directory index display.

Ascending: Ascending order

Descending: Descending order

Name: Sort by the file name.

Date: Sort by the file update date.

Size: Sort by the file size.

Description: Sort by the descriptive text specified in the AddDescription directive.

(b) Location where you can code

httpsd.conf, <VirtualHost>, <Directory>, .htaccess

(c) Overwrite permission

Indexes level