summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2019-01-24 20:56:26 +0100
committerDaniel Mueller <deso@posteo.net>2019-01-26 23:10:08 -0800
commit3f4b606513386ad8c8d52ef9e3874a7b19bd56cd (patch)
tree1c7059f2c2a6ccbcc83bef3eb4bae6c50386577a
parentaae8315ea3986b40844959c4ec3d7734b124ddac (diff)
downloadnitrocli-3f4b606513386ad8c8d52ef9e3874a7b19bd56cd.tar.gz
nitrocli-3f4b606513386ad8c8d52ef9e3874a7b19bd56cd.tar.bz2
Document problems in conjunction with nitrokey-app
If nitrokey-app is running, the device it connected to cannot be detected by other applications. This patch adds this issue to the list of known problems in the README.
-rw-r--r--nitrocli/README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/nitrocli/README.md b/nitrocli/README.md
index 3003c6b..76bb2cb 100644
--- a/nitrocli/README.md
+++ b/nitrocli/README.md
@@ -110,12 +110,17 @@ $ cargo build --release
It is recommended that the resulting executable be installed in a
directory accessible via the `PATH` environment variable.
-#### Known Problems
-Due to a problem with the default `hidapi` version on macOS, users are advised
-to build and install [`libnitrokey`][] from source and then set the
-`USE_SYSTEM_LIBNITROKEY` environment variable when building `nitrocli` using
-one of the methods described above.
+Known Problems
+--------------
+
+- Due to a problem with the default `hidapi` version on macOS, users are
+ advised to build and install [`libnitrokey`][] from source and then
+ set the `USE_SYSTEM_LIBNITROKEY` environment variable when building
+ `nitrocli` using one of the methods described above.
+- `nitrocli` cannot connect to a Nitrokey device that is currently being
+ accessed by `nitrokey-app` ([upstream issue][libnitrokey#32]). To
+ prevent this problem, quit `nitrokey-app` before using `nitrocli`.
Contributing
@@ -152,3 +157,4 @@ the full text of the license.
[nitrocli-cratesio]: https://crates.io/crates/nitrocli
[nitrocli-gentoo]: https://packages.gentoo.org/packages/app-crypt/nitrocli
[gplv3-tldr]: https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)
+[libnitrokey#32]: https://github.com/Nitrokey/libnitrokey/issues/32