emacs
/
mu
mirror of https://github.com/djcb/mu.git
1
0
Fork 0
Code Issues Releases Wiki Activity

man: improve exit code descriptions

This commit is contained in:
Dirk-Jan C. Binnema 2023-01-29 15:38:06 +02:00
parent e21d59e346
commit 4449ac9d29
5 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
man/exit-code.inc
View File

@ -1,8 +1,20 @@
* EXIT CODE
This command returns 0 upon successful completion, or a non-zero exit code
otherwise.
otherwise. Typical values are 2 (no matches found), 11 (database schema
mismatch) and 12 (failed to acquire database lock).
** no matches found (2)
Nothing matching found; try a different query
** database schema mismatch (11)
You need to re-initialize ~mu~, see *mu-init(1*)
** failed to acquire lock (19)
Some other program has exclusive access to the mu (Xapian) database
# Local Variables:
# mode: org

5
man/mu-cfind.1.org
View File

@ -147,10 +147,7 @@ which is (by default) accessible by pressing *Q*.
=--format=bbdb=. This is hard-coded to UTF-8, and as such specified in the
output-file, so emacs/bbdb can handle things correctly, without guessing.
* EXIT CODE
This command returns 0 upon successful completion, or a non-zero exit code
otherwise: 1 for a generals error and 2 for 'no matches'.
#+include: "exit-code.inc" :minlevel 1
#+include: "bugs.inc" :minlevel 1

6
man/mu-find.1.org
View File

@ -272,11 +272,7 @@ After restarting Wanderlust, the virtual folders should appear.
(the default), and UTF-8 for all other formats (=sexp=,
=xml=).
* EXIT CODE
This command returns 0 upon successful completion, or a non-zero exit code
otherwise: 1 for a generals error and 2 for 'no matches'.
#+include: "exit-code.inc" :minlevel 1
#+include: "bugs.inc" :minlevel 1

2
man/mu-index.1.org
View File

@ -176,6 +176,8 @@ Things are again a little faster, even though the index does a lot more now
(text-normalizatian, and pre-generating message-sexps). A faster machine helps,
too!
#+include: "exit-code.inc" :minlevel 1
#+include: "prefooter.inc"
* SEE ALSO

1
man/mu-init.1.org
View File

@ -40,6 +40,7 @@ reinitialize the database from an earlier version; that is, create a new
empty database witht the existing settings. This cannot be combined
with the other ~init~ options.
#+include: "exit-code.inc" :minlevel 1
#+include: "muhome.inc" :minlevel 2