[deployment-guide/comm-rel: 376/727] Updated the Common Directives section.

Jaromir Hradilek jhradile at fedoraproject.org
Tue Oct 19 12:56:20 UTC 2010


commit c399b6a0fb34d0cb95aeee18ea28aea4379897bb
Author: Jaromir Hradilek <jhradile at redhat.com>
Date:   Mon Aug 16 13:49:17 2010 +0200

    Updated the Common Directives section.

 en-US/The_BIND_DNS_Server.xml |   35 +++++++++++++++++------------------
 1 files changed, 17 insertions(+), 18 deletions(-)
---
diff --git a/en-US/The_BIND_DNS_Server.xml b/en-US/The_BIND_DNS_Server.xml
index e1d5c59..939141a 100644
--- a/en-US/The_BIND_DNS_Server.xml
+++ b/en-US/The_BIND_DNS_Server.xml
@@ -1036,50 +1036,49 @@ options {
         <tertiary>zone file directives</tertiary>
       </indexterm>
       <para>
-        Directives begin with the dollar sign character (<command>$</command>) followed by the name of the directive. They usually appear at the top of the zone file.
-      </para>
-      <para>
-        The following are commonly used directives:
+        Directives begin with the dollar sign character (that is, <literal>$</literal>) followed by the name of the directive, and usually appear at the top of the file. The following directives are commonly used in zone files:
       </para>
       <variablelist>
         <varlistentry>
           <term><command>$INCLUDE</command></term>
           <listitem>
             <para>
-              Configures <command>named</command> to include another zone file in this zone file at the place where the directive appears. This allows additional zone settings to be stored apart from the main zone file.
+              The <command>$INCLUDE</command> directive allows you to include another file at the the place where it appears, so that other zone settings can be stored in a separate zone file.
             </para>
+            <example id="example-bind-zone-directive-include">
+              <title>Using the <command>$INCLUDE</command> directive</title>
+              <screen>$INCLUDE /var/named/penguin.example.com</screen>
+            </example>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term><command>$ORIGIN</command></term>
           <listitem>
             <para>
-              Appends the domain name to unqualified records, such as those with the hostname and nothing more.
-            </para>
-            <para>
-              For example, a zone file may contain the following line:
+              The <command>$ORIGIN</command> directive allows you to append the domain name to unqualified records, such as those with the hostname only. Note that the use of this directive is not necessary if the zone is specified in <filename>/etc/named.conf</filename>, since the zone name is used by default.
             </para>
-            <screen>$ORIGIN example.com.</screen>
             <para>
-              Any names used in resource records that do not end in a trailing period (<command>.</command>) are appended with <command>example.com</command>.
+              In <xref linkend="example-bind-zone-directive-origin" />, any names used in resource records that do not end in a trailing period (that is, the <literal>.</literal> character) are appended with <literal>example.com</literal>.
             </para>
-            <note>
-              <title>Note</title>
-              <para>
-                The use of the <command>$ORIGIN</command> directive is unnecessary if the zone is specified in <filename>/etc/named.conf</filename> because the zone name is used as the value for the <command>$ORIGIN</command> directive by default.
-              </para>
-            </note>
+            <example id="example-bind-zone-directive-origin">
+              <title>Using the <command>$ORIGIN</command> directive</title>
+              <screen>$ORIGIN example.com.</screen>
+            </example>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term><command>$TTL</command></term>
           <listitem>
             <para>
-              Sets the default <firstterm>Time to Live (TTL)</firstterm> value for the zone. This is the length of time, in seconds, that a zone resource record is valid. Each resource record can contain its own TTL value, which overrides this directive.
+              The <command>$TTL</command> directive allows you to set the default <firstterm>Time to Live</firstterm> (TTL) value for the zone, that is, how long is a zone record valid. Each resource record can contain its own TTL value, which overrides this directive.
             </para>
             <para>
               Increasing this value allows remote nameservers to cache the zone information for a longer period of time, reducing the number of queries for the zone and lengthening the amount of time required to proliferate resource record changes.
             </para>
+            <example id="example-bind-zone-directive-ttl">
+              <title>Using the <command>$TTL</command> directive</title>
+              <screen>$TTL 1D</screen>
+            </example>
           </listitem>
         </varlistentry>
       </variablelist>


More information about the docs-commits mailing list