[svn] commit: r1522 - /trunk/doc/userguide/userguide.xml

[BIND 10 source code commits]

Author: mgraff
Date: Thu Mar 18 17:31:17 2010
New Revision: 1522

Log:
rework parts; introduction is more of an introduction.  Checkpoint commit mostly to avoid lots of merge errors

Modified:
    trunk/doc/userguide/userguide.xml

Modified: trunk/doc/userguide/userguide.xml
==============================================================================
--- trunk/doc/userguide/userguide.xml (original)
+++ trunk/doc/userguide/userguide.xml Thu Mar 18 17:31:17 2010
@@ -21,56 +21,106 @@
     <para>
       BIND is the popular implementation of a DNS server, developer
       interfaces, and DNS tools.
-      BIND 10 is a rewrite, using C++ and Python, to provide
-      modular components for serving and maintaining DNS.
-    </para>
-
-    <note><para>BIND 10, at this time, does not provide an recursive
-      DNS server. It does provide a EDNS0- and DNSSEC-capable
-      authoritative DNS server.</para></note>
-
-    <note><para>This guide covers the experimental prototype version
-      of BIND 10.</para></note>
-
-    <para>
-      BIND 10 provides separate executables for different tasks.
-      The standard components include:
-
+      BIND 10 is a rewrite of BIND 9.  BIND 10 is written in C++ and Python
+      and provides a modular environment for serving and maintaining DNS.
+    </para>
+
+    <note>
+      <para>
+        This guide covers the experimental prototype version of
+        BIND 10.
+      </para>
+    </note>
+
+    <note>
+      <para>
+        BIND 10, at this time, does not provide an recursive
+        DNS server. It does provide a EDNS0- and DNSSEC-capable
+        authoritative DNS server.
+      </para>
+    </note>
+    
+    <para>
+      BIND 10 is modular.  Part of this modularity is
+      accomplished using multiple cooperating processes which, together,
+      provide DNS functionality.  This is a change from the previous generation
+      of BIND software, which used a single process.
+    </para>
+    
+    <para>
+      At first, running many different processes may seem confusing.  However,
+      these processes are started, stopped, and maintained by a single command,
+      <command>bind10</command>.  Additionally, most processes started by
+      the <command>bind10</command> command have names starting with "b10-",
+      with one exception, <command>msgq</command>.
+    </para>
+
+    <section id="starting_stopping">
+      <title>Starting and Stopping the Server</title>
+      
+      <para>
+        Starting and stopping the server is performed by a single command,
+        <command>bind10</command>.  This command starts a master process
+        which will start other processes as needed.
+      </para>
+      
+      <para>
+        Most of these are run automatically by a single command,
+        <command>bind10</command> and should not be run manually.
+
+        <itemizedlist>
+          <listitem>
+            <simpara>
+              <command>msgq</command> —
+              message bus daemon
+            </simpara>
+          </listitem>
+          <listitem>
+            <simpara>
+              <command>b10-auth</command> —
+              authoritative DNS server
+            </simpara>
+          </listitem>
+          <listitem>
+            <simpara>
+              <command>b10-cfgmgr</command> —
+              configuration manager
+            </simpara>
+          </listitem>
+          <listitem>
+            <simpara>
+              <command>b10-cmdctl</command> —
+              REST-ful communication service
+            </simpara>
+          </listitem>
+
+          <listitem>
+            <simpara>
+              <command>b10-xfrin</command> —
+              Incoming zone transfer service
+            </simpara>
+          </listitem>
+
+        </itemizedlist>
+      </para>
+    </section>
+
+    <para>
+      Once BIND 10 is running, two commands are used to interact directly with
+      the system:
       <itemizedlist>
-
-      <listitem>
-      <simpara><command>msgq</command> — message bus daemon</simpara>
-      </listitem>
-      <listitem>
-      <simpara><command>b10-auth</command> — authoritative DNS server</simpara>
-      </listitem>
-      <listitem>
-      <simpara><command>b10-cfgmgr</command> — configuration manager</simpara>
-      </listitem>
-      <listitem>
-      <simpara><command>b10-cmdctl</command> REST-ful communication service</simpara>
-      </listitem>
-
-      <listitem>
-      <simpara><command>b10-xfrin</command> Incoming zone transfer service</simpara>
-      </listitem>
-
-      <listitem>
-      <simpara><command>bind10</command> — master process for BIND 10</simpara>
-      </listitem>
-      </itemizedlist>
-    </para>
-
-    <para>
-      The user tools include:
-
-      <itemizedlist>
-      <listitem>
-      <simpara><command>bindctl</command> — interactive administration interface</simpara>
-      </listitem>
-      <listitem>
-      <simpara><command>b10-loadzone</command> — tool to load standard master zone files</simpara>
-      </listitem>
+        <listitem>
+          <simpara>
+            <command>bindctl</command> —
+            interactive administration interface
+          </simpara>
+        </listitem>
+        <listitem>
+          <simpara>
+            <command>b10-loadzone</command> —
+            tool to load standard master zone files
+          </simpara>
+        </listitem>
 <!-- TODO usermgr -->
       </itemizedlist>
     </para>