From a58bdb48e0f9c1b74f99459a47c9ff5ac0d6b7eb Mon Sep 17 00:00:00 2001 From: Marcin Chrzanowski Date: Sun, 31 May 2020 12:34:48 +0200 Subject: Document OTP flags --- contrib/dmenu/README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) (limited to 'contrib') diff --git a/contrib/dmenu/README.md b/contrib/dmenu/README.md index 9d54fb4..cc810e2 100644 --- a/contrib/dmenu/README.md +++ b/contrib/dmenu/README.md @@ -1,13 +1,27 @@ `passmenu` is a [dmenu][]-based interface to [pass][], the standard Unix password manager. This design allows you to quickly copy a password to the clipboard without having to open up a terminal window if you don't already have -one open. If `--type` is specified, the password is typed using [xdotool][] -instead of copied to the clipboard. +one open. -# Usage +If `--type` is specified, the password is typed using [xdotool][] instead of +copied to the clipboard. - passmenu [--type] [dmenu arguments...] +If `--otp` is specified, it will be assumed that [pass-otp][] is an installed +extension and instead of just getting the specified password, `passmenu` will +get the current one-time code. + +If `--infer-otp` is specified, `passmenu` will determine whether to treat the +selected password as a regular password or an OTP secret based on a regex +pattern match. Note that the default pattern matches all password IDs, so you +probably want to use this flag in combination with `--otp-pattern`. + +If `--otp-pattern REGEXP` is specified, password IDs matching the regular +expression will be interpreted as secrets for OTP-style two-factor +authentication. When used with `--otp`, only OTP password IDs will be displayed. + + passmenu [--type] [--otp] [--infer-otp] [--otp-pattern ] [dmenu arguments...] [dmenu]: http://tools.suckless.org/dmenu/ [xdotool]: http://www.semicomplete.com/projects/xdotool/ [pass]: http://www.zx2c4.com/projects/password-store/ +[pass-otp]: https://github.com/tadfisher/pass-otp -- cgit v1.2.3