summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2022-05-28 10:59:52 +0300
committerDirk-Jan C. Binnema <djcb@djcbsoftware.nl>2022-05-29 11:10:46 +0300
commitb1ff292bbb3d1be6ff2c15e901acc5d2b49e1163 (patch)
tree8887a310fc1019dc23508c36f8d35f54c276bdbd /man
parent926b49220e58282fdc37983e51e4427ee1de99e7 (diff)
mu: support MUHOME environment variable
Diffstat (limited to 'man')
-rw-r--r--man/mu-init.112
-rw-r--r--man/mu.18
2 files changed, 16 insertions, 4 deletions
diff --git a/man/mu-init.1 b/man/mu-init.1
index 27309e8..e5697d4 100644
--- a/man/mu-init.1
+++ b/man/mu-init.1
@@ -1,4 +1,4 @@
-.TH MU-INIT 1 "January 2022" "User Manuals"
+.TH MU-INIT 1 "May 2022" "User Manuals"
.SH NAME
@@ -23,8 +23,12 @@ man-page and not here, as they apply to multiple mu commands.
\fB\-\-muhome\fR
use an alternative directory to store and read the database, write the logs,
etc. By default, \fBmu\fR uses XDG Base Directory Specification (e.g. on Linux
-this defaults to \fI~/.cache/mu\fR, \fI~/.config/mu\fR). Earlier versions of
-\fBmu\fR defaulted to \fI~/.mu\fR, which now requires \fI\-\-muhome=~/.mu\fR.
+this defaults to \fI~/.cache/mu\fR, \fI~/.config/mu\fR).
+
+Earlier versions of \fBmu\fR defaulted to \fI~/.mu\fR, which now requires
+\fI\-\-muhome=~/.mu\fR.
+
+Alternatively, use can use the \fBMUHOME\fR environment variable (the command-line takes precedence).
.TP
\fB\-m\fR, \fB\-\-maildir\fR=\fI<maildir>\fR
@@ -52,6 +56,8 @@ shell program, the argument may need to b quoted.
specified explicitly with \fB\-\-maildir\fR=\fI<maildir>\fR. If \fBMAILDIR\fR is
not set, \fBmu init\fR uses \fI~/Maildir\fR.
+\fBMUHOME\fR can be used as an alternative to \fB\-\-muhome\fR.
+
.SH RETURN VALUE
\fBmu init\fR returns 0 upon successful completion, or a non-zero exit code if
diff --git a/man/mu.1 b/man/mu.1
index c6a9063..95469e9 100644
--- a/man/mu.1
+++ b/man/mu.1
@@ -1,4 +1,4 @@
-.TH MU 1 "February 2021" "User Manuals"
+.TH MU 1 "May 2022" "User Manuals"
.SH NAME
@@ -162,6 +162,12 @@ prints \fBmu\fR version and copyright information.
\fB\-h\fR, \fB\-\-help\fR
lists the various command line options.
+.SH ENVIRONMENT
+
+\fBMUHOME\fR can be used as an alternative to \fB\-\-muhome\fR. The latter has precedence.
+
+\fBNO_COLOR\fR can be used as an alternative to \fB\-\-nocolor\fR.
+
.SH ERROR CODES
The various mu subcommands typically exit with 0 (zero) upon success, and