From 5db376b22250d10e652d3e697f2b0a22e8446c76 Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Sun, 30 Dec 2018 01:12:27 +0100 Subject: Document the lock command This patch adds documentation and examples for the lock command to the README and to the man page. It also adds the lock command to the top-level help message. --- nitrocli/README.md | 1 + nitrocli/doc/nitrocli.1 | 5 +++++ nitrocli/doc/nitrocli.1.pdf | Bin 13301 -> 13301 bytes nitrocli/src/args.rs | 2 +- 4 files changed, 7 insertions(+), 1 deletion(-) diff --git a/nitrocli/README.md b/nitrocli/README.md index 96ae3a5..33e094a 100644 --- a/nitrocli/README.md +++ b/nitrocli/README.md @@ -12,6 +12,7 @@ certain commands on the [Nitrokey Storage][nitrokey-storage] device. The following commands are currently supported: - status: Report status information about the Nitrokey. +- lock: Lock the Nitrokey. - config: Access the Nitrokey's configuration - get: Read the current configuration. - set: Change the configuration. diff --git a/nitrocli/doc/nitrocli.1 b/nitrocli/doc/nitrocli.1 index fc993f1..f16ecc6 100644 --- a/nitrocli/doc/nitrocli.1 +++ b/nitrocli/doc/nitrocli.1 @@ -17,6 +17,11 @@ and the password safe. Print the status of the connected Nitrokey device, including the stick serial number, the firmware version, and the PIN retry count. .TP +.B nitrocli lock +Lock the Nitrokey. +This command locks the password safe (see the Password safe section). On the +Nitrokey Storage, it will also close the encrypted volume (see the Storage +section). .SS Storage .TP diff --git a/nitrocli/doc/nitrocli.1.pdf b/nitrocli/doc/nitrocli.1.pdf index a98b9d2..0354e93 100644 Binary files a/nitrocli/doc/nitrocli.1.pdf and b/nitrocli/doc/nitrocli.1.pdf differ diff --git a/nitrocli/src/args.rs b/nitrocli/src/args.rs index f1db33f..ffcc0d1 100644 --- a/nitrocli/src/args.rs +++ b/nitrocli/src/args.rs @@ -952,7 +952,7 @@ fn parse_arguments(args: Vec) -> Result<(Command, Vec)> { let _ = parser.refer(&mut command).required().add_argument( "command", argparse::Store, - "The command to execute (config|otp|pin|pws|status|storage)", + "The command to execute (config|lock|otp|pin|pws|status|storage)", ); let _ = parser.refer(&mut subargs).add_argument( "arguments", -- cgit v1.2.1