diff options
author | Teddy Wing | 2018-03-03 15:50:23 +0100 |
---|---|---|
committer | Teddy Wing | 2018-03-03 17:58:49 +0100 |
commit | 094f65dc9966ffddc9798ed506de6c4e159d82af (patch) | |
tree | 5856bc8a96d90b81a0c1965168381229c1db7090 /doc/passextract.1.txt | |
parent | 28623a4dda3963b65e50b6ff0deda40dcb500d53 (diff) | |
download | Passextract-094f65dc9966ffddc9798ed506de6c4e159d82af.tar.bz2 |
Add man page
Provide a man page for in situ documentation. Use AsciiDoc to generate
the man page.
Yay, my first man page!
Resources:
- https://github.com/BurntSushi/ripgrep/blob/fe9be65/build.rs
- https://github.com/BurntSushi/ripgrep/blob/f5411b9/doc/rg.1.txt.tpl
- http://www.methods.co.nz/asciidoc/asciidoc.1.txt
- https://github.com/git/git/blob/23f8239/Documentation/git-clean.txt
- https://github.com/git/git/blob/8a8f121049fdd881981799755a041b3f81449805/Documentation/asciidoctor-extensions.rb
- http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
- https://github.com/git/git/commit/5945717009cbd07fc303939452df6475ac342fe7
Diffstat (limited to 'doc/passextract.1.txt')
-rw-r--r-- | doc/passextract.1.txt | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/passextract.1.txt b/doc/passextract.1.txt new file mode 100644 index 0000000..7b4596d --- /dev/null +++ b/doc/passextract.1.txt @@ -0,0 +1,68 @@ +passextract(1) +============== + +NAME +---- +passextract - Copy login details from pass(1) + +SYNOPSIS +-------- +*passextract* ['OPTIONS'] ['PASS_FILE'] + +DESCRIPTION +----------- +An extension to the pass(1) password manager. Passextract provides a UI +similar to urlview(2) that enables these additional fields to be copied +to the system clipboard. Three fields are recognised: emails, usernames, +and passwords. They are defined as follows: + + This text is ignored + + e: email@example.com + u: username + p: secret-password + +In order to be recognised by Passextract, those fields must be prefixed +by “e: ”, “u: ”, or “p: ” as illustrated above. + +The passextract(1) command will parse those fields from 'PASS_FILE'. If +'PASS_FILE' is not provided or if it's '-' then the standard input is +used. + +OPTIONS +------- +-i:: + Make password strings invisible by replacing them with stars ("*"). + +INTERACTIVE CONTROL +------------------- +In the interactive UI, the following commands are available: + +q / C-c:: + Quit and clear the clipboard +j:: + Move the selection down +k:: + Move the selection up +g:: + Move the selection to the top +G:: + Move the selection to the bottom +ENTER:: + Copy the currently selected line + +EXAMPLES +-------- +Passextract can be invoked on its own or with the piped output of `pass +show`. + + $ pass show github.com | passextract + $ passextract github.com + +The included Bash completion file provides the same tab completion +options as `pass show`. + +SHELL COMPLETION +---------------- +Shell completion is provided to complete pass(1) files. To enable Bash +completion, source the included `passextract.bash-completion` file. |