Package: pass-otp Version: 1.2.0-9 Severity: wishlist Tags: patch upstream X-Debbugs-Cc: tipos...@tiscali.it
Dear Maintainer, I noticed that there is a URI needed to configure a seed, but that format is not documented anywhere in the manpage. I made a patch (which I've also sent upstream) to have some examples in the manpage so that people can read how to configure their seeds. Best -- System Information: Debian Release: trixie/sid APT prefers unstable APT policy: (500, 'unstable'), (500, 'testing') Architecture: amd64 (x86_64) Foreign Architectures: i386 Kernel: Linux 6.5.0-2-amd64 (SMP w/8 CPU threads; PREEMPT) Locale: LANG=it_IT.UTF-8, LC_CTYPE=it_IT.UTF-8 (charmap=UTF-8), LANGUAGE not set Shell: /bin/sh linked to /usr/bin/dash Init: systemd (via /run/systemd/system) LSM: AppArmor: enabled Versions of packages pass-otp depends on: ii pass 1.7.4-6 Versions of packages pass-otp recommends: ii oathtool 2.6.9-1 ii qrencode 4.1.1-1 Versions of packages pass-otp suggests: pn zbar-tools <none> -- no debconf information
>From f93d3206c6f16f3ef3b7dafadd1e0156e1d64f8c Mon Sep 17 00:00:00 2001 From: Salvo 'LtWorf' Tomaselli <tipos...@tiscali.it> Date: Sat, 21 Oct 2023 01:42:01 +0200 Subject: [PATCH] Add examples to manpage I copied the more relevant examples from the README and put them in the manpage, so that it should be possible to use the tool by learning its usage from man. Without the url format being documented it is not possible to use it. --- pass-otp.1 | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/pass-otp.1 b/pass-otp.1 index 9bded0c..1928ebe 100644 --- a/pass-otp.1 +++ b/pass-otp.1 @@ -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. @@ -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/exam...@gmail.com +.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/exam...@gmail.com +.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), -- 2.42.0
