alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mu: Default to XDG Base Directory Specification

Browse Source 
Instead of using ~/.mu, use the XDG Base Directory Specification, typically:
  ~/.cache/xapian
  ~/.cache/mu.log
  ~/.cache/parts
  ~/.config/bookmarks

Update dependencies, documentation.
This commit is contained in:
Dirk-Jan C. Binnema
2019-07-12 17:36:08 +03:00
parent 003d0a39b5
commit 632f383c38
11 changed files with 156 additions and 343 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
man/mu-bookmarks.5
View File

@ -1,17 +1,18 @@
.TH MU-BOOKMARKS 5 "May 2011" "User Manuals"
.TH MU-BOOKMARKS 5 "July 2019" "User Manuals"
.SH NAME
.SH NAME
bookmarks \- file with bookmarks (shortcuts) for mu search expressions
.SH DESCRIPTION
Bookmarks are named shortcuts for search queries. They allow using a
convenient name for often-used queries. The bookmarks are also visible as
shortcuts in the mu experimental user interfaces, \fImug\fR and \fImug2\fR.
Bookmarks are named shortcuts for search queries. They allow using a convenient
name for often-used queries. The bookmarks are also visible as shortcuts in the
mu experimental user interfaces, \fImug\fR and \fImug2\fR.
\fBmu\fR supports bookmarks stored in a file called \fBbookmarks\fR in the mu
home directory (typically, this would be \fI~/.mu/bookmarks\fR).
The bookmarks file is read from \fI<muhome>/bookmarks\fR. On Unix this would
typically be w be \fI~/.config/mu/bookmarks\fR, but this can be influenced using
the \fB\-\-muhome\fR parameter for \fBmu-find\fR(1) and \fBmug\fR(1).
The bookmarks file is a typical key=value \fB.ini\fR-file, which is best shown
by means of an example:
@ -26,12 +27,6 @@ The \fB[mu]\fR group header is required.
For practical uses of bookmarks, see \fBmu-find\fR(1).
.SH LOCATION
The bookmarks file is read from \fI<muhome>/bookmarks\fR. Typically, this
would be \fI~/.mu/bookmarks\fR, but this can be influenced using the
\fB\-\-muhome\fR parameter for \fBmu-find\fR(1) and \fBmug\fR(1).
.SH AUTHOR
Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>

46
man/mu.1
View File

@ -1,4 +1,4 @@
.TH MU 1 "September 2018" "User Manuals"
.TH MU 1 "July 2019" "User Manuals"
.SH NAME
@ -120,10 +120,10 @@ including \fBmu\fR without any command.
.TP
\fB\-\-muhome\fR
causes \fBmu\fR to use an alternative directory to
store and read its database and logs. By default, \fBmu\fR uses
whatever the \fBMU_HOME\fR environment variable is set to; if it is
not set, \fI~/.mu\fR is used.
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
by default \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.
.TP
\fB\-d\fR, \fB\-\-debug\fR
@ -157,40 +157,7 @@ lists the various command line options.
.SH ERROR CODES
The various mu subcommands typically exit with 0 (zero) upon success, and
non-zero when some error occurred. The table lists the various error codes.
.nf
exit code | error
----------+-------------------------------------------
1 | MU_ERROR
2 | MU_ERROR_IN_PARAMETERS
3 | MU_ERROR_INTERNAL
4 | MU_ERROR_NO_MATCHES
|
11 | MU_ERROR_XAPIAN
|
13 | MU_ERROR_XAPIAN_QUERY
14 | MU_ERROR_XAPIAN_DIR_NOT_ACCESSIBLE
15 | MU_ERROR_XAPIAN_NOT_UP_TO_DATE
16 | MU_ERROR_XAPIAN_MISSING_DATA
17 | MU_ERROR_XAPIAN_CORRUPTION
18 | MU_ERROR_XAPIAN_CANNOT_GET_WRITELOCK
30 | MU_ERROR_GMIME
|
50 | MU_ERROR_CONTACTS
51 | MU_ERROR_CONTACTS_CANNOT_RETRIEVE
|
70 | MU_ERROR_FILE
71 | MU_ERROR_FILE_INVALID_NAME
72 | MU_ERROR_FILE_CANNOT_LINK
73 | MU_ERROR_FILE_CANNOT_OPEN
74 | MU_ERROR_FILE_CANNOT_READ
75 | MU_ERROR_FILE_CANNOT_CREATE
76 | MU_ERROR_FILE_CANNOT_MKDIR
77 | MU_ERROR_FILE_STAT_FAILED
78 | MU_ERROR_FILE_READDIR_FAILED
79 | MU_ERROR_FILE_INVALID_SOURCE
.fi
non-zero when some error occurred.
.SH BUGS
@ -204,3 +171,4 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu-index (1), mu-find (1), mu-cfind (1), mu-mkdir (1), mu-view (1),
.BR mu-extract (1), mu-easy (1), mu-bookmarks (5), mu-query (7)
.BR https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html