[deployment-guide/comm-rel: 538/727] Updated the ReadmeName directive description.

Jaromir Hradilek jhradile at fedoraproject.org
Tue Oct 19 13:10:10 UTC 2010


commit 1e67ab21a114a1f01a4f16cddef9e58eff930a02
Author: Jaromir Hradilek <jhradile at redhat.com>
Date:   Tue Aug 31 17:29:25 2010 +0200

    Updated the ReadmeName directive description.

 en-US/The_Apache_HTTP_Server.xml |   30 ++++++++++++++++--------------
 1 files changed, 16 insertions(+), 14 deletions(-)
---
diff --git a/en-US/The_Apache_HTTP_Server.xml b/en-US/The_Apache_HTTP_Server.xml
index 704afff..3366f8f 100644
--- a/en-US/The_Apache_HTTP_Server.xml
+++ b/en-US/The_Apache_HTTP_Server.xml
@@ -1688,6 +1688,22 @@ ErrorDocument 404 /404-not_found.html</screen>
             </example>
           </listitem>
         </varlistentry>
+        <varlistentry>
+          <term><option>ReadmeName</option></term>
+          <listitem>
+            <para>
+              The <option>ReadmeName</option> directive allows you to specify a file to be appended to the end of the server-generated directory listing. It takes the following form: 
+            </para>
+            <screen>ReadmeName <replaceable>filename</replaceable></screen>
+            <para>
+              The <replaceable>filename</replaceable> is a name of the file to look for in the requested directory. By default, the server looks for <filename>README.html</filename>.
+            </para>
+            <example id="example-apache-httpdconf-readmename">
+              <title>Using the <option>ReadmeName</option> directive</title>
+              <screen>ReadmeName README.html</screen>
+            </example>
+          </listitem>
+        </varlistentry>
       </variablelist>
       <formalpara id="s2-apache-indexoptions">
         <title>IndexOptions</title>
@@ -1715,20 +1731,6 @@ ErrorDocument 404 /404-not_found.html</screen>
       <para>
         <command>IndexOptions</command> has a number of other parameters which can be set to control the appearance of server generated directories. The <command>IconHeight</command> and <command>IconWidth</command> parameters require the server to include HTML <command>HEIGHT</command> and <command>WIDTH</command> tags for the icons in server generated webpages. The <command>IconsAreLinks</command> parameter combines the graphical icon with the HTML link anchor, which contains the URL link target.
       </para>
-      <formalpara id="s2-apache-readmename">
-        <title>ReadmeName</title>
-        <indexterm>
-          <primary><command>ReadmeName</command></primary>
-          <secondary>Apache configuration directive</secondary>
-        </indexterm>
-        <indexterm>
-          <primary>configuration directives, Apache</primary>
-          <secondary><command>ReadmeName</command></secondary>
-        </indexterm>
-        <para>
-          <command>ReadmeName</command> names the file which, if it exists in the directory, is appended to the end of server generated directory listings. The Web server first tries to include the file as an HTML document and then tries to include it as plain text. By default, <command>ReadmeName</command> is set to <filename>README.html</filename>.
-        </para>
-      </formalpara>
       <formalpara id="s2-apache-redirect">
         <title>Redirect</title>
         <indexterm>


More information about the docs-commits mailing list