From 8302fb23bb809afa976ba5f507fc85afad1b22a0 Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Sat, 13 Aug 2011 02:35:05 +0300 Subject: [PATCH] * update docs --- man/mu-easy.1 | 10 +++++----- man/mu-find.1 | 5 ++--- man/mu-mv.1 | 34 +++++++++++++++------------------- man/mu.1 | 38 ++++++++++++++++++++++++++++++++++++++ www/cheatsheet.org | 4 ++-- 5 files changed, 62 insertions(+), 29 deletions(-) diff --git a/man/mu-easy.1 b/man/mu-easy.1 index 982db99b..141ae434 100644 --- a/man/mu-easy.1 +++ b/man/mu-easy.1 @@ -138,20 +138,20 @@ Get all messages from Jim without an attachment: \fB$ mu find from:jim AND NOT flag:attach\fR .fi -Get all unread messages where the subject mentions Ångström: +Get all unseen messages where the subject mentions Ångström: .nf - \fB$ mu find flag:unread subject:Ångström\fR + \fB$ mu find subject:Ångström NOT flag:seen\fR .fi which is equivalent to: .nf - \fB$ mu find flag:unread subject:angstrom\fR + \fB$ mu find subject:angstrom NOT flag:seen\fR .fi because does mu is case-insensitive and accent-insensitive. -Get all unread messages between March 2002 and August 2003 about some bird (or +Get all unseen messages between March 2002 and August 2003 about some bird (or a Swedish rock band): .nf - \fB$ mu find date:20020301..20030831 flag:new nightingale\fR + \fB$ mu find date:20020301..20030831 nightingale NOT flag:seen\fR .fi Get all messages received today: diff --git a/man/mu-find.1 b/man/mu-find.1 index 0485ebe9..abb6077c 100644 --- a/man/mu-find.1 +++ b/man/mu-find.1 @@ -141,7 +141,6 @@ listed in the following table: p,passed Passed ('Handled') r,replied Replied s,seen Seen - u,unread Unread (shorthand for 'new or not seen') t,thrashed Marked for deletion a,attach Has attachment z,signed Signed message @@ -470,7 +469,7 @@ Find all messages in the 'Archive' folder from Fred: Find all unread messages with attachments: .nf - $ mu find flag:unread flag:attach + $ mu find flag:attach NOT flag:seen .fi @@ -521,7 +520,7 @@ VFolders { [size:1m..100m]!mu "Big" - [flag:unread]!mu "Unread" + [NOT flag:seen]!mu "Unread" } .fi diff --git a/man/mu-mv.1 b/man/mu-mv.1 index c138f14c..b6000209 100644 --- a/man/mu-mv.1 +++ b/man/mu-mv.1 @@ -6,7 +6,7 @@ mu mv\- move a message file to a Maildir .SH SYNOPSIS -.B mu mv [--flags=] [--printtarget] +.B mu mv [--flags=] [--printtarget] [] .SH DESCRIPTION @@ -25,9 +25,9 @@ documentation for details about 'cur' and 'new'. As a special case, when \fI/dev/null\fR is specified as the target directory, the mail file will be unlinked (deleted). -Note, unlike the UNIX \fImv\fR command, \fImu mv\fR takes precisely two -parameters. It's recommended not to use wildcards on the shell, the result may -be unexpected. +Note, unlike the UNIX \fImv\fR command, \fImu mv\fR takes precisely one source +message parameter. It's recommended not to use wildcards on the shell, as the +result may be unexpected. Also note, \fBmu mv\fR only updates the file system; it does \fBnot\fR update the database. To update the database, there is \fBmu index(1)\fR or \fBmu add\fR @@ -43,7 +43,8 @@ directory ('new' vs 'cur'). The flags is a sequence of characters from the set D (draft), F (flagged), N (new), P (passed), R (replied), S (seen) and T (trashed). Note, the -flags-parameter is case-sensitive. +flags-parameter is case-sensitive. Any other characters will be silently +ignored. .TP \fB\-\-printtarget\fR @@ -75,9 +76,15 @@ To mark a message as no longer new and 'Seen', and update the database afterwards, you could do: .nf - mu --flags=S mv /home/roger/Maildir/inbox/new/123123123:2, /home/roger/Maildir/inbox/ + mu --flags=S mv /home/roger/Maildir/inbox/new/123123123 /home/roger/Maildir/inbox/ .fi +In this case, as we are not moving the message to a diffent maildir, we can +leave off the maildir-argument; so the following is equivalent: + +.nf + mu --flags=S mv /home/roger/Maildir/inbox/new/123123123 +.fi .SH LIMITATIONS @@ -88,19 +95,8 @@ except when the target-directory is \fI/dev/null\fR. .SH RETURN VALUE -\fBmu mv\fR returns 0 upon success; in general, the following error codes are -returned: - -.nf -| code | meaning | -|------+-----------------------------------| -| 0 | ok | -| 1 | general error | -| 6 | file error | -.fi - -Note that if you get a database error rather than a general error, this means -that moving the file succeeded, but that the database update afterwards failed. +\fBmu mv\fR returns 0 upon success, and some other value when an error +occurs. See \fBmu(1)\fR for a list. .SH BUGS diff --git a/man/mu.1 b/man/mu.1 index 0b862125..402982c5 100644 --- a/man/mu.1 +++ b/man/mu.1 @@ -178,6 +178,44 @@ lists the various command line options, while \fB\-\-help\-index\fR, \fB\-\-help\-find\fR and \fB\-\-help\-all\fR list only the options for respectively the specified command or for all commands. +.SH ERROR CODES + +The various mu subcommands typically exit with 0 (zero) upon success, and +non-zero when some error occured. 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 + .SH BUGS Please report bugs if you find them: diff --git a/www/cheatsheet.org b/www/cheatsheet.org index 23f35491..1803aea7 100644 --- a/www/cheatsheet.org +++ b/www/cheatsheet.org @@ -38,8 +38,8 @@ If =mu= did not guess the right Maildir, you can set it explicitly: *** signed messages about apples *OR* oranges #+html:
  $ mu find flag:signed apples OR oranges
-*** unread messages about things starting with 'soc' (soccer, society, socrates, ...) -#+html:
  $ mu find 'subject:soc*' flag:unread
+*** unseen messages about things starting with 'soc' (soccer, society, socrates, ...) +#+html:
  $ mu find 'subject:soc*' NOT flag:seen
Note, the '*' only works at the /end/ of a search term. (searching using the '*' wildcard is available since mu 0.9.6)