From: Tomek Mrugalski <tomasz@isc.org>
Date: Tue, 14 Aug 2018 13:33:25 +0000 (+0200)
Subject: [gitlab3] Man pages updated.
X-Git-Tag: gitlab29-base~9
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b516cf883e4a515dd89c8a35a1d942b694edf189;p=thirdparty%2Fkea.git

[gitlab3] Man pages updated.
---

diff --git a/src/bin/admin/kea-admin.xml b/src/bin/admin/kea-admin.xml
index a4b126cdb4..9edc16452a 100644
--- a/src/bin/admin/kea-admin.xml
+++ b/src/bin/admin/kea-admin.xml
@@ -233,6 +233,11 @@
         <manvolnum>8</manvolnum>
       </citerefentry>,
 
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
       <citerefentry>
         <refentrytitle>keactrl</refentrytitle>
         <manvolnum>8</manvolnum>
diff --git a/src/bin/d2/kea-dhcp-ddns.xml b/src/bin/d2/kea-dhcp-ddns.xml
index 4297a0c824..248c0056f5 100644
--- a/src/bin/d2/kea-dhcp-ddns.xml
+++ b/src/bin/d2/kea-dhcp-ddns.xml
@@ -199,6 +199,11 @@
         <manvolnum>8</manvolnum>
       </citerefentry>,
 
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
       <citerefentry>
         <refentrytitle>perfdhcp</refentrytitle>
         <manvolnum>8</manvolnum>
diff --git a/src/bin/dhcp4/kea-dhcp4.xml b/src/bin/dhcp4/kea-dhcp4.xml
index 3ca921fb70..9b580d0519 100644
--- a/src/bin/dhcp4/kea-dhcp4.xml
+++ b/src/bin/dhcp4/kea-dhcp4.xml
@@ -204,6 +204,11 @@
         <manvolnum>8</manvolnum>
       </citerefentry>,
 
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
       <citerefentry>
         <refentrytitle>perfdhcp</refentrytitle>
         <manvolnum>8</manvolnum>
diff --git a/src/bin/dhcp6/kea-dhcp6.xml b/src/bin/dhcp6/kea-dhcp6.xml
index d4e167504c..5be6199bbc 100644
--- a/src/bin/dhcp6/kea-dhcp6.xml
+++ b/src/bin/dhcp6/kea-dhcp6.xml
@@ -204,6 +204,11 @@
         <manvolnum>8</manvolnum>
       </citerefentry>,
 
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
       <citerefentry>
         <refentrytitle>perfdhcp</refentrytitle>
         <manvolnum>8</manvolnum>
diff --git a/src/bin/keactrl/keactrl.xml b/src/bin/keactrl/keactrl.xml
index 8b20c41fe8..8aa002f2ba 100644
--- a/src/bin/keactrl/keactrl.xml
+++ b/src/bin/keactrl/keactrl.xml
@@ -258,6 +258,11 @@
         <manvolnum>8</manvolnum>
       </citerefentry>,
 
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
       <citerefentry>
         <refentrytitle>perfdhcp</refentrytitle>
         <manvolnum>8</manvolnum>
diff --git a/src/bin/lfc/kea-lfc.xml b/src/bin/lfc/kea-lfc.xml
index d2f5ed7ee4..d37c7c7cba 100644
--- a/src/bin/lfc/kea-lfc.xml
+++ b/src/bin/lfc/kea-lfc.xml
@@ -263,6 +263,11 @@
         <manvolnum>8</manvolnum>
       </citerefentry>,
 
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
       <citerefentry>
         <refentrytitle>keactrl</refentrytitle>
         <manvolnum>8</manvolnum>
diff --git a/src/bin/netconf/kea-netconf.xml b/src/bin/netconf/kea-netconf.xml
index 6b3b33e30d..e369f700bb 100644
--- a/src/bin/netconf/kea-netconf.xml
+++ b/src/bin/netconf/kea-netconf.xml
@@ -10,8 +10,8 @@
 
   <info>
     <productname>ISC Kea</productname>
