* manpage updates

This commit is contained in:
Dirk-Jan C. Binnema 2011-01-12 23:14:51 +02:00
parent 321cae64b9
commit 920f714859
3 changed files with 39 additions and 5 deletions

View File

@ -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:

View File

@ -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

View File

@ -165,6 +165,18 @@ without the need for any manual maintenance of log files.
been specified explicitly with \fB\-\-maildir\fR=\fI<maildir>\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: