mirror of https://github.com/djcb/mu.git
* update man pages
This commit is contained in:
Dirk-Jan C. Binnema
parent
f20a81ae8f
commit
283f3036a6
|
|
@ -1,4 +1,4 @@
|
|||
.TH MU CLEANUP 1 "August 2010" "User Manuals"
|
||||
.TH MU CLEANUP 1 "September 2010" "User Manuals"
|
||||
|
||||
.SH NAME
|
||||
|
||||
|
|
@ -26,7 +26,7 @@ try \fI~/Maildir\fR.
|
|||
.
|
||||
.SH BUGS
|
||||
|
||||
There probably are some; please report bugs when you find them:
|
||||
Please report bugs if you find them:
|
||||
.BR http://code.google.com/p/mu0/issues/list
|
||||
|
||||
.SH AUTHOR
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH MU VIEW 1 "August 2010" "User Manuals"
|
||||
.TH MU EXTRACT 1 "September 2010" "User Manuals"
|
||||
|
||||
.SH NAME
|
||||
|
||||
|
|
@ -11,7 +11,7 @@ mu extract\- display and save message parts (attachments)
|
|||
.SH DESCRIPTION
|
||||
|
||||
\fBmu extact\fR is the \fBmu\fR sub-command for extracting MIME-parts (e.g.,
|
||||
attachments) from mail messages. It works on files, and does not require the
|
||||
attachments) from mail messages. It works on message files, and does not require the
|
||||
message to be indexed.
|
||||
|
||||
For attachments, the name specified in the message is used; when saving
|
||||
|
|
@ -27,14 +27,14 @@ save all MIME-parts that look like attachments.
|
|||
save all non-multipart MIME-parts.
|
||||
|
||||
\fB\-\-target\-dir\fR=<dir>
|
||||
save the parts in some other directory than the current one.
|
||||
save the parts in the target directory rather than the current one.
|
||||
|
||||
\fB\-\-overwrite\fR
|
||||
overwrite existing files with the same name.
|
||||
|
||||
.SH BUGS
|
||||
|
||||
There probably are some; please report bugs when you find them:
|
||||
Please report bugs if you find them:
|
||||
.BR http://code.google.com/p/mu0/issues/list
|
||||
|
||||
.SH AUTHOR
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH MU FIND 1 "August 2010" "User Manuals"
|
||||
.TH MU FIND 1 "September 2010" "User Manuals"
|
||||
|
||||
.SH NAME
|
||||
|
||||
|
|
@ -20,20 +20,27 @@ store earlier using
|
|||
The \fBfind\fR command starts a search for messages in the database that match
|
||||
the search pattern.
|
||||
|
||||
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
|
||||
parameter consists of multiple parts (multiple command line parameters) they
|
||||
are treated as if there were a logical \fBAND\fR between them.
|
||||
|
||||
If you want to make your own constructions (using \fBAND\fR, \fBOR\fR,
|
||||
\fBNOT\fR etc., you have to put quote them so \fBmu\fR can consider them as a
|
||||
unit.
|
||||
\fBNOT\fR etc., you have to put quotes around them so \fBmu\fR can consider
|
||||
them as a unit; for example to find mails with oranges OR mandarins in the
|
||||
subject-field, you'd use:
|
||||
.nf
|
||||
mu find 'subject:orange OR subject:mandarin'
|
||||
.fi
|
||||
|
||||
\fBmu find\fR does not distinguish between uppercase or lowercase for search
|
||||
terms.
|
||||
|
||||
\fBmu\fR relies on the Xapian database for its searching capabilities, so it
|
||||
offers all the search functionality that Xapian offers; please refer to:
|
||||
|
||||
\fIhttp://xapian.org/docs/queryparser.html\fR
|
||||
|
||||
All queries are logged in \fI<mu-home>/mu.log\fR.
|
||||
Note that queries are logged in \fI<mu-home>/mu.log\fR.
|
||||
|
||||
The basic way to search a message is to type some words matching it, as you
|
||||
would do in an internet search engine. For example,
|
||||
|
|
@ -46,7 +53,6 @@ will find all message that contain both 'monkey' and 'banana'. Matching is
|
|||
case-insensitive and recognizes various forms of a word such as plurals; this
|
||||
is all courtesy of Xapian.
|
||||
|
||||
|
||||
\fBmu\fR also recognizes prefixes for specific fields in a messages; for
|
||||
example:
|
||||
|
||||
|
|
@ -289,7 +295,7 @@ typing 'Q' will start a query.
|
|||
|
||||
.SH BUGS
|
||||
|
||||
There probably are some; please report bugs when you find them:
|
||||
Please report bugs if you find them:
|
||||
.BR http://code.google.com/p/mu0/issues/list
|
||||
|
||||
.SH AUTHOR
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH MU-INDEX 1 "August 2010" "User Manuals"
|
||||
.TH MU-INDEX 1 "September 2010" "User Manuals"
|
||||
|
||||
.SH NAME
|
||||
|
||||
|
|
@ -11,26 +11,21 @@ mu index \- index e-mail messages stored in Maildirs
|
|||
.SH DESCRIPTION
|
||||
|
||||
\fBmu index\fR is the \fBmu\fR sub-command for scanning the contents of
|
||||
Maildir directories and storing it in a database which can then be searched
|
||||
using
|
||||
Maildir directories and storing the results in a Xapian database which can
|
||||
then be searched using
|
||||
.BR mu-find(1)
|
||||
\.
|
||||
|
||||
Using the
|
||||
.B index
|
||||
command, you can index your Maildir directories, and store the information in
|
||||
a Xapian database.
|
||||
|
||||
.B index
|
||||
understands Maildirs as defined by Dan Bernstein for qmail(7). In addition, it
|
||||
understands recursive Maildirs (Maildirs within Maildirs), Maildir++. It can
|
||||
also deal with VFAT-based Maildirs which use '!' as the seperators instead
|
||||
understands Maildirs as defined by Daniel Bernstein for qmail(7). In addition,
|
||||
it understands recursive Maildirs (Maildirs within Maildirs), Maildir++. It
|
||||
can also deal with VFAT-based Maildirs which use '!' as the seperators instead
|
||||
of ':' as used by Tinymail/Modest and some other e-mail programs.
|
||||
|
||||
E-mail messages which are not stored in something resembling a maildir leaf
|
||||
directory (\fIcur\fR and \fInew\fR) are ignored.
|
||||
|
||||
Currently, symlinks are not followed.
|
||||
Symlinks are not followed.
|
||||
|
||||
If there is a file called \fI.noindex\fR in a directory, the contents of that
|
||||
directory and all of its subdirectories will be ignored. This can be useful to
|
||||
|
|
@ -169,11 +164,10 @@ To store these files elsewhere from their default location, one can use the
|
|||
\fBmu index\fR uses \fBMAILDIR\fR to find the user's Maildir if it has not
|
||||
been specified explicitly with \fB\-\-maildir\fR=\fI<maildir>\fR. If MAILDIR
|
||||
is not set, \fBmu index\fR will try \fI~/Maildir\fR.
|
||||
.
|
||||
|
||||
.SH BUGS
|
||||
|
||||
There probably are some; please report bugs when you find them:
|
||||
Please report bugs if you find them:
|
||||
.BR http://code.google.com/p/mu0/issues/list
|
||||
|
||||
.SH AUTHOR
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH MU MKDIR 1 "August 2010" "User Manuals"
|
||||
.TH MU MKDIR 1 "September 2010" "User Manuals"
|
||||
|
||||
.SH NAME
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH MU VIEW 1 "August 2010" "User Manuals"
|
||||
.TH MU VIEW 1 "September 2010" "User Manuals"
|
||||
|
||||
.SH NAME
|
||||
|
||||
|
|
@ -11,26 +11,24 @@ mu view\- display an e-mail message file
|
|||
.SH DESCRIPTION
|
||||
|
||||
\fBmu view\fR is the \fBmu\fR sub-command for displaying an e-mail message
|
||||
file. It works on files, and does not require the message to be indexed before
|
||||
using
|
||||
file. It works on message files and does not require the message to be indexed
|
||||
in the mu database with
|
||||
.BR mu-index(1)
|
||||
\.
|
||||
|
||||
Currently, the command shows some common headers (From:, To:, Cc:, Subject:
|
||||
and Date:) and the plain-text body of the message.
|
||||
The command shows some common headers (From:, To:, Cc:, Subject: and Date:)
|
||||
and the plain-text body of the message, if there is any.
|
||||
|
||||
.SH OPTIONS
|
||||
|
||||
.TP
|
||||
\fB\-k\fR, \fB\-\-summary\-len\fR=\fI<len>\fR
|
||||
instead of the full message, output a summary based on up to \fI\len\fR lines
|
||||
of the message. The default is
|
||||
.B 0
|
||||
, which means 'show full body'.
|
||||
of the message. The default is 0, which means 'show full body'.
|
||||
|
||||
.SH BUGS
|
||||
|
||||
There probably are some; please report bugs when you find them:
|
||||
Please report bugs if you find them:
|
||||
.BR http://code.google.com/p/mu0/issues/list
|
||||
|
||||
.SH AUTHOR
|
||||
|
|
|
|||
Loading…
Reference in New Issue