Skip to content

GitLab

Kea
Kea
Commit 44fefd4a authored by Tomek Mrugalski's avatar Tomek Mrugalski 🛰
Browse files
Options

[3515] Remaining man pages updated (after applying review comments)

parent eaba8e2b
Hide whitespace changes
Inline Side-by-side
Showing with 452 additions and 42 deletions
src/bin/admin/kea-admin.xml
View file @ 44fefd4a
......@@ -11,13 +11,25 @@
<refentry>
<refentryinfo>
<date>Nov 5, 2014</date>
<productname>ISC Kea</productname>
<date>Sep. 28, 2016</date>
<edition>1.1.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>
</refentryinfo>
<refmeta>
<refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo>Kea</refmiscinfo>
<refmiscinfo class="manual">Kea</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -27,7 +39,7 @@
<docinfo>
<copyright>
<year>2014</year>
<year>2014-2016</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
......@@ -211,6 +223,16 @@
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>keactrl</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>perfdhcp</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>Kea Administrator Guide</citetitle>.
</para>
......
src/bin/d2/kea-dhcp-ddns.xml
View file @ 44fefd4a
......@@ -12,13 +12,25 @@
<refentry>
<refentryinfo>
<date>June 10, 2015</date>
<productname>ISC Kea</productname>
<date>Sep. 28, 2016</date>
<edition>1.1.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>
</refentryinfo>
<refmeta>
<refentrytitle>kea-dhcp-ddns</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo>Kea</refmiscinfo>
<refmiscinfo class="manual">Kea</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -28,7 +40,7 @@
<docinfo>
<copyright>
<year>2014-2015</year>
<year>2013-2016</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
......@@ -103,6 +115,43 @@
</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 on-line version is available at
http://kea.isc.org/docs/.</para>
<para>
Kea source code is documented in the Kea Developer's Guide. It's
on-line version is available at http://kea.isc.org. Please
follow Developer's Guide link.
</para>
<para>
Kea project website is available at: http://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>
......@@ -112,9 +161,48 @@
<para>
Kea became a standalone server and the BIND10 framework was
removed. The DHCP-DDNS server binary was renamed to kea-dhcp-ddns
in July 2014.
in July 2014. Kea 1.0.0 was released in December 2015.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>kea-dhcp4</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-dhcp6</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>keactrl</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>perfdhcp</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-lfc</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>Kea Administrator's Guide</citetitle>.
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
......
src/bin/dhcp4/kea-dhcp4.xml
View file @ 44fefd4a
......@@ -14,6 +14,7 @@
<refentryinfo>
<productname>ISC Kea</productname>
<date>Sep. 28, 2016</date>
<edition>1.1.0</edition>
<author>
<contrib>The Kea software has been written by a number of
engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
......@@ -24,10 +25,8 @@
contributors, see AUTHORS file.</contrib>
<orgname>Internet Systems Consortium, Inc.</orgname>
</author>
<edition>1.1.0</edition>
</refentryinfo>
<refmeta>
<refentrytitle>kea-dhcp4</refentrytitle>
<manvolnum>8</manvolnum>
......@@ -146,10 +145,11 @@
<title>MAILING LISTS AND SUPPORT</title>
<para>
There are two mailing lists available for Kea project. kea-users
is intended for Kea users, while kea-dev 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.
(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
......@@ -164,9 +164,9 @@
November 2011 by Tomek Mrugalski.
</para>
<para>
Kea became a standalone server and the BIND10 framework was
removed. The DHCPv4 server binary was renamed to kea-dhcp4
in July 2014. Kea 1.0 was released in December 2015.
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.
</para>
</refsect1>
......
src/bin/dhcp6/kea-dhcp6.xml
View file @ 44fefd4a
......@@ -12,13 +12,25 @@
<refentry>
<refentryinfo>
<date>June 10, 2015</date>
<productname>ISC Kea</productname>
<date>Sep. 28, 2016</date>
<edition>1.1.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>
</refentryinfo>
<refmeta>
<refentrytitle>kea-dhcp6</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo>Kea</refmiscinfo>
<refmiscinfo class="manual">Kea</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -28,7 +40,7 @@
<docinfo>
<copyright>
<year>2014-2015</year>
<year>2011-2016</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
......@@ -109,6 +121,43 @@
</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 on-line version is available at
http://kea.isc.org/docs/.</para>
<para>
Kea source code is documented in the Kea Developer's Guide. It's
on-line version is available at http://kea.isc.org. Please
follow Developer's Guide link.
</para>
<para>
Kea project website is available at: http://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>
......@@ -121,6 +170,45 @@
July 2014.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>kea-dhcp4</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-dhcp-ddns</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>keactrl</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>perfdhcp</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-lfc</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>Kea Administrator's Guide</citetitle>.
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
......
src/bin/keactrl/keactrl.xml
View file @ 44fefd4a
......@@ -11,13 +11,25 @@
<refentry>
<refentryinfo>
<date>July 3, 2014</date>
<productname>ISC Kea</productname>
<date>Sep. 28, 2016</date>
<edition>1.1.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>
</refentryinfo>
<refmeta>
<refentrytitle>keactrl</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo>Kea</refmiscinfo>
<refmiscinfo class="manual">Kea</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -27,7 +39,7 @@
<docinfo>
<copyright>
<year>2014</year>
<year>2014-2016</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
......@@ -167,6 +179,43 @@
</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 on-line version is available at
http://kea.isc.org/docs/.</para>
<para>
Kea source code is documented in the Kea Developer's Guide. It's
on-line version is available at http://kea.isc.org. Please
follow Developer's Guide link.
</para>
<para>
Kea project website is available at: http://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>
......@@ -185,6 +234,22 @@
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>perfdhcp</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-lfc</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>Kea Administrator's Guide</citetitle>.
</para>
......
src/bin/lfc/kea-lfc.xml
View file @ 44fefd4a
......@@ -12,13 +12,25 @@
<refentry>
<refentryinfo>
<date>June 20, 2015</date>
<productname>ISC Kea</productname>
<date>Sep. 28, 2016</date>
<edition>1.1.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>
</refentryinfo>
<refmeta>
<refentrytitle>kea-lfc</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo>Kea</refmiscinfo>
<refmiscinfo class="manual">Kea</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -183,6 +195,43 @@
</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 on-line version is available at
http://kea.isc.org/docs/.</para>
<para>
Kea source code is documented in the Kea Developer's Guide. It's
on-line version is available at http://kea.isc.org. Please
follow Developer's Guide link.
</para>
<para>
Kea project website is available at: http://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>
......@@ -190,6 +239,45 @@
2015 by the ISC Kea/DHCP team.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>kea-dhcp4</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-dhcp6</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-dhcp-ddns</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>keactrl</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>perfdhcp</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>Kea Administrator's Guide</citetitle>.
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
......
src/bin/perfdhcp/perfdhcp.xml
View file @ 44fefd4a
......@@ -10,14 +10,27 @@
-->
<refentry>
<refentryinfo>
<date>August 31, 2016</date>
<productname>ISC Kea</productname>
<date>Sep. 28, 2016</date>
<edition>1.1.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>
</refentryinfo>
<refmeta>
<refentrytitle>perfdhcp</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo>Kea</refmiscinfo>
<refmiscinfo class="manual">Kea</refmiscinfo>
</refmeta>
<refnamediv>
......@@ -871,27 +884,73 @@
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>dhcpd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>kea-dhcp4</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>kea-dhcp6</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citetitle>Kea Administrator Guide</citetitle>.
<!--
see http://kea.isc.org/ticket/4077
<citetitle>DHCP Performance Guide</citetitle>
-->
</para>
</refsect1>
<!-- perfdhcp is not documented in the User's Guide at
all. There's one reference when we list binaries, but that's
it. Once it's documented, we can copy over the DOCUMENTATION
section from src/bin/dhcp4/kea-dhcp4.xml -->
<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>
The <command>perfdhcp</command> tool was initially coded by John DuBois, Francis Dupont and Marcin Siodelski of ISC.
The <command>perfdhcp</command> tool was initially coded
in October 2011 by John DuBois, Francis Dupont and Marcin
Siodelski of ISC. Kea 1.0.0 that included perfdhcp was
released in December 2015.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>kea-dhcp4</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-dhcp6</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-dhcp-ddns</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>