Browse Source

merge in trac3429

handled conflicts (keactl to keactrl)

Conflicts:
	doc/guide/ddns.xml
Jeremy C. Reed 10 years ago
parent
commit
4ddbfb3d05

+ 2 - 0
doc/Makefile.am

@@ -6,6 +6,8 @@ nobase_dist_doc_DATA  = examples/kea4/single-subnet.json
 nobase_dist_doc_DATA += examples/kea4/several-subnets.json
 nobase_dist_doc_DATA += examples/kea6/simple.json
 nobase_dist_doc_DATA += examples/kea6/several-subnets.json
+nobase_dist_doc_DATA += examples/ddns/sample1.json
+nobase_dist_doc_DATA += examples/ddns/template.json
 
 devel:
 	mkdir -p html

+ 16 - 16
doc/guide/config.xml

@@ -13,8 +13,8 @@
   made when the configure script is run.</para>
 
   <section id="bundy-backend">
-    <title>BIND 10 configuration backend</title>
-    <para>This legacy configuration backend allows Kea to use the former BIND10
+    <title>BUNDY configuration backend</title>
+    <para>This legacy configuration backend allows Kea to use the former BIND 10
     framework. That framework and this Kea configuration backend is no longer
     supported by ISC. It is currently developed as part of the Bundy project (see
     <ulink url="http://bundy-dns.de">Bundy homepage</ulink>). See the Bundy project
@@ -23,30 +23,30 @@
 
   <section id="json-backend">
     <title>JSON configuration backend</title>
-    <para>JSON is the default configuration backend and the only one supported
-    as of the 0.9 release. It assumes that the servers are started from the command line
-    (either directly or using a script, see TODO for details). The JSON backend uses
-    certain signals to influence Kea. The configuration file is
-    specified upon startup using -c parameter.</para>
+    <para>JSON is the default configuration backend.
+    It assumes that the servers are started from the command line
+    (either directly or using a script, e.g. <filename>keactrl</filename>).
+    The JSON backend uses certain signals to influence Kea. The
+    configuration file is specified upon startup using -c parameter.</para>
 
     <section id="json-format">
       <title>JSON syntax</title>
       <para>Configuration files for DHCPv4, DHCPv6 and DDNS modules are defined
       in an extended JSON format. Basic JSON is defined in <ulink
       url="http://tools.ietf.org/html/rfc4627">RFC 4627</ulink>.  Kea components
