aboutsummaryrefslogtreecommitdiff
path: root/doc/nitrocli.1
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2020-09-06 23:44:18 +0200
committerDaniel Mueller <deso@posteo.net>2020-09-07 10:05:15 -0700
commit4d25d79f18cd2c5627c46727b425c745c78cf942 (patch)
treedda037f0b979415c6307d3b91ce9e81bf5636939 /doc/nitrocli.1
parent1f8e482cfebb13b64002d65e61e29932770388be (diff)
downloadnitrocli-4d25d79f18cd2c5627c46727b425c745c78cf942.tar.gz
nitrocli-4d25d79f18cd2c5627c46727b425c745c78cf942.tar.bz2
Fail if multiple matching devices are attached
Previously, we just applied our filter (if any) to all attached Nitrokey devices and selected the first match when connection to a Nitrokey device. This may lead to unexpected behavior if multiple devices are attached. This patch changes the find_device function to return an error if multiple matching devices are found.
Diffstat (limited to 'doc/nitrocli.1')
-rw-r--r--doc/nitrocli.113
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/nitrocli.1 b/doc/nitrocli.1
index 74cc2d9..680af3b 100644
--- a/doc/nitrocli.1
+++ b/doc/nitrocli.1
@@ -1,4 +1,4 @@
-.TH NITROCLI 1 2020-09-01
+.TH NITROCLI 1 2020-09-07
.SH NAME
nitrocli \- access Nitrokey devices
.SH SYNOPSIS
@@ -10,12 +10,17 @@ nitrocli \- access Nitrokey devices
It supports the Nitrokey Pro and the Nitrokey Storage.
It can be used to access the encrypted volume, the one-time password generator,
and the password safe.
+.SS Device selection
+Per default, \fBnitrocli\fR connects to any attached Nitrokey device.
+You can use the \fB\-\-model\fR option to select the device to connect to.
+\fBnitrocli\fR fails if more than one attached Nitrokey device matches
+this filter or if multiple Nitrokey devices are attached and this option
+is not set.
.SH OPTIONS
.TP
\fB\-m\fR, \fB\-\-model pro\fR|\fBstorage\fR
-Restrict connections to the given device model.
-If this option is not set, nitrocli will connect to any connected Nitrokey Pro
-or Nitrokey Storage device.
+Restrict connections to the given device model, see the Device selection
+section.
.TP
\fB\-\-no\-cache\fR
If this option is set, nitrocli will not cache any inquired secrets using