ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaiemod_auto_index.htm

803 lines
51 KiB
HTML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="topic" />
<meta name="DC.Title" content="Module mod_autoindex" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzaiemod_auto_index" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>Module mod_autoindex</title>
</head>
<body id="rzaiemod_auto_index"><a name="rzaiemod_auto_index"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Module mod_autoindex</h1>
<div><div class="important"><span class="importanttitle">Important:</span> Information
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
It is recommended that you install the latest PTFs to upgrade to the latest
level of the HTTP Server for i5/OS. Some of the topics documented here are
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
<p><strong>Summary</strong></p>
<p>The module mod_autoindex provides for automatic directory indexing. The
index of a directory can come from one of two sources: </p>
<ul><li>A file written by the user, typically called index.html. The <a href="rzaiemod_dir.htm#directoryindex">DirectoryIndex</a> directive sets the name of this file. This is controlled
by <a href="rzaiemod_dir.htm">mod_dir</a>. </li>
<li>A listing generated by the server. The other directives control the format
of this listing. The AddIcon, AddIconByEncoding and AddIconByType are used
to set a list of icons to display for various file types; for each file listed,
the first icon listed that matches the file is displayed. These are controlled
by mod_autoindex. </li>
</ul>
<p>If the FancyIndexing keyword is present on the IndexOptions directive,
the column headers are links that control the order of the display. If you
select a header link, the listing will be regenerated, sorted by the values
in that column. Selecting the same header repeatedly toggles between ascending
and descending order.</p>
<p>For all mod_autoindex directives that specify a file name (AddDescription,
AddIcon, and so on), case sensitivity is handled based on the file system.
If the object is in the QOpenSys file system, the name is handled in a case
sensitive manner. If the object is a file system other than QOpenSys, the
name is handled in a case insensitive manner. </p>
<div class="note"><span class="notetitle">Note:</span> When the display is sorted by "Size", it is the actual size of the files
that's used, not the displayed value - so a 1010-byte file will always be
displayed before a 1011-byte file (if in ascending order) even though the
size of both files could be displayed as "1K". </div>
<p><strong>Directives</strong></p>
<ul><li><a href="#addalt">AddAlt</a></li>
<li><a href="#addaltbyencoding">AddAltByEncoding</a></li>
<li><a href="#addaltbytype">AddAltByType</a></li>
<li><a href="#adddescription">AddDescription</a></li>
<li><a href="#addicon">AddIcon</a></li>
<li><a href="#addiconbyencoding">AddIconByEncoding</a></li>
<li><a href="#addiconbytype">AddIconByType</a></li>
<li><a href="#defaulticon">DefaultIcon</a></li>
<li><a href="#headername">HeaderName</a></li>
<li><a href="#indexignore">IndexIgnore</a></li>
<li><a href="#indexoptions">IndexOptions</a></li>
<li><a href="#indexorderdefault">IndexOrderDefault</a></li>
<li><a href="#readmename">ReadmeName</a></li>
</ul>
</div>
<div class="hr" id="addalt"><a name="addalt"><!-- --></a><h2 class="topictitle2">AddAlt</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: AddAlt <em>string file [file...] </em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="addalt__addalt_context"><a name="addalt__addalt_context"><!-- --></a>server config,
virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="addalt__addalt_origin"><a name="addalt__addalt_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: AddAlt "IMG" jpg gif </td>
</tr>
</tbody>
</table>
</div>
<p>The AddAlt directive sets the alternate text to display for automatic directory
indexing. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter One</strong>: <em>string </em></dt>
<dd><ul><li>The <em>string</em> parameter is enclosed in double quotes ("..."). This
alternate text is displayed if the client is image-incapable or has image
loading disabled. </li>
</ul>
</dd>
</dl>
<dl class="block"><dt class="dlterm"><strong>Parameter Two</strong>: <em>file </em></dt>
<dd><ul><li>The <em>file</em> parameter is either ^^DIRECTORY^^ for child directories,
^^PARENT^^ for parent directories, ^^BLANKICON^^ for blank lines (to format
the list correctly), a file extension, a wildcard expression, a partial file,
or a complete filename. It could also be a QSYS.LIB member type if this directive
is being used to set alternate text for QSYS.LIB members. For example:<pre>AddAlt "IMG" .jpg .gif
AddAlt " " ^^BLANKICON^^
AddAlt "BAK" *~ </pre>
</li>
</ul>
</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="addaltbyencoding"><a name="addaltbyencoding"><!-- --></a><h2 class="topictitle2">AddAltByEncoding</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: AddAltByEncoding <em>string MIME-encoding
[MIME-encoding...] </em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="addaltbyencoding__addaltbyencoding_context"><a name="addaltbyencoding__addaltbyencoding_context"><!-- --></a>server
config, virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="addaltbyencoding__addaltbyencoding_origin"><a name="addaltbyencoding__addaltbyencoding_origin"><!-- --></a>Apache</span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: AddAltByEncoding "CMP" x-compress </td>
</tr>
</tbody>
</table>
</div>
<p>The AddAltByEncoding directive sets the alternate text to display for a
file, instead of an icon, for automatic directory indexing. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter One</strong>: <em>string </em></dt>
<dd><ul><li>The <em>string</em> parameter is enclosed in double quotes ("..."). This
alternate text is displayed if the client is image-incapable or has image
loading disabled. </li>
</ul>
</dd>
</dl>
<dl class="block"><dt class="dlterm"><strong>Parameter Two</strong>: <em>MIME-encoding </em></dt>
<dd><ul><li>The <em>MIME-encoding</em> parameter is a valid content-encoding, such as
x-compress. </li>
</ul>
</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="addaltbytype"><a name="addaltbytype"><!-- --></a><h2 class="topictitle2">AddAltByType</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: AddAltByType <em>string MIME-type [MIME-type
...] </em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="addaltbytype__addaltbytype_context"><a name="addaltbytype__addaltbytype_context"><!-- --></a>server config,
virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes</td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="addaltbytype__addaltbytype_origin"><a name="addaltbytype__addaltbytype_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: AddAltByType "HTM" text/html </td>
</tr>
</tbody>
</table>
</div>
<p>The AddAltByType directive sets the alternate text to display for a file,
instead of an icon, for automatic directory indexing. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter One</strong>: <em>string </em></dt>
<dd><ul><li>The <em>string</em> parameter is enclosed in double quotes ("..."). This
alternate text is displayed if the client is image-incapable or has image
loading disabled. </li>
</ul>
</dd>
</dl>
<dl class="block"><dt class="dlterm"><strong>Parameter Two</strong>: <em>MIME-type </em></dt>
<dd><ul><li>The <em>MIME-type</em> parameter is a valid content-type, such as text/html. </li>
</ul>
</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="adddescription"><a name="adddescription"><!-- --></a><h2 class="topictitle2">AddDescription</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: AddDescription <em>string file [file...]</em> </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="adddescription__adddescription_context"><a name="adddescription__adddescription_context"><!-- --></a>server
config, virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="adddescription__adddescription_origin"><a name="adddescription__adddescription_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: AddDescription "Famous People" /web/pics/famous* </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: AddDescription "My pictures" /QSYS.LIB/MYLIB/MYFILE.FILE/pic* </td>
</tr>
</tbody>
</table>
</div>
<p>The AddDescription directive sets the description to display for a file,
for automatic directory indexing. File is a file extension, partial filename,
QSYS.LIB member type, wildcard expression or full filename for files to describe.
String is enclosed in double quotes ("). For example: </p>
<pre class="block">AddDescription "The planet Mars" /web/pics/mars.gif</pre>
<p>By default, the description field is 23 bytes wide. Seven more bytes may
be added if the directory is covered by an IndexOptions SuppressSize, and
19 bytes may be added if IndexOptions SuppressLastModified is in effect. The
widest this column can be is therefore 49 bytes, unless configured differently
using IndexOptions DescriptionMaxWidth.</p>
<p>The DescriptionWidth IndexOptions keyword allows you to adjust this width
to any arbitrary size.</p>
<p>The following order of precedence will be used to search for a directory
listing file description. The first mechanism from this list that applies
will be used to generate the file description:</p>
<ol><li>The file matches one of those specified on an AddDescription directive.
The string from the directive is displayed. This option is the least CPU
intensive. </li>
<li>The file system contains a description for the file. The file system
description information is displayed. Note that if the file is a QSYS.LIB
member, the member text is displayed.</li>
<li>If IndexOptions ScanHTMLTitles is configured, the title is extracted from
HTML documents for fancy indexing. This is CPU and disk intensive. </li>
</ol>
<div class="note"><span class="notetitle">Note:</span> Descriptive text defined with AddDescription may contain
HTML markup, such as tags and character entities. If the width of the description
column should happen to truncate a tagged element (such as cutting off the
end of a bold phrase), the results may affect the rest of the directory listing.
This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="addicon"><a name="addicon"><!-- --></a><h2 class="topictitle2">AddIcon</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: AddIcon <em>icon name [name ...] </em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="addicon__addicon_context"><a name="addicon__addicon_context"><!-- --></a>server config,
virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="addicon__addicon_origin"><a name="addicon__addicon_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: AddIcon (IMG,icons/image) .gif .jpg </td>
</tr>
</tbody>
</table>
</div>
<p>The AddIcon directive sets the icon to display next to a file ending in
name for automatic directory indexing. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter One</strong>: <em>icon </em></dt>
<dd><ul><li>The <em>icon</em> parameter is either a (%-escape) relative URL to the icon
or of the format (alttext,url) where alttext is the text tag given for an
icon for non-graphical browsers. </li>
</ul>
</dd>
</dl>
<dl class="block"><dt class="dlterm"><strong>Parameter Two</strong>: <em>name </em></dt>
<dd><ul><li>The <em>name</em> parameter is either <tt>^^DIRECTORY^^</tt> for child directories, <tt>^^PARENT^^</tt> for
parent directories, <tt>^^BLANKICON^^</tt> for blank lines (to format the
list correctly), a file extension, a wildcard expression, a partial file or
a complete filename. For example <pre class="block">AddIcon (IMG,icons/image) .gif .jpg
AddIcon (PAR, icons/parent .gif) ^^PARENT^^
AddIcon /dir.gif ^^DIRECTORY^^
AddIcon backup.gif *~ </pre>
</li>
</ul>
</dd>
</dl>
<p><a href="#addiconbytype">AddIconByType</a> should be used in preference to AddIcon,
when possible.</p>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="addiconbyencoding"><a name="addiconbyencoding"><!-- --></a><h2 class="topictitle2">AddIconByEncoding</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: AddIconByEncoding <em>icon MIME-encoding
[MIME-encoding ...]</em> </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="addiconbyencoding__addiconbyencoding_context"><a name="addiconbyencoding__addiconbyencoding_context"><!-- --></a>server
config, virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="addiconbyencoding__addiconbyencoding_origin"><a name="addiconbyencoding__addiconbyencoding_origin"><!-- --></a>Apache
</span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: AddIconByEncoding /compress.xbm x-compress </td>
</tr>
</tbody>
</table>
</div>
<p>The AddIConByEncoding directive sets the icon to display next to files
with MIME-encoding for automatic directory indexing. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter One</strong>: <em>icon </em></dt>
<dd><ul><li>The icon parameter is either a (%-escaped) relative URL to the icon or
of the format (alttext,url) where alttext is the text tag five for an icon
for non-graphical browsers.</li>
</ul>
</dd>
</dl>
<dl class="block"><dt class="dlterm"><strong>Parameter Two</strong>: <em>MIME-encoding </em></dt>
<dd><ul><li>The <em>MIME-encoding</em> parameter is a wildcard expression matching required
content-encoding. </li>
</ul>
</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="addiconbytype"><a name="addiconbytype"><!-- --></a><h2 class="topictitle2">AddIconByType</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: AddIconByType <em>icon MIME-type [MIME-type
...] </em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none</td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="addiconbytype__addiconbytype_context"><a name="addiconbytype__addiconbytype_context"><!-- --></a>server config,
virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="addiconbytype__addiconbytype_origin"><a name="addiconbytype__addiconbytype_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: AddIconByType (IMG,image.gif) image/* </td>
</tr>
</tbody>
</table>
</div>
<p>The AddIconByType directive sets the icon to display next to files of type
MIME-type for FancyIndexing. Icon is either a (%-escaped) relative URL to
the icon, or of the format (alttext,url) where alttext is the text tag given
for an icon for non-graphical browsers. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter One</strong>: <em>icon </em></dt>
<dd><ul><li>The icon parameter is either a (%-escaped) relative URL to the icon or
of the format (alttext,url) where alttext is the text tag given for an icon
for non-graphical browsers. </li>
</ul>
</dd>
</dl>
<dl class="block"><dt class="dlterm"><strong>Parameter Two</strong>: <em>MIME-type </em></dt>
<dd><ul><li>The MIME-type parameter is a wildcard expression matching the required
MIME types. </li>
</ul>
</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="defaulticon"><a name="defaulticon"><!-- --></a><h2 class="topictitle2">DefaultIcon</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: DefaultIcon <em>url</em> </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="defaulticon__defaulticon_context"><a name="defaulticon__defaulticon_context"><!-- --></a>server config,
virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="defaulticon__defaulticon_origin"><a name="defaulticon__defaulticon_origin"><!-- --></a>Modified</span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: DefaultIcon /icon/unknown.gif </td>
</tr>
</tbody>
</table>
</div>
<p>The DefaultIcon directive sets the icon to display for files when no specific
icon is known, for automatic directory indexing. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>url </em></dt>
<dd><ul><li>The url parameter is either a (%-escaped) relative URL to the icon or
of the format (alttext,url) where alttext is the text tag given for an icon
for non-graphical browsers. For example: <pre class="block">DefaultIcon (UNK,unknown.gif)</pre>
</li>
</ul>
</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="headername"><a name="headername"><!-- --></a><h2 class="topictitle2">HeaderName</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: HeaderName <em>filename</em> </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="headername__headername_context"><a name="headername__headername_context"><!-- --></a>server config,
virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="headername__headername_origin"><a name="headername__headername_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: HeaderName headerfile</td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: HeaderName PREAMBLE.MBR </td>
</tr>
</tbody>
</table>
</div>
<p>The HeaderName directive sets the name of the file that will be inserted
at the top of the index listing. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>filename </em></dt>
<dd><ul><li>The <em>filename</em> parameter is the name of the file to include. </li>
</ul>
</dd>
</dl>
<p>Filename is treated as a URI path relative to the one used to access the
directory being indexed, and must resolve to a document with a major content
type of "text" (for example, text/html, text/plain). This means that filename
may refer to a CGI script if the script's actual file type (as opposed to
its output) is marked as text/html such as with a directive like: </p>
<pre class="block">AddType text/html .cgi</pre>
<p>Content negotiation will be performed if the MultiViews option is enabled.
See <a href="rzaiecontent-negotiation.htm">Content negotiation for HTTP Server (powered by Apache)</a> for more
information.</p>
<p>If filename resolves to a static text/html document (not a CGI script)
and the Includes Option is enabled, the file will be processed for server-side
includes. See <a href="rzaiemod_include.htm">mod_include</a> for more information. </p>
<p>See also <a href="#readmename">ReadmeName</a>.</p>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="indexignore"><a name="indexignore"><!-- --></a><h2 class="topictitle2">IndexIgnore</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: IndexIgnore file [file ...] </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="indexignore__indexignore_context"><a name="indexignore__indexignore_context"><!-- --></a>server config,
virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="indexignore__indexignore_origin"><a name="indexignore__indexignore_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: IndexIgnore README .htaccess</td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: IndexIgnore README.MBR </td>
</tr>
</tbody>
</table>
</div>
<p>The IndexIgnore directive adds to the list of files to hide when listing
a directory. Multiple IndexIgnore directives add to the list, rather than
the replacing the list of ignored files. By default, the dot directory (.)
is ignored. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>file </em></dt>
<dd><ul><li>The <em>file</em> parameter is a file extension, QSYS.LIB member type, partial
filename, wildcard expression or full filename for files to ignore. </li>
</ul>
</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="indexoptions"><a name="indexoptions"><!-- --></a><h2 class="topictitle2">IndexOptions</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: IndexOptions <em>[+|-]option [+|-]option
... </em></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="indexoptions__indexoptions_context"><a name="indexoptions__indexoptions_context"><!-- --></a>server config,
virtual host, directory, .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="indexoptions__indexoptions_origin"><a name="indexoptions__indexoptions_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: IndexOptions FancyIndexing ShowOwner FoldersFirst </td>
</tr>
</tbody>
</table>
</div>
<p>The IndexOptions directive specifies the behavior of the directory indexing.
</p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>option </em></dt>
<dd><ul><li>The <em>option</em> parameter can be one of the following:
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" width="23.97959183673469%" id="d0e1092">Parameter</th>
<th valign="top" width="76.0204081632653%" id="d0e1094">Description</th>
</tr>
</thead>
<tbody><tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">DescriptionWidth= [n] </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 "><ul><li>The DescriptionWidth keyword allows you to specify the width of the description
column in characters. </li>
<li>-DescriptionWidth (or unset) allows mod_autoindex to calculate the best
width. </li>
<li>DescriptionWidth=n fixes the column width to n characters wide. </li>
<li>DescriptionWidth=* grows the column to the width necessary to accommodate
the longest description string. </li>
</ul>
See <a href="#adddescription">AddDescription</a> for information on truncating.</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">FancyIndexing </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This turns on fancy indexing of directories. With FancyIndexing,
the column headers are links that control the order of the display. If you
select a header link, the listing will be regenerated, sorted by the values
in that column. Selecting the same header repeatedly toggles between ascending
and descending order. <div class="note"><span class="notetitle">Note:</span> When the display is sorted by "Size", it is
the actual size of the files that's used, not the displayed value. Regardless
of the ShowSmallFileBytes option setting, a 1010-byte file will always be
displayed before a 1011-byte file (if in ascending order) even though the
size of both files could be displayed as "1K". </div>
</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">FoldersFirst</td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">If this option is enabled, subdirectories in a FancyIndexed
listing will always appear first, followed by normal files in the directory.
The listing is broken into two components, the files and the subdirectories,
and each is sorted separately and then displayed (subdirectories-first). For
instance, if the sort order is descending by name, and FoldersFirst is enabled,
subdirectory Zed will be listed before subdirectory Beta, which will be listed
before normal files Gamma and Alpha. This option only has an effect if FancyIndexing
is also enabled.</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">IconsAreLinks </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This makes the icons part of the anchor for the filename,
for fancy indexing.</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">IconHeight=[pixels] </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">Presence of this option, when used with IconWidth, will
cause the server to include HEIGHT and WIDTH attributes in the IMG tag for
the file icon. This allows browser to precalculate the page layout without
having to wait until all the images have been loaded. If no value is given
for the option, it defaults to the standard height of the icons supplied with
HTTP Server software. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">IconWidth=[pixels] </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">Presence of this option, when used with IconHeight,
will cause the server to include HEIGHT and WIDTH attributes in the IMG tag
for the file icon. This allows browser to precalculate the page layout without
having to wait until all the images have been loaded. If no value is given
for the option, it defaults to the standard width of the icons supplied with
HTTP Server software. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">IgnoreClient</td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This option causes mod_autoindex to ignore all query
variables from the client, including sort order (implies SuppressColumnSorting).</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">NameWidth=[n | *] </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 "><ul><li>The NameWidth keyword allows you to specify the width of the filename
column in characters. If the keyword value is '*', then the column is automatically
sized to the length of the longest filename in the display. </li>
<li>NameWidth (or unset) allows mod_autoindex to calculate the best width. </li>
<li>NameWidth=n fixes the column width to n characters wide.</li>
<li>The minimum value allowed is 5.</li>
</ul>
</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">NameMinWidth=[n] </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">The NameMinWidth keyword allows you to specify the minimum
width that will always be reserved for the filename column in characters.
The default setting is 15. The minimum value allowed is 5. If NameMinWidth
is greater than NameWidth, then the filename column will have a length=NameMinWidth. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">ScanHTMLTitles </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This enables the extraction of the title from HTML documents
for fancy indexing. If the file does not have a description given by AddDescription
then HTTP Server will read the document for the value of the TITLE tag. This
is CPU and disk intensive. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">SelectiveDirAccess</td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This option causes the server to return directory listings
only for directories that contain a wwwbrws file. The contents of the wwwbrws
file are not important. The server only checks for its existence. The object
is a member name of an i5/OS™ physical file or a type of object in an integrated
file system directory. For case-sensitive file systems such as /QOpenSys,
the wwwbrws name is lowercase. <p><strong>Note:</strong> SelectiveDirAccess is an i5/OS
specific option. This specific option works on a per directory basis. You
must specify the ± SelectiveDirAccess on a Directory container.</p>
</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">ShowOwner</td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This determines whether directory listings should include
the owner ID for each file.</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">SuppressColumnSorting </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">If specified, HTTP Server will not make the column headings
in a FancyIndexed directory listing into links for sorting. The default behavior
is for them to be links; selecting the column heading will sort the directory
listing by the values in that column. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">SuppressDescription </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This will suppress the file description in fancy indexing
listings. See <a href="#adddescription">AddDescription</a> for information about setting
the file description. See also the DescriptionWidth index option to limit
the size of the description column. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">SuppressHTMLPreamble </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">If the directory actually contains a file specified
by the <a href="#headername">HeaderName</a> directive, the module usually includes
the contents of the file after a standard HTML preamble (&lt;HTML&gt;, &lt;HEAD&gt;,
and so on). The SuppressHTMLPreamble option disables this behavior, causing
the module to start the display with the header file contents. The header
file must contain appropriate HTML instructions in this case. If there is
no header file, the preamble is generated as usual. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">SuppressIcon</td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This suppresses the display of icons on directory listings.
The default is that no options are enabled. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">SuppressLastModified </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This will suppress the display of the last modification
date, in fancy indexing listings. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">SuppressRules</td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This will suppress the horizontal rule lines (HR tags)
in directory listings. Combining both SuppressIcon and SuppressRules yields
proper HTML 3.2 output, which by the final specification prohibits IMG and
HR tags from the PRE block (used to format FancyIndexed listings).</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">SuppressSize </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This will suppress the file size in fancy indexing listings. </td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">TrackModified</td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">This returns the Last-Modified and ETag values for the
listed directory in the HTTP header. It is only valid if the operating system
and file system return appropriate stat() results. Some UNIX<sup>®</sup> systems do
so, as do OS/2's JFS and Win32's NTFS volumes. OS/2<sup>®</sup> and Win32 FAT volumes, for example,
do not. Once this feature is enabled, the client or proxy can track changes
to the list of files when they perform a HEAD request. Note some operating
systems correctly track new and removed files, but do not track changes for
sizes or dates of the files within the directory. Changes to the size or date
stamp of an existing file will not update the Last-Modified header on all
UNIX platforms. If this is a concern, leave this option disabled.</td>
</tr>
<tr><td valign="top" width="23.97959183673469%" headers="d0e1092 ">VersionSort </td>
<td valign="top" width="76.0204081632653%" headers="d0e1094 ">The VersionSort keyword causes files containing version
numbers to sort in a natural way. Strings are sorted as usual, except that
substrings of digits in the name and description are compared according to
their numeric value. For example: <ul><li>ibm-1.7 </li>
<li>ibm-1.7.2 </li>
<li>ibm-1.7.12 </li>
<li>ibm-1.8.2 </li>
<li>ibm-1.8.2a </li>
<li>ibm-1.12 </li>
</ul>
If the number starts with a zero, then it is considered to be a fraction:
<ul><li>ibm-1.001 </li>
<li>ibm-1.002 </li>
<li>ibm-1.030 </li>
<li>ibm-1.04 </li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</dd>
</dl>
<p>Notes on IndexOptions directives: </p>
<ul><li>Multiple IndexOptions directives for a single directory are merged together.
</li>
<li>The directive allows incremental syntax (i.e., prefixing keywords with
'+' or '-').</li>
</ul>
<p>Whenever a '+' or '-' prefixed keyword is encountered, it is applied to
the current IndexOptions settings (which may have been inherited from an upper-level
directory). However, whenever an non-prefixed keyword is processed, it clears
all inherited options and any incremental settings encountered so far. Consider
the following example: </p>
<pre class="block">IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
IndexOptions +SuppressSize</pre>
<p>The net effect is equivalent to IndexOptions FancyIndexing +SuppressSize,
because the non-prefixed FancyIndexing discarded the incremental keywords
before it, but allowed them to start accumulating again afterward. To unconditionally
set the IndexOptions for a particular directory, clearing the inherited settings,
specify keywords without either '+' or '-' prefixes. </p>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
<div class="hr" id="indexorderdefault"><a name="indexorderdefault"><!-- --></a><h2 class="topictitle2">IndexOrderDefault</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: IndexOrderDefault [<em> ascending | descending
] [ name | date | size | owner | description</em> ] [ <em>CaseSense | NoCaseSense </em>] </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: IndexOrderDefault Ascending Name CaseSense </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="indexorderdefault__indexorderdefault_context"><a name="indexorderdefault__indexorderdefault_context"><!-- --></a>server
config, virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="indexorderdefault__indexorderdefault_origin"><a name="indexorderdefault__indexorderdefault_origin"><!-- --></a>Modified
</span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: IndexOrderDefault descending size </td>
</tr>
</tbody>
</table>
</div>
<p>The IndexOrderDefault directive is used in combination with the FancyIndexing
index option. By default, FancyIndexed directory listings are displayed in
ascending order by filename; the IndexOrderDefault allows you to change this
initial display order. </p>
<p>IndexOrderDefault takes two required arguments and a third optional argument.
</p>
<dl class="block"><dt class="dlterm"><strong>Parameter One</strong>: <em>ascending | descending </em></dt>
<dd><ul><li>The <em>ascending</em> and <em>descending</em> parameter indicates the direction
of the sort. </li>
</ul>
</dd>
</dl>
<dl class="block"><dt class="dlterm"><strong>Parameter Two</strong>: <em>name | date | size | owner | description </em></dt>
<dd><ul><li>The <em>name</em>, <em>date</em>, <em>size</em>, <em>owner</em>, and <em>description</em> parameter
arguments must be used and identifies the primary key. The secondary key is
always ascending filename. </li>
</ul>
</dd>
</dl>
<dl class="block"><dt class="dlterm"><strong>Parameter Three</strong>: <em>CaseSense | NoCaseSense </em></dt>
<dd><ul><li>The <em>CaseSense</em> and <em>NoCaseSense</em> parameters are optional third
keywords that allow you to choose if the column sort is case sensitive. This
keyword is valid if the second keyword is <em>name</em>, <em>owner</em> or <em>description</em> only.
If the second keyword is <em>date</em> or <em>size</em>, then this parameter is
ignored. The default for keyword is <em>CaseSense</em>. </li>
</ul>
</dd>
</dl>
<p>You can force a directory listing to only be displayed in a particular
order by combining this directive with the SuppressColumnSorting index option;
this will prevent the client from requesting the directory listing in a different
order. </p>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers. The directive may be inherited in a <a href="rzaiemod_core.htm#directory">&lt;Directory&gt;</a> context, but not
in a <a href="rzaiemod_core.htm#virtualhost">&lt;VirtualHost&gt;</a> context.</div>
</div>
</div>
<div class="hr" id="readmename"><a name="readmename"><!-- --></a><h2 class="topictitle2">ReadmeName</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_autoindex </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: ReadmeName <em>filename</em> </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="readmename__readmename_context"><a name="readmename__readmename_context"><!-- --></a>server config,
virtual host, directory (but not location), .htaccess </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: Indexes </td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="readmename__readmename_origin"><a name="readmename__readmename_origin"><!-- --></a>Apache </span></td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: ReadMeName readme</td>
</tr>
<tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: ReadMeName README.MBR</td>
</tr>
</tbody>
</table>
</div>
<p>The ReadmeName directive sets the name of the file that will be appended
to the end of the index listing. </p>
<dl class="block"><dt class="dlterm"><strong>Parameter</strong>: <em>filename</em></dt>
<dd><ul><li>The <em>filename</em> parameter is the name of the file to include and is
taken to be relative to the location being indexed. Details of how its handled
may be found under the description of the <a href="#headername">HeaderName</a> directive,
which uses the same mechanism as ReadmeName. </li>
</ul>
</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> This directive is not supported in <a href="rzaiemod_core.htm#location">&lt;Location&gt;</a> containers.</div>
</div>
</div>
</body>
</html>