diff options
| author | David VaĊĦek <david.vasek@nic.cz> | 2023-04-19 12:59:36 +0200 |
|---|---|---|
| committer | Daniel Salzman <daniel.salzman@nic.cz> | 2023-04-19 14:53:22 +0200 |
| commit | 846a6f937a4a459236f23a51aa5e393a88e44171 (patch) | |
| tree | 67d1cd17f4442a3d65b461c41d1222131bf0f122 /doc/man_keymgr.rst | |
| parent | Merge branch 'test_no_resign_fix' into 'master' (diff) | |
| download | knot-846a6f937a4a459236f23a51aa5e393a88e44171.tar.xz knot-846a6f937a4a459236f23a51aa5e393a88e44171.zip | |
doc/keymgr: link the lists of DNSSEC and TSIG key algorithms in reference
Diffstat (limited to 'doc/man_keymgr.rst')
| -rw-r--r-- | doc/man_keymgr.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/man_keymgr.rst b/doc/man_keymgr.rst index 77f8e1a2a..156deb78a 100644 --- a/doc/man_keymgr.rst +++ b/doc/man_keymgr.rst @@ -41,10 +41,11 @@ Options ....... **-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. + Generates a TSIG key for the given name. Optionally the key algorithm can + be specified by its :ref:`name<key_algorithm>` (default: hmac-sha256) and + a bit length of the key (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. **-e**, **--extended** Extended output (listing of keys with full description). @@ -177,7 +178,8 @@ Generate arguments Arguments are separated by space, each of them is in format 'name=value'. **algorithm** - Either an algorithm number (e.g. 14), or text name without dashes (e.g. ECDSAP384SHA384). + Either an algorithm number (e.g. 14) or :ref:`algorithm name<policy_algorithm>` + without dashes (e.g. ECDSAP384SHA384). **size** Key length in bits. |