From: Eric Covener <covener@apache.org>
Date: Fri, 15 Jul 2011 21:47:15 +0000 (+0000)
Subject: doc for DirectoryIndexRedirect
X-Git-Tag: 2.3.14^2~51
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e896193f30a0ef8866d575a82c3224f28dcb6855;p=thirdparty%2Fapache%2Fhttpd.git

doc for DirectoryIndexRedirect


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1147328 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/mod_dir.xml b/docs/manual/mod/mod_dir.xml
index 2a69d1db343..346e2977e73 100644
--- a/docs/manual/mod/mod_dir.xml
+++ b/docs/manual/mod/mod_dir.xml
@@ -103,6 +103,38 @@ a directory</description>
 </usage>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>DirectoryIndexRedirect</name>
+<description>Configures an external redirect for directory indexes.
+</description>
+<syntax>DirectoryIndexRedirect on | off | permanent | temp | seeother | 
+<var>3xx-code</var>
+</syntax>
+<default>DirectoryIndexRedirect off</default>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context></contextlist>
+<override>Indexes</override>
+<compatability>Available in version 2.3.14 and later</compatability>
+
+<usage>
+    <p>By default, the <directive>DirectoryIndex</directive> is selected
+    and returned transparently to the client.  <directive
+    >DirectoryIndexRedirect</directive> causes an external redirect
+    to instead be issued.</p>
+
+    <example><title>Example</title>
+      DirectoryIndexRedirect on
+    </example>
+
+    <p>A request for <code>http://example.com/docs/</code> would
+    return a temporary redirect to <code
+    >http://example.com/docs/index.html</code> 
+    if it exists.</p>
+
+</usage>
+</directivesynopsis>
+
+
 <directivesynopsis>
 <name>DirectorySlash</name>
 <description>Toggle trailing slash redirects on or off</description>