summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/man/kea-dhcp4.8.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 14:53:22 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 14:53:22 +0000
commit52c021ee0b0c6ad2128ed550c694aad0d11d4c3f (patch)
tree83cf8627b94336cf4bee7479b9749263bbfd3a06 /doc/sphinx/man/kea-dhcp4.8.rst
parentInitial commit. (diff)
downloadisc-kea-upstream.tar.xz
isc-kea-upstream.zip
Adding upstream version 2.5.7.upstream/2.5.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--doc/sphinx/man/kea-dhcp4.8.rst116
1 files changed, 116 insertions, 0 deletions
diff --git a/doc/sphinx/man/kea-dhcp4.8.rst b/doc/sphinx/man/kea-dhcp4.8.rst
new file mode 100644
index 0000000..6bc42f4
--- /dev/null
+++ b/doc/sphinx/man/kea-dhcp4.8.rst
@@ -0,0 +1,116 @@
+..
+ Copyright (C) 2019-2023 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.
+
+.. iscman:: kea-dhcp4
+
+``kea-dhcp4`` - DHCPv4 server in Kea
+------------------------------------
+
+Synopsis
+~~~~~~~~
+
+:program:`kea-dhcp4` [**-v**] [**-V**] [**-W**] [**-d**] [**-c** config-file] [**-t** config-file] [**-p** server-port-number] [**-P** client-port-number]
+
+Description
+~~~~~~~~~~~
+
+The ``kea-dhcp4`` daemon provides the DHCPv4 server implementation.
+
+Arguments
+~~~~~~~~~
+
+The arguments are as follows:
+
+``-v``
+ Displays the version.
+
+``-V``
+ Displays the extended version.
+
+``-W``
+ Displays the configuration report.
+
+``-d``
+ Enables the debug mode with extra verbosity.
+
+``-c config-file``
+ Specifies the configuration file with the configuration for the DHCPv4 server. It
+ may also contain configuration entries for other Kea services.
+
+``-t config-file``
+ Checks the configuration file and reports the first error, if any. Note
+ that not all parameters are completely checked; in particular,
+ service and control channel sockets are not opened, and hook
+ libraries are not loaded.
+
+``-T config-file``
+ Checks the configuration file and reports the first error, if any.
+ It performs extra checks beyond what -t offers, such as establishing
+ database connections (for the lease backend, host reservations backend,
+ configuration backend, and forensic logging backend), loading hook libraries,
+ parsing hook-library configurations, etc. It does not open UNIX or TCP/UDP sockets,
+ nor does it open or rotate files, as any of these actions could interfere
+ with a running process on the same machine.
+
+``-p server-port-number``
+ Specifies the server port number (1-65535) on which the server listens. This is
+ useful for testing purposes only.
+
+``-P client-port-number``
+ Specifies the client port number (1-65535) to which the server responds. This is
+ useful for testing purposes only.
+
+Documentation
+~~~~~~~~~~~~~
+
+Kea comes with an extensive Kea Administrator Reference Manual that covers
+all aspects of running the Kea software - compilation, installation,
+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
+available in various formats (.txt, .html, .pdf) with the Kea
+distribution. The Kea documentation is available at
+https://kea.readthedocs.io.
+
+Kea source code is documented in the Kea Developer's Guide,
+available at https://reports.kea.isc.org/dev_guide/.
+
+The Kea project website is available at https://kea.isc.org.
+
+Mailing Lists and Support
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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
+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
+~~~~~~~
+
+The ``b10-dhcp4`` daemon was first coded in November 2011 by Tomek
+Mrugalski.
+
+In mid-2014, Kea was decoupled from the BIND 10 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.
+
+See Also
+~~~~~~~~
+
+: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-netconf(8)`, :manpage:`kea-lfc(8)`,
+Kea Administrator Reference Manual.