diff options
| author | Robin Krahl <robin.krahl@ireas.org> | 2020-09-29 19:18:56 +0200 |
|---|---|---|
| committer | Robin Krahl <robin.krahl@ireas.org> | 2020-10-02 11:58:21 +0200 |
| commit | a6538455de33f6d09dfa4011fbbdaa6e59b132f4 (patch) | |
| tree | 7f7fcfd2150a56f3c88b2371b63486090e22d207 /doc | |
| parent | 458d87d2a7fb31beea3e965bd77d7d0ce25eb4b4 (diff) | |
| download | nitrocli-nitrokey-v0.8.0.tar.gz nitrocli-nitrokey-v0.8.0.tar.bz2 | |
Rename numlock, capslock, scrollock optionsnitrokey-v0.8.0
This patch renames the options for the config set command:
--numlock ==> --num-lock
--capslock ==> --caps-lock
--scrolllock ==> --scroll-lock
--no-numlock ==> --no-num-lock
--no-capslock ==> --no-caps-lock
--no-scrolllock ==> --no-scroll-lock
The original naming was based on a typo in nitrokey-rs (scrollock vs.
scrolllock). Also, the typical spelling for the keys is Num Lock, Caps
Lock and Scroll Lock, so using a hyphen is a more natural.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/nitrocli.1 | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/nitrocli.1 b/doc/nitrocli.1 index 12ced4b..047a9df 100644 --- a/doc/nitrocli.1 +++ b/doc/nitrocli.1 @@ -217,26 +217,26 @@ List all OTP slots. If \fB\-\-all\fR is not set, empty slots are ignored. .SS Configuration -Nitrokey devices have four configuration settings: the numlock, capslock and -scrollock keys can be mapped to an HOTP slot, and OTP generation can be set to -require the user PIN. +Nitrokey devices have four configuration settings: the Num Lock, Caps Lock and +Scroll Lock keys can be mapped to an HOTP slot, and OTP generation can be set +to require the user PIN. .TP \fBnitrocli config get\fR Print the current Nitrokey configuration. .TP \fBnitrocli config set \fR\ -[[\fB\-n\fR|\fB\-\-numlock \fIslot\fR] | [\fB\-N\fR|\fB\-\-no\-numlock\fR]] \ -[[\fB\-c\fR|\fB\-\-capslock \fIslot\fR] | [\fB\-C\fR|\fB\-\-no\-capslock\fR]] \ -[[\fB\-s\fR|\fB\-\-scrollock \fIslot\fR] | [\fB\-S\fR|\fB\-\-no\-scrollock\fR]] \ +[[\fB\-n\fR|\fB\-\-num-lock \fIslot\fR] | [\fB\-N\fR|\fB\-\-no\-num-lock\fR]] \ +[[\fB\-c\fR|\fB\-\-caps-lock \fIslot\fR] | [\fB\-C\fR|\fB\-\-no\-caps-lock\fR]] \ +[[\fB\-s\fR|\fB\-\-scroll-lock \fIslot\fR] | [\fB\-S\fR|\fB\-\-no\-scroll-lock\fR]] \ [[\fB\-o\fR|\fB\-\-otp\-pin\fR] | [\fB\-O\fR|\fB\-\-no\-otp\-pin\fR]] Update the Nitrokey configuration. This command requires the admin PIN. -With the \fB\-\-numlock\fR, \fB\-\-capslock\fR and \fB\-\-scrollock\fR options, -the respective bindings can be set. +With the \fB\-\-num-lock\fR, \fB\-\-caps-lock\fR and \fB\-\-scroll-lock\fR +options, the respective bindings can be set. \fIslot\fR is the number of the HOTP slot to bind the key to. -If \fB\-\-no\-numlock\fR, \fB\-\-no\-capslock\fR or \fB\-\-no\-scrollock\fR is -set, the respective binding is disabled. +If \fB\-\-no\-num-lock\fR, \fB\-\-no\-caps-lock\fR or \fB\-\-no\-scroll-lock\fR +is set, the respective binding is disabled. The two corresponding options are mutually exclusive. If \fB\-\-otp\-pin\fR is set, the user PIN will be required to generate one-time |