path: root/README.markdown
diff options
authorTom Ryder <tom@sanctum.geek.nz>2018-06-10 00:24:34 +1200
committerTom Ryder <tom@sanctum.geek.nz>2018-06-10 00:24:47 +1200
commite92517df50a7450ec51f2dbb872f89034e90e6d4 (patch)
tree3bdd97ea49e8881c2f81767fa7bd168797fc1797 /README.markdown
parentDisable 'writebackup' too (diff)
Completely refactor for version 1.0.0v1.0.0
Turn off leaky options globally just after startup if we have only one file to edit and it matches the typical pass(1) path.
Diffstat (limited to 'README.markdown')
1 files changed, 6 insertions, 7 deletions
diff --git a/README.markdown b/README.markdown
index 8087640..eeee26b 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,17 +1,16 @@
-This plugin switches off the` 'viminfo'`, `'backup'`, `'swapfile'`, and
-`'undofile'` options locally for the buffer when editing passwords in the
-`pass(1)` password manager, or a comparable tool if `g:redact_pass_pattern` is
-set beforehand.
+This plugin switches off the 'viminfo', 'backup', 'writebackup', 'swapfile',
+and 'undofile' options globally when editing a password in `pass(1)`.
This is to prevent anyone being able to extract passwords from your Vim cache
files in the event of a compromise.
-Test this carefully to make sure it works! If it doesn't, it is probably
-because you need to set `g:redact_pass_pattern` to fit your system's behaviour,
-or the plugin hasn't loaded at all.
+You should test this after installed to ensure you see this message is printed
+whenever you `pass edit`:
+> Editing password file--disabled leaky options!