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

Organization of this subsection
(1) ErrorDocument error-status-number {Text | local-URL | full-URL}
(2) ErrorLog {file-name | pipe}
(3) ExtendedStatus {On | Off}
(4) ExpiresActive {On | Off}
(5) ExpiresByType MIME-type {A | M} time
(6) ExpiresDefault {A | M} time
(7) FancyIndexing {On | Off}
(8) FileETag [{ + | - }]option [[{ + | - }]option ...]
(9) ForceType MIME-type
(10) Group group-name
(11) Header {{set | append | add} header header-value [env=[!]environment-variable] | unset header}
(12) HeaderName file-name
(13) HostnameLookups {On | Off | double}
(14) HWSContentCacheMaxFileSize size
(15) HWSContentCacheSize size
(16) HWSErrorDocumentMETACharset {On | Off | character-set}
(17) HWSErrorLogClientAddr X-Forwarded-For
(18) HWSGracefulStopLog {On | Off}
(19) HWSGracefulStopTimeout forced-termination-time
(20) HWSImapMenuCharset character-set
(21) HWSKeepStartServers {On | Off}
(22) HWSLogSSLVerbose {On | Off}
(23) HWSLogTimeVerbose {On | Off}
(24) HWSMaxQueueSize request-queue-size
(25) HWSNotModifiedResponseHeaders header-name [header-name ...]
(26) HWSProxyPassReverseCookie path-name
(27) HWSRequestLog {file-name | pipe}
(28) HWSRequestLogType trace-type [trace-type...]
(29) HWSSetEnvIfIPv6 request-value IPv6- address environment-variable [= value] [environment-variable [= value] ...]
(30) HWSStackTrace {On | Off}
(31) HWSSuppressModuleTrace module-file-name [all | hook | handler]
(32) HWSTraceIdFile file-name
(33) HWSTraceLogFile file-name
(34) IdentityCheck {On | Off}
(35) ImapBase {map | referrer | URL}
(36) ImapDefault {error | nocontent | map | referrer | URL}
(37) ImapMenu {none | formatted | semiformatted | unformatted}
(38) Include file-name
(39) IndexIgnore file-name [file-name ...]
(40) IndexOptions [{+ | -}]option [[{+ | -}]option ...]
(41) IndexOrderDefault {Ascending | Descending} {Name | Date | Size | Description}

(1) ErrorDocument error-status-number {Text | local-URL | full-URL}

(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:

Error status number (meaning)TextLocal URLFull URL
400 (Bad Request)YNN
401 (Authorization Required)YYN
403 (Forbidden)YYY
404 (Not Found)YYY
405 (Method Not Allowed)YYY
406 (Not Acceptable)YYY
408 (Request Time-out)NNN
410 (Gone)YYY
411 (Length Required)YNN
412 (Precondition Failed)YYY
413 (Request Entity Too Large)YYY
414 (Request-URI Too Large)YNN
416 (Requested Range Not Satisfiable)YYY
417 (Expectation Failed)YNN
500 (Internal Server Error)YYY
501 (Method Not Implemented)YYY
502 (Bad Gateway)YYN
503 (Service Temporarily Unavailable)Y#Y#Y#
506 (Variant Also Negotiates)YYY
Legend:
Y: can be specified.
N: cannot be specified.
#
Use the QOSResponse directive or the QOSRedirect directive when customizing the message returned by the flow restriction functionality.

When you specify this directive, consider the following points:

(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

(2) ErrorLog {file-name | pipe}

~<<logs/error_log>> (UNIX version)

~<<logs/error.log>> (Windows version)

(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

(3) ExtendedStatus {On | Off}

(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

(4) ExpiresActive {On | Off}

(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
(c) Location where you can code

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

(d) Overwrite permission

Indexes level

(5) ExpiresByType MIME-type {A | M} time

~((0-2147483647))(Unit: Seconds)

(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
(c) Location where you can code

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

(d) Overwrite permission

Indexes level

(e) Specification example

ExpiresByType text/html A604800

(6) ExpiresDefault {A | M} time

~((0 - 2147483647)) (Unit: Seconds)

(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
(c) Location where you can code

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

(d) Overwrite permission

Indexes level

(e) Specification example

ExpiresDefault A604800

(7) FancyIndexing {On | Off}

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

(8) FileETag [{ + | - }]option [[{ + | - }]option ...]

~<<All>>

(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:

OptionMeaning
InodeThe unique ID assigned to the file is included.
MtimeLast updated time of the file is included.
SizeBytes count of the file is included.
AllAll the Inode, Mtime, and the Size options are enabled.
NoneEtag header is not added.
(b) Notes
(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.

(9) ForceType MIME-type

(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

(10) Group group-name[Figure]

~<<#-1>>

(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

(11) Header {{set | append | add} header header-value [env=[!]environment-variable] | unset header}

(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:

FormatMeaning
%tDisplay the time when the request was received, by the time elapsed from January 01, 1970, 00:00:00 (GMT: Greenwich Mean Time. The unit is Microseconds. "t=" is added in the beginning.
%DDisplay the time taken for request processing. The unit is microseconds. "D=" is added in the beginning.
%{env_name}eValue of the environment variable env_name.
(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

(12) HeaderName file-name

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

(13) HostnameLookups {On | Off | double}

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

(14) HWSContentCacheMaxFileSize size[Figure]

~((1 - 2097093))<<256>> (Unit: KB)

(a) Contents

The HWSContentCacheMaxFileSize directive specifies the upper limit of the file size that you can cache in KB. In the HWSContentCacheMaxFileSize directive, if you specify a value greater than the value of the HWSContentCacheSize directive, the value of the HWSContentCacheSize directive is set.

(b) Note

The mod_hws_cache module must be embedded to use the static contents cache functionality. For details on the static contents cache functionality, see 4.12 Static contents cache functionality.

(c) Location where you can code

httpsd.conf

(d) Specification example

HWSContentCacheMaxFileSize 32

(15) HWSContentCacheSize size[Figure]

~((1 - 2097093))<<8192>> (unit: KB)

(a) Contents

The HWSContentCacheSize directive specifies the upper limit of the memory size of the data to be cached in server process, in KB.

(b) Note

The mod_hws_cache module must be embedded to use the static contents cache functionality. For details on the static contents cache functionality, see 4.12 Static contents cache functionality.

(c) Location where you can code

httpsd.conf

(d) Specification example

HWSContentCacheSize 1024

(16) HWSErrorDocumentMETACharset {On | Off | character-set} [Figure]

(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

(17) HWSErrorLogClientAddr X-Forwarded-For [Figure]

(a) Contents

Specify The HWSErrorLogClientAddr directive to change the message text to be output to error log from"[client client-address]" to "[X-Forwarded-For header-value]".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. The messages you cannot change are as follows.

(c) Location where you can code

httpsd.conf

(18) HWSGracefulStopLog {On | Off}

(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

(19) HWSGracefulStopTimeout forced-termination-time

~((0 - 3600))<<300>> (Unit: Seconds)

(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

(20) HWSImapMenuCharset character-set

(ISO-8859-1)

(a) Contents

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

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

(21) HWSKeepStartServers {On | Off} [Figure]

(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. This functionality is valid when the value specified in each directive regarding the number of processes, is related as follows:

MinSpareServers < StartServers [Figure] MaxClients

and

MinSpareServers < MaxSpareServers [Figure] 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.Off: The running server processes, equivalent to the number specified in the StartServers directive are not maintained.

For details on other directives regarding the number of processes, see 4.1 Relationship between processes and directives of Cosminexus HTTP Server.

(b) Location where you can code

httpsd.conf

(22) HWSLogSSLVerbose {On | Off}

(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

(23) HWSLogTimeVerbose {On | Off}

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

#: 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

(24) HWSMaxQueueSize request-queue-size[Figure]

~((0 - 2147483647))<<8192>>

(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

(25) HWSNotModifiedResponseHeaders header-name [header-name ...]

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

(b) Location where you can code

httpsd.conf

(c) Specification example

HWSNotModifiedResponseHeaders Set-Cookie Set-Cookie2

(26) HWSProxyPassReverseCookie path-name

(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>

(27) HWSRequestLog {file-name | pipe}

(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 that refers to module trace information, request trace information, and I/O filter 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
(c) Location where you can code

httpsd.conf

(28) HWSRequestLogType trace-type [trace-type...]

(module-info request)

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

Trace typeDescription
module-debugOutputs trace information for internal modules and the trace information corresponding to module-info. Because specifying this trace type results in the output of a large amount of data, do not specify this trace type for a purpose other than debugging.
module-infoOutputs the module trace information collected when external modules and CGI programs are executed.
requestOutputs trace information when a request process starts and is completed. For a KeepAlive connection, trace information is also output when the next request line is received. This trace is called a request trace.
filterOutputs I/O filter trace information that indicates the execution trigger of the input and output filter function for a module. Because specifying this trace type results in the output of a large amount of data, do not specify this trace type for a purpose other than debugging.
noneNo request logs are collected.
(b) Note

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

(c) Location where you can code

httpsd.conf

(29) HWSSetEnvIfIPv6 request-value IPv6- address environment-variable [= value] [environment-variable [= value] ...]

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

Request valueDescription
Remote_AddrThe IPv6 address of the client
Server_AddrThe IPv6 address of the server that received the request

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.

(30) HWSStackTrace {On | Off} [Figure]

(a) Contents

The HWSStackTrace directive specifies whether to output the contents of the stack trace information. This directive is enabled only when using the HP-UX version.

On: Outputs the contents of the stack trace information to the error log file.

Off: Does not output the contents of the stack trace information to the error log file.

(b) Location where you can code

httpsd.conf

(c) Specification example

HWSStackTrace On

(31) HWSSuppressModuleTrace module-file-name [all | hook | handler]

(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 Cosminexus HTTP Server and the corresponding module file names:

Table 6-5 TableNames of standard external modules provided by Cosminexus HTTP Server and corresponding module file names

Module nameModule file name
mod_expires.somod_expires.c
mod_headers.somod_headers.c
mod_hws_cache.somod_hws_cache.c
mod_hws_ldap.somod_hws_ldap.c
mod_hws_qos.somod_hws_qos.c
mod_proxy.somod_proxy.c
mod_proxy_http.soModule trace information is not output.

When using external modules other than the standard modules provided by Cosminexus 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.

(32) HWSTraceIdFile file-name

~<<logs/hws.trcid>>

(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

(33) HWSTraceLogFile file-name

~<<logs/hws.trclog>>

(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 Cosminexus 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 Cosminexus 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

(34) IdentityCheck {On | Off} [Figure]

(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>

(35) ImapBase {map | referrer | URL}

(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

(36) ImapDefault {error | nocontent | map | referrer | URL}

(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

(37) ImapMenu {none | formatted | semiformatted | unformatted}

(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

(38) Include file-name

(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

(39) IndexIgnore file-name [file-name ...]

(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

(40) IndexOptions [{+ | -}]option [[{+ | -}]option ...]

(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:

Table 6-6 The Option list

OptionMeaning
Charset=character-set
(ISO-8859-1 [Figure]
(UTF-8 [Figure]
This option specifies the character set of the pages used for index display. If the character set used in the file specified in the HeaderName directive or the ReadmeName directive differs from the default character set (for the UNIX version: ISO-8859-1, for the Windows version: UTF-8), specify the same character set as for the file specified in the HeaderName directive or the ReadmeName directive. For this option, =character-set cannot be omitted. The operation when -Charset is specified is the same as the operation when +Charset is specified.
DescriptionWidth[={Number of characters | *}]
<<23, 30, 42, or 49>>
This option specifies the width of file descriptive text area by number of characters (1 character=1 byte). If you specify *, the display is in accordance with the maximum length of the file descriptive text specified in the AddDescription directive. If you omit this option, the width of the file descriptive text area is 23 bytes (However, width is +7 when SuppressSize is specified and +19 when SuppressLastModified is specified).
You can omit ={number-of-characters | *} when the -DescriptionWidth is specified. Display width in such case is 23 bytes.
FancyIndexingEnables the format display functionality of the directory index.
FoldersFirstSpecify this option when performing the index display of the directory before the file. However, this is the case only when the FancyIndexing is enabled.
IconsAreLinksLink the icons to files when you display the directory in index format.
IconHeight[=Number of pixels]((>0))<<22>>This option specifies the height of icon in number of pixels when you display the directory index format. Specify this option along with the IconWidth option. This option becomes the HEIGHT attribute of the HTML IMG tag that displays the index.
IconWidth[=Number of pixels]((>0))<<20>>This option specifies the icon width in pixels when you display the directory index format. Specify this option along with the IconHeight option. This option becomes the Width attribute of the HTML IMG tag that displays the index.
IgnoreCaseWhen you display the directory index format, this option sorts the file names and the directory names ignoring the case.
NameWidth[={number-of-characters | *}]<<23>>This option specifies the width of file name and the directory name area with the number of characters (1 character=1byte). If you specify *, the display is in accordance with the maximum length of file name and the directory name.
If you omit ={number-of-characters | *}, always specify this option as -NameWidth.
ScanHTMLTitlesWhen the AddDescription directive is not specified, search for the <TITLE> tag in the HTML file and display it as the descriptive text.
SuppressColumnSortingThis option disables the functionality that sorts the index into the columns of the file name, directory name, last updated date and time, file size, and file descriptive text.
SuppressDescriptionThis option does not display the descriptive text of the file.
SuppressHTMLPreambleThis option outputs both the contents of the file specified in the HeaderName directive and the HTML header that is automatically created (such as <HTML> and <TITLE>) when the HeaderName directive is specified. This option suppresses the output of the HTML header that is automatically created when the file specified in the HeaderName directive is written in HTML.
SuppressLastModifiedThis option does not display the last updated date and time.
SuppressSizeThis option does not display the file size.
TrackModifiedThis option sets the Last-Modified value and Etag value in the HTTP response header of the response for directory display. If you specify this option, as the directory can check the file configuration changes, the client can use the cache functionality effectively. This option is valid only when the operating system and file system supports stat().
(b) Notes
(c) Location where you can code

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

(d) Overwrite permission

Indexes level

(41) IndexOrderDefault {Ascending | Descending} {Name | Date | Size | Description}

(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