[deployment-guide/comm-rel: 568/727] Updated the UseCanonicalName directive description.

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


commit 451d7dbc534aa88c836e55fd1f3f4599ec41e949
Author: Jaromir Hradilek <jhradile at redhat.com>
Date:   Thu Sep 2 13:49:19 2010 +0200

    Updated the UseCanonicalName directive description.
    
    Also, copy and paste can back-stab you.

 en-US/The_Apache_HTTP_Server.xml |   84 ++++++++++++++++++++++++++++---------
 1 files changed, 63 insertions(+), 21 deletions(-)
---
diff --git a/en-US/The_Apache_HTTP_Server.xml b/en-US/The_Apache_HTTP_Server.xml
index 181c585..ae735d1 100644
--- a/en-US/The_Apache_HTTP_Server.xml
+++ b/en-US/The_Apache_HTTP_Server.xml
@@ -1867,12 +1867,12 @@ ErrorDocument 404 /404-not_found.html</screen>
             <table id="table-apache-httpdconf-serversignature">
               <title>Available <option>ServerSignature</option> options</title>
               <tgroup cols="2">
-                <colspec colname="status" colnum="1" colwidth="20*" />
+                <colspec colname="option" colnum="1" colwidth="20*" />
                 <colspec colname="description" colnum="2" colwidth="60*" />
                 <thead>
                   <row>
                     <entry>
-                      Status
+                      Option
                     </entry>
                     <entry>
                       Description
@@ -1926,12 +1926,12 @@ ErrorDocument 404 /404-not_found.html</screen>
             <table id="table-apache-httpdconf-servertokens">
               <title>Available <option>ServerTokens</option> options</title>
               <tgroup cols="2">
-                <colspec colname="status" colnum="1" colwidth="20*" />
+                <colspec colname="option" colnum="1" colwidth="20*" />
                 <colspec colname="description" colnum="2" colwidth="60*" />
                 <thead>
                   <row>
                     <entry>
-                      Status
+                      Option
                     </entry>
                     <entry>
                       Description
@@ -2053,6 +2053,65 @@ ErrorDocument 404 /404-not_found.html</screen>
             </example>
           </listitem>
         </varlistentry>
+        <varlistentry>
+          <term><option>UseCanonicalName</option></term>
+          <listitem>
+            <para>
+              The <option>UseCanonicalName</option> allows you to specify the way the server refers to itself. It takes the following form:
+            </para>
+            <screen>UseCanonicalName <replaceable>option</replaceable></screen>
+            <para>
+              The <replaceable>option</replaceable> has to be a valid keyword as described in <xref linkend="table-apache-httpdconf-usecanonicalname" />. The default option is <option>Off</option>.
+            </para>
+            <table id="table-apache-httpdconf-usecanonicalname">
+              <title>Available <option>UseCanonicalName</option> options</title>
+              <tgroup cols="2">
+                <colspec colname="option" colnum="1" colwidth="20*" />
+                <colspec colname="description" colnum="2" colwidth="60*" />
+                <thead>
+                  <row>
+                    <entry>
+                      Option
+                    </entry>
+                    <entry>
+                      Description
+                    </entry>
+                  </row>
+                </thead>
+                <tbody>
+                  <row>
+                    <entry>
+                      <option>On</option>
+                    </entry>
+                    <entry>
+                      Enables the use of the name that is specified by the <option>ServerName</option> directive.
+                    </entry>
+                  </row>
+                  <row>
+                    <entry>
+                      <option>Off</option>
+                    </entry>
+                    <entry>
+                      Disables the use of the name that is specified by the <option>ServerName</option> directive. The hostname and port number provided by the requesting client are used instead.
+                    </entry>
+                  </row>
+                  <row>
+                    <entry>
+                      <option>DNS</option>
+                    </entry>
+                    <entry>
+                      Disables the use of the name that is specified by the <option>ServerName</option> directive. The hostname determined by a reverse DNS lookup is used instead.
+                    </entry>
+                  </row>
+                </tbody>
+              </tgroup>
+            </table>
+            <example id="example-apache-httpdconf-usecanonicalname">
+              <title>Using the <option>UseCanonicalName</option> directive</title>
+              <screen>UseCanonicalName Off</screen>
+            </example>
+          </listitem>
+        </varlistentry>
       </variablelist>
       <formalpara id="s2-apache-indexoptions">
         <title>IndexOptions</title>
@@ -2080,23 +2139,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-usecanonicalname">
-        <title>UseCanonicalName</title>
-        <indexterm>
-          <primary><command>UseCanonicalName</command></primary>
-          <secondary>Apache configuration directive</secondary>
-        </indexterm>
-        <indexterm>
-          <primary>configuration directives, Apache</primary>
-          <secondary><command>UseCanonicalName</command></secondary>
-        </indexterm>
-        <para>
-          When set to <option>on</option>, this directive configures the Apache HTTP Server to reference itself using the value specified in the <command>ServerName</command> and <command>Port</command> directives. When <command>UseCanonicalName</command> is set to <option>off</option>, the server instead uses the value used by the requesting client when referring to itself.
-        </para>
-      </formalpara>
-      <para>
-        <command>UseCanonicalName</command> is set to <option>off</option> by default.
-      </para>
       <formalpara id="s2-apache-user">
         <title>User</title>
         <indexterm>


More information about the docs-commits mailing list