]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[333-parser-libraries-for-servers] Added manual pages 333-parser-libraries-for-servers
authorFrancis Dupont <fdupont@isc.org>
Sat, 5 Jan 2019 16:33:04 +0000 (17:33 +0100)
committerFrancis Dupont <fdupont@isc.org>
Sat, 5 Jan 2019 16:33:04 +0000 (17:33 +0100)
src/bin/agent/tools/Makefile.am
src/bin/agent/tools/tools-ca.xml [new file with mode: 0644]
src/bin/d2/tools/Makefile.am
src/bin/d2/tools/tools2.xml [new file with mode: 0644]
src/bin/dhcp4/tools/Makefile.am
src/bin/dhcp4/tools/tools4.xml [new file with mode: 0644]
src/bin/dhcp6/tools/Makefile.am
src/bin/dhcp6/tools/tools6.xml [new file with mode: 0644]
src/bin/netconf/tools/Makefile.am
src/bin/netconf/tools/tools-nc.xml [new file with mode: 0644]

index 6d8861260ccf8703a8a8a44263646c5b9bfab00f..9a272b129bb8677dd54f998eb574485835ebae2e 100644 (file)
@@ -4,8 +4,30 @@ AM_CPPFLAGS += -I$(top_srcdir)/src/bin -I$(top_builddir)/src/bin
 AM_CPPFLAGS += $(BOOST_INCLUDES)
 #AM_CPPFLAGS += $(SYSREPO_CPPFLAGS)
 
+if USE_STATIC_LINK
+AM_LDFLAGS = -static
+endif
+
 CLEANFILES = *.gcno *.gcda
 
+man_MANS = tools-ca.8
+DISTCLEANFILES = $(man_MANS)
+EXTRA_DIST = $(man_MANS) tools-ca.xml
+
+if GENERATE_DOCS
+tools-ca.8: tools-ca.xml
+       @XSLTPROC@ --novalid --xinclude --nonet -o $@ \
+       http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl \
+       $(srcdir)/tools-ca.xml
+
+else
+
+$(man_MANS):
+       @echo Man generation disabled.  Creating dummy $@.  Configure with --enable-generate-docs to enable it.
+       @echo Man generation disabled.  Remove this file, configure with --enable-generate-docs, and rebuild Kea > $@
+
+endif
+
 sbin_PROGRAMS = parser-ca
 #sbin_PROGRAMS += to-yang from-yang
 
diff --git a/src/bin/agent/tools/tools-ca.xml b/src/bin/agent/tools/tools-ca.xml
new file mode 100644 (file)
index 0000000..d4b54af
--- /dev/null
@@ -0,0 +1,150 @@
+<!--
+ - Copyright (C) 2019 Internet Systems Consortium, Inc. ("ISC")
+ -
+ - This Source Code Form is subject to the terms of the Mozilla Public
+ - License, v. 2.0. If a copy of the MPL was not distributed with this
+ - file, You can obtain one at http://mozilla.org/MPL/2.0/.
+-->
+<!-- Converted by db4-upgrade version 1.1 -->
+<refentry>
+
+  <info>
+    <productname>ISC Kea</productname>
+    <date>Jan 5, 2019</date>
+    <edition>1.6.0</edition>
+    <author>
+      <contrib>The Kea software has been written by a number of
+        engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
+        Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed,
+        Wlodek Wencel and Shawn Routhier.  That list is roughly in the
+        chronological order in which the authors made their first
+        contribution. For a complete list of authors and
+        contributors, see AUTHORS file.</contrib><orgname>Internet Systems Consortium, Inc.</orgname></author>
+  </info>
+
+  <refmeta>
+    <refentrytitle>tools-ca</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="manual">Kea</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>tools-ca</refname>
+    <refpurpose>Control-agent configuration tools</refpurpose>
+  </refnamediv>
+
+  <docinfo>
+    <copyright>
+      <year>2019</year>
+      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
+    </copyright>
+  </docinfo>
+
+  <refsynopsisdiv>
+    <cmdsynopsis sepchar=" ">
+      <command>parser-ca</command>
+      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
+      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
+      <arg choice="req" rep="norepeat"><option>-i <replaceable class="parameter">input-file</replaceable></option></arg>
+      <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">output-file</replaceable></option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para>
+      The <command>parser-ca</command> tool reads a configuration file
+      for <command>kea-ctrl-agent</command> and pretty prints the result of
+       the flex/bison AGENT parser.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>ARGUMENTS</title>
+
+    <para>The arguments are as follows:</para>
+
+    <variablelist>
+
+      <varlistentry>
+        <term><option>-v</option></term>
+        <listitem><para>
+          Display the version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-V</option></term>
+        <listitem><para>
+          Display the extended version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-i</option></term>
+        <listitem><para>
+          The input configuration file.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-o</option></term>
+        <listitem><para>
+          The output configuration file. When it is not given the
+          parsed configuration is written on the standard output.
+        </para></listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>DOCUMENTATION</title>
+    <para>Kea comes with an extensive Kea User's Guide documentation
+      that covers all aspects of running the Kea software -
+      compilation, installation, configuration, configuration examples
+      and many more. Kea also features a Kea Messages Manual, which
+      lists all possible messages Kea can print with a brief
+      description for each of them. Both documents are typically
+      available in various formats (txt, html, pdf) with your Kea
+      distribution. The Kea documentation is available at
+      https://kb.isc.org/docs/kea-administrator-reference-manual .</para>
+    <para>
+      Kea source code is documented in the Kea Developer's Guide. Its
+      on-line version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
+    </para>
+    <para>
+      Kea project website is available at: https://kea.isc.org.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>MAILING LISTS AND SUPPORT</title>
+    <para>
+      There are two mailing lists available for Kea project. kea-users
+      (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
+      (kea-dev at lists.isc.org) is intended for Kea developers, prospective
+      contributors and other advanced users.  Both lists are available at
+      http://lists.isc.org. The community provides best effort type of support
+      on both of those lists.
+    </para>
+    <para>
+      ISC provides professional support for Kea services. See
+      https://www.isc.org/kea/ for details.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>kea-ctrl-agent</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
+      <citetitle>Kea Administrator's Guide</citetitle>.
+
+    </para>
+  </refsect1>
+
+</refentry>
index 467048da5e6085e7356d39046a81b831aa1e5fc7..939fa3899e527f11391a81133770c4dff7cb2275 100644 (file)
@@ -4,8 +4,30 @@ AM_CPPFLAGS += -I$(top_srcdir)/src/bin -I$(top_builddir)/src/bin
 AM_CPPFLAGS += $(BOOST_INCLUDES)
 #AM_CPPFLAGS += $(SYSREPO_CPPFLAGS)
 
+if USE_STATIC_LINK
+AM_LDFLAGS = -static
+endif
+
 CLEANFILES = *.gcno *.gcda
 
+man_MANS = tools2.8
+DISTCLEANFILES = $(man_MANS)
+EXTRA_DIST = $(man_MANS) tools2.xml
+
+if GENERATE_DOCS
+tools2.8: tools2.xml
+       @XSLTPROC@ --novalid --xinclude --nonet -o $@ \
+       http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl \
+       $(srcdir)/tools2.xml
+
+else
+
+$(man_MANS):
+       @echo Man generation disabled.  Creating dummy $@.  Configure with --enable-generate-docs to enable it.
+       @echo Man generation disabled.  Remove this file, configure with --enable-generate-docs, and rebuild Kea > $@
+
+endif
+
 sbin_PROGRAMS = parser2
 #sbin_PROGRAMS += to-yang from-yang
 
diff --git a/src/bin/d2/tools/tools2.xml b/src/bin/d2/tools/tools2.xml
new file mode 100644 (file)
index 0000000..019a44a
--- /dev/null
@@ -0,0 +1,150 @@
+<!--
+ - Copyright (C) 2019 Internet Systems Consortium, Inc. ("ISC")
+ -
+ - This Source Code Form is subject to the terms of the Mozilla Public
+ - License, v. 2.0. If a copy of the MPL was not distributed with this
+ - file, You can obtain one at http://mozilla.org/MPL/2.0/.
+-->
+<!-- Converted by db4-upgrade version 1.1 -->
+<refentry>
+
+  <info>
+    <productname>ISC Kea</productname>
+    <date>Jan 5, 2019</date>
+    <edition>1.6.0</edition>
+    <author>
+      <contrib>The Kea software has been written by a number of
+        engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
+        Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed,
+        Wlodek Wencel and Shawn Routhier.  That list is roughly in the
+        chronological order in which the authors made their first
+        contribution. For a complete list of authors and
+        contributors, see AUTHORS file.</contrib><orgname>Internet Systems Consortium, Inc.</orgname></author>
+  </info>
+
+  <refmeta>
+    <refentrytitle>tools2</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="manual">Kea</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>tools2</refname>
+    <refpurpose>DHCP-DDNS configuration tools</refpurpose>
+  </refnamediv>
+
+  <docinfo>
+    <copyright>
+      <year>2019</year>
+      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
+    </copyright>
+  </docinfo>
+
+  <refsynopsisdiv>
+    <cmdsynopsis sepchar=" ">
+      <command>parser2</command>
+      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
+      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
+      <arg choice="req" rep="norepeat"><option>-i <replaceable class="parameter">input-file</replaceable></option></arg>
+      <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">output-file</replaceable></option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para>
+      The <command>parser2</command> tool reads a configuration file
+      for <command>kea-dhcp-ddns</command> and pretty prints the result of
+       the flex/bison DHCP-DDNS parser.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>ARGUMENTS</title>
+
+    <para>The arguments are as follows:</para>
+
+    <variablelist>
+
+      <varlistentry>
+        <term><option>-v</option></term>
+        <listitem><para>
+          Display the version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-V</option></term>
+        <listitem><para>
+          Display the extended version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-i</option></term>
+        <listitem><para>
+          The input configuration file.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-o</option></term>
+        <listitem><para>
+          The output configuration file. When it is not given the
+          parsed configuration is written on the standard output.
+        </para></listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>DOCUMENTATION</title>
+    <para>Kea comes with an extensive Kea User's Guide documentation
+      that covers all aspects of running the Kea software -
+      compilation, installation, configuration, configuration examples
+      and many more. Kea also features a Kea Messages Manual, which
+      lists all possible messages Kea can print with a brief
+      description for each of them. Both documents are typically
+      available in various formats (txt, html, pdf) with your Kea
+      distribution. The Kea documentation is available at
+      https://kb.isc.org/docs/kea-administrator-reference-manual .</para>
+    <para>
+      Kea source code is documented in the Kea Developer's Guide. Its
+      on-line version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
+    </para>
+    <para>
+      Kea project website is available at: https://kea.isc.org.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>MAILING LISTS AND SUPPORT</title>
+    <para>
+      There are two mailing lists available for Kea project. kea-users
+      (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
+      (kea-dev at lists.isc.org) is intended for Kea developers, prospective
+      contributors and other advanced users.  Both lists are available at
+      http://lists.isc.org. The community provides best effort type of support
+      on both of those lists.
+    </para>
+    <para>
+      ISC provides professional support for Kea services. See
+      https://www.isc.org/kea/ for details.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>kea-dhcp-ddns</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
+      <citetitle>Kea Administrator's Guide</citetitle>.
+
+    </para>
+  </refsect1>
+
+</refentry>
index 9204aa376b5adbb53e32464854e0c92deb11b2a1..e0c348f821d9e3234c2d83522a235bfd42e09e9d 100644 (file)
@@ -6,8 +6,30 @@ if HAVE_SYSREPO
 AM_CPPFLAGS += $(SYSREPO_CPPFLAGS)
 endif
 
+if USE_STATIC_LINK
+AM_LDFLAGS = -static
+endif
+
 CLEANFILES = *.gcno *.gcda
 
+man_MANS = tools4.8
+DISTCLEANFILES = $(man_MANS)
+EXTRA_DIST = $(man_MANS) tools4.xml
+
+if GENERATE_DOCS
+tools4.8: tools4.xml
+       @XSLTPROC@ --novalid --xinclude --nonet -o $@ \
+       http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl \
+       $(srcdir)/tools4.xml
+
+else
+
+$(man_MANS):
+       @echo Man generation disabled.  Creating dummy $@.  Configure with --enable-generate-docs to enable it.
+       @echo Man generation disabled.  Remove this file, configure with --enable-generate-docs, and rebuild Kea > $@
+
+endif
+
 sbin_PROGRAMS = parser4
 if HAVE_SYSREPO
 sbin_PROGRAMS += import-to-yang4 export-from-yang4
@@ -28,20 +50,23 @@ import_to_yang4_LDADD  = $(top_builddir)/src/bin/dhcp4/libparser4.la
 import_to_yang4_LDADD += $(top_builddir)/src/lib/yang/libkea-yang.la
 import_to_yang4_LDADD += $(top_builddir)/src/lib/cc/libkea-cc.la
 import_to_yang4_LDADD += $(top_builddir)/src/lib/asiolink/libkea-asiolink.la
+import_to_yang4_LDADD += $(top_builddir)/src/lib/log/libkea-log.la
+import_to_yang4_LDADD += $(top_builddir)/src/lib/util/threads/libkea-threads.la
 import_to_yang4_LDADD += $(top_builddir)/src/lib/util/libkea-util.la
 import_to_yang4_LDADD += $(top_builddir)/src/lib/exceptions/libkea-exceptions.la
-import_to_yang4_LDADD += $(BOOST_LIBS)
+import_to_yang4_LDADD += $(LOG4CPLUS_LIBS) $(BOOST_LIBS)
 import_to_yang4_LDADD += $(SYSREPO_LIBS)
 import_to_yang4_LDFLAGS = $(AM_LDFLAGS)
 
 export_from_yang4_SOURCES = export_from_yang4.cc
-export_from_yang4_LDADD  = $(top_builddir)/src/bin/dhcp4/libparser4.la
-export_from_yang4_LDADD += $(top_builddir)/src/lib/yang/libkea-yang.la
+export_from_yang4_LDADD  = $(top_builddir)/src/lib/yang/libkea-yang.la
 export_from_yang4_LDADD += $(top_builddir)/src/lib/cc/libkea-cc.la
 export_from_yang4_LDADD += $(top_builddir)/src/lib/asiolink/libkea-asiolink.la
+export_from_yang4_LDADD += $(top_builddir)/src/lib/log/libkea-log.la
+export_from_yang4_LDADD += $(top_builddir)/src/lib/util/threads/libkea-threads.la
 export_from_yang4_LDADD += $(top_builddir)/src/lib/util/libkea-util.la
 export_from_yang4_LDADD += $(top_builddir)/src/lib/exceptions/libkea-exceptions.la
-export_from_yang4_LDADD += $(BOOST_LIBS)
+export_from_yang4_LDADD += $(LOG4CPLUS_LIBS) $(BOOST_LIBS)
 export_from_yang4_LDADD += $(SYSREPO_LIBS)
 export_from_yang4_LDFLAGS = $(AM_LDFLAGS)
 endif
diff --git a/src/bin/dhcp4/tools/tools4.xml b/src/bin/dhcp4/tools/tools4.xml
new file mode 100644 (file)
index 0000000..f28d69f
--- /dev/null
@@ -0,0 +1,196 @@
+<!--
+ - Copyright (C) 2019 Internet Systems Consortium, Inc. ("ISC")
+ -
+ - This Source Code Form is subject to the terms of the Mozilla Public
+ - License, v. 2.0. If a copy of the MPL was not distributed with this
+ - file, You can obtain one at http://mozilla.org/MPL/2.0/.
+-->
+<!-- Converted by db4-upgrade version 1.1 -->
+<refentry>
+
+  <info>
+    <productname>ISC Kea</productname>
+    <date>Jan 5, 2019</date>
+    <edition>1.6.0</edition>
+    <author>
+      <contrib>The Kea software has been written by a number of
+        engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
+        Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed,
+        Wlodek Wencel and Shawn Routhier.  That list is roughly in the
+        chronological order in which the authors made their first
+        contribution. For a complete list of authors and
+        contributors, see AUTHORS file.</contrib><orgname>Internet Systems Consortium, Inc.</orgname></author>
+  </info>
+
+  <refmeta>
+    <refentrytitle>tools4</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="manual">Kea</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>tools4</refname>
+    <refpurpose>DHCPv4 configuration tools</refpurpose>
+  </refnamediv>
+
+  <docinfo>
+    <copyright>
+      <year>2019</year>
+      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
+    </copyright>
+  </docinfo>
+
+  <refsynopsisdiv>
+    <cmdsynopsis sepchar=" ">
+      <command>parser4</command>
+      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
+      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
+      <arg choice="req" rep="norepeat"><option>-i <replaceable class="parameter">input-file</replaceable></option></arg>
+      <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">output-file</replaceable></option></arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>import-to-yang4</command>
+      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
+      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
+      <arg choice="req" rep="norepeat"><option>-i <replaceable class="parameter">input-file</replaceable></option></arg>
+      <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">model</replaceable></option></arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>export-from-yang4</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>-m <replaceable class="parameter">model</replaceable></option></arg>
+      <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">output-file</replaceable></option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para>
+      The <command>parser4</command> tool reads a configuration file
+      for <command>kea-dhcp4</command> and pretty prints the result of
+       the flex/bison DHCPv4 parser.
+    </para>
+    <para>
+      The <command>import-to-yang4</command> tool reads a configuration
+      file for <command>kea-dhcp4</command>, translates it into YANG
+      and imports it into the sysrepo startup datastore.
+    </para>
+    <para>
+       The <command>export-from-yang4</command> tool exports the YANG
+       configuration following the model from the sysrepo startup datastore
+       and pretty prints the result of the translation to JSON.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>ARGUMENTS</title>
+
+    <para>The arguments are as follows:</para>
+
+    <variablelist>
+
+      <varlistentry>
+        <term><option>-v</option></term>
+        <listitem><para>
+          Display the version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-V</option></term>
+        <listitem><para>
+          Display the extended version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-i</option></term>
+        <listitem><para>
+          The input configuration file.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-o</option></term>
+        <listitem><para>
+          The output configuration file. When it is not given the
+          parsed configuration is written on the standard output.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+         <term><option>-m</option></term>
+         <listitem><para>
+           The name of the model, default is kea-dhcp4-server.
+         </para></listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>DOCUMENTATION</title>
+    <para>Kea comes with an extensive Kea User's Guide documentation
+      that covers all aspects of running the Kea software -
+      compilation, installation, configuration, configuration examples
+      and many more. Kea also features a Kea Messages Manual, which
+      lists all possible messages Kea can print with a brief
+      description for each of them. Both documents are typically
+      available in various formats (txt, html, pdf) with your Kea
+      distribution. The Kea documentation is available at
+      https://kb.isc.org/docs/kea-administrator-reference-manual .</para>
+    <para>
+      Kea source code is documented in the Kea Developer's Guide. Its
+      on-line version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
+    </para>
+    <para>
+      Kea project website is available at: https://kea.isc.org.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>MAILING LISTS AND SUPPORT</title>
+    <para>
+      There are two mailing lists available for Kea project. kea-users
+      (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
+      (kea-dev at lists.isc.org) is intended for Kea developers, prospective
+      contributors and other advanced users.  Both lists are available at
+      http://lists.isc.org. The community provides best effort type of support
+      on both of those lists.
+    </para>
+    <para>
+      ISC provides professional support for Kea services. See
+      https://www.isc.org/kea/ for details.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>HISTORY</title>
+    <para>
+      First versions of the <command>export-from-yang4</command> and
+      <command>import-to-yang4</command> where attached to the yang
+      library but as they did not handle well extended comments they
+      were not included in the 1.5.0 release.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>kea-dhcp4</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
+      <citetitle>Kea Administrator's Guide</citetitle>.
+
+    </para>
+  </refsect1>
+
+</refentry>
index 253e735cbb80e783189af2098357337081bcf966..defe08d962ae62fb9ec9a728514bca9c2320566c 100644 (file)
@@ -6,8 +6,30 @@ if HAVE_SYSREPO
 AM_CPPFLAGS += $(SYSREPO_CPPFLAGS)
 endif
 
+if USE_STATIC_LINK
+AM_LDFLAGS = -static
+endif
+
 CLEANFILES = *.gcno *.gcda
 
+man_MANS = tools6.8
+DISTCLEANFILES = $(man_MANS)
+EXTRA_DIST = $(man_MANS) tools6.xml
+
+if GENERATE_DOCS
+tools6.8: tools6.xml
+       @XSLTPROC@ --novalid --xinclude --nonet -o $@ \
+       http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl \
+       $(srcdir)/tools6.xml
+
+else
+
+$(man_MANS):
+       @echo Man generation disabled.  Creating dummy $@.  Configure with --enable-generate-docs to enable it.
+       @echo Man generation disabled.  Remove this file, configure with --enable-generate-docs, and rebuild Kea > $@
+
+endif
+
 sbin_PROGRAMS = parser6
 if HAVE_SYSREPO
 sbin_PROGRAMS += import-to-yang6 export-from-yang6
@@ -28,20 +50,23 @@ import_to_yang6_LDADD  = $(top_builddir)/src/bin/dhcp6/libparser6.la
 import_to_yang6_LDADD += $(top_builddir)/src/lib/yang/libkea-yang.la
 import_to_yang6_LDADD += $(top_builddir)/src/lib/cc/libkea-cc.la
 import_to_yang6_LDADD += $(top_builddir)/src/lib/asiolink/libkea-asiolink.la
+import_to_yang6_LDADD += $(top_builddir)/src/lib/log/libkea-log.la
+import_to_yang6_LDADD += $(top_builddir)/src/lib/util/threads/libkea-threads.la
 import_to_yang6_LDADD += $(top_builddir)/src/lib/util/libkea-util.la
 import_to_yang6_LDADD += $(top_builddir)/src/lib/exceptions/libkea-exceptions.la
-import_to_yang6_LDADD += $(BOOST_LIBS)
+import_to_yang6_LDADD += $(LOG4CPLUS_LIBS) $(BOOST_LIBS)
 import_to_yang6_LDADD += $(SYSREPO_LIBS)
 import_to_yang6_LDFLAGS = $(AM_LDFLAGS)
 
 export_from_yang6_SOURCES = export_from_yang6.cc
-export_from_yang6_LDADD  = $(top_builddir)/src/bin/dhcp6/libparser6.la
-export_from_yang6_LDADD += $(top_builddir)/src/lib/yang/libkea-yang.la
+export_from_yang6_LDADD  = $(top_builddir)/src/lib/yang/libkea-yang.la
 export_from_yang6_LDADD += $(top_builddir)/src/lib/cc/libkea-cc.la
 export_from_yang6_LDADD += $(top_builddir)/src/lib/asiolink/libkea-asiolink.la
+export_from_yang6_LDADD += $(top_builddir)/src/lib/log/libkea-log.la
+export_from_yang6_LDADD += $(top_builddir)/src/lib/util/threads/libkea-threads.la
 export_from_yang6_LDADD += $(top_builddir)/src/lib/util/libkea-util.la
 export_from_yang6_LDADD += $(top_builddir)/src/lib/exceptions/libkea-exceptions.la
-export_from_yang6_LDADD += $(BOOST_LIBS)
+export_from_yang6_LDADD += $(LOG4CPLUS_LIBS) $(BOOST_LIBS)
 export_from_yang6_LDADD += $(SYSREPO_LIBS)
 export_from_yang6_LDFLAGS = $(AM_LDFLAGS)
 endif
diff --git a/src/bin/dhcp6/tools/tools6.xml b/src/bin/dhcp6/tools/tools6.xml
new file mode 100644 (file)
index 0000000..54f5cf3
--- /dev/null
@@ -0,0 +1,196 @@
+<!--
+ - Copyright (C) 2019 Internet Systems Consortium, Inc. ("ISC")
+ -
+ - This Source Code Form is subject to the terms of the Mozilla Public
+ - License, v. 2.0. If a copy of the MPL was not distributed with this
+ - file, You can obtain one at http://mozilla.org/MPL/2.0/.
+-->
+<!-- Converted by db4-upgrade version 1.1 -->
+<refentry>
+
+  <info>
+    <productname>ISC Kea</productname>
+    <date>Jan 5, 2019</date>
+    <edition>1.6.0</edition>
+    <author>
+      <contrib>The Kea software has been written by a number of
+        engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
+        Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed,
+        Wlodek Wencel and Shawn Routhier.  That list is roughly in the
+        chronological order in which the authors made their first
+        contribution. For a complete list of authors and
+        contributors, see AUTHORS file.</contrib><orgname>Internet Systems Consortium, Inc.</orgname></author>
+  </info>
+
+  <refmeta>
+    <refentrytitle>tools6</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="manual">Kea</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>tools6</refname>
+    <refpurpose>DHCPv6 configuration tools</refpurpose>
+  </refnamediv>
+
+  <docinfo>
+    <copyright>
+      <year>2019</year>
+      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
+    </copyright>
+  </docinfo>
+
+  <refsynopsisdiv>
+    <cmdsynopsis sepchar=" ">
+      <command>parser6</command>
+      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
+      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
+      <arg choice="req" rep="norepeat"><option>-i <replaceable class="parameter">input-file</replaceable></option></arg>
+      <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">output-file</replaceable></option></arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>import-to-yang6</command>
+      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
+      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
+      <arg choice="req" rep="norepeat"><option>-i <replaceable class="parameter">input-file</replaceable></option></arg>
+      <arg choice="opt" rep="norepeat"><option>-m <replaceable class="parameter">model</replaceable></option></arg>
+    </cmdsynopsis>
+    <cmdsynopsis>
+      <command>export-from-yang6</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>-m <replaceable class="parameter">model</replaceable></option></arg>
+      <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">output-file</replaceable></option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para>
+      The <command>parser6</command> tool reads a configuration file
+      for <command>kea-dhcp6</command> and pretty prints the result of
+       the flex/bison DHCPv6 parser.
+    </para>
+    <para>
+      The <command>import-to-yang6</command> tool reads a configuration
+      file for <command>kea-dhcp6</command>, translates it into YANG
+      and imports it into the sysrepo startup datastore.
+    </para>
+    <para>
+       The <command>export-from-yang6</command> tool exports the YANG
+       configuration following the model from the sysrepo startup datastore
+       and pretty prints the result of the translation to JSON.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>ARGUMENTS</title>
+
+    <para>The arguments are as follows:</para>
+
+    <variablelist>
+
+      <varlistentry>
+        <term><option>-v</option></term>
+        <listitem><para>
+          Display the version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-V</option></term>
+        <listitem><para>
+          Display the extended version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-i</option></term>
+        <listitem><para>
+          The input configuration file.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-o</option></term>
+        <listitem><para>
+          The output configuration file. When it is not given the
+          parsed configuration is written on the standard output.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+         <term><option>-m</option></term>
+         <listitem><para>
+           The name of the model, default is kea-dhcp6-server.
+         </para></listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>DOCUMENTATION</title>
+    <para>Kea comes with an extensive Kea User's Guide documentation
+      that covers all aspects of running the Kea software -
+      compilation, installation, configuration, configuration examples
+      and many more. Kea also features a Kea Messages Manual, which
+      lists all possible messages Kea can print with a brief
+      description for each of them. Both documents are typically
+      available in various formats (txt, html, pdf) with your Kea
+      distribution. The Kea documentation is available at
+      https://kb.isc.org/docs/kea-administrator-reference-manual .</para>
+    <para>
+      Kea source code is documented in the Kea Developer's Guide. Its
+      on-line version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
+    </para>
+    <para>
+      Kea project website is available at: https://kea.isc.org.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>MAILING LISTS AND SUPPORT</title>
+    <para>
+      There are two mailing lists available for Kea project. kea-users
+      (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
+      (kea-dev at lists.isc.org) is intended for Kea developers, prospective
+      contributors and other advanced users.  Both lists are available at
+      http://lists.isc.org. The community provides best effort type of support
+      on both of those lists.
+    </para>
+    <para>
+      ISC provides professional support for Kea services. See
+      https://www.isc.org/kea/ for details.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>HISTORY</title>
+    <para>
+      First versions of the <command>export-from-yang6</command> and
+      <command>import-to-yang6</command> where attached to the yang
+      library but as they did not handle well extended comments they
+      were not included in the 1.5.0 release.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>kea-dhcp6</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
+      <citetitle>Kea Administrator's Guide</citetitle>.
+
+    </para>
+  </refsect1>
+
+</refentry>
index 8b1c587873b010a727a00f810d78476697d8434d..a40cb6f50134fad44628cc57c09975a52c98cdf4 100644 (file)
@@ -3,8 +3,30 @@ AM_CPPFLAGS += -I$(top_srcdir)/src -I$(top_builddir)/src
 AM_CPPFLAGS += -I$(top_srcdir)/src/bin -I$(top_builddir)/src/bin
 AM_CPPFLAGS += $(BOOST_INCLUDES)
 
+if USE_STATIC_LINK
+AM_LDFLAGS = -static
+endif
+
 CLEANFILES = *.gcno *.gcda
 
+man_MANS = tools-nc.8
+DISTCLEANFILES = $(man_MANS)
+EXTRA_DIST = $(man_MANS) tools-nc.xml
+
+if GENERATE_DOCS
+tools-nc.8: tools-nc.xml
+       @XSLTPROC@ --novalid --xinclude --nonet -o $@ \
+       http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl \
+       $(srcdir)/tools-nc.xml
+
+else
+
+$(man_MANS):
+       @echo Man generation disabled.  Creating dummy $@.  Configure with --enable-generate-docs to enable it.
+       @echo Man generation disabled.  Remove this file, configure with --enable-generate-docs, and rebuild Kea > $@
+
+endif
+
 sbin_PROGRAMS = parser-nc
 
 parser_nc_SOURCES = parser-nc.cc
diff --git a/src/bin/netconf/tools/tools-nc.xml b/src/bin/netconf/tools/tools-nc.xml
new file mode 100644 (file)
index 0000000..37bdc1e
--- /dev/null
@@ -0,0 +1,150 @@
+<!--
+ - Copyright (C) 2019 Internet Systems Consortium, Inc. ("ISC")
+ -
+ - This Source Code Form is subject to the terms of the Mozilla Public
+ - License, v. 2.0. If a copy of the MPL was not distributed with this
+ - file, You can obtain one at http://mozilla.org/MPL/2.0/.
+-->
+<!-- Converted by db4-upgrade version 1.1 -->
+<refentry>
+
+  <info>
+    <productname>ISC Kea</productname>
+    <date>Jan 5, 2019</date>
+    <edition>1.6.0</edition>
+    <author>
+      <contrib>The Kea software has been written by a number of
+        engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
+        Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed,
+        Wlodek Wencel and Shawn Routhier.  That list is roughly in the
+        chronological order in which the authors made their first
+        contribution. For a complete list of authors and
+        contributors, see AUTHORS file.</contrib><orgname>Internet Systems Consortium, Inc.</orgname></author>
+  </info>
+
+  <refmeta>
+    <refentrytitle>tools-nc</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo class="manual">Kea</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>tools-nc</refname>
+    <refpurpose>Netconf configuration tools</refpurpose>
+  </refnamediv>
+
+  <docinfo>
+    <copyright>
+      <year>2019</year>
+      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
+    </copyright>
+  </docinfo>
+
+  <refsynopsisdiv>
+    <cmdsynopsis sepchar=" ">
+      <command>parser-nc</command>
+      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
+      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
+      <arg choice="req" rep="norepeat"><option>-i <replaceable class="parameter">input-file</replaceable></option></arg>
+      <arg choice="opt" rep="norepeat"><option>-o <replaceable class="parameter">output-file</replaceable></option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para>
+      The <command>parser-nc</command> tool reads a configuration file
+      for <command>kea-netconf</command> and pretty prints the result of
+       the flex/bison NETCONF parser.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>ARGUMENTS</title>
+
+    <para>The arguments are as follows:</para>
+
+    <variablelist>
+
+      <varlistentry>
+        <term><option>-v</option></term>
+        <listitem><para>
+          Display the version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-V</option></term>
+        <listitem><para>
+          Display the extended version.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-i</option></term>
+        <listitem><para>
+          The input configuration file.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-o</option></term>
+        <listitem><para>
+          The output configuration file. When it is not given the
+          parsed configuration is written on the standard output.
+        </para></listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>DOCUMENTATION</title>
+    <para>Kea comes with an extensive Kea User's Guide documentation
+      that covers all aspects of running the Kea software -
+      compilation, installation, configuration, configuration examples
+      and many more. Kea also features a Kea Messages Manual, which
+      lists all possible messages Kea can print with a brief
+      description for each of them. Both documents are typically
+      available in various formats (txt, html, pdf) with your Kea
+      distribution. The Kea documentation is available at
+      https://kb.isc.org/docs/kea-administrator-reference-manual .</para>
+    <para>
+      Kea source code is documented in the Kea Developer's Guide. Its
+      on-line version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
+    </para>
+    <para>
+      Kea project website is available at: https://kea.isc.org.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>MAILING LISTS AND SUPPORT</title>
+    <para>
+      There are two mailing lists available for Kea project. kea-users
+      (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
+      (kea-dev at lists.isc.org) is intended for Kea developers, prospective
+      contributors and other advanced users.  Both lists are available at
+      http://lists.isc.org. The community provides best effort type of support
+      on both of those lists.
+    </para>
+    <para>
+      ISC provides professional support for Kea services. See
+      https://www.isc.org/kea/ for details.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+        <refentrytitle>kea-netconf</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </citerefentry>,
+
+      <citetitle>Kea Administrator's Guide</citetitle>.
+
+    </para>
+  </refsect1>
+
+</refentry>