Commit de425560 authored by Marcin Siodelski's avatar Marcin Siodelski

[5075] Created man page for Kea Control Agent.

parent ceb361c7
...@@ -223,6 +223,11 @@ ...@@ -223,6 +223,11 @@
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
</citerefentry>, </citerefentry>,
<citerefentry>
<refentrytitle>kea-ctrl-agent</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry> <citerefentry>
<refentrytitle>keactrl</refentrytitle> <refentrytitle>keactrl</refentrytitle>
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
......
...@@ -2,4 +2,5 @@ ...@@ -2,4 +2,5 @@
/ctrl_agent_messages.cc /ctrl_agent_messages.cc
/ctrl_agent_messages.h /ctrl_agent_messages.h
/s-messages /s-messages
/kea-ctrl-agent.8
...@@ -11,23 +11,23 @@ endif ...@@ -11,23 +11,23 @@ endif
CLEANFILES = *.gcno *.gcda ctrl_agent_messages.h ctrl_agent__messages.cc s-messages CLEANFILES = *.gcno *.gcda ctrl_agent_messages.h ctrl_agent__messages.cc s-messages
#man_MANS = kea-ctrl-agent.8 man_MANS = kea-ctrl-agent.8
#DISTCLEANFILES = $(man_MANS) DISTCLEANFILES = $(man_MANS)
#EXTRA_DIST = $(man_MANS) kea-ctrl-agent.xml agent.dox EXTRA_DIST = $(man_MANS) kea-ctrl-agent.xml
#if GENERATE_DOCS if GENERATE_DOCS
#kea-ctrl-agent.8: kea-ctrl-agent.xml kea-ctrl-agent.8: kea-ctrl-agent.xml
# @XSLTPROC@ --novalid --xinclude --nonet -o $@ \ @XSLTPROC@ --novalid --xinclude --nonet -o $@ \
# http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl \ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl \
# $(srcdir)/kea-ctrl-agent.xml $(srcdir)/kea-ctrl-agent.xml
#else else
#$(man_MANS): $(man_MANS):
# @echo Man generation disabled. Creating dummy $@. Configure with --enable-generate-docs to enable it. @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 > $@ @echo Man generation disabled. Remove this file, configure with --enable-generate-docs, and rebuild Kea > $@
#endif endif
ctrl_agent_messages.h ctrl_agent_messages.cc: s-messages ctrl_agent_messages.h ctrl_agent_messages.cc: s-messages
...@@ -48,7 +48,7 @@ libagent_la_SOURCES += ctrl_agent_log.cc ctrl_agent_log.h ...@@ -48,7 +48,7 @@ libagent_la_SOURCES += ctrl_agent_log.cc ctrl_agent_log.h
libagent_la_SOURCES += ctrl_agent_process.cc ctrl_agent_process.h libagent_la_SOURCES += ctrl_agent_process.cc ctrl_agent_process.h
nodist_libagent_la_SOURCES = ctrl_agent_messages.h ctrl_agent_messages.cc nodist_libagent_la_SOURCES = ctrl_agent_messages.h ctrl_agent_messages.cc
EXTRA_DIST = ctrl_agent_messages.mes EXTRA_DIST += ctrl_agent_messages.mes
sbin_PROGRAMS = kea-ctrl-agent sbin_PROGRAMS = kea-ctrl-agent
......
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]>
<!--
- Copyright (C) 2013-2015 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/.
-->
<refentry>
<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
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-ctrl-agent</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="manual">Kea</refmiscinfo>
</refmeta>
<refnamediv>
<refname>kea-ctrl-agent</refname>
<refpurpose>Control Agent process in Kea</refpurpose>
</refnamediv>
<docinfo>
<copyright>
<year>2016</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
<refsynopsisdiv>
<cmdsynopsis>
<command>kea-ctrl-agent</command>
<arg><option>-v</option></arg>
<arg><option>-V</option></arg>
<arg><option>-W</option></arg>
<arg><option>-d</option></arg>
<arg><option>-s</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
The <command>kea-ctrl-agent</command> provides a REST service for
controlling Kea services. The received HTTP requests are decapsulated
and forwarded to the respective Kea services as JSON strings. Received
JSON responses are encapsulated within HTTP responses and returned to
the controlling entity. Some commands may be handled by the Control
Agent directly, and not forwarded to any Kea service.
</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>-W</option></term>
<listitem><para>
Display the configuration report.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<listitem><para>
Verbose mode sets the logging level to debug. This is primarily
for development purposes in stand-alone mode.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option></term>
<listitem><para>
Configuration file including the configuration for the Control Agent
server. It may also contain configuration entries for other Kea
services.
</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 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>
The <command>kea-ctrl-agent</command> was first coded in December 2016
by Marcin Siodelski.
</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>,
<citerefentry>
<refentrytitle>kea-lfc</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>Kea Administrator's Guide</citetitle>.
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]> [<!ENTITY mdash "&#8212;">]>
<!-- <!--
- Copyright (C) 2013-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2013-2016 Internet Systems Consortium, Inc. ("ISC")
- -
- This Source Code Form is subject to the terms of the Mozilla Public - 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 - License, v. 2.0. If a copy of the MPL was not distributed with this
...@@ -178,6 +178,11 @@ ...@@ -178,6 +178,11 @@
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
</citerefentry>, </citerefentry>,
<citerefentry>
<refentrytitle>kea-ctrl-agent</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry> <citerefentry>
<refentrytitle>kea-admin</refentrytitle> <refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]> [<!ENTITY mdash "&#8212;">]>
<!-- <!--
- Copyright (C) 2011-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2011-2016 Internet Systems Consortium, Inc. ("ISC")
- -
- This Source Code Form is subject to the terms of the Mozilla Public - 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 - License, v. 2.0. If a copy of the MPL was not distributed with this
...@@ -183,6 +183,11 @@ ...@@ -183,6 +183,11 @@
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
</citerefentry>, </citerefentry>,
<citerefentry>
<refentrytitle>kea-ctrl-agent</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry> <citerefentry>
<refentrytitle>kea-admin</refentrytitle> <refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]> [<!ENTITY mdash "&#8212;">]>
<!-- <!--
- Copyright (C) 2011-2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2011-2016 Internet Systems Consortium, Inc. ("ISC")
- -
- This Source Code Form is subject to the terms of the Mozilla Public - 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 - License, v. 2.0. If a copy of the MPL was not distributed with this
...@@ -184,6 +184,11 @@ ...@@ -184,6 +184,11 @@
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
</citerefentry>, </citerefentry>,
<citerefentry>
<refentrytitle>kea-ctrl-agent</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry> <citerefentry>
<refentrytitle>kea-admin</refentrytitle> <refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
......
...@@ -234,6 +234,11 @@ ...@@ -234,6 +234,11 @@
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
</citerefentry>, </citerefentry>,
<citerefentry>
<refentrytitle>kea-ctrl-agent</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry> <citerefentry>
<refentrytitle>kea-admin</refentrytitle> <refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]> [<!ENTITY mdash "&#8212;">]>
<!-- <!--
- Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC") - Copyright (C) 2015-2016 Internet Systems Consortium, Inc. ("ISC")
- -
- This Source Code Form is subject to the terms of the Mozilla Public - 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 - License, v. 2.0. If a copy of the MPL was not distributed with this
...@@ -258,6 +258,11 @@ ...@@ -258,6 +258,11 @@
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
</citerefentry>, </citerefentry>,
<citerefentry>
<refentrytitle>kea-ctrl-agent</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry> <citerefentry>
<refentrytitle>kea-admin</refentrytitle> <refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
......
...@@ -933,6 +933,11 @@ ...@@ -933,6 +933,11 @@
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
</citerefentry>, </citerefentry>,
<citerefentry>
<refentrytitle>kea-ctrl-agent</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry> <citerefentry>
<refentrytitle>kea-admin</refentrytitle> <refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum> <manvolnum>8</manvolnum>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment