summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2020-10-04 06:51:10 -0700
committerDaniel Mueller <deso@posteo.net>2020-10-04 06:51:10 -0700
commita992925f7dcee6a27404df0a56b47c09faed5265 (patch)
tree47c6290a58a41b30cc8c9d81fb6dfc963ffb3769 /doc
parent1af85ad50523427384234313fe00aa8bfa89135f (diff)
downloadnitrocli-a992925f7dcee6a27404df0a56b47c09faed5265.tar.gz
nitrocli-a992925f7dcee6a27404df0a56b47c09faed5265.tar.bz2
Update man page after change to base32 default OTP format
When we switched the default OTP format from hexadecimal to base32 we missed that the manual was providing examples of the otp set command that were implicitly making use of the default format -- leading to a mismatch between what the example is meant to do and what it actually does. This change fixes this oversight in the manual by adjusting the examples accordingly.
Diffstat (limited to 'doc')
-rw-r--r--doc/nitrocli.112
-rw-r--r--doc/nitrocli.1.pdfbin42200 -> 42165 bytes
2 files changed, 6 insertions, 6 deletions
diff --git a/doc/nitrocli.1 b/doc/nitrocli.1
index 7e788d0..e65a9e7 100644
--- a/doc/nitrocli.1
+++ b/doc/nitrocli.1
@@ -397,9 +397,9 @@ the encrypted volume (i.e., 50%) and stretching all the way to its end (100%):
.SS One-time passwords
Configure a one-time password slot with a hexadecimal secret representation:
- $ \fBnitrocli otp set 0 test\-rfc4226 3132333435363738393031323334353637383930 \-\-algorithm hotp\fR
- $ \fBnitrocli otp set 1 test\-foobar 666F6F626172 \-\-algorithm hotp\fR
- $ \fBnitrocli otp set 0 test\-rfc6238 3132333435363738393031323334353637383930 \-\-algorithm totp \-\-digits 8\fR
+ $ \fBnitrocli otp set 0 test\-rfc4226 3132333435363738393031323334353637383930 \-\-format hex \-\-algorithm hotp\fR
+ $ \fBnitrocli otp set 1 test\-foobar 666F6F626172 \-\-format hex \-\-algorithm hotp\fR
+ $ \fBnitrocli otp set 0 test\-rfc6238 3132333435363738393031323334353637383930 \-\-format hex \-\-algorithm totp \-\-digits 8\fR
.P
Configure a one-time password slot with an ASCII secret representation:
$ \fBnitrocli otp set 0 test\-rfc4226 12345678901234567890 \-\-format ascii \-\-algorithm hotp\fR
@@ -407,9 +407,9 @@ Configure a one-time password slot with an ASCII secret representation:
$ \fBnitrocli otp set 0 test\-rfc6238 12345678901234567890 \-\-format ascii \-\-algorithm totp \-\-digits 8\fR
.P
Configure a one-time password slot with a base32 secret representation:
- $ \fBnitrocli otp set 0 test\-rfc4226 gezdgnbvgy3tqojqgezdgnbvgy3tqojq \-\-format base32 \-\-algorithm hotp\fR
- $ \fBnitrocli otp set 1 test\-foobar mzxw6ytboi====== \-\-format base32 \-\-algorithm hotp\fR
- $ \fBnitrocli otp set 0 test\-rfc6238 gezdgnbvgy3tqojqgezdgnbvgy3tqojq \-\-format base32 \-\-algorithm totp \-\-digits 8\fR
+ $ \fBnitrocli otp set 0 test\-rfc4226 gezdgnbvgy3tqojqgezdgnbvgy3tqojq \-\-algorithm hotp\fR
+ $ \fBnitrocli otp set 1 test\-foobar mzxw6ytboi====== \-\-algorithm hotp\fR
+ $ \fBnitrocli otp set 0 test\-rfc6238 gezdgnbvgy3tqojqgezdgnbvgy3tqojq \-\-algorithm totp \-\-digits 8\fR
.P
Generate a one-time password:
$ \fBnitrocli otp get 0 \-\-algorithm hotp\fR
diff --git a/doc/nitrocli.1.pdf b/doc/nitrocli.1.pdf
index 1637449..030a80d 100644
--- a/doc/nitrocli.1.pdf
+++ b/doc/nitrocli.1.pdf
Binary files differ