-    <date>Oct. 27, 2017</date>
-    <edition>1.3.0</edition>
+    <date>Dec. 31, 3000</date>
+    <edition>1.5.0</edition>
     <author>
       <contrib>The Kea software has been written by a number of
         engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
@@ -29,13 +29,13 @@
   </refmeta>
 
   <refnamediv>
-    <refname>kea-dhcp4</refname>
-    <refpurpose>DHCPv4 server in Kea</refpurpose>
+    <refname>kea-netconf</refname>
+    <refpurpose>NETCONF agent for Kea environment</refpurpose>
   </refnamediv>
 
   <docinfo>
     <copyright>
-      <year>2011-2017</year>
+      <year>2018</year>
       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
     </copyright>
   </docinfo>
@@ -45,19 +45,16 @@
       <command>kea-dhcp4</command>
       <arg choice="opt" rep="norepeat"><option>-v</option></arg>
       <arg choice="opt" rep="norepeat"><option>-V</option></arg>
-      <arg choice="opt" rep="norepeat"><option>-W</option></arg>
       <arg choice="opt" rep="norepeat"><option>-d</option></arg>
       <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
-      <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">config-file</replaceable></option></arg>
-      <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port-number</replaceable></option></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
   <refsect1>
     <title>DESCRIPTION</title>
     <para>
-      The <command>kea-dhcp4</command> daemon provides the
-       DHCPv4 server implementation.
+      The <command>kea-netconf</command> daemon provides a YANG/NETCONF
+      interface for the Kea environment.
     </para>
 
   </refsect1>
@@ -83,12 +80,13 @@
         </para></listitem>
       </varlistentry>
 
+      <!-- not supported yet in kea-netconf
       <varlistentry>
         <term><option>-W</option></term>
         <listitem><para>
           Display the configuration report.
         </para></listitem>
-      </varlistentry>
+      </varlistentry> -->
 
       <varlistentry>
         <term><option>-d</option></term>
@@ -100,26 +98,7 @@
       <varlistentry>
         <term><option>-c</option></term>
         <listitem><para>
-          Configuration file including the configuration for DHCPv4 server.
-          It may also contain configuration entries for other Kea services.
-        </para></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><option>-t</option></term>
-        <listitem><para> Check the configuration file
-          and report the first error if any. Note
-          that not all parameters are completely checked, in
-          particular, service and control channel sockets
-          are not opened, and hook libraries are not loaded.
-        </para></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><option>-p</option></term>
-        <listitem><para>
-          Port number (1-65535) on which the server listens. This is useful
-          for testing purposes only.
+          Configuration file including the configuration for NETCONF daemon.
         </para></listitem>
       </varlistentry>
 
@@ -166,13 +145,10 @@
   <refsect1>
     <title>HISTORY</title>
     <para>
-      The <command>b10-dhcp4</command> daemon was first coded in
-      November 2011 by Tomek Mrugalski.
-    </para>
-    <para>
-      In the mid 2014 Kea was decoupled from the BIND10 framework and became a
-      standalone DHCP server. The DHCPv4 server binary was renamed to
-      kea-dhcp4. Kea 1.0.0 was released in December 2015.
+      Early prototypes of kea-netconf implementation were written during IETF
+      Hackathons in Berlin, London and Montreal. An actual production ready
+      implementation was started in August 2018 by Tomek Mrugalski and Francis
+      Dupont.
     </para>
   </refsect1>
 
diff --git a/src/bin/perfdhcp/perfdhcp.xml b/src/bin/perfdhcp/perfdhcp.xml
index 7b6bc3a787..44e289e045 100644
--- a/src/bin/perfdhcp/perfdhcp.xml
+++ b/src/bin/perfdhcp/perfdhcp.xml
@@ -959,6 +959,11 @@
         <manvolnum>8</manvolnum>
       </citerefentry>,
 
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
       <citerefentry>
         <refentrytitle>keactrl</refentrytitle>
         <manvolnum>8</manvolnum>