diff options
| author | Daniel Salzman <daniel.salzman@nic.cz> | 2021-09-21 16:50:47 +0200 |
|---|---|---|
| committer | Daniel Salzman <daniel.salzman@nic.cz> | 2021-09-22 16:44:27 +0200 |
| commit | 388893e66de50e857b9ad85caf54eb162cac8a43 (patch) | |
| tree | 9283b55b5d421e970f0b133294b877ed207733e3 /doc/man_keymgr.rst | |
| parent | kjournalprint: take path to journal from configuration (diff) | |
| download | knot-388893e66de50e857b9ad85caf54eb162cac8a43.tar.xz knot-388893e66de50e857b9ad85caf54eb162cac8a43.zip | |
keymgr: unify program parameter processing
Diffstat (limited to 'doc/man_keymgr.rst')
| -rw-r--r-- | doc/man_keymgr.rst | 50 |
1 files changed, 26 insertions, 24 deletions
diff --git a/doc/man_keymgr.rst b/doc/man_keymgr.rst index 0c0dc1187..94b48fb70 100644 --- a/doc/man_keymgr.rst +++ b/doc/man_keymgr.rst @@ -6,9 +6,11 @@ keymgr – Key management utility Synopsis -------- -:program:`keymgr` *basic_option* [*parameters*...] +:program:`keymgr` [*config_option* *config_argument*] [*option*...] *zone* *command* *argument*... -:program:`keymgr` [*config_option* *config_storage*] *zone* *command* *argument*... +:program:`keymgr` [*config_option* *config_argument*] **-l** + +:program:`keymgr` **-t** *parameter*... Description ----------- @@ -21,47 +23,47 @@ management are provided. The DNSSEC and KASP configuration is stored in a so called KASP database. The database is backed by LMDB. -Basic options -............. +Config options +.............. -**-h**, **--help** - Print the program help. +**-c**, **--config** *file* + Use a textual configuration file (default is :file:`@config_dir@/knot.conf`). -**-V**, **--version** - Print the program version. +**-C**, **--confdb** *directory* + Use a binary configuration database directory (default is :file:`@storage_dir@/confdb`). + The default configuration database, if exists, has a preference to the default + configuration file. + +**-D**, **--dir** *path* + Use specified KASP database path and default configuration. + +Options +....... -**-t**, **--tsig** *tsig_name* [*tsig_algorithm*] [*tsig_bits*] +**-t**, **--tsig** *tsig_name* [*tsig_algorithm* [*tsig_bits*]] Generates a TSIG key. TSIG algorithm can be specified by string (default: hmac-sha256), bit length of the key by number (default: optimal length given by algorithm). The generated TSIG key is only displayed on `stdout`: the command does not create a file, nor include the key in a keystore. -**-b**, **--brief** - List keys briefly. Output to a terminal is colorized by default. - **-l**, **--list** Print the list of zones that have at least one key stored in the configured KASP database. +**-b**, **--brief** + List keys briefly. Output to a terminal is colorized by default. + **-x**, **--mono** Don't generate colorized output. **-X**, **--color** Force colorized output in the **--brief** mode. -Config options -.............. - -**-c**, **--config** *file* - Use a textual configuration file (default is :file:`@config_dir@/knot.conf`). - -**-C**, **--confdb** *directory* - Use a binary configuration database directory (default is :file:`@storage_dir@/confdb`). - The default configuration database, if exists, has a preference to the default - configuration file. +**-h**, **--help** + Print the program help. -**-D**, **--dir** *path* - Use specified KASP database path and default configuration. +**-V**, **--version** + Print the program version. .. NOTE:: Keymgr runs with the same user privileges as configured for :doc:`knotd<man_knotd>`. |