From: Marcin Siodelski Date: Mon, 5 Dec 2016 15:39:31 +0000 (+0100) Subject: [5075] Created man page for Kea Control Agent. X-Git-Tag: trac5088_base~8^2~5 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=de425560b75a1faa51f00d3e4d92a2f9109722ea;p=thirdparty%2Fkea.git [5075] Created man page for Kea Control Agent. --- diff --git a/src/bin/admin/kea-admin.xml b/src/bin/admin/kea-admin.xml index 7ef4788f96..90957bc8d7 100644 --- a/src/bin/admin/kea-admin.xml +++ b/src/bin/admin/kea-admin.xml @@ -223,6 +223,11 @@ 8 , + + kea-ctrl-agent + 8 + , + keactrl 8 diff --git a/src/bin/agent/.gitignore b/src/bin/agent/.gitignore index da8810a72f..076c41267f 100644 --- a/src/bin/agent/.gitignore +++ b/src/bin/agent/.gitignore @@ -2,4 +2,5 @@ /ctrl_agent_messages.cc /ctrl_agent_messages.h /s-messages +/kea-ctrl-agent.8 diff --git a/src/bin/agent/Makefile.am b/src/bin/agent/Makefile.am index 68886bc276..d12012edca 100644 --- a/src/bin/agent/Makefile.am +++ b/src/bin/agent/Makefile.am @@ -11,23 +11,23 @@ endif CLEANFILES = *.gcno *.gcda ctrl_agent_messages.h ctrl_agent__messages.cc s-messages -#man_MANS = kea-ctrl-agent.8 -#DISTCLEANFILES = $(man_MANS) -#EXTRA_DIST = $(man_MANS) kea-ctrl-agent.xml agent.dox +man_MANS = kea-ctrl-agent.8 +DISTCLEANFILES = $(man_MANS) +EXTRA_DIST = $(man_MANS) kea-ctrl-agent.xml -#if GENERATE_DOCS -#kea-ctrl-agent.8: kea-ctrl-agent.xml -# @XSLTPROC@ --novalid --xinclude --nonet -o $@ \ -# http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl \ -# $(srcdir)/kea-ctrl-agent.xml +if GENERATE_DOCS +kea-ctrl-agent.8: kea-ctrl-agent.xml + @XSLTPROC@ --novalid --xinclude --nonet -o $@ \ + http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl \ + $(srcdir)/kea-ctrl-agent.xml -#else +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 > $@ +$(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 +endif 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 libagent_la_SOURCES += ctrl_agent_process.cc ctrl_agent_process.h 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 diff --git a/src/bin/agent/kea-ctrl-agent.xml b/src/bin/agent/kea-ctrl-agent.xml new file mode 100644 index 0000000000..f7f6560700 --- /dev/null +++ b/src/bin/agent/kea-ctrl-agent.xml @@ -0,0 +1,213 @@ +]> + + + + + + ISC Kea + Sep. 28, 2016 + 1.1.0 + + 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. + Internet Systems Consortium, Inc. + + + + + kea-ctrl-agent + 8 + Kea + + + + kea-ctrl-agent + Control Agent process in Kea + + + + + 2016 + Internet Systems Consortium, Inc. ("ISC") + + + + + + kea-ctrl-agent + + + + + + + + + + + DESCRIPTION + + The kea-ctrl-agent 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. + + + + + + ARGUMENTS + + The arguments are as follows: + + + + + + + Display the version. + + + + + + + Display the extended version. + + + + + + + Display the configuration report. + + + + + + + Verbose mode sets the logging level to debug. This is primarily + for development purposes in stand-alone mode. + + + + + + + Configuration file including the configuration for the Control Agent + server. It may also contain configuration entries for other Kea + services. + + + + + + + + DOCUMENTATION + 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/. + + 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. + + + Kea project website is available at: http://kea.isc.org. + + + + + MAILING LISTS AND SUPPORT + + 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. + + + ISC provides professional support for Kea services. See + https://www.isc.org/kea/ for details. + + + + + HISTORY + + The kea-ctrl-agent was first coded in December 2016 + by Marcin Siodelski. + + + + + SEE ALSO + + + kea-dhcp4 + 8 + , + + + kea-dhcp6 + 8 + , + + + kea-dhcp-ddns + 8 + , + + + kea-admin + 8 + , + + + keactrl + 8 + , + + + perfdhcp + 8 + , + + + kea-lfc + 8 + , + + Kea Administrator's Guide. + + + + + diff --git a/src/bin/d2/kea-dhcp-ddns.xml b/src/bin/d2/kea-dhcp-ddns.xml index dde8d0a7d4..78650c097c 100644 --- a/src/bin/d2/kea-dhcp-ddns.xml +++ b/src/bin/d2/kea-dhcp-ddns.xml @@ -2,7 +2,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" []>