about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorLyle Hanson <lyle2.0@gmail.com>2019-06-12 11:20:49 -0500
committerDrew DeVault <sir@cmpwn.com>2019-06-14 10:55:55 -0400
commit0b14d92baf19ad01369d10e84bac1af4f57f179d (patch)
tree43eeb625a94972d48ebebdd6811e8c533cf13a46
parentfd0265d917edaf6d9448bdf9df2708f5de380cab (diff)
downloadaerc-0b14d92baf19ad01369d10e84bac1af4f57f179d.tar.gz
Document collecting log output
Redirecting stdout writes log output to that file, but this wasn't
easily discoverable.

v2 removes changes to aerc-tutorial; I was also on the fence about that,
and agree that it isn't on-topic for the tutorial.

Addresses https://todo.sr.ht/~sircmpwn/aerc2/180
-rw-r--r--README.md4
-rw-r--r--doc/aerc.1.scd8
2 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index dac8848..7a07406 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,10 @@ Then compile aerc:
 On its first run, aerc will copy the default config files to `~/.config/aerc`
 and show the account configuration wizard.
 
+If you redirect stdout to a file, logging output will be written to that file:
+
+    $ aerc > log
+
 ## Resources
 
 [Send patches](https://git-send-email.io) and questions to
diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd
index 7b09531..e7d3c59 100644
--- a/doc/aerc.1.scd
+++ b/doc/aerc.1.scd
@@ -132,6 +132,14 @@ message list, the message in the message viewer, etc).
 *close*
 	Closes the terminal.
 
+# LOGGING
+
+Aerc does not log by default, but collecting log output can be useful for
+troubleshooting and reporting issues. Redirecting stdout when invoking aerc will
+write log messages to that file:
+
+	$ aerc > log
+
 # SEE ALSO
 
 *aerc-config*(5) *aerc-imap*(5) *aerc-smtp*(5) *aerc-tutorial*(7)