aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2019-01-07 19:20:34 +0000
committerRobin Krahl <me@robin-krahl.de>2019-01-11 04:36:25 +0100
commit000ba4f00084b8b91f863f376109383aab8b6f28 (patch)
tree76d06fa14825880bde0916da422bd2f5e7a3e8a6
parent42169d8456b493b6edc547610208cfe7bd2d6344 (diff)
downloadnitrocli-otp-qr-000ba4f00084b8b91f863f376109383aab8b6f28.tar.gz
nitrocli-otp-qr-000ba4f00084b8b91f863f376109383aab8b6f28.tar.bz2
Add man page as specification
-rw-r--r--nitrocli-otp-qr.123
1 files changed, 23 insertions, 0 deletions
diff --git a/nitrocli-otp-qr.1 b/nitrocli-otp-qr.1
new file mode 100644
index 0000000..7e907d9
--- /dev/null
+++ b/nitrocli-otp-qr.1
@@ -0,0 +1,23 @@
+.TH NITROCLI-OTP-QR 1 2019-01-07
+.SH NAME
+nitrocli-otp-qr \- read OTP configuration from a QR code and store it on a
+Nitrokey device
+.SH SYNOPSIS
+\fBnitrocli-otp-qr\fR \fIslot\fR [\fIfile\fR] \fB\-\-name \fIname\fR
+.SH DESCRIPTION
+\fBnitrocli-otp-qr\fR reads one-time password configuration from a QR code and
+stores it in an OTP slot on a Nitrokey device using \fBnitrocli\fR(1).
+
+\fIslot\fR is the number of the OTP slot to store the data in.
+\fIfile\fR is the image file to read the QR code from.
+If the argument is omitted, \fBimport\fR(1) is called and the user may select a
+screen region to capture the QR code from.
+
+The QR code must contain a otpauth URI as specified by Google Authenticator.
+
+.SH OPTIONS
+.TP
+\fB\-\-name \fIname\fR
+Set the name to store in the OTP slot.
+If this option is not set, \fBzenity\fR(1) is used to query a name
+interactively.