aboutsummaryrefslogtreecommitdiff
path: root/nitrocli/README.md
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2018-12-30 00:36:56 +0100
committerDaniel Mueller <deso@posteo.net>2019-01-01 17:14:39 -0800
commit2f4a7b691ac676b028c7bc94b5974987f1e22046 (patch)
tree97ef4db84bd26e4d074d3c901cf3ceb81c59523e /nitrocli/README.md
parent76b1858c4f35ea3c1b542481222ca84a355c2342 (diff)
downloadnitrocli-2f4a7b691ac676b028c7bc94b5974987f1e22046.tar.gz
nitrocli-2f4a7b691ac676b028c7bc94b5974987f1e22046.tar.bz2
Document the config commands
This patch adds documentation and examples for config get and config set to the README and to the man page.
Diffstat (limited to 'nitrocli/README.md')
-rw-r--r--nitrocli/README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/nitrocli/README.md b/nitrocli/README.md
index 7504b1c..c36caff 100644
--- a/nitrocli/README.md
+++ b/nitrocli/README.md
@@ -13,6 +13,9 @@ certain commands on the [Nitrokey Storage][nitrokey-storage] device.
The following commands are currently supported:
- status: Report status information about the Nitrokey.
- clear: Remove the user and admin PIN from gpg-agent's cache.
+- config: Access the Nitrokey's configuration
+ - get: Read the current configuration.
+ - set: Change the configuration.
- storage: Work with the Nitrokey's storage.
- open: Open the encrypted volume. The user PIN needs to be entered.
- close: Close the encrypted volume.