-      use a slightly modified JSON, in that they allowing bash-style
+      use a slightly modified JSON, in that they allow shell-style
       comments in the file: lines with the hash (#) character in the first column
       are comment lines and are ignored.</para>
 
       <para>The configuration file consists of a single object (often colloquially
       called a map) started with a curly bracket. It comprises the "Dhcp4", "Dhcp6",
       "DhcpDdns" and/or "Logging" objects. It is possible to define additional
-      elements, but they will be ignored. (That principle was chosen to ease
-      configuration management.) For example, it is possible to define Dhcp4,
-      Dhcp6 and Logging elements in a single configuration file that can be used to
-      start both the DHCPv4 and DHCPv6 components.  When starting, the DHCPv4 component
-      will use Dhcp4 object to configure itself and the Logging object to configure logging
-      parameters; it will ignore the Dhcp6 object.</para>
+      elements, but they will be ignored. For example, it is possible to define
+      Dhcp4, Dhcp6 and Logging elements in a single configuration file that can
+      be used to start both the DHCPv4 and DHCPv6 components. When starting,
+      the DHCPv4 component will use Dhcp4 object to configure itself and the
+      Logging object to configure logging parameters; it will ignore the Dhcp6
+      object.</para>
 
       <para>For example, a very simple configuration for both DHCPv4 and DHCPv6
       could look like this:
@@ -99,8 +99,8 @@
 </screen>
 	</para>
 
-        <para>More examples are available in the Kea source code in the
-        <filename>doc/examples</filename> directory.</para>
+        <para>More examples are available in the installed
+        <filename>share/doc/kea/examples</filename> directory.</para>
 
         <para>To avoid repetition of mostly similar structures, examples in the
         rest of this guide will showcase only the subset of parameters appropriate for a given

+ 9 - 8
doc/guide/ddns.xml

@@ -56,9 +56,9 @@
       and, due to the nature of DDNS, it is run alongside either the
       DHCPv4 or DHCPv6 components (or both).  Like other parts of
       Kea, is a separate binary that can be run on its own or through
-      <command>keactl</command> (see <xref linkend="keactrl"/>). In
+      <command>keactrl</command> (see <xref linkend="keactrl"/>). In
       normal operation, controlling <command>kea-dhcp-ddns</command>
-      with <command>keactl</command> is recommended. However, it is also
+      with <command>keactrl</command> is recommended. However, it is also
       possible to run the DHCP-DDNS server directly. It accepts the
       following command-line switches:
       </para>
@@ -200,14 +200,15 @@
 	</para>
 	<warning>
 	  <simpara>
-	    When the DHCP-DDNS server is configured to listen at an address
-	    other than the loopback address (127.0.0.1 or ::1), it is possible
-	    for a malicious attacker to send bogus NameChangeRequests to it
-	    and change entries in the DNS. For this reason, addresses other
-	    than the IPv4 or IPv6 loopback addresses should only be used
-	    for testing purposes. A future version of Kea will implement
+	    It is possible for a malicious attacker to send bogus
+	    NameChangeRequests to the DHCP-DDNS server.  Addresses
+	    other than the IPv4 or IPv6 loopback addresses (127.0.0.1
+	    or ::1) should only be used for testing purposes, but
+	    note that local users may still communicate with the
+	    DHCP-DDNS server.  A future version of Kea will implement
 	    authentication to guard against such attacks.
 	  </simpara>
+<!-- see ticket #3514 -->
 	</warning>
 <note>
 <simpara>

+ 38 - 26
doc/guide/dhcp4-srv.xml

@@ -14,7 +14,7 @@
 
       <para>
       It is recommended that the Kea DHCPv4 server be started and stopped
-      using <command>keactl</command> (described in <xref linkend="keactrl"/>).
+      using <command>keactrl</command> (described in <xref linkend="keactrl"/>).
       However, it is also possible to run the server directly: it accepts
       the following command-line switches:
       </para>
@@ -146,8 +146,8 @@ the configuration file must be a well formed JSON. That means that parameters
 for any given scope must be separate by a comma and there must not be a comma
 after the last parameter. When reordering configuration file, keep in mind that
 moving a parameter to or from the last position in a given scope may require
-moving the comma as well. The second caveat is that it is uncommon - although
-legal JSON - to
+moving the comma as well. The second caveat is that it is uncommon &mdash; although
+legal JSON &mdash; to
 repeat the same parameter multiple times. If that appears, the last occurrence of a
 given parameter in a given scope is used while all previous instances are
 ignored. This is unlikely to cause any confusion as there are no real life
@@ -172,7 +172,10 @@ use it for 4000 seconds. (Note that integer numbers are specified as is,
 without any quotes around them.) <command>renew-timer</command> and
 <command>rebind-timer</command> are values that
 define T1 and T2 timers that govern when the client will begin renewal and
-rebind procedures.</para>
+rebind procedures. Note that <command>renew-timer</command> and
+<command>rebind-timer</command> are optional. If they are not specified the
+client will select values for T1 and T2 timers according to the
+<ulink url="http://tools.ietf.org/html/rfc2131">RFC 2131</ulink>.</para>
 
 <para>The next couple lines define the lease database, the place where the server
 stores its lease information. This particular example tells the server to use
@@ -258,7 +261,9 @@ url="http://jsonviewer.stack.hu/"/>.
   parameters. Let's comment this out When default parameters are used, the
   Memfile backend will write leases to a disk in the
   [kea-install-dir]/var/kea/kea-leases4.csv. -->
-  The following configuration:
+  The following configuration sets the name of the lease file to
+  <filename>/tmp/kea-leases4.csv</filename>:
+
 <screen>
 "Dhcp4": {
     "lease-database": {
@@ -269,7 +274,6 @@ url="http://jsonviewer.stack.hu/"/>.
     ...
 }
 </screen>
-  ...sets the name of the lease file to /tmp/kea-leases4.csv.
   </para>
 
   <para>The "persist" parameter controls whether the leases are written to disk.
@@ -372,7 +376,9 @@ temporarily override a list of interface names and listen on all interfaces.
     manually specify a unique identifier for each subnet.
   </para>
       <para>
-        The following configuration:
+	The following configuration will assign the arbitrary subnet
+	identifier to the newly configured subnet:
+
         <screen>
 "Dhcp4": {
     "subnet4": [
@@ -382,7 +388,6 @@ temporarily override a list of interface names and listen on all interfaces.
     ]
 }
 </screen>
-    will assign the arbitrary subnet identifier to the newly configured subnet.
     This identifier will not change for this subnet unless the "id" parameter is
     removed or set to 0. The value of 0 forces auto-generation of the subnet
     identifier.
@@ -569,7 +574,7 @@ temporarily override a list of interface names and listen on all interfaces.
                 {
                     "name": "domain-name-servers",
                     "code": 6,
-                    "space: "dhcp4",
+                    "space": "dhcp4",
                     "csv-format": true,
                     "data": "192.0.2.3"
                 },
@@ -1089,8 +1094,8 @@ temporarily override a list of interface names and listen on all interfaces.
     value as well as the sub-options, the "type" value would have to be set to "uint16" in
     the option definition. (Such an option would then have the following
     data structure: DHCP header, uint16 value, sub-options.) The value specified
-    with the "data" parameter - which should be a valid integer enclosed in quotes,
-    e.g. "123" - would then be assigned to the uint16 field in the "container" option.
+    with the "data" parameter &mdash; which should be a valid integer enclosed in quotes,
+    e.g. "123" &mdash; would then be assigned to the uint16 field in the "container" option.
     </para>
     </section>
 
@@ -1223,7 +1228,7 @@ temporarily override a list of interface names and listen on all interfaces.
 "Dhcp4": {
     "subnet4": [
         {
-            <userinput>subnet: "192.0.2.0/24",
+            <userinput>"subnet": "192.0.2.0/24",
             "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ],
             "client-class": "VENDOR_CLASS_docsis3.0"</userinput>
         }
@@ -1268,7 +1273,7 @@ temporarily override a list of interface names and listen on all interfaces.
         "server-ip": "127.0.0.1",
         "server-port": 53001,
         "sender-ip": "",
-        "sender-port: 0,
+        "sender-port": 0,
         "max-queue-size": 1024,
         "ncr-protocol": "UDP",
         "ncr-format": "JSON",
@@ -1349,7 +1354,7 @@ temporarily override a list of interface names and listen on all interfaces.
       would be required:
 <screen>
 "Dhcp4": {
-    "dhcp-ddns: {
+    "dhcp-ddns": {
         <userinput>"server-ip": "192.168.1.10",
         "server-port": 900</userinput>,
         ...
@@ -1713,8 +1718,8 @@ temporarily override a list of interface names and listen on all interfaces.
         field of the DHCPv4 packet) to select the appropriate subnet.
       </para>
       <para>
-        However, that is not always the case. In certain uncommon - but
-        valid - deployments, the relay address may not match the subnet. This
+        However, that is not always the case. In certain uncommon &mdash;
+        valid &mdash; deployments, the relay address may not match the subnet. This
         usually means that there is more than one subnet allocated for a given
         link. The two most common examples where this is the case are long lasting
         network renumbering (where both old and new address space is still being
@@ -1732,7 +1737,7 @@ temporarily override a list of interface names and listen on all interfaces.
         It will also select that subnet for a relay with address 10.0.0.1.
 <screen>
 "Dhcp4": {
-    "subnet4: [
+    "subnet4": [
         {
             "subnet": "192.0.2.0/24",
             "pools": [ { "pool": "192.0.2.10 - 192.0.2.20" } ],
@@ -1768,7 +1773,7 @@ temporarily override a list of interface names and listen on all interfaces.
           10.1.1.1. The following configuration can serve that configuration:
 <screen>
 "Dhcp4": {
-    "subnet4: [
+    "subnet4": [
         {
             "subnet": "10.1.1.0/24",
             "pools":  [ { "pool": "10.1.1.2 - 10.1.1.20" } ],
@@ -1795,31 +1800,38 @@ temporarily override a list of interface names and listen on all interfaces.
 
 
     <section id="dhcp4-std">
-      <title>Supported Standards</title>
-      <para>The following standards and draft standards are currently supported:</para>
+      <title>Supported DHCP Standards</title>
+      <para>The following standards are currently supported:</para>
       <itemizedlist>
           <listitem>
-            <simpara><ulink url="http://tools.ietf.org/html/rfc2131">RFC 2131</ulink>: Supported messages are DISCOVER (1), OFFER (2),
+            <simpara><emphasis>Dynamic Host Configuration Protocol</emphasis>,
+            <ulink url="http://tools.ietf.org/html/rfc2131">RFC 2131</ulink>:
+            Supported messages are DISCOVER (1), OFFER (2),
             REQUEST (3), RELEASE (7), INFORM (8), ACK (5), and NAK(6).</simpara>
           </listitem>
           <listitem>
-            <simpara><ulink url="http://tools.ietf.org/html/rfc2132">RFC 2132</ulink>:
+            <simpara><emphasis>DHCP Options and BOOTP Vendor Extensions</emphasis>,
+            <ulink url="http://tools.ietf.org/html/rfc2132">RFC 2132</ulink>:
             Supported options are: PAD (0),
             END(255), Message Type(53), DHCP Server Identifier (54),
             Domain Name (15), DNS Servers (6), IP Address Lease Time
             (51), Subnet mask (1), and Routers (3).</simpara>
           </listitem>
           <listitem>
-            <simpara><ulink url="http://tools.ietf.org/html/rfc3046">RFC 3046</ulink>:
+            <simpara><emphasis>DHCP Relay Agent Information Option</emphasis>,
+            <ulink url="http://tools.ietf.org/html/rfc3046">RFC 3046</ulink>:
             Relay Agent Information option is supported.</simpara>
           </listitem>
           <listitem>
-            <simpara><ulink url="http://tools.ietf.org/html/rfc3925">RFC 3925</ulink>:
+            <simpara><emphasis>Vendor-Identifying Vendor Options for
+            Dynamic Host Configuration Protocol version 4</emphasis>,
+            <ulink url="http://tools.ietf.org/html/rfc3925">RFC 3925</ulink>:
             Vendor-Identifying Vendor Class and Vendor-Identifying Vendor-Specific
-            Information option are supported.</simpara>
+            Information options are supported.</simpara>
           </listitem>
           <listitem>
-            <simpara><ulink url="http://tools.ietf.org/html/rfc6842">RFC 6842</ulink>:
+            <simpara><emphasis>Client Identifier Option in DHCP Server Replies</emphasis>,
+            <ulink url="http://tools.ietf.org/html/rfc6842">RFC 6842</ulink>:
             Server by default sends back client-id option. That capability may be
             disabled. See <xref linkend="dhcp4-echo-client-id"/> for details.
             </simpara>

+ 39 - 26
doc/guide/dhcp6-srv.xml

@@ -12,7 +12,7 @@
 
       <para>
       It is recommended that the Kea DHCPv4 server be started and stopped
-      using <command>keactl</command> (described in <xref linkend="keactrl"/>).
+      using <command>keactrl</command> (described in <xref linkend="keactrl"/>).
       However, it is also possible to run the server directly: it accepts
       the following command-line switches:
       </para>
@@ -148,8 +148,8 @@ the configuration file must be a well formed JSON. That means that parameters
 for any given scope must be separate by a comma and there must not be a comma
 after the last parameter. When reordering configuration file, keep in mind that
 moving a parameter to or from the last position in a given scope may require
-moving the comma as well. The second caveat is that it is uncommon - although
-legal JSON - to
+moving the comma as well. The second caveat is that it is uncommon &mdash; although
+legal JSON &mdash; to
 repeat the same parameter multiple times. If that happens, the last occurrence of a
 given parameter in a given scope is used while all previous instances are
 ignored. This is unlikely to cause any confusion as there are no real life
@@ -265,7 +265,9 @@ JSON validator is available at <ulink url="http://jsonviewer.stack.hu/"/>.
   parameters. Let's comment this out When default parameters are used, the
   Memfile backend will write leases to a disk in the
   [kea-install-dir]/var/kea/kea-leases4.csv. -->
-  The following configuration:
+  The following configuration sets the name of the lease file to
+  <filename>/tmp/kea-leases6.csv</filename>:
+
 <screen>
 "Dhcp6": {
     "lease-database": {
@@ -276,7 +278,6 @@ JSON validator is available at <ulink url="http://jsonviewer.stack.hu/"/>.
     ...
 }
 </screen>
-  ...sets the name of the lease file to /tmp/kea-leases6.csv.
   </para>
 
   <para>The "persist" parameter controls whether the leases are written to disk.
@@ -379,7 +380,9 @@ temporarily override a list of interface names and listen on all interfaces.
       </para>
 
       <para>
-	The following configuration:
+	The following configuration will assign the arbitrary subnet
+	identifier to the newly configured subnet:
+
 	<screen>
 "Dhcp6": {
     "subnet6": [
@@ -389,7 +392,6 @@ temporarily override a list of interface names and listen on all interfaces.
     ]
 }
 </screen>
-        will assign the arbitrary subnet identifier to the newly configured subnet.
 	This identifier will not change for this subnet unless the "id" parameter is
 	removed or set to 0. The value of 0 forces auto-generation of the subnet
 	identifier.
@@ -455,7 +457,7 @@ temporarily override a list of interface names and listen on all interfaces.
            "subnet": "2001:db8:1::/64",
            "pools": [
                {
-                   pool: "2001:db8:1::1-2001:db8:1::ffff"
+                   "pool": "2001:db8:1::1-2001:db8:1::ffff"
                }
            ],
            ...
@@ -487,8 +489,8 @@ temporarily override a list of interface names and listen on all interfaces.
     {
         "subnet": "2001:db8:1::/64",
         "pools": [
-            { pool: "2001:db8:1::1-2001:db8:1::ffff" },
-            { pool: "2001:db8:1:05::/80" }
+            { "pool": "2001:db8:1::1-2001:db8:1::ffff" },
+            { "pool": "2001:db8:1:05::/80" }
         ]</userinput>,
         ...
     }
@@ -506,13 +508,13 @@ temporarily override a list of interface names and listen on all interfaces.
     {
         "subnet": "2001:db8:1::/64",
         "pools": [
-            { pool: "2001:db8:1::1-2001:db8:1::ffff" }
+            { "pool": "2001:db8:1::1-2001:db8:1::ffff" }
         ]
     },
     {
         "subnet": "2001:db8:2::/64",
         "pools": [
-            { pool: "2001:db8:2::/64" }
+            { "pool": "2001:db8:2::/64" }
         ]
     },
 </userinput>
@@ -664,7 +666,7 @@ temporarily override a list of interface names and listen on all interfaces.
                 {
                     "name": "dns-servers",
                     "code": 23,
-                    "space: "dhcp6",
+                    "space": "dhcp6",
                     "csv-format": true,
                     "data": "2001:db8:1::3"
                 },
@@ -1070,7 +1072,7 @@ should include options from the isc option space:
 
     Even though the "container" option does not carry any data except
     sub-options, the "data" field must be explicitly set to an empty value.
-    This is required because in the current version of BIND 10 DHCP, the default
+    This is required because in the current version of Kea, the default
     configuration values are not propagated to the configuration parsers: if the
     "data" is not set the parser will assume that this parameter is not
     specified and an error will be reported.
@@ -1082,8 +1084,8 @@ should include options from the isc option space:
     required to carry an uint16 value as well as the sub-options, the "type"
     value would have to be set to "uint16" in the option definition. (Such an
     option would then have the following data structure: DHCP header, uint16
-    value, sub-options.) The value specified with the "data" parameter - which
-    should be a valid integer enclosed in quotes, e.g. "123" - would then be
+    value, sub-options.) The value specified with the "data" parameter &mdash; which
+    should be a valid integer enclosed in quotes, e.g. "123" &mdash; would then be
     assigned to the uint16 field in the "container" option.
     </para>
     </section>
@@ -1306,7 +1308,7 @@ should include options from the isc option space:
         "server-ip": "127.0.0.1",
         "server-port": 53001,
         "sender-ip": "",
-        "sender-port: 0,
+        "sender-port": 0,
         "max-queue-size": 1024,
         "ncr-protocol": "UDP",
         "ncr-format": "JSON",
@@ -1379,7 +1381,7 @@ should include options from the isc option space:
       would be required:
 <screen>
 "Dhcp6": {
-    "dhcp-ddns: {
+    "dhcp-ddns": {
         <userinput>"server-ip": "2001:db8::5",
         "server-port": 900</userinput>,
         ...
@@ -1655,8 +1657,8 @@ should include options from the isc option space:
         It is unlikely that this parameter should ever need to be changed.
         However, if such a need arises, stop the server, edit the file and restart
         the server. (The file is named kea-dhcp6-serverid and by default is
-        stored in the "var" subdirectory of the directory in which BIND 10 is installed.
-        This can be changed when BIND 10 is built by using "--localstatedir"
+        stored in the "var" subdirectory of the directory in which Kea is installed.
+        This can be changed when Kea is built by using "--localstatedir"
         on the "configure" command line.)  The file is a text file that contains
         double digit hexadecimal values
         separated by colons. This format is similar to typical MAC address
@@ -1767,23 +1769,34 @@ should include options from the isc option space:
 
 
     <section id="dhcp6-std">
-      <title>Supported Standards</title>
-      <para>The following standards and draft standards are currently
+      <title>Supported DHCPv6 Standards</title>
+      <para>The following standards are currently
       supported:</para>
       <itemizedlist>
           <listitem>
-            <simpara><ulink url="http://tools.ietf.org/html/rfc3315">RFC 3315</ulink>: Supported messages are SOLICIT,
+            <simpara><emphasis>Dynamic Host Configuration Protocol for IPv6</emphasis>,
+            <ulink url="http://tools.ietf.org/html/rfc3315">RFC 3315</ulink>:
+            Supported messages are SOLICIT,
             ADVERTISE, REQUEST, RELEASE, RENEW, REBIND, CONFIRM and REPLY.</simpara>
           </listitem>
           <listitem>
-            <simpara><ulink url="http://tools.ietf.org/html/rfc3633">RFC 3633</ulink>: Supported options are IA_PD and
+            <simpara><emphasis>IPv6 Prefix Options for
+            Dynamic Host Configuration Protocol (DHCP) version 6</emphasis>,
+            <ulink url="http://tools.ietf.org/html/rfc3633">RFC 3633</ulink>:
+            Supported options are IA_PD and
             IA_PREFIX. Also supported is the status code NoPrefixAvail.</simpara>
           </listitem>
           <listitem>
-            <simpara><ulink url="http://tools.ietf.org/html/rfc3646">RFC 3646</ulink>: Supported option is DNS_SERVERS.</simpara>
+            <simpara><emphasis>DNS Configuration options for Dynamic Host
+            Configuration Protocol for IPv6 (DHCPv6)</emphasis>,
+            <ulink url="http://tools.ietf.org/html/rfc3646">RFC 3646</ulink>:
+            Supported option is DNS_SERVERS.</simpara>
           </listitem>
           <listitem>
-            <simpara><ulink url="http://tools.ietf.org/html/rfc4704">RFC 4704</ulink>: Supported option is CLIENT_FQDN.</simpara>
+            <simpara><emphasis>The Dynamic Host Configuration Protocol for IPv6 (DHCPv6) Client
+            Fully Qualified Domain Name (FQDN) Option</emphasis>,
+            <ulink url="http://tools.ietf.org/html/rfc4704">RFC 4704</ulink>:
+            Supported option is CLIENT_FQDN.</simpara>
           </listitem>
       </itemizedlist>
     </section>

+ 65 - 81
doc/guide/install.xml

@@ -30,52 +30,39 @@
         (all directories paths are relative to the installation directory):
         <itemizedlist>
           <listitem>
-           <simpara>
-              <filename>bin/</filename> &mdash;
-              general tools and diagnostic clients.
-            </simpara>
-          </listitem>
-          <listitem>
           <simpara>
-	    <!-- @todo: 0.9: update this -->
-            <filename>etc/bind10/</filename> &mdash;
+            <filename>etc/kea/</filename> &mdash;
             configuration files.
           </simpara>
           </listitem>
           <listitem>
             <simpara>
-              <filename>lib/</filename> &mdash;
-              libraries and python modules.
+              <filename>include/</filename> &mdash;
+              C++ development header files.
             </simpara>
           </listitem>
           <listitem>
             <simpara>
-	      <!-- @todo 0.9: update this -->
-              <filename>libexec/bind10/</filename> &mdash;
-              executables that a user wouldn't normally run directly and
-              are not run independently.
-              These are the BIND 10 and Kea modules which are daemons started by
-              the <command>b10-init</command> master process.
+              <filename>lib/</filename> &mdash;
+              libraries.
             </simpara>
           </listitem>
           <listitem>
             <simpara>
               <filename>sbin/</filename> &mdash;
-              commands used by the system administrator.
+              server software and commands used by the system administrator.
             </simpara>
           </listitem>
           <listitem>
             <simpara>
-	      <!-- @todo 0.9: update this -->
-              <filename>share/bind10/</filename> &mdash;
-              configuration specifications.
+              <filename>share/kea/</filename> &mdash;
+              configuration specifications and examples.
             </simpara>
           </listitem>
           <listitem>
             <simpara>
-	      <!-- @todo 0.9: update this -->
-              <filename>share/doc/bind10/</filename> &mdash;
-              this guide and other supplementary documentation.
+              <filename>share/doc/kea/</filename> &mdash;
+              this guide, other supplementary documentation, and examples.
             </simpara>
           </listitem>
           <listitem>
@@ -86,9 +73,8 @@
           </listitem>
           <listitem>
             <simpara>
-	      <!-- @todo 0.9: update this -->
-              <filename>var/bind10/</filename> &mdash;
-              data source and configuration databases.
+              <filename>var/kea/</filename> &mdash;
+              server identification, lease databases, and log files.
             </simpara>
           </listitem>
         </itemizedlist>
@@ -128,15 +114,13 @@
 
             <listitem>
         <para>
-          Botan (at least version
-          1.8).</para>
+          Botan (at least version 1.8) or OpenSSL.</para>
           </listitem>
 
           <listitem>
           <para>
             log4cplus (at least version 1.0.3)
           development include headers.
-	  <!-- @todo: Add OpenSSL note here once #2406 is merged -->
         </para>
         </listitem>
 
@@ -146,9 +130,6 @@ Debian and Ubuntu:
  libgmp3-dev and libbz2-dev required for botan too
 -->
 
-<!-- NOTE: _sqlite3 is only needed at test time; it is already listed
-as a dependency earlier -->
-
         <listitem>
         <para>
           A C++ compiler and
@@ -162,7 +143,7 @@ as a dependency earlier -->
         <listitem>
         <para>
           The development tools "make" and "pkg-config".
-	  <!-- @todo update this list -->
+	  <!-- @todo update this list, pkg-config shouldn't be required -->
         </para>
         </listitem>
 
@@ -179,8 +160,7 @@ as a dependency earlier -->
     <section id="install">
       <title>Installation from Source</title>
       <para>
-        Kea is open source software written in C++ (some components of the
-        BIND 10 framework are written in Python).
+        Kea is open source software written in C++.
         It is freely available in source code form from ISC as a
         downloadable tar file or via Kea Git code revision control
         service. (It may also be available in pre-compiled ready-to-use
@@ -191,10 +171,8 @@ as a dependency earlier -->
 
         <title>Download Tar File</title>
         <para>
-          Kea 0.8 is available as a part of BIND10 1.2 release, which is a final
-          release of BIND10 from ISC. This release can be downloaded from:
-          <ulink url="ftp://ftp.isc.org/isc/bind10/"/>. The upcoming Kea 0.9 and all
-	  following releases will be shipped as a stand-alone tarball.
+          The Kea release tarballs may be downloaded from:
+          <ulink url="http://ftp.isc.org/isc/kea/"/> (using FTP or HTTP).
         </para>
       </section>
 
@@ -279,11 +257,10 @@ as a dependency earlier -->
           </varlistentry>
 
           <varlistentry>
-            <term>--with-pythonpath</term>
+            <term>--with-botan-config</term>
             <listitem>
-              <simpara>Define the path to Python 3.x if it is not in the
-                standard execution path. Python 3.x is mandatory for Kea 0.8,
-		but will not be required for the upcoming Kea 0.9.
+              <simpara>To specific the path to the botan-config
+                script to build with Botan for the crypto code.
               </simpara>
             </listitem>
           </varlistentry>
@@ -301,6 +278,15 @@ as a dependency earlier -->
           </varlistentry>
 
           <varlistentry>
+            <term>--with-log4cplus</term>
+            <listitem>
+              <simpara>Define the path to find the Log4cplus headers
+                and libraries.
+              </simpara>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
             <term>--with-openssl</term>
             <listitem>
               <simpara>Replace Botan by OpenSSL for the crypto library.
@@ -310,8 +296,6 @@ as a dependency earlier -->
             </listitem>
           </varlistentry>
 
-<!-- missing -with-botan-config -->
-
           <varlistentry>
             <term>--without-werror</term>
             <listitem>
@@ -408,35 +392,36 @@ as a dependency earlier -->
       <para>Kea 0.9 introduces configuration backends that are
       switchable during compilation phase. The backend is chosen using
       the --with-kea-config switch when running the configure script. It
-      currently supports two values: BIND10 and JSON. This is currently
-      only supported by DHCPv6 component.</para>
+      currently supports two values: BUNDY and JSON. JSON is the default.
+      </para>
 
       <variablelist>
 
         <varlistentry>
-          <term>BIND10</term>
+          <term>BUNDY</term>
           <listitem>
-            <simpara>BIND10 (which is the default value as of April 2014) means
-            that Kea6 is linked with the BIND10 configuration backend that
-            connects to the BIND10 framework and in general works exactly the
-            same as Kea 0.8 and earlier versions. The benefits of that backend
-            are uniform integration with BIND10 framework, easy on-line
-            reconfiguration using bindctl, available RESTful API. On the other
-            hand, it requires the whole heavy BIND10 framework that requires
-            Python3 to be present. That backend is likely to go away with the
-            release of Kea 0.9.</simpara>
+            <simpara>BUNDY means
+            that Kea is linked with the Bundy configuration backend that
+            connects to the Bundy framework and in general works exactly the
+	    same as Kea 0.8 and earlier BIND10 versions. The benefits
+	    of that backend are uniform integration with the Bundy
+	    framework, easy on-line reconfiguration using bindctl,
+	    available RESTful API. On the other hand, it requires
+	    the whole heavy Bundy framework that requires Python3
+	    to be present. That backend is likely to go away with
+	    the release of Kea 1.0.</simpara>
           </listitem>
         </varlistentry>
 
         <varlistentry>
           <term>JSON</term>
           <listitem>
-            <simpara>JSON is a new configuration backend that causes Kea to read
-            JSON configuration file from disk. It does not require any framework
-            and thus is considered more lightweight. It will allow dynamic
-            on-line reconfiguration, but will lack remote capabilities (i.e. no
-            RESTful API). This configuration backend is expected to be the
-            default for upcoming Kea 0.9.</simpara>
+	    <simpara>JSON is a new default configuration backend
+	    that causes Kea to read JSON configuration file from
+	    disk. It does not require any framework and thus is
+	    considered more lightweight. It will allow dynamic
+	    on-line reconfiguration, but will lack remote capabilities
+	    (i.e. no RESTful API).</simpara>
           </listitem>
         </varlistentry>
       </variablelist>
@@ -450,8 +435,8 @@ as a dependency earlier -->
         a way that makes it possible to choose which database product should be used to
         store the lease information.  At present, Kea supports three database backends: MySQL,
         PostgreSQL and Memfile. To limit external dependencies, both MySQL and PostgreSQL
-        support are disabled by default and only Memfile (which is implemented in pure C++)
-        is available. Support for a given database backend must be explicitly included when
+        support are disabled by default and only Memfile
+        is available. Support for the optional external database backend must be explicitly included when
         Kea is built.  This section covers the building of Kea with MySQL and/or PostgreSQL
         and the creation of the lease database.
       </para>
@@ -463,14 +448,12 @@ as a dependency earlier -->
         </para>
         <para>
           Build and install Kea as described in <xref linkend="installation"/>, with
-          the following modification: to enable the MySQL database code, at the
-          "configure" step (see <xref linkend="configure"/>), specify the location of the
-          MySQL configuration program "mysql_config" with the "--with-dhcp-mysql" switch,
-          i.e.
+          the following modification. To enable the MySQL database code, at the
+          "configure" step (see <xref linkend="configure"/>), do:
           <screen><userinput>./configure [other-options] --with-dhcp-mysql</userinput></screen>
-          ...if MySQL was installed in the default location, or:
+	  Or specify the location of the MySQL configuration program
+	  "mysql_config" if MySQL was not installed in the default location:
           <screen><userinput>./configure [other-options] --with-dhcp-mysql=<replaceable>path-to-mysql_config</replaceable></userinput></screen>
-          ...if not.
         </para>
       </section>
       <section id="dhcp-mysql-database-create">
@@ -489,12 +472,13 @@ mysql></screen>
         <para>
           2. Create the database:
           <screen>mysql> <userinput>CREATE DATABASE <replaceable>database-name</replaceable>;</userinput></screen>
-          ... <replaceable>database-name</replaceable> is the name you have chosen for the database.
+	  (<replaceable>database-name</replaceable> is the name you
+	  have chosen for the database.)
         </para>
          <para>
           3. Create the database tables by running the dhcpdb_create.mysql script supplied as part of Kea:
           <screen>mysql> <userinput>CONNECT <replaceable>database-name</replaceable>;</userinput>
-mysql> <userinput>SOURCE <replaceable>path-to-bind10</replaceable>/share/bind10/dhcpdb_create.mysql</userinput></screen>
+mysql> <userinput>SOURCE <replaceable>path-to-kea</replaceable>/share/kea/dhcpdb_create.mysql</userinput></screen>
         </para>
          <para>
           4. Create the user under which Kea will access the database (and give it a password), then grant it access to the database tables:
@@ -518,14 +502,13 @@ $</screen>
         </para>
         <para>
           Build and install Kea as described in <xref linkend="installation"/>, with
-          the following modification: to enable the PostgreSQL database code, at the
-          "configure" step (see <xref linkend="configure"/>), specify the location of the
-          PostgreSQL configuration program "pg_config" with the "--with-dhcp-pgsql" switch,
-          i.e.
+          the following modification. To enable the PostgreSQL database code, at the
+          "configure" step (see <xref linkend="configure"/>), do:
           <screen><userinput>./configure [other-options] --with-dhcp-pgsql</userinput></screen>
-          ...if PostgreSQL was installed in the default location, or:
+	  Or specify the location of the PostgreSQL configuration
+	  program "pg_config" if PostgreSQL was not installed in
+	  the default location:
           <screen><userinput>./configure [other-options] --with-dhcp-pgsql=<replaceable>path-to-pg_config</replaceable></userinput></screen>
-          ...if not.
         </para>
       </section>
       <section id="dhcp-pgsql-database-create">
@@ -548,7 +531,8 @@ postgres=#<userinput> CREATE DATABASE <replaceable>database-name</replaceable>;<
 CREATE DATABASE
 postgres=#
 </screen>
-          ... <replaceable>database-name</replaceable> is the name you have chosen for the database.
+	  (<replaceable>database-name</replaceable> is the name you
+	  have chosen for the database.)
         </para>
          <para>
           3. Create the user under which Kea will access the database (and give it a password), then grant it access to the database:
@@ -571,7 +555,7 @@ $</screen>
         After entering the following command, you will be prompted for the new
         user's password. When the command completes you will be returned to
         the shell prompt. You should see output similar to following:
-<screen>$ <userinput>psql -d <replaceable>database-name</replaceable> -U <replaceable>user-name</replaceable> -f <replaceable>path-to-bind10</replaceable>/share/bind10/dhcpdb_create.pgsql</userinput>
+<screen>$ <userinput>psql -d <replaceable>database-name</replaceable> -U <replaceable>user-name</replaceable> -f <replaceable>path-to-kea</replaceable>/share/kea/dhcpdb_create.pgsql</userinput>
 Password for user <replaceable>user-name</replaceable>:
 CREATE TABLE
 CREATE INDEX

+ 18 - 151
doc/guide/intro.xml

@@ -18,26 +18,9 @@
       Kea was initially developed as a part of the BIND 10 framework
       (<ulink url="http://bind10.isc.org"/>). In early 2014, ISC
       made the decision to discontinue active development of BIND 10 and
-      continue development of Kea as standalone DHCP software. As a result,
-      the components and libraries related to the BIND10 framework and DNS
-      are going to be removed from the Kea source tree over time.
-      In order to remove the dependency on Python 3, the BIND 10 framework
-      will be replaced by the server startup and configuration mechanisms
-      written in C++.
+      continue development of Kea as standalone DHCP software.
     </para>
 
-    <note>
-      <simpara>Kea was implemented in the BIND 10 framework and to certain extent
-      still depends on various BIND 10 libraries. It also requires the BIND 10
-      framework to run, because the BIND 10 configuration mechanisms are used to
-      configure Kea. As a result, this document still refers to BIND 10 in many
-      paragraphs. The term "BIND 10" in the context of this document means
-      "BIND 10 libraries and applications which are necessary for Kea to run
-      and configure". The term "Kea" means "the collection of binaries and libraries
-      which, as a whole, implement the DHCP protocols".
-      </simpara>
-    </note>
-
     <para>
       This guide covers Kea version &__VERSION__;.
     </para>
@@ -70,29 +53,15 @@
       </para>
 
       <itemizedlist>
-        <listitem>
-            <simpara>
-        Kea was developed as a collection of applications within BIND
-        10 framework and it still relies on the remaining parts of
-        this framework. In particular, the servers' configuration and
-        startup are still facilitated by the modules which originate
-        in BIND 10. These modules require at least Python 3.1 to run.
-        They also work with Python 3.2, 3.3 or 3.4 (<ulink
-        url="http://www.python.org/"/>). The dependency on Python will
-        be removed once replacement configuration and startup
-        mechanisms are developed and released as Kea 0.9. At this
-        point Kea will be written in pure C++.
-            </simpara>
-        </listitem>
 
         <listitem>
             <simpara>
         Kea supports two crypto libraries: Botan and OpenSSL. Only one of them
-        is required during compilation. Kea uses the Botan crypto library for
-        C++ (<ulink url="http://botan.randombit.net/"/>), version 1.8 or
-        later. As an alternative to Botan, Kea can use the OpenSSL crypto
-        library (<ulink url="http://www.openssl.org/"/>).  It requires a version
-        with SHA-2 support.
+        is required to be installed during compilation. Kea uses the Botan
+        crypto library for C++ (<ulink url="http://botan.randombit.net/"/>),
+        version 1.8 or later. As an alternative to Botan, Kea can use the
+        OpenSSL crypto library (<ulink url="http://www.openssl.org/"/>).
+        It requires a version with SHA-2 support.
             </simpara>
         </listitem>
 
@@ -122,24 +91,13 @@
       </itemizedlist>
     </section>
 
-    <section id="starting_stopping">
-      <title>Starting and Stopping the Server</title>
-      <!-- @todo: Rewrite this section after #3422 is done -->
+    <section id="kea_software">
+      <title>Kea Software</title>
       <para>
         Kea is modular.  Part of this modularity is
         accomplished using multiple cooperating processes which, together,
         provide the server functionality.
-      </para>
-
-      <!-- @todo: Rename processes here, once they are renamed in the source -->
-      <para>
-        At first, running many different processes may seem confusing.
-        However, these processes are started by running a single
-	command, <command>bind10</command>.  This command starts
-	a master process, <command>b10-init</command>, which will
-	start other required processes and other processes when
-	configured.  The processes that may be started have names
-	starting with "kea-", including:
+        The following software is included with Kea:
       </para>
 
       <para>
@@ -148,17 +106,9 @@
 
           <listitem>
             <simpara>
-              <command>b10-cfgmgr</command> &mdash;
-              Configuration manager.
-              This process maintains all of the configuration for BIND 10.
-            </simpara>
-          </listitem>
-
-          <listitem>
-            <simpara>
-              <command>b10-cmdctl</command> &mdash;
-              Command and control service.
-              This process allows external control of the BIND 10 system.
+              <command>keactrl</command> &mdash;
+              Tool to start, stop, reconfigure, and report status
+              for the Kea servers.
             </simpara>
           </listitem>
 
@@ -190,75 +140,15 @@
 
           <listitem>
             <simpara>
-              <command>b10-msgq</command> &mdash;
-              Message bus daemon.
-              This process coordinates communication between all of the other
-              BIND 10 processes.
-            </simpara>
-          </listitem>
-
-          <listitem>
-            <simpara>
-              <command>kea-sockcreator</command> &mdash;
-              Socket creator daemon.
-              This process creates sockets used by
-              network-listening BIND 10 processes.
-            </simpara>
-          </listitem>
-
-          <listitem>
-            <simpara>
-              <command>b10-stats</command> &mdash;
-              Statistics collection daemon.
-              This process collects and reports statistics data.
-            </simpara>
-          </listitem>
-
-          <listitem>
-            <simpara>
-              <command>b10-stats-httpd</command> &mdash;
-              HTTP server for statistics reporting.
-              This process reports statistics data in XML format over HTTP.
+              <command>perfdhcp</command> &mdash;
+              DHCP benchmarking tool which simulates multiple clients to
+              test both DHCPv4 and DHCPv6 servers performance.
             </simpara>
           </listitem>
 
         </itemizedlist>
       </para>
 
-      <para>
-        These do not need to be manually started independently.
-      </para>
-
-    </section>
-
-    <section id="managing_once_running">
-      <title>Managing BIND 10</title>
-      <!-- @todo: Rewrite this section after #3422 is done -->
-
-      <para>
-        Once BIND 10 is running, a few commands are used to interact
-        directly with the system:
-        <itemizedlist>
-          <listitem>
-            <simpara>
-              <command>bindctl</command> &mdash;
-              Interactive administration interface.
-              This is a low-level command-line tool which allows
-              a developer or an experienced administrator to control
-              Kea.
-            </simpara>
-          </listitem>
-          <listitem>
-            <simpara>
-              <command>b10-cmdctl-usermgr</command> &mdash;
-              User access control.
-              This tool allows an administrator to authorize additional users
-              to manage Kea.
-            </simpara>
-          </listitem>
-  <!-- TODO usermgr -->
-        </itemizedlist>
-      </para>
     </section>
 
     <para>
@@ -267,33 +157,10 @@
       In addition, manual pages are also provided in the default installation.
     </para>
 
-<!--
-bin/
-  bindctl*
-  host*
-lib/
-  libauth
-  libdns
-  libexceptions
-  python3.1/site-packages/isc/{cc,config}
-sbin/
-  bind10
-share/
-  share/bind10/
-    auth.spec
-    b10-cmdctl.pem
-    init.spec
-    passwd.csv
-  man/
-var/
-  bind10/b10-config.db
--->
-
     <para>
-      BIND 10 also provides libraries and programmer interfaces
-      for C++ and Python for the message bus and configuration backend,
-      and, of course, DHCP. These include detailed developer
-      documentation and code examples.
+      Kea also provides C++ libraries and programmer interfaces for
+      DHCP.  These include detailed developer documentation and
+      code examples.
 <!-- TODO point to this -->
     </para>
 

+ 9 - 25
doc/guide/kea-guide.xml

@@ -74,17 +74,21 @@
     <chapter id="acknowledgements">
       <title>Acknowledgements</title>
 
+      <para>Kea is primarily designed, developed, and maintained by
+      Internet Systems Consortium, Inc. It is an open source project
+      and contributions are welcomed.</para>
+
       <para>Support for the development of the DHCPv4, DHCPv6 and
       DHCP-DDNS  components was provided by
       <ulink url="http://www.comcast.com/">Comcast</ulink>.</para>
 
       <para>Kea was initially implemented as a collection of applications
       within the BIND 10 framework. Hence, Kea development would not be
-      possible without the generous support of BIND 10 project sponsors.</para>
+      possible without the generous support of past BIND 10 project sponsors.</para>
 
       <para><ulink url="http://jprs.co.jp/">JPRS</ulink> and
-      <ulink url="http://cira.ca/">CIRA</ulink> are Patron Level
-      sponsors.</para>
+      <ulink url="http://cira.ca/">CIRA</ulink> were Patron Level
+      BIND 10 sponsors.</para>
 
       <para><ulink url="https://www.afnic.fr/">AFNIC</ulink>,
       <ulink url="https://www.cnnic.net.cn/">CNNIC</ulink>,
@@ -95,15 +99,13 @@
       <ulink url="https://registro.br/">Registro.br</ulink>,
       <ulink url="https://nzrs.net.nz/">.nz Registry Services</ulink>, and
       <ulink url="https://www.tcinet.ru/">Technical Center of Internet</ulink>
-      are current sponsors.</para>
+      were past BIND 10 sponsors.</para>
 
       <para><ulink url="https://www.afilias.info/">Afilias</ulink>,
       <ulink url="https://www.iis.se/">IIS.SE</ulink>,
       <ulink url="http://www.nominet.org.uk/">Nominet</ulink>, and
       <ulink url="https://www.sidn.nl/">SIDN</ulink> were founding
-      sponsors of the project.</para>
-
-<!-- DHCP sponsorship by Comcast -->
+      sponsors of the BIND 10 project.</para>
 
     </chapter>
 
@@ -116,21 +118,3 @@
   <!-- <index>    <title>Index</title> </index> -->
 
 </book>
-
-<!--
-
-TODO:
-
-Overview
-
-Getting BIND 10 Installed
-  Basics
-  Dependencies
-  Optional
-  Advanced
-
-How Does Everything Work Together?
-
-Need Help?
-
--->

+ 13 - 12
doc/guide/keactrl.xml

@@ -41,10 +41,11 @@ keactrl &lt;command&gt; [-c keactrl-config-file] [-s server[,server,..]]
 
       <para>
         The optional <command>-s server[,server ...]</command> switch selects
-        the servers to which the command is issued. If absent,
-        the command is sent to all servers enabled in the keactrl
-        configuration file. (<command>--server</command> is a synonym for
-        <command>-s</command>.) If multiple servers are specified, they
+        the servers to which the command is issued.
+        (<command>--server</command> is a synonym for <command>-s</command>.)
+        If absent, the command is sent to all servers enabled in the keactrl
+        configuration file.
+        If multiple servers are specified, they
         should be separated by commas with no intervening spaces.
       </para>
     </section>
@@ -214,23 +215,23 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf
       <para>
         The optional <command>-s</command> switch allows
         the selection of the servers to which <command>keactrl</command>
-        command is issued.  For example,
+        command is issued.  For example, the following
+        instructs <command>keactrl</command> to stop the
+        <command>kea-dhcp4</command> and <command>kea-dhcp6</command> servers
+        and leave the <command>kea-dhcp-ddns</command> server running:
 <screen>
 <userinput>$ keactrl stop -s dhcp4,dhcp6</userinput>
 </screen>
-        ... instructs <command>keactrl</command> to stop the
-        <command>kea-dhcp4</command> and <command>kea-dhcp6</command> servers
-        and leave the <command>kea-dhcp-ddns</command> running.
       </para>
 
       <para>
-        Similarly,
+        Similarly, the following
+        will only start the <command>kea-dhcp4</command> and
+        <command>kea-dhcp-ddns</command> servers and not
+        <command>kea-dhcp6</command>.
 <screen>
 <userinput>$ keactrl start -s dhcp4,dhcp_ddns</userinput>
 </screen>
-        ... will only start the <command>kea-dhcp4</command> and
-        <command>kea-dhcp-ddns</command> servers and not
-        <command>kea-dhcp6</command>.
       </para>
       <para>
         Note that the behavior of the <command>-s</command> switch

+ 2 - 2
doc/guide/logging.xml

@@ -469,7 +469,7 @@ file be created.</para>
         Note: the layout of messages written to the system logging
         file (syslog) may be slightly different.  This message has
         been split across two lines here for display reasons; in the
-        logging file, it will appear on one line.)
+        logging file, it will appear on one line.
       </para>
 
       <para>
@@ -495,7 +495,7 @@ file be created.</para>
           <term>[kea-dhcp4.dhcpsrv/27456]</term>
           <listitem><para>
             The source of the message.  This comprises two components:
-            the BIND 10 process generating the message (in this
+            the Kea process generating the message (in this
             case, <command>kea-dhcp4</command>) and the module
             within the program from which the message originated
             (which is the name of the common library used by DHCP server

+ 1 - 1
doc/guide/quickstart.xml

@@ -88,7 +88,7 @@ $ <userinput>./configure [your extra parameters]</userinput></screen>
           <orderedlist>
         <listitem>
           <para>Edit your configuration file for DHCPv6. <xref linkend="dhcp6-configuration"/>
-          describes the configuration ch, and some example DHCPv6 configuration can be found in
+          describes the configuration choices, and some example DHCPv6 configuration can be found in
           doc/examples/kea6.</para>
 	</listitem>
 

+ 1 - 1
src/bin/dhcp4/json_config_parser.cc

@@ -255,7 +255,7 @@ protected:
     }
 
     /// @brief Determines if the given option space name and code describe
-    /// a standard option for the DCHP4 server.
+    /// a standard option for the DHCP4 server.
     ///
     /// @param option_space is the name of the option space to consider
     /// @param code is the numeric option code to consider

+ 13 - 13
tools/system_messages.py

@@ -15,7 +15,7 @@
 # Produce System Messages Manual
 #
 # This tool reads all the .mes files in the directory tree whose root is given
-# on the command line and interprets them as BIND 10 message files.  It pulls
+# on the command line and interprets them as message files.  It pulls
 # all the messages and description out, sorts them by message ID, and writes
 # them out as a single (formatted) file.
 #
@@ -65,10 +65,10 @@ SEC_HEADER="""<?xml version="1.0" encoding="UTF-8"?>
      Do not edit this file.
 -->
 <book>
-  <?xml-stylesheet href="bind10-guide.css" type="text/css"?>
+  <?xml-stylesheet href="kea-guide.css" type="text/css"?>
 
   <bookinfo>
-    <title>BIND 10 Messages Manual</title>
+    <title>Kea Messages Manual</title>
 
     <copyright>
       <year>2011-2014</year><holder>Internet Systems Consortium, Inc.</holder>
@@ -76,14 +76,14 @@ SEC_HEADER="""<?xml version="1.0" encoding="UTF-8"?>
 
     <abstract>
       <para>
-        This is the messages manual for BIND 10 version &__VERSION__;.
+        This is the messages manual for Kea version &__VERSION__;.
 	    The most up-to-date version of this document, along with
-	    other documents for BIND 10, can be found at
-        <ulink url="http://bind10.isc.org/docs"/>.
+	    other documents for Kea, can be found at
+        <ulink url="http://kea.isc.org/docs"/>.
       </para>
     </abstract>
 
-    <releaseinfo>This is the messages manual for BIND 10 version
+    <releaseinfo>This is the messages manual for Kea version
         &__VERSION__;.</releaseinfo>
   </bookinfo>
 
@@ -91,7 +91,7 @@ SEC_HEADER="""<?xml version="1.0" encoding="UTF-8"?>
     <title>Introduction</title>
     <para>
       This document lists each message that can be logged by the
-      programs in the BIND 10 package.  Each entry in this manual
+      programs in the Kea package.  Each entry in this manual
       is of the form:
       <screen>IDENTIFICATION message-text</screen>
       ... where "IDENTIFICATION" is the message identification included
@@ -106,13 +106,13 @@ SEC_HEADER="""<?xml version="1.0" encoding="UTF-8"?>
       being logged.
     </para>
     <para>
-      For information on configuring and using BIND 10 logging,
-      refer to the <ulink url="bind10-guide.html">BIND 10 Guide</ulink>.
+      For information on configuring and using Kea logging,
+      refer to the <ulink url="kea-guide.html">Kea Guide</ulink>.
     </para>
   </chapter>
 
   <chapter id="messages">
-    <title>BIND 10 Messages</title>
+    <title>Kea Log Messages</title>
     <para>
       <variablelist>
 """
@@ -270,7 +270,7 @@ def addToDictionary(msgid, msgtext, desc, filename):
 
     # If the ID is in the dictionary, append a "(n)" to the name - this will
     # flag that there are multiple instances.  (However, this is an error -
-    # each ID should be unique in BIND-10.)
+    # each ID should be unique in the code.)
     if msgid in dictionary:
         i = 1
         while msgid + " (" + str(i) + ")" in dictionary:
@@ -371,7 +371,7 @@ def processAllFiles(root):
        calls processFile for all .mes files found.
 
        Parameters:
-       root     Directory that is the root of the BIND-10 source tree
+       root     Directory that is the root of the source tree
     """
     for (path, dirs, files) in os.walk(root):