Browse Source

[master] various minor edits

Some capitalization, clarifications, add XML tag, etc.

I didn't get this reviewed; it is many minor edits.
Jeremy C. Reed 13 years ago
parent
commit
4089f1e72a
1 changed files with 23 additions and 16 deletions
  1. 23 16
      doc/guide/bind10-guide.xml

+ 23 - 16
doc/guide/bind10-guide.xml

@@ -36,8 +36,8 @@
     <abstract>
     <abstract>
       <para>BIND 10 is a framework that features Domain Name System
       <para>BIND 10 is a framework that features Domain Name System
       (DNS) suite and Dynamic Host Configuration Protocol (DHCP)
       (DNS) suite and Dynamic Host Configuration Protocol (DHCP)
-      servers managed by Internet Systems Consortium (ISC). It
-      includes DNS libraries, modular components for controlling
+      servers with development managed by Internet Systems Consortium (ISC).
+      It includes DNS libraries, modular components for controlling
       authoritative and recursive DNS servers, and experimental DHCPv4
       authoritative and recursive DNS servers, and experimental DHCPv4
       and DHCPv6 servers.
       and DHCPv6 servers.
       </para>
       </para>
@@ -59,6 +59,8 @@
     <section id="acknowledgements">
     <section id="acknowledgements">
       <title>Acknowledgements</title>
       <title>Acknowledgements</title>
 
 
+<!-- TODO: acknowledge all sponsors and CNNIC and CZNIC too -->
+
       <para>ISC would like to acknowledge generous support for
       <para>ISC would like to acknowledge generous support for
       BIND 10 development of DHCPv4 and DHCPv6 components provided
       BIND 10 development of DHCPv4 and DHCPv6 components provided
       by <ulink url="http://www.comcast.com/">Comcast</ulink>.</para>
       by <ulink url="http://www.comcast.com/">Comcast</ulink>.</para>
@@ -72,11 +74,13 @@
     <para>
     <para>
       BIND is the popular implementation of a DNS server, developer
       BIND is the popular implementation of a DNS server, developer
       interfaces, and DNS tools.
       interfaces, and DNS tools.
-      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.
+      BIND 10 is a rewrite of BIND 9 and ISC DHCP.
+      BIND 10 is written in C++ and Python and provides a modular
+      environment for serving, maintaining, and developing DNS and DHCP.
       BIND 10 provides a EDNS0- and DNSSEC-capable authoritative
       BIND 10 provides a EDNS0- and DNSSEC-capable authoritative
       DNS server and a caching recursive name server which also
       DNS server and a caching recursive name server which also
       provides forwarding.
       provides forwarding.
+      It also provides experimental DHCPv4 and DHCPv6 servers.
     </para>
     </para>
 
 
     <para>
     <para>
@@ -105,7 +109,7 @@
       <para>
       <para>
         BIND 10 requires at least Python 3.1
         BIND 10 requires at least Python 3.1
         (<ulink url="http://www.python.org/"/>).
         (<ulink url="http://www.python.org/"/>).
-        It has also been tested with Python 3.2.
+        It also works with Python 3.2.
       </para>
       </para>
 
 
       <para>
       <para>
@@ -118,6 +122,7 @@
         BIND 10 uses the log4cplus C++ logging library
         BIND 10 uses the log4cplus C++ logging library
         (<ulink url="http://log4cplus.sourceforge.net/"/>).
         (<ulink url="http://log4cplus.sourceforge.net/"/>).
         It requires at least log4cplus version 1.0.3.
         It requires at least log4cplus version 1.0.3.
+<!-- TODO: It is recommended to use at least version .... -->
       </para>
       </para>
 
 
       <para>
       <para>
@@ -218,8 +223,8 @@
             <simpara>
             <simpara>
               <command>b10-resolver</command> &mdash;
               <command>b10-resolver</command> &mdash;
               Recursive name server.
               Recursive name server.
-              This process handles incoming queries.
-<!-- TODO: -->
+              This process handles incoming DNS queries and provides
+              answers from its cache or by recursively doing remote lookups.
             </simpara>
             </simpara>
           </listitem>
           </listitem>
 
 
@@ -262,15 +267,14 @@
               <command>b10-xfrout</command> &mdash;
               <command>b10-xfrout</command> &mdash;
               Outgoing zone transfer service.
               Outgoing zone transfer service.
               This process is used to handle transfer requests to
               This process is used to handle transfer requests to
-              send a local zone to a remote secondary server,
-              when acting as a master server.
+              send a local zone to a remote secondary server.
             </simpara>
             </simpara>
           </listitem>
           </listitem>
 
 
           <listitem>
           <listitem>
             <simpara>
             <simpara>
               <command>b10-zonemgr</command> &mdash;
               <command>b10-zonemgr</command> &mdash;
-              Secondary manager.
+              Secondary zone manager.
               This process keeps track of timers and other
               This process keeps track of timers and other
               necessary information for BIND 10 to act as a slave server.
               necessary information for BIND 10 to act as a slave server.
             </simpara>
             </simpara>
@@ -280,8 +284,8 @@
       </para>
       </para>
 
 
       <para>
       <para>
-        These are ran automatically by <command>bind10</command>
-        and do not need to be run manually.
+        These are ran by <command>bind10</command>
+        and do not need to be manually started independently.
       </para>
       </para>
 
 
     </section>
     </section>
@@ -296,7 +300,7 @@
           <listitem>
           <listitem>
             <simpara>
             <simpara>
               <command>bindctl</command> &mdash;
               <command>bindctl</command> &mdash;
-              interactive administration interface.
+              Interactive administration interface.
               This is a low-level command-line tool which allows
               This is a low-level command-line tool which allows
               a developer or an experienced administrator to control
               a developer or an experienced administrator to control
               BIND 10.
               BIND 10.
@@ -305,7 +309,7 @@
           <listitem>
           <listitem>
             <simpara>
             <simpara>
               <command>b10-loadzone</command> &mdash;
               <command>b10-loadzone</command> &mdash;
-              zone file loader.
+              Zone file loader.
               This tool will load standard masterfile-format zone files into
               This tool will load standard masterfile-format zone files into
               BIND 10.
               BIND 10.
             </simpara>
             </simpara>
@@ -313,7 +317,7 @@
           <listitem>
           <listitem>
             <simpara>
             <simpara>
               <command>b10-cmdctl-usermgr</command> &mdash;
               <command>b10-cmdctl-usermgr</command> &mdash;
-              user access control.
+              User access control.
               This tool allows an administrator to authorize additional users
               This tool allows an administrator to authorize additional users
               to manage BIND 10.
               to manage BIND 10.
             </simpara>
             </simpara>
@@ -356,6 +360,7 @@ var/
       for C++ and Python for the message bus, configuration backend,
       for C++ and Python for the message bus, configuration backend,
       and, of course, DNS. These include detailed developer
       and, of course, DNS. These include detailed developer
       documentation and code examples.
       documentation and code examples.
+<!-- TODO: DHCP also but no Python yet. -->
 <!-- TODO point to this -->
 <!-- TODO point to this -->
     </para>
     </para>
 
 
@@ -369,7 +374,8 @@ var/
 
 
         <para>
         <para>
           In addition to the run-time requirements, building BIND 10
           In addition to the run-time requirements, building BIND 10
-          from source code requires various development include headers.
+          from source code requires various development include headers and
+          program development tools.
         </para>
         </para>
 
 
         <note>
         <note>
@@ -841,6 +847,7 @@ as a dependency earlier -->
         in usual way. This is the list of components that need to be started
         in usual way. This is the list of components that need to be started
         in a special way, with the value of special used for them:
         in a special way, with the value of special used for them:
         <table>
         <table>
+          <title>Special startup components</title>
           <tgroup cols='3' align='left'>
           <tgroup cols='3' align='left'>
           <colspec colname='component'/>
           <colspec colname='component'/>
           <colspec colname='special'/>
           <colspec colname='special'/>