]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
doc/gettingstarted-config: kresctl doc update
authorAleš Mrázek <ales.mrazek@nic.cz>
Mon, 12 Dec 2022 20:54:14 +0000 (21:54 +0100)
committerAleš Mrázek <ales.mrazek@nic.cz>
Tue, 10 Jan 2023 18:57:14 +0000 (19:57 +0100)
doc/gettingstarted-config.rst

index b6e33ee2d3e61d0b03692b2768cd621e5a278fb3..2461197e7bd33d80661df46a041073d953148522 100644 (file)
@@ -71,37 +71,22 @@ HTTP request methods               Operation
 kresctl utility
 ===============
 
-Command-line utility to configure and control running Knot Resolver. It uses the above mentioned HTTP API.
-With no changed configuration for management HTTP API, ``kresctl`` shoul work out of the box.
-In other case there is ``-s`` argument to specify path to HTTP API endpoint.
+This command-line utility allows you to configure and control running Knot Resolver.
+For that it uses the above mentioned HTTP API.
 
-.. code-block::
-
-    $ kresctl -h
-    usage: kresctl [-h] [-i] [-s SOCKET] {stop,config,exit} ...
-
-    Command-line interface for controlling Knot Resolver
-
-    positional arguments:
-    {stop,config,exit}    command type
-        stop                shutdown everything
-        config              dynamically change configuration of a running resolver
-        exit                exit kresctl
-
-    optional arguments:
-    -h, --help            show this help message and exit
-    -i, --interactive     Interactive mode of kresctl utility
-    -s SOCKET, --socket SOCKET
-                          Path to the Unix domain socket of the configuration API
+For example, folowing command changes the number of ``kresd`` workers to 4.
 
+.. code-block::
 
-You can also get detailed help of every command, e.g. ``$ kresctl config -h``.
+    $ kresctl config /workers 4
 
-Folowing command changes configuration of the number of daemon workers to 4.
+The utility can also help with configuration **validation** and with configuration format **conversion**.
+For more information read full :ref:`kresctl documentation <manager-client>` or use ``kresctl --help`` command.
 
-.. code-block::
+.. note::
 
-    $ kresctl config /workers 4
+    With no changes in management configuration, ``kresctl`` should work out of the box.
+    In other case there is ``-s`` argument to specify path to HTTP API endpoint.
 
 
 ========================