* update docs, www

This commit is contained in:
Dirk-Jan C. Binnema
2011-08-03 23:04:38 +03:00
parent 42d69b7501
commit 757c533be7
4 changed files with 22 additions and 16 deletions

View File

@ -33,7 +33,7 @@ like:
Note, this the default, plain-text output, which is the default, so you don't Note, this the default, plain-text output, which is the default, so you don't
have to use \fB--format=plain\fR. For other types of output (such as symlinks, have to use \fB--format=plain\fR. For other types of output (such as symlinks,
XML, JSON or s-expressions), see the discussion in the \fBOPTIONS\fR-section XML or s-expressions), see the discussion in the \fBOPTIONS\fR-section
below about \fB--format\fR. below about \fB--format\fR.
The search pattern is taken as a command-line parameter. If the search The search pattern is taken as a command-line parameter. If the search
@ -339,7 +339,15 @@ choice, but for dates it may be more useful to sort in the opposite direction.
output a summary based upon the first lines of the message. output a summary based upon the first lines of the message.
.TP .TP
\fB\-\-format\fR=\fIplain|links|xquery|xml|json|sexp\fR \fB\-\-include\-unreadable\fR
normally, \fBmu find\fR does not include messages that are unreadable,
typically do not have corresponding disk file, i.e., messages that live only
in the databases. With this option even such messages are included. Note, for
\fB\-\-format=\fRlinks, unreadable message are ignore even when this option is
set.
.TP
\fB\-\-format\fR=\fIplain|links|xquery|xml|sexp\fR
output results in the specified format. output results in the specified format.
The default is \fBplain\fR, i.e normal output with one line per message. The default is \fBplain\fR, i.e normal output with one line per message.
@ -350,9 +358,6 @@ information). See \fB\-\-linksdir\fR and \fB\-\-clearlinks\fR below.
\fBxml\fR formats the search results as XML. \fBxml\fR formats the search results as XML.
\fBjson\fR formats the search results as JSON (\fIJavascript Object
Notation\fR).
\fBsexp\fR formats the search results as an s-expression as used in Lisp \fBsexp\fR formats the search results as an s-expression as used in Lisp
programming environments. programming environments.
@ -585,7 +590,7 @@ non-zero return value, for example:
.SH ENCODING .SH ENCODING
\fBmu find\fR output is encoded according the locale for \fI--format=plain\fR \fBmu find\fR output is encoded according the locale for \fI--format=plain\fR
(the default), and UTF-8 for all other formats (\fIjson\fR, \fIsexp\fR, (the default), and UTF-8 for all other formats (\fIsexp\fR,
\fIxml\fR). \fIxml\fR).

View File

@ -6,7 +6,7 @@ mu mv\- move a message file to a Maildir
.SH SYNOPSIS .SH SYNOPSIS
.B mu mv [--flags=<flags>] [--updatedb] [--printtarget] <source-path> <target-maildir> .B mu mv [--flags=<flags>] [--printtarget] <source-path> <target-maildir>
.SH DESCRIPTION .SH DESCRIPTION
@ -29,6 +29,10 @@ 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 parameters. It's recommended not to use wildcards on the shell, the result may
be unexpected. 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
and \fBmu remove\fR.
.SH OPTIONS .SH OPTIONS
.TP .TP
@ -41,12 +45,6 @@ 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 (new), P (passed), R (replied), S (seen) and T (trashed). Note, the
flags-parameter is case-sensitive. flags-parameter is case-sensitive.
.TP
\fB\-\-updatedb\fR
update the Xapian database after the move. You can use the general
\fB\-\-muhome=\fR option to specify the database if it does not live at the
default place.
.TP .TP
\fB\-\-printtarget\fR \fB\-\-printtarget\fR
return the target path on standard output upon succesful completion of the return the target path on standard output upon succesful completion of the
@ -118,4 +116,7 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.BR maildir(5) .BR maildir(5)
.BR mu(1) .BR mu(1)
.BR mu-index(1)
.BR mu-add(1)
.BR mu-remove(1)
.BR chmod(1) .BR chmod(1)

View File

@ -124,7 +124,7 @@ If =mu= did not guess the right Maildir, you can set it explicitly:
Note that we use ='l'=, so the returned message paths will be quoted. This is Note that we use ='l'=, so the returned message paths will be quoted. This is
useful if you have maildirs with spaces in their names. useful if you have maildirs with spaces in their names.
For further processing, also the ~--format=(xml|json|sexp)~ can be useful. For For further processing, also the ~--format=(xml|sexp)~ can be useful. For
example, example,
#+html:<pre> $ mu find --format=xml pancake</pre> #+html:<pre> $ mu find --format=xml pancake</pre>

View File

@ -70,12 +70,12 @@
- search for messages based on the sender, receiver, message subject, size, - search for messages based on the sender, receiver, message subject, size,
priority, words in the message body, attachments, date range, flags priority, words in the message body, attachments, date range, flags
(signed, encrypted, new, replied, unread, ...), message-id, maildir (signed, encrypted, new, replied, unread, ...), message-id, maildir
- known to work on Linux (Ubuntu/Fedora/Debian/GenToo), FreeBSD, MacOS, - known to work on Linux (Ubuntu/Fedora/Debian/Gentoo), FreeBSD, MacOS,
Solaris, ... Solaris, ...
- fully documented (man pages) - fully documented (man pages)
- can be integrated with e-mail clients; documentation has examples for [[http://www.mutt.org/][mutt]] - can be integrated with e-mail clients; documentation has examples for [[http://www.mutt.org/][mutt]]
and [[http://www.emacswiki.org/emacs/WanderLust][Wanderlust]]. and [[http://www.emacswiki.org/emacs/WanderLust][Wanderlust]].
- output in plain text, xml, json, s-expressions (experimental) - output in plain text, xml, s-expressions (experimental)
- extract message parts, attachments, open them using their default - extract message parts, attachments, open them using their default
application application