]> git.madduck.net Git - etc/vim.git/blob - .vim/bundle/password-store/doc/vim-password-store.txt

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Write mail backups on write
[etc/vim.git] / .vim / bundle / password-store / doc / vim-password-store.txt
1 *vim-password-store* Niceties for editing password-store files
2
3 ===============================================================================
4 CONTENTS                                              *password-store-contents*
5
6     1. Intro ........................................... |password-store-intro|
7     2. Requirements ............................. |password-store-requirements|
8     3. Usage ........................................... |password-store-usage|
9     4. Configuration .................................. |password-store-config|
10     5. Licence ....................................... |password-store-licence|
11     6. Credits ....................................... |password-store-credits|
12 ===============================================================================
13 1. Intro                                                 *password-store-intro*
14
15 Password store is a nice command line password manager, well suited to
16 vim's style. Tom Ryder has written a plugin to unset the standard
17 password security leakages, backup files, info files etc. This works
18 well, but doesn't provide hooks for extending. I wanted to add a few
19 simple enhancements, including unsetting spelling (no password should be
20 spell checked :-) and some simple syntax highlighting.
21
22 2. Requirements                                   *password-store-requirements*
23
24 A plugin manager (not required but the plugin is written to expect
25 this) and password-store https://www.passwordstore.org/ .
26
27 3. Usage                                                 *password-store-usage*
28
29 The plugin automatically loads when it sees the appropriate file paths
30 for password-store. This is Tom Ryders 
31
32 There are two functions:
33 >
34   :Conceal
35   :Reveal
36 <
37 That apply syntax highlighting to obscure and un-obscure the password.
38 By default the pass file loads in obscured mode, however when the cursor is on
39 the word it should readable and editable. This offers minor "shoulder surfing"
40 protection, facilitating editing of metadata, such as adding URLs etc.
41
42 There's minor feedback for short passwords, with Error highlighting for
43 passwords 6 or less characters long.
44
45 Password store also adds password generation support via pwgen. Since
46 password-store already leverages pwgen, this is a fairly safe assumption.
47 There is a Plug mapping *<Plug>rotate_password*
48 by default this is mapped to <C-X> and <C-A> but can be overridden via setting
49 an alternate plug mapping
50 >
51   nnoremap >M-a> <Plug>rotate_password
52 <
53 The mapped sequence will generate a random password. As neither decrement nor
54 increment mean anything in this context, buth are mapped to the same plug.
55 The default length of the password is 10 character, but
56 modifiable by configuration This is also available via the function call(s)
57 >
58    password_store#replace()
59 <
60 4. Configuration                                       *password-store-config*
61
62 Configuration is done through a global dictionary *g:password_store_settings*
63 Initialize the dictionary and add settings as needed
64 >
65     let g:password_store_settings = {}
66
67 Syntax obfustaction is enabled by default. To disable it:
68 >
69     let g:password_store_settings.enable_syntax = 'false"
70
71
72 Auto "increment" password length is 12 characters. To change it
73 >
74   let g:password_store_settings.pw_length = 20
75 <
76 4. Licence                                            *password-store-licence*
77
78 This plugin is licensed under the same terms as vim itself (see
79 |license| )
80
81 5. Credits                                            *password-store-credits*
82
83 Tom Ryder
84 https://git.zx2c4.com/password-store/
85
86 vim:ft=help