Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add examples to manpage #188

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add examples to manpage #188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion pass-otp.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH PASS-OTP 1 "2017 March 19" "Password store OTP extension"
.TH PASS-OTP 1 "2023 September 21" "Password store OTP extension"

.SH NAME
pass-otp - A \fBpass\fP(1) extension for managing one-time-password (OTP) tokens.
Expand Down Expand Up @@ -113,6 +113,32 @@ information about this format, see the documentation at
\fBhelp\fP, \fB\-h\fP, \fB\-\-help\fP
Show usage message.

.SH EXAMPLES

.TP
.B Insert new OTP seed
$ pass otp insert totp-secret
.br
For totp the secret will be in the format: otpauth://totp/totp-secret?secret=AAAAAAAAAAA&issuer=totp-secret
.TP
.B To use your webcam to scan a QR code
$ zbarcam -q --raw | pass otp insert totp-secret
.TP
.B To use your webcam to append to an existing passfile
$ zbarimg -q --raw google-qrcode.png | pass otp append google/[email protected]
.br
If you have a clipboard management console tool such as `wl-clipboard` for
Wayland installed, you can also select "Copy Image" in your favorite browser
and run
.br
$ wl-paste | zbarimg -q --raw - | pass otp append google/[email protected]
.TP
.B Generate a 2FA code using seed
$ pass otp totp-secret
.TP
.B Display a QR code for an OTP token:
$ pass otp uri -q totp-secret

.SH SEE ALSO
.BR pass (1),
.BR qrencode (1),
Expand Down