cryptutils

otp: Add otp manpage

Diffstat

1 files changed, 31 insertions, 0 deletions

diff --git a/man/otp.1 b/man/otp.1
new file mode 100644
index 0000000..7f1ad3a
--- /dev/null
+++ b/man/otp.1
@@ -0,0 +1,31 @@
+.TH OTP 1 2021-01-23 "OMKOV cryptutils" "General Commands Manual"
+.SH NAME
+otp \(em compute hotp or totp tokens
+.SH SYNOPSYS
+\fBotp\fR \fIsecret\fR [\fIcounter\fR]
+.SH DESCRIPTION
+Compute and print an HOTP or TOTP token for a given secret.
+.SH OPTIONS
+The following options are supported:
+.IP "\fB--help\fR" 8
+Display help information.
+.IP "\fB--version\fR" 8
+Display version information.
+.SH OPERANDS
+The following operands are supported:
+.IP "\fIsecret\fR" 8
+A secret key in Base16.
+.IP "\fIcounter\fR" 8
+A counter for HOTP. If no counter is specified, TOTP will be used instead.
+.SH EXIT STATUS
+The following exit values will be returned:
+.IP "\ 0" 8
+Successful completion.
+.IP ">0" 8
+An error occurred.
+.SH COPYRIGHT
+.nf
+Copyright (C) 2020, Jakob Wakeling
+All rights reserved.
+OMKOV Permissive Licence (https://www.omkov.net/OLPE)
+.fi