diff --git a/man/mu-cleanup.1 b/man/mu-cleanup.1 index 3f03f620..4f4c1b89 100644 --- a/man/mu-cleanup.1 +++ b/man/mu-cleanup.1 @@ -1,4 +1,4 @@ -.TH MU CLEANUP 1 "November 2010" "User Manuals" +.TH MU CLEANUP 1 "January 2011" "User Manuals" .SH NAME @@ -18,6 +18,19 @@ be found, from the database. This is done automatically when running specified Maildir, as long as they still exist. The command only takes global options, which are described in the \fBmu (1)\fR man page. +.SH RETURN VALUE + +\fBmu cleanup\fR return 0 upon successful completion. Anything else leads to a +non-zero return value, for example: + +.sh +| code | meaning | +|------+--------------------------------| +| 0 | ok | +| 1 | general error | +| 4 | database is corrupted | +.si + .SH BUGS Please report bugs if you find them: diff --git a/man/mu-find.1 b/man/mu-find.1 index 7abcf4d4..34e0f215 100644 --- a/man/mu-find.1 +++ b/man/mu-find.1 @@ -470,10 +470,19 @@ definitions can be used; typing 'Q' will start a query. .SH RETURN VALUE - -\fBmu\fR returns 0 for searches with at least one matching message, 2 for -searches that do not match anything. In case of errors 1 or any number greater -than 2 will be returned. + +\fBmu find\fR return 0 upon successful completion; if it the a search was +performed, there needs to be a least one match. Anything else leads to a +non-zero return value, for example: + +.sh +| code | meaning | +|------+--------------------------------| +| 0 | ok | +| 1 | general error | +| 2 | no matches (for 'mu find') | +| 4 | database is corrupted | +.si .SH BUGS diff --git a/man/mu-index.1 b/man/mu-index.1 index fa3b914d..cc1e45e1 100644 --- a/man/mu-index.1 +++ b/man/mu-index.1 @@ -165,6 +165,18 @@ without the need for any manual maintenance of log files. been specified explicitly with \fB\-\-maildir\fR=\fI\fR. If \fBMAILDIR\fR is not set, \fBmu index\fR will try \fI~/Maildir\fR. +.SH RETURN VALUE +\fBmu index\fR return 0 upon successful completion, and any other number +greater than 2 signals an error, for example: +.sh +| code | meaning | +|------+--------------------------------| +| 0 | ok | +| 1 | general error | +| 3 | could not obtain db write lock | +| 4 | database is corrupted | +.si + .SH BUGS Please report bugs if you find them: