aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDale Phurrough <dale@hidale.com>2018-03-05 19:10:43 +0100
committerDale Phurrough <dale@hidale.com>2018-03-05 19:10:43 +0100
commitab9d3f2302b8f4093661678a7fa6a96662027991 (patch)
treeddbc373778f97ea10c9bcea0af5a89232227891f
parentbeb56d7a51eab19847d148bab49837e9eb49075a (diff)
downloadpinentry-rofi-ab9d3f2302b8f4093661678a7fa6a96662027991.tar.gz
tweak README and code comments
-rw-r--r--README.md4
-rw-r--r--pinentry-wsl-ps1.sh7
2 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 617a2b0..7aed855 100644
--- a/README.md
+++ b/README.md
@@ -39,8 +39,8 @@ with a GUI when running within WSL (Windows Subsystem for Linux)
* `"LocalMachine"` persists the password for the current Windows login on the local Windows computer
* `"Enterprise"` persists the password for the current Windows login and requests Windows Credential Manager to synchronize it across Windows computers for that same Windows login
4. Optionally _disable_ toast notification of password retrieval from Credential Manager. By default, this code notifies you with a toast notification every time gpg-agent retrieves a password from the Windows Credential Manager. Gpg-agent caches passwords by default (see gpg-agent settings like [`max-cache-ttl`](https://gnupg.org/documentation/manuals/gnupg/Agent-Options.html#Agent-Options)) so you may not see the notification with every usage.
- * Disable: edit the script, near the top, set `TOAST` to the value `"0"`
- * Enable: edit the script, near the top, set `TOAST` to the value `"1"`
+ * Disable: edit the script, near the top, set `NOTIFY` to the value `"0"`
+ * Enable: edit the script, near the top, set `NOTIFY` to the value `"1"`
## Troubleshooting Ideas
diff --git a/pinentry-wsl-ps1.sh b/pinentry-wsl-ps1.sh
index ceecb29..779ad8c 100644
--- a/pinentry-wsl-ps1.sh
+++ b/pinentry-wsl-ps1.sh
@@ -24,6 +24,13 @@
# Please follow instructions there to install from the Gallery or GitHub.
# Note security perspectives like https://security.stackexchange.com/questions/119765/how-secure-is-the-windows-credential-manager
# Possible values for PERSISTENCE are: "", "Session", "LocalMachine", or "Enterprise"
+# 4. Optionally disable toast notification of password retrieval from Credential Manager.
+# By default, this code notifies you with a toast notification every time gpg-agent
+# retrieves a password from the Windows Credential Manager. Gpg-agent caches passwords
+# by default (see gpg-agent settings like max-cache-ttl) so you may not see the notification
+# with every usage.
+# * Disable: edit the script, near the top, set NOTIFY to the value "0"
+# * Enable: edit the script, near the top, set NOTIFY to the value "1"
PERSISTENCE=""
NOTIFY="1"
DEBUGLOG=""