[deployment-guide/comm-rel: 369/727] Indexed the Common Statement Types section.

Jaromir Hradilek jhradile at fedoraproject.org
Tue Oct 19 12:55:43 UTC 2010


commit 0ec365d4c50e559947f949446864be3d95825c95
Author: Jaromir Hradilek <jhradile at redhat.com>
Date:   Fri Aug 13 19:11:20 2010 +0200

    Indexed the Common Statement Types section.

 en-US/The_BIND_DNS_Server.xml |   78 ++++++++++++++++++++++++++++-------------
 1 files changed, 53 insertions(+), 25 deletions(-)
---
diff --git a/en-US/The_BIND_DNS_Server.xml b/en-US/The_BIND_DNS_Server.xml
index ee6e6ba..b716a3a 100644
--- a/en-US/The_BIND_DNS_Server.xml
+++ b/en-US/The_BIND_DNS_Server.xml
@@ -301,7 +301,7 @@
     <note>
       <title>Note: Running BIND in a Chroot Environment</title>
       <para>
-        If you have installed the <package>bind-chroot</package> package, the BIND service will run in the <command>/var/named/chroot</command> environment. In that case, the initialization script will mount the above configuration files using the <command>mount --bind</command> command, so that you can manage the configuration outside this environment.
+        If you have installed the <package>bind-chroot</package> package, the BIND service will run in the <filename class="directory">/var/named/chroot</filename> environment. In that case, the initialization script will mount the above configuration files using the <command>mount --bind</command> command, so that you can manage the configuration outside this environment.
       </para>
     </note>
     <section id="s2-bind-namedconf-state">
@@ -311,10 +311,17 @@
       </para>
       <variablelist>
         <varlistentry>
-          <term><command>acl</command></term>
+          <term>
+            <indexterm>
+              <primary>BIND</primary>
+              <secondary>configuration</secondary>
+              <tertiary><option>acl</option> statement</tertiary>
+            </indexterm>
+            <option>acl</option>
+          </term>
           <listitem>
             <para>
-              The <command>acl</command> (Access Control List) statement allows you to define groups of hosts, so that they can be permitted or denied access to the nameserver. It takes the following form:
+              The <option>acl</option> (Access Control List) statement allows you to define groups of hosts, so that they can be permitted or denied access to the nameserver. It takes the following form:
             </para>
             <screen>acl <replaceable>acl-name</replaceable> {
   <replaceable>match-element</replaceable>;
@@ -375,10 +382,10 @@
               </tgroup>
             </table>
             <para>
-              The <command>acl</command> statement can be especially useful with conjunction with other statements such as <command>options</command>. <xref linkend="example-bind-namedconf-common-acl" /> defines two access control lists, <literal>black-hats</literal> and <literal>red-hats</literal>, and adds <literal>black-hats</literal> on the blacklist while granting <literal>red-hats</literal> a normal access.
+              The <option>acl</option> statement can be especially useful with conjunction with other statements such as <option>options</option>. <xref linkend="example-bind-namedconf-common-acl" /> defines two access control lists, <literal>black-hats</literal> and <literal>red-hats</literal>, and adds <literal>black-hats</literal> on the blacklist while granting <literal>red-hats</literal> a normal access.
             </para>
             <example id="example-bind-namedconf-common-acl">
-              <title>Using <command>acl</command> in conjunction with <command>options</command></title>
+              <title>Using <option>acl</option> in conjunction with <option>options</option></title>
               <screen>acl black-hats {
   10.0.2.0/24;
   192.168.0.0/24;
@@ -396,10 +403,17 @@ options {
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>include</command></term>
+          <term>
+            <indexterm>
+              <primary>BIND</primary>
+              <secondary>configuration</secondary>
+              <tertiary><option>include</option> statement</tertiary>
+            </indexterm>
+            <option>include</option>
+          </term>
           <listitem>
             <para>
-              The <command>include</command> statement allows you to include files in the <filename>/etc/named.conf</filename>, so that potentially sensitive data can be placed in a separate file with restricted permissions. It takes the following form:
+              The <option>include</option> statement allows you to include files in the <filename>/etc/named.conf</filename>, so that potentially sensitive data can be placed in a separate file with restricted permissions. It takes the following form:
             </para>
             <screen>include "<replaceable>file-name</replaceable>"</screen>
             <para>
@@ -412,10 +426,17 @@ options {
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>options</command></term>
+          <term>
+            <indexterm>
+              <primary>BIND</primary>
+              <secondary>configuration</secondary>
+              <tertiary><option>options</option> statement</tertiary>
+            </indexterm>
+            <option>options</option>
+          </term>
           <listitem>
             <para>
-              The <command>options</command> statement allows you to define global server configuration options as well as to set defaults for other statements. It can be used to specify the location of the <command>named</command> working directory, the types of queries allowed, and much more. It takes the following form:
+              The <option>options</option> statement allows you to define global server configuration options as well as to set defaults for other statements. It can be used to specify the location of the <systemitem class="service">named</systemitem> working directory, the types of queries allowed, and much more. It takes the following form:
             </para>
             <screen>options {
   <replaceable>option</replaceable>;
@@ -485,7 +506,7 @@ options {
                       <option>dnssec-validation</option>
                     </entry>
                     <entry>
-                      Specifies whether to prove that resource records are authentic via DNSSEC. The default option is <command>yes</command>.
+                      Specifies whether to prove that resource records are authentic via DNSSEC. The default option is <option>yes</option>.
                     </entry>
                   </row>
                   <row>
@@ -502,7 +523,7 @@ options {
                     </entry>
                     <entry>
                       <para>
-                        Specifies the behavior of the <command>forwarders</command> directive. It accepts the following options:
+                        Specifies the behavior of the <option>forwarders</option> directive. It accepts the following options:
                       </para>
                       <itemizedlist>
                         <listitem>
@@ -611,7 +632,7 @@ options {
               Refer to the <citetitle>BIND 9 Administrator Reference Manual</citetitle> referenced in <xref linkend="s2-bind-installed-docs" />, and the <filename>named.conf</filename> manual page for a complete list of available options.
             </para>
             <example id="example-bind-namedconf-common-options">
-              <title>Using the <command>options</command> statement</title>
+              <title>Using the <option>options</option> statement</title>
               <screen>options {
   allow-query       { localhost; };
   listen-on port    53 { 127.0.0.1; };
@@ -628,20 +649,27 @@ options {
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>zone</command></term>
+          <term>
+            <indexterm>
+              <primary>BIND</primary>
+              <secondary>configuration</secondary>
+              <tertiary><option>zone</option> statement</tertiary>
+            </indexterm>
+            <option>zone</option>
+          </term>
           <listitem>
             <para>
-              The <command>zone</command> statement allows you to define the characteristics of a zone, such as the location of its configuration file and zone-specific options, and can be used to override the global <command>options</command> statements. It takes the following form:
+              The <option>zone</option> statement allows you to define the characteristics of a zone, such as the location of its configuration file and zone-specific options, and can be used to override the global <option>options</option> statements. It takes the following form:
             </para>
             <screen>zone <replaceable>zone-name</replaceable> [<replaceable>zone-class</replaceable>] {
   <replaceable>option</replaceable>;
   ...
 };</screen>
             <para>
-              The <replaceable>zone-name</replaceable> attribute is the name of the zone, <replaceable>zone-class</replaceable> is the optional class of the zone, and <replaceable>option</replaceable> is a <command>zone</command> statement option as described in <xref linkend="table-bind-namedconf-common-zone" />.
+              The <replaceable>zone-name</replaceable> attribute is the name of the zone, <replaceable>zone-class</replaceable> is the optional class of the zone, and <replaceable>option</replaceable> is a <option>zone</option> statement option as described in <xref linkend="table-bind-namedconf-common-zone" />.
             </para>
             <para>
-              The <replaceable>zone-name</replaceable> attribute is particularly important, as it is the default value assigned for the <option>$ORIGIN</option> directive used within the corresponding zone file located in the <filename>/var/named/</filename> directory. The <systemitem class="service">named</systemitem> daemon appends the name of the zone to any non-fully qualified domain name listed in the zone file. For example, if a <command>zone</command> statement defines the namespace for <literal>example.com</literal>, use <literal>example.com</literal> as the <replaceable>zone-name</replaceable> so that it is placed at the end of hostnames within the <literal>example.com</literal> zone file.
+              The <replaceable>zone-name</replaceable> attribute is particularly important, as it is the default value assigned for the <option>$ORIGIN</option> directive used within the corresponding zone file located in the <filename>/var/named/</filename> directory. The <systemitem class="service">named</systemitem> daemon appends the name of the zone to any non-fully qualified domain name listed in the zone file. For example, if a <option>zone</option> statement defines the namespace for <literal>example.com</literal>, use <literal>example.com</literal> as the <replaceable>zone-name</replaceable> so that it is placed at the end of hostnames within the <literal>example.com</literal> zone file.
             </para>
             <para>
               For more information about zone files, refer to <xref linkend="s1-bind-zone" />.
@@ -750,27 +778,27 @@ options {
                       <itemizedlist>
                         <listitem>
                           <para>
-                            <command>delegation-only</command> — Enforces the delegation status of infrastructure zones such as COM, NET, or ORG. Any answer that is received without an explicit or implicit delegation is treated as <command>NXDOMAIN</command>. This option is only applicable in TLDs or root zone files used in recursive or caching implementations.
+                            <option>delegation-only</option> — Enforces the delegation status of infrastructure zones such as COM, NET, or ORG. Any answer that is received without an explicit or implicit delegation is treated as <literal>NXDOMAIN</literal>. This option is only applicable in TLDs or root zone files used in recursive or caching implementations.
                           </para>
                         </listitem>
                         <listitem>
                           <para>
-                            <command>forward</command> — Forwards all requests for information about this zone to other nameservers.
+                            <option>forward</option> — Forwards all requests for information about this zone to other nameservers.
                           </para>
                         </listitem>
                         <listitem>
                           <para>
-                            <command>hint</command> — A special type of zone used to point to the root nameservers which resolve queries when a zone is not otherwise known. No configuration beyond the default is necessary with a <command>hint</command> zone.
+                            <option>hint</option> — A special type of zone used to point to the root nameservers which resolve queries when a zone is not otherwise known. No configuration beyond the default is necessary with a <option>hint</option> zone.
                           </para>
                         </listitem>
                         <listitem>
                           <para>
-                            <command>master</command> — Designates the nameserver as authoritative for this zone. A zone should be set as the <command>master</command> if the zone's configuration files reside on the system.
+                            <option>master</option> — Designates the nameserver as authoritative for this zone. A zone should be set as the <option>master</option> if the zone's configuration files reside on the system.
                           </para>
                         </listitem>
                         <listitem>
                           <para>
-                            <command>slave</command> — Designates the nameserver as a slave server for this zone. Master server is specified in <command>masters</command> directive.
+                            <option>slave</option> — Designates the nameserver as a slave server for this zone. Master server is specified in <option>masters</option> directive.
                           </para>
                         </listitem>
                       </itemizedlist>
@@ -780,13 +808,13 @@ options {
               </tgroup>
             </table>
             <para>
-              Most changes to the <filename>/etc/named.conf</filename> file of a primary or secondary nameserver involve adding, modifying, or deleting <command>zone</command> statements, and only a small subset of <command>zone</command> statement options is usually needed for a nameserver to work efficiently.
+              Most changes to the <filename>/etc/named.conf</filename> file of a primary or secondary nameserver involve adding, modifying, or deleting <option>zone</option> statements, and only a small subset of <option>zone</option> statement options is usually needed for a nameserver to work efficiently.
             </para>
             <para>
               In <xref linkend="example-bind-namedconf-common-zone-primary" />, the zone is identified as <literal>example.com</literal>, the type is set to <literal>master</literal>, and the <systemitem class="service">named</systemitem> service is instructed to read the <filename>/var/named/example.com.zone</filename> file. It also allows only a secondary nameserver (<literal>192.168.0.2</literal>) to transfer the zone.
             </para>
             <example id="example-bind-namedconf-common-zone-primary">
-              <title>A <command>zone</command> statement for a primary nameserver</title>
+              <title>A <option>zone</option> statement for a primary nameserver</title>
               <screen>zone "example.com" IN {
   type master;
   file "example.com.zone";
@@ -794,13 +822,13 @@ options {
 };</screen>
             </example>
             <para>
-              A secondary server's <command>zone</command> statement is slightly different. The type is set to <literal>slave</literal>, and the <literal>masters</literal> directive is telling <command>named</command> the IP address of the master server.
+              A secondary server's <option>zone</option> statement is slightly different. The type is set to <literal>slave</literal>, and the <literal>masters</literal> directive is telling <systemitem class="service">named</systemitem> the IP address of the master server.
             </para>
             <para>
               In <xref linkend="example-bind-namedconf-common-zone-secondary" />, the <systemitem class="service">named</systemitem> service is configured to query the primary server at the <literal>192.168.0.1</literal> IP address for information about the <literal>example.com</literal> zone. The received information is then saved to the <filename>/var/named/slaves/example.com.zone</filename> file. Note that you have to put all slave zones to <filename>/var/named/slaves</filename> directory, otherwise the service will fail to transfer the zone.
             </para>
             <example id="example-bind-namedconf-common-zone-secondary">
-              <title>A <command>zone</command> statement for a secondary nameserver</title>
+              <title>A <option>zone</option> statement for a secondary nameserver</title>
               <screen>zone "example.com" {
   type slave;
   file "slaves/example.com.zone";


More information about the docs-commits mailing list