diff options
Diffstat (limited to 'doc/sphinx/man/kea-netconf.8.rst')
| -rw-r--r-- | doc/sphinx/man/kea-netconf.8.rst | 112 |
1 files changed, 58 insertions, 54 deletions
diff --git a/doc/sphinx/man/kea-netconf.8.rst b/doc/sphinx/man/kea-netconf.8.rst index 928f7cb7e5..671f8756f8 100644 --- a/doc/sphinx/man/kea-netconf.8.rst +++ b/doc/sphinx/man/kea-netconf.8.rst @@ -1,94 +1,98 @@ -:orphan: - -kea-netconf -8 -Kea -kea-netconf -NETCONF agent for Kea environment -2018 -Internet Systems Consortium, Inc. ("ISC") -kea-netconf --v --V --W --d --c -config-file --t -config-file -DESCRIPTION -=========== +.. + Copyright (C) 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/. + + See the COPYRIGHT file distributed with this work for additional + information regarding copyright ownership. + +.. highlight: console + +.. kea-netconf: + +kea-netconf - NETCONF agent for Kea environment +----------------------------------------------- + +Synopsis +~~~~~~~~ + +:program:`kea-netconf` [**-v**] [**-V**] [**-W**] [**-d**] [**-c** config-file] [**-t** config-file] + +Description +~~~~~~~~~~~ The ``kea-netconf`` agent provides a YANG/NETCONF interface for the Kea environment. -ARGUMENTS -========= +Arguments +~~~~~~~~~ The arguments are as follows: ``-v`` - Display the version. + Displays the version. ``-V`` - Display the extended version. + Displays the extended version. ``-W`` - Display the configuration report. + Displays the configuration report. ``-d`` - Enable the debug mode with extra verbosity. + Enables the debug mode with extra verbosity. -``-c`` - Configuration file including the configuration for NETCONF agent. +``-c config-file`` + Specifies the file with the configuration for the NETCONF agent. -``-t`` - Check the syntax of the configuration file and report the first error - if any. Note that not all parameters are completely checked, in +``-t config-file`` + Checks the syntax of the configuration file and reports the first error, + if any. Note that not all parameters are completely checked; in particular, service and client sockets are not opened, and hook libraries are not loaded. -DOCUMENTATION -============= +Documentation +~~~~~~~~~~~~~ -Kea comes with an extensive Kea User's Guide documentation that covers +Kea comes with an extensive Kea Administrator Reference Manual that covers all aspects of running the Kea software - compilation, installation, -configuration, configuration examples and many more. Kea also features a +configuration, configuration examples, and much 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 +with a brief description for each of them. Both documents are +available in various formats (.txt, .html, .pdf) with the Kea distribution. The Kea documentation is available at https://kb.isc.org/docs/kea-administrator-reference-manual . -Kea source code is documented in the Kea Developer's Guide. Its on-line +Kea source code is documented in the Kea Developer's Guide. Its online version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/. -Kea project website is available at: -https://gitlab.isc.org/isc-projects/kea. +The Kea project website is available at https://kea.isc.org. -MAILING LISTS AND SUPPORT -========================= +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 +There are two public mailing lists available for the 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 +contributors, and other advanced users. Both lists are available at +https://lists.isc.org. The community provides best-effort support on both of those lists. ISC provides professional support for Kea services. See https://www.isc.org/kea/ for details. -HISTORY -======= +History +~~~~~~~ -Early prototypes of kea-netconf implementation were written during IETF -Hackathons in Berlin, London and Montreal. An actual production ready +Early prototypes of ``kea-netconf`` implementation were written during IETF +Hackathons in Berlin, London, and Montreal. An actual production-ready implementation was started in August 2018 by Tomek Mrugalski and Francis Dupont. -SEE ALSO -======== +See Also +~~~~~~~~ -kea-dhcp4 8, kea-dhcp6 8, kea-dhcp-ddns 8, kea-ctrl-agent 8, kea-admin -8, keactrl 8, perfdhcp 8, kea-lfc 8, Kea Administrator's Guide. +:manpage:`kea-dhcp4(8)`, :manpage:`kea-dhcp6(8)`, :manpage:`kea-dhcp-ddns(8)`, +:manpage:`kea-ctrl-agent(8)`, :manpage:`kea-admin(8)`, :manpage:`keactrl(8)`, +:manpage:`perfdhcp(8)`, :manpage:`kea-lfc(8)`, Kea Administrator Reference Manual. |