aboutsummaryrefslogtreecommitdiff
path: root/nitrocli/doc
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2019-01-04 18:27:45 -0800
committerDaniel Mueller <deso@posteo.net>2019-01-04 18:27:45 -0800
commit1af4c0771034aa5d5f0a1f558dabc58c87fa3b19 (patch)
treec5013b6302fa17de4eaa820d365da9356e66b23c /nitrocli/doc
parente569fec44940add141cc526ce77f67dfe976c8e0 (diff)
downloadnitrocli-1af4c0771034aa5d5f0a1f558dabc58c87fa3b19.tar.gz
nitrocli-1af4c0771034aa5d5f0a1f558dabc58c87fa3b19.tar.bz2
Introduce -v/--verbose option
This change introduces a new option, -v/--verbose, that can be used to increase the log level of libnitrokey. The option can be supplied multiple times, with each occurrence increasing the verbosity of the logging. On the implementation side, the option is set as part of connecting the device (piggy-backing on the previously introduced command execution context), although it describes global state that strictly speaking could be set anywhere. It is bad enough that libnitrokey just prints log messages to stderr (and does not accept a file handle) and that it does not track the log level on a per-device basis, but we don't want setting of global state from arbitrary locations inside the program. Instead, let's do that along with what pretty much is the first call into libnitrokey anyway: the connection to the device.
Diffstat (limited to 'nitrocli/doc')
-rw-r--r--nitrocli/doc/nitrocli.112
-rw-r--r--nitrocli/doc/nitrocli.1.pdfbin13301 -> 13820 bytes
2 files changed, 11 insertions, 1 deletions
diff --git a/nitrocli/doc/nitrocli.1 b/nitrocli/doc/nitrocli.1
index f16ecc6..7786fc1 100644
--- a/nitrocli/doc/nitrocli.1
+++ b/nitrocli/doc/nitrocli.1
@@ -1,8 +1,9 @@
-.TH NITROCLI 1 2018-12-30
+.TH NITROCLI 1 2019-01-05
.SH NAME
nitrocli \- access Nitrokey devices
.SH SYNOPSIS
.B nitrocli
+\fR[\fB\-v\fR|\fB\-\-verbose\fR]
\fIcommand\fR
[\fIarguments\fR]
.SH DESCRIPTION
@@ -10,6 +11,15 @@ 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.
+.SH OPTIONS
+.TP
+.B \-v, \-\-verbose
+Enable additional logging and control its verbosity. Logging enabled through
+this option will appear on the standard error stream. This option can be
+supplied multiple times. A single occurrence will show additional warnings.
+Commands sent to the device will be shown when supplied three times and full
+device communication is available with four occurrences. Supplying this option
+five times enables the highest verbosity.
.SH COMMANDS
.SS General
.TP
diff --git a/nitrocli/doc/nitrocli.1.pdf b/nitrocli/doc/nitrocli.1.pdf
index 0354e93..c5e8898 100644
--- a/nitrocli/doc/nitrocli.1.pdf
+++ b/nitrocli/doc/nitrocli.1.pdf
Binary files differ