Add password obscuring

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

diff --git a/doc/vim-password-store.txt b/doc/vim-password-store.txt
index 1ab17389721773b4e6372e12e11b643345c9063c..03a42c07f8fea159fadbc9f6298dcb1c76d6e16e 100644 (file)
--- a/doc/vim-password-store.txt
+++ b/doc/vim-password-store.txt
@@ -28,6 +28,18 @@ 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 
 
 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 file it's quite likely readable and editable.
+
+This offers minor "shoulder surfing" protection, facilitating editing of
+metadata, such as adding URLs etc.
+

 4. Licence                                            *password-store-licence*
 
 This plugin is licensed under the same terms as vim itself (see
 4. Licence                                            *password-store-licence*
 
 This plugin is licensed under the same terms as vim itself (see