From e91b579434e7bc3c49041d4139715447ba52e60c Mon Sep 17 00:00:00 2001 From: Tomek Mrugalski Date: Wed, 8 Mar 2017 10:59:40 +0100 Subject: [PATCH] [5137] Man page written. --- src/bin/shell/kea-shell.xml | 226 ++++++++++++++++++++++++++++++++++++ 1 file changed, 226 insertions(+) create mode 100644 src/bin/shell/kea-shell.xml diff --git a/src/bin/shell/kea-shell.xml b/src/bin/shell/kea-shell.xml new file mode 100644 index 0000000000..78edb659a4 --- /dev/null +++ b/src/bin/shell/kea-shell.xml @@ -0,0 +1,226 @@ +]> + + + + + + ISC Kea + 2016 Mar 8 + 1.2.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-shell + 8 + Kea + + + + kea-shell + Text client for Control Agent process + + + + + 2016 + Internet Systems Consortium, Inc. ("ISC") + + + + + + kea-shell + + + + + + + + + + + DESCRIPTION + + The kea-shell provides a REST client for the + Kea Control Agent (CA). It takes command as a command-line parameter + that is being sent to CA with proper JSON + encapsulation. Optional parameters may be specified on the + stdin. The request it sent of HTTP and a response is + retrieved. That response is printed out on stdout. + + + + + + ARGUMENTS + + The arguments are as follows: + + + + + + + Display the version. + + + + + + + Displays help regarding command line parameters. + + + + + + + Specifies the host to connect to. Control Agent must be + running at specified host. If not specified, 127.0.0.1 is used. + + + + + + + Specifies the TCP port to connect to. Control Agent must be + listening at specified port. If not specified, 8000 is used. + + + + + + + Specifies the connection timeout in seconds. If not + specified, 10 (seconds) is used. + + + + + + + Specifies the command to be sent to CA. If not + specified, "list-commands" is used. + + + + + + + + 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-shell was first coded in March 2017 + by Tomek Mrugalski. + + + + + SEE ALSO + + + kea-ctrl-agent + 8 + , + + + kea-dhcp4 + 8 + , + + + kea-dhcp6 + 8 + , + + + kea-dhcp-ddns + 8 + , + + + kea-admin + 8 + , + + + keactrl + 8 + , + + + perfdhcp + 8 + , + + + kea-lfc + 8 + , + + Kea Administrator's Guide. + + + + + -- 2.47.3