summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAndrei Pavel <andrei@isc.org>2024-04-23 18:57:05 +0200
committerAndrei Pavel <andrei@isc.org>2024-04-24 14:23:48 +0200
commit677f8a8f0e4659b3a1ad2e4b1db8e6c0c6b6ee00 (patch)
treec3e4d90051f4a4b567de05f9cce669c2e7bc3a67 /doc
parent[#3254] show premium source in extended version (diff)
downloadkea-677f8a8f0e4659b3a1ad2e4b1db8e6c0c6b6ee00.tar.xz
kea-677f8a8f0e4659b3a1ad2e4b1db8e6c0c6b6ee00.zip
[#3254] consistent version output across executables
- replace VERSION with PACKAGE_VERSION in src/bin/admin to avoid overlap with VERSION used in src/share/database. - add -V to kea-admin - add -V to kea-shell - add -V to keactrl - add -V to perfdhcp - removed getVersionAddendum from d2 and added the openssl version to the output of other process versions since it's not only used by d2 - make all -V outputs consistent. Some are showing only core version and are missing premium version which is fine since they are the executables that don't have something to do with premium directly anyway.
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/arm/ddns.rst2
-rw-r--r--doc/sphinx/arm/shell.rst4
-rw-r--r--doc/sphinx/man/kea-admin.8.rst5
-rw-r--r--doc/sphinx/man/kea-ctrl-agent.8.rst4
-rw-r--r--doc/sphinx/man/kea-dhcp-ddns.8.rst4
-rw-r--r--doc/sphinx/man/kea-dhcp4.8.rst4
-rw-r--r--doc/sphinx/man/kea-dhcp6.8.rst4
-rw-r--r--doc/sphinx/man/kea-lfc.8.rst4
-rw-r--r--doc/sphinx/man/kea-netconf.8.rst4
-rw-r--r--doc/sphinx/man/kea-shell.8.rst2
-rw-r--r--doc/sphinx/man/keactrl.8.rst5
-rw-r--r--doc/sphinx/man/perfdhcp.8.rst5
12 files changed, 30 insertions, 17 deletions
diff --git a/doc/sphinx/arm/ddns.rst b/doc/sphinx/arm/ddns.rst
index bab8c96a65..df9a4ec7a1 100644
--- a/doc/sphinx/arm/ddns.rst
+++ b/doc/sphinx/arm/ddns.rst
@@ -133,6 +133,8 @@ directly. It accepts the following command-line switches:
- ``-v`` - displays the Kea version and exits.
+- ``-V`` - displays the extended Kea version and exits.
+
- ``-W`` - displays the Kea configuration report and exits. The report
is a copy of the ``config.report`` file produced by ``./configure``;
it is embedded in the executable binary.
diff --git a/doc/sphinx/arm/shell.rst b/doc/sphinx/arm/shell.rst
index 62a9900c69..377145a3ce 100644
--- a/doc/sphinx/arm/shell.rst
+++ b/doc/sphinx/arm/shell.rst
@@ -66,7 +66,9 @@ Other switches are:
- ``-h`` - prints a help message.
-- ``-v`` - prints the software version.
+- ``-v`` - displays the Kea version.
+
+- ``-V`` - displays the extended Kea version.
See :ref:`shell-tls` for new command-line arguments associated with TLS/HTTPS support.
diff --git a/doc/sphinx/man/kea-admin.8.rst b/doc/sphinx/man/kea-admin.8.rst
index 05f5d16db3..ee628bb6d3 100644
--- a/doc/sphinx/man/kea-admin.8.rst
+++ b/doc/sphinx/man/kea-admin.8.rst
@@ -111,7 +111,10 @@ Arguments
``lease-dump``.
``-v|--version``
- Prints the ``kea-admin`` version and quits.
+ Displays the Kea version.
+
+``-V``
+ Displays the extended Kea version.
``-4``
Directs ``kea-admin`` to lease-dump the DHCPv4 leases. Incompatible with
diff --git a/doc/sphinx/man/kea-ctrl-agent.8.rst b/doc/sphinx/man/kea-ctrl-agent.8.rst
index 815c0e3b90..03aeccd44e 100644
--- a/doc/sphinx/man/kea-ctrl-agent.8.rst
+++ b/doc/sphinx/man/kea-ctrl-agent.8.rst
@@ -34,10 +34,10 @@ Arguments
The arguments are as follows:
``-v``
- Displays the version.
+ Displays the Kea version.
``-V``
- Displays the extended version.
+ Displays the extended Kea version.
``-W``
Displays the configuration report.
diff --git a/doc/sphinx/man/kea-dhcp-ddns.8.rst b/doc/sphinx/man/kea-dhcp-ddns.8.rst
index ecaf3fde01..eba83ac439 100644
--- a/doc/sphinx/man/kea-dhcp-ddns.8.rst
+++ b/doc/sphinx/man/kea-dhcp-ddns.8.rst
@@ -31,10 +31,10 @@ Arguments
The arguments are as follows:
``-v``
- Displays the version.
+ Displays the Kea version.
``-V``
- Displays the extended version.
+ Displays the extended Kea version.
``-W``
Displays the configuration report.
diff --git a/doc/sphinx/man/kea-dhcp4.8.rst b/doc/sphinx/man/kea-dhcp4.8.rst
index 6bc42f46ea..eec7dcba44 100644
--- a/doc/sphinx/man/kea-dhcp4.8.rst
+++ b/doc/sphinx/man/kea-dhcp4.8.rst
@@ -29,10 +29,10 @@ Arguments
The arguments are as follows:
``-v``
- Displays the version.
+ Displays the Kea version.
``-V``
- Displays the extended version.
+ Displays the extended Kea version.
``-W``
Displays the configuration report.
diff --git a/doc/sphinx/man/kea-dhcp6.8.rst b/doc/sphinx/man/kea-dhcp6.8.rst
index d18e7b6b13..d42f3e1fde 100644
--- a/doc/sphinx/man/kea-dhcp6.8.rst
+++ b/doc/sphinx/man/kea-dhcp6.8.rst
@@ -29,10 +29,10 @@ Arguments
The arguments are as follows:
``-v``
- Displays the version.
+ Displays the Kea version.
``-V``
- Displays the extended version.
+ Displays the extended Kea version.
``-W``
Displays the configuration report.
diff --git a/doc/sphinx/man/kea-lfc.8.rst b/doc/sphinx/man/kea-lfc.8.rst
index d00e97d40a..16d36e3ed4 100644
--- a/doc/sphinx/man/kea-lfc.8.rst
+++ b/doc/sphinx/man/kea-lfc.8.rst
@@ -73,10 +73,10 @@ The arguments are as follows:
if one of the processes was interrupted before completing its task.
``-v``
- Causes the version stamp to be printed.
+ Displays the Kea version.
``-V``
- Causes a longer form of the version stamp to be printed.
+ Displays the extended Kea version.
``-W``
Displays the configuration report.
diff --git a/doc/sphinx/man/kea-netconf.8.rst b/doc/sphinx/man/kea-netconf.8.rst
index d9cf92e9dc..30adfbe3f8 100644
--- a/doc/sphinx/man/kea-netconf.8.rst
+++ b/doc/sphinx/man/kea-netconf.8.rst
@@ -30,10 +30,10 @@ Arguments
The arguments are as follows:
``-v``
- Displays the version.
+ Displays the Kea version.
``-V``
- Displays the extended version.
+ Displays the extended Kea version.
``-W``
Displays the configuration report.
diff --git a/doc/sphinx/man/kea-shell.8.rst b/doc/sphinx/man/kea-shell.8.rst
index d46af789a3..b591a062a9 100644
--- a/doc/sphinx/man/kea-shell.8.rst
+++ b/doc/sphinx/man/kea-shell.8.rst
@@ -38,7 +38,7 @@ The arguments are as follows:
Displays help regarding command-line parameters.
``-v``
- Displays the version.
+ Displays the Kea version.
``--host``
Specifies the host to connect to. The Control Agent must be running at the
diff --git a/doc/sphinx/man/keactrl.8.rst b/doc/sphinx/man/keactrl.8.rst
index ca188e631a..5b5e432022 100644
--- a/doc/sphinx/man/keactrl.8.rst
+++ b/doc/sphinx/man/keactrl.8.rst
@@ -87,7 +87,10 @@ Options
built. This is the default.
``-v|--version``
- Prints the ``keactrl`` version and quits.
+ Displays the Kea version.
+
+``-V``
+ Displays the extended Kea version.
Documentation
~~~~~~~~~~~~~
diff --git a/doc/sphinx/man/perfdhcp.8.rst b/doc/sphinx/man/perfdhcp.8.rst
index 465d6f051f..74d0c11e97 100644
--- a/doc/sphinx/man/perfdhcp.8.rst
+++ b/doc/sphinx/man/perfdhcp.8.rst
@@ -287,7 +287,10 @@ Options
releasing it.
``-v``
- Prints the version of this program.
+ Displays the Kea version.
+
+``-V``
+ Displays the extended Kea version.
``-W exit-wait-time``
Specifies the exit-wait-time parameter, which causes ``perfdhcp`` to wait for