diff options
| author | Robin Krahl <me@robin-krahl.de> | 2018-12-14 01:57:15 +0100 |
|---|---|---|
| committer | Daniel Müller <d-e-s-o@users.noreply.github.com> | 2018-12-14 18:40:00 -0800 |
| commit | f96905aeaf603840f83f2ce34f20399cb85289fa (patch) | |
| tree | 76ee273ad868f23a74f7425470e19adee92db97b | |
| parent | 4127a18330a3622bc5821f2e8476ef955a4626fa (diff) | |
| download | nitrocli-f96905aeaf603840f83f2ce34f20399cb85289fa.tar.gz nitrocli-f96905aeaf603840f83f2ce34f20399cb85289fa.tar.bz2 | |
Add a nitrocli(1) man page
| -rw-r--r-- | nitrocli/doc/nitrocli.1 | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/nitrocli/doc/nitrocli.1 b/nitrocli/doc/nitrocli.1 new file mode 100644 index 0000000..db6dde1 --- /dev/null +++ b/nitrocli/doc/nitrocli.1 @@ -0,0 +1,27 @@ +.TH NITROCLI 1 2018-12-14 +.SH NAME +nitrocli \- access Nitrokey devices +.SH SYNOPSIS +.B nitrocli +\fBclear\fR|\fBclose\fR|\fBopen\fR|\fBstatus\fR +.SH DESCRIPTION +\fBnitrocli\fR provides access to Nitrokey devices. +Currently, \fBnitrocli\fR only supports accessing the encrypted volume of a +Nitrokey Storage. +.SH COMMANDS +.TP +.B open +Open the encrypted volume on the Nitrokey Storage. +The user PIN that is required to open the volume is queried using +\fBpinentry\fR(1) and cached by \fBgpg-agent\fR(1). +.TP +.B close +Close the encrypted volume on the Nitrokey Storage. +.TP +.B status +Print the status of the connected Nitrokey Storage, including the SD card +serial number, the firmware version, the encryption status, the PIN retry count +and the status of the volumes. +.TP +.B clear +Clear the passphrase cached by the \fBopen\fR command. |