X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/e22f51bf92fa6320a1b09ad479c6203fa29fa014..5e84ddfd6dcd1a8797b8c678c94f9bffb0cd7800:/doc/vim-password-store.txt

diff --git a/doc/vim-password-store.txt b/doc/vim-password-store.txt
index 1ab1738..eca22ab 100644
--- a/doc/vim-password-store.txt
+++ b/doc/vim-password-store.txt
@@ -28,6 +28,38 @@ this) and password-store https://www.passwordstore.org/ .
 The plugin automatically loads when it sees the appropriate file paths
 for password-store. This is Tom Ryders 
 
+There are two functions:
+>
+  :Conceal
+  :Reveal
+<
+That apply syntax highlighting to obscure and un-obscure the password.
+By default the pass file loads in obscured mode, however when the cursor is on
+the word it should readable and editable. This offers minor "shoulder surfing"
+protection, facilitating editing of metadata, such as adding URLs etc.
+
+There's minor feedback for short passwords, with Error highlighting for
+passwords 6 or less characters long.
+
+Password store also adds password generation support via pwgen. Since
+password-store already leverages pwgen, this is a fairly safe assumption.
+There is a Plug mapping *<Plug>rotate_password*
+by default this is mapped to <C-X> and <C-A> but can be overridden via setting
+an alternate plug mapping
+>
+  nnoremap >M-a> <Plug>rotate_password
+<
+The mapped sequence will generate a random password. As neither decrement nor
+increment mean anything in this context, buth are mapped to the same plug.
+The default length of the password is 10 character, but
+modifiable by altering the global g:password_store_pwlength
+>
+  let g:password_store_pwlength = 20
+<
+This is also available via the function call(s)
+>
+   password_store#replace()
+<
 4. Licence                                            *password-store-licence*
 
 This plugin is licensed under the same terms as vim itself (see