aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMoviuro <moviuro+git@gmail.com>2017-12-05 20:57:13 +0100
committerMoviuro <moviuro+git@gmail.com>2017-12-05 20:59:37 +0100
commit856611e2f89dc71da8d10f26e18c9fa2b12474eb (patch)
treea4655faef1a88d39850633fe4fb16f9495b0cbd6
parent1b62f92dfb4fe89b7590049b3abe635c71775a9d (diff)
downloadrofi-pass-856611e2f89dc71da8d10f26e18c9fa2b12474eb.tar.gz
README.md: add documentation for OTPs
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 27c4ce9..fe1f407 100644
--- a/README.md
+++ b/README.md
@@ -36,11 +36,24 @@ in a convenient way using [rofi](https://github.com/DaveDavenport/rofi).
url: http://my.url.foo
autotype: SomeField :tab UserName :tab AnotherField :tab pass
```
-
You can use `:tab`, `:enter`, or `:space` here to type <kbd>Tab</kbd>,
<kbd>Enter</kbd>, or <kbd>Space</kbd> (useful for toggling checkboxes)
respectively.
`:delay` will trigger a delay (2 seconds by default).
+ `:otp` will generate an OTP, either `pass-otp(1)` style, or according to the
+ `otp_method:`, if it is defined.
+* Generating OTPs.
+ The format for OTPs should either be `pass-otp(1)`-compatible
+ ```
+ [...]
+ otpauth://[...]
+ ```
+ Or it should define a method for generating OTPs:
+ ```
+ [...]
+ otp_method: /opt/obscure-otp-generator/oog --some-option some args
+ ```
+
* All hotkeys are configurable in the config file
* The field names for `user`, `url` and `autotype` are configurable
* Bookmarks mode (open stored URLs in browser, default: Alt+x)
@@ -55,6 +68,7 @@ in a convenient way using [rofi](https://github.com/DaveDavenport/rofi).
* gawk
* bash
* pwgen
+* pass-otp(1) (https://github.com/tadfisher/pass-otp) (optional: for OTPs)
### BSD