aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGuilhem Moulin <guilhem@fripost.org>2019-11-06 02:55:18 +0100
committerGuilhem Moulin <guilhem@fripost.org>2019-11-06 03:21:13 +0100
commit2f8350700091e766bdab24e7e8d8e051701da9e2 (patch)
tree8016ba7ef9b1cd0ca01847d01c1e14870f27c62a /doc
parent67e0d741f21bd589a2cbb4d23f07f5fb5eae889b (diff)
pullimap, interimap: redact AUTHENTICATE and LOGIN commands
In --debug mode in order to avoid inadvertently receiving credentials in bug reports. --debug can be set twice to spell out these commands in full.
Diffstat (limited to 'doc')
-rw-r--r--doc/interimap.1.md9
-rw-r--r--doc/pullimap.1.md9
2 files changed, 10 insertions, 8 deletions
diff --git a/doc/interimap.1.md b/doc/interimap.1.md
index 0fb83ea..8fa5def 100644
--- a/doc/interimap.1.md
+++ b/doc/interimap.1.md
@@ -178,10 +178,11 @@ Options
`--debug`
-: Turn on debug mode. Debug messages are written to the given *logfile*.
- Note that this include all IMAP traffic (except literals).
- Depending on the chosen authentication mechanism, this might include
- authentication credentials.
+: Turn on debug mode. Debug messages, which includes all IMAP traffic
+ besides literals, are written to the given *logfile*. The `LOGIN`
+ and `AUTHENTICATE` commands are however redacted (in order to avoid
+ disclosing authentication credentials) unless the `--debug` flag is
+ set multiple times.
`-h`, `--help`
diff --git a/doc/pullimap.1.md b/doc/pullimap.1.md
index 1b2e509..d40ece8 100644
--- a/doc/pullimap.1.md
+++ b/doc/pullimap.1.md
@@ -57,10 +57,11 @@ Options
`--debug`
-: Turn on debug mode. Debug messages are written to the error output.
- Note that this include all IMAP traffic (except literals).
- Depending on the chosen authentication mechanism, this might include
- authentication credentials.
+: Turn on debug mode. Debug messages, which includes all IMAP traffic
+ besides literals, are written to the given *logfile*. The `LOGIN`
+ and `AUTHENTICATE` commands are however redacted (in order to avoid
+ disclosing authentication credentials) unless the `--debug` flag is
+ set multiple times.
`-h`, `--help`