Sort of correct

[etc/vim.git] / doc / vim-password-store.txt

diff --git a/doc/vim-password-store.txt b/doc/vim-password-store.txt
index 1ab17389721773b4e6372e12e11b643345c9063c..1ffcf3654b49ea4314b67fa36b574f00834b0473 100644 (file)
--- a/doc/vim-password-store.txt
+++ b/doc/vim-password-store.txt
@@ -6,8 +6,9 @@ CONTENTS                                              *password-store-contents*
     1. Intro ........................................... |password-store-intro|
     2. Requirements ............................. |password-store-requirements|
     3. Usage ........................................... |password-store-usage|
-    4. Licence ....................................... |password-store-licence|
-    5. Credits ....................................... |password-store-credits|
+    4. Configuration .................................. |password-store-config|
+    5. Licence ....................................... |password-store-licence|
+    6. Credits ....................................... |password-store-credits|
 ===============================================================================
 1. Intro                                                 *password-store-intro*
 
@@ -28,6 +29,50 @@ 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 configuration This is also available via the function call(s)
+>
+   password_store#replace()
+<
+4. Configuration                                       *password-store-config*
+
+Configuration is done through a global dictionary *g:password_store_settings*
+Initialize the dictionary and add settings as needed
+>
+    let g:password_store_settings = {}
+
+Syntax obfustaction is enabled by default. To disable it:
+>
+    let g:password_store_settings.enable_syntax = 'false"
+
+
+Auto "increment" password length is 12 characters. To change it
+>
+  let g:password_store_settings.pw_length = 20
+<
 4. Licence                                            *password-store-licence*
 
 This plugin is licensed under the same terms as vim itself (see