document defaults of referenced XDG env vars

so users don't have to google the spec.
This commit is contained in:
Oswald Buddenhagen 2022-07-09 08:26:01 +02:00
parent 8648d7a479
commit 65cd4429bb

View File

@ -36,6 +36,7 @@ Multiple replicas of each mailbox can be maintained.
Read configuration from \fIfile\fR. Read configuration from \fIfile\fR.
By default, the configuration is read from $XDG_CONFIG_HOME/isyncrc, and By default, the configuration is read from $XDG_CONFIG_HOME/isyncrc, and
if that does not exist, ~/.mbsyncrc is tried in turn. if that does not exist, ~/.mbsyncrc is tried in turn.
$XDG_CONFIG_HOME defaults to ~/.config if not set.
.TP .TP
\fB-a\fR, \fB--all\fR \fB-a\fR, \fB--all\fR
Select all configured Channels. Any Channel/Group specifications on the Select all configured Channels. Any Channel/Group specifications on the
@ -732,7 +733,8 @@ the appended string is made up according to the pattern
(see also \fBFieldDelimiter\fR below). (see also \fBFieldDelimiter\fR below).
.br .br
(Global default: \fI$XDG_STATE_HOME/isync/\fR, with a fallback to (Global default: \fI$XDG_STATE_HOME/isync/\fR, with a fallback to
\fI~/.mbsync/\fR if only that exists) \fI~/.mbsync/\fR if only that exists.
$XDG_STATE_HOME defaults to ~/.local/state if not set.)
. .
.SS Groups .SS Groups
.TP .TP
@ -858,11 +860,11 @@ There is no risk as long as the IMAP mailbox is accessed by only one client
. .
.SH FILES .SH FILES
.TP .TP
.B $XDG_CONFIG_HOME/isyncrc \fB$XDG_CONFIG_HOME/isyncrc\fR (usually \fB~/.config/isyncrc\fR)
Default configuration file. Default configuration file.
See also the example file in the documentation directory. See also the example file in the documentation directory.
.TP .TP
.B $XDG_STATE_HOME/isync/ \fB$XDG_STATE_HOME/isync/\fR (usually \fB~/.local/state/isync/\fR)
Directory containing synchronization state files. Directory containing synchronization state files.
.TP .TP
.B ~/.mbsyncrc .B ~/.mbsyncrc