Skip to content

Commit

Permalink
man: update description of logging
Browse files Browse the repository at this point in the history
Fixes #2762.
  • Loading branch information
djcb committed Sep 24, 2024
1 parent 18a9bd4 commit 23b3975
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
7 changes: 3 additions & 4 deletions man/common-options.inc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

** -d, --debug
Makes *mu* generate extra debug information, useful for debugging the program
itself. By default, debug information goes to the log file, _~/.cache/mu/mu.log_.
It can safely be deleted when *mu* is not running. When running with *--debug*
option, the log file can grow rather quickly. See the note on logging below.
itself. Debug information goes to the standard logging location; see
{{{man-link(mu,1)}}}.

** -q, --quiet
Causes *mu* not to output informational messages and progress information to
Expand All @@ -14,7 +13,7 @@ recommended you use this option when using *mu* from scripts etc.

** --log-stderr
Causes *mu* to not output log messages to standard error, in addition to sending
them to the log file.
them to the standard logging location.

** --nocolor
Do not use ANSI colors. The environment variable *NO_COLOR* can be used as an
Expand Down
11 changes: 11 additions & 0 deletions man/mu.1.org
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,17 @@ The *index*, *find*, and *cfind* commands work with the database, while the othe
ones work on individual mail files. Hence, running *view*, *mkdir* and *extract* does
not require the *mu* database.

* LOGGING

*mu* logs to the standard logging location, which is either the systemd journal,
*syslog* or a log file (by default, _~/.cache/mu/mu.log_), depending on your
*system's setup; the first that appears to be working is used.

When using a log file, it can safely be deleted when *mu* is not running. When
running with *--debug* option, the log file can grow rather quickly. See the note
on logging below.


#+include: "common-options.inc" :minlevel 1

#+include: "exit-code.inc" :minlevel 1
Expand Down

0 comments on commit 23b3975

Please sign in to comment.