summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/keymgr.8in20
-rw-r--r--doc/man_keymgr.rst19
2 files changed, 26 insertions, 13 deletions
diff --git a/doc/man/keymgr.8in b/doc/man/keymgr.8in
index 01e244f..020d854 100644
--- a/doc/man/keymgr.8in
+++ b/doc/man/keymgr.8in
@@ -34,6 +34,8 @@ keymgr \- Knot DNS key management utility
.sp
\fBkeymgr\fP [\fIconfig_option\fP] [\fIoptions\fP] \fIzone_name\fP \fIcommand\fP
.sp
+\fBkeymgr\fP [\fIconfig_option\fP] [\fIoptions\fP] \fIkeystore_id\fP \fIcommand\fP
+.sp
\fBkeymgr\fP [\fIconfig_option\fP] [\-j] \fB\-l\fP
.sp
\fBkeymgr\fP \fB\-t\fP \fIparameter\fP\&...
@@ -173,13 +175,17 @@ owned by both zones equally.
.SS Keystore commands
.INDENT 0.0
.TP
-\fBkeystore_test\fP
-Conduct some tests on the specified keystore. Use a configured keystore id
-or \fB\-\fP for the default.
-.TP
-\fBkeystore_bench\fP [\fInum_threads\fP]
-Conduct a signing benchmark for each supported algorithm. Use a configured
-keystore id or \fB\-\fP for the default.
+\fBkeystore\-test\fP
+Conduct some tests on the specified keystore. For each algorithm, key generation,
+import, removal, and use (signing and verification) are tested.
+Use a configured \fIkeystore_id\fP or \fB\-\fP for the default.
+.TP
+\fBkeystore\-bench\fP [\fInum_threads\fP]
+Conduct a signing benchmark on the specified keystore.
+Random blocks of data are signed by the selected number of threads
+(default is 1) in a loop, and the average number of signing operations per
+second for each algorithm is returned.
+Use a configured \fIkeystore_id\fP or \fB\-\fP for the default.
.UNINDENT
.SS Commands related to Offline KSK feature
.INDENT 0.0
diff --git a/doc/man_keymgr.rst b/doc/man_keymgr.rst
index de86972..136a92c 100644
--- a/doc/man_keymgr.rst
+++ b/doc/man_keymgr.rst
@@ -8,6 +8,8 @@ Synopsis
:program:`keymgr` [*config_option*] [*options*] *zone_name* *command*
+:program:`keymgr` [*config_option*] [*options*] *keystore_id* *command*
+
:program:`keymgr` [*config_option*] [-j] **-l**
:program:`keymgr` **-t** *parameter*...
@@ -146,12 +148,17 @@ Commands
Keystore commands
.................
-**keystore_test**
- Conduct some tests on the specified keystore. Use a configured keystore id
- or **-** for the default.
-**keystore_bench** [*num_threads*]
- Conduct a signing benchmark for each supported algorithm. Use a configured
- keystore id or **-** for the default.
+**keystore-test**
+ Conduct some tests on the specified keystore. For each algorithm, key generation,
+ import, removal, and use (signing and verification) are tested.
+ Use a configured *keystore_id* or **-** for the default.
+
+**keystore-bench** [*num_threads*]
+ Conduct a signing benchmark on the specified keystore.
+ Random blocks of data are signed by the selected number of threads
+ (default is 1) in a loop, and the average number of signing operations per
+ second for each algorithm is returned.
+ Use a configured *keystore_id* or **-** for the default.
Commands related to Offline KSK feature
.......................................