mirror of https://github.com/djcb/mu.git
update man pages
This commit is contained in:
parent
45aec819f6
commit
f32b429084
|
@ -49,27 +49,28 @@ you have, the speed of your computer, hard drive etc. Usually,
|
||||||
indexing should be able to reach a speed of a few hundred messages per
|
indexing should be able to reach a speed of a few hundred messages per
|
||||||
second.
|
second.
|
||||||
|
|
||||||
\fBmu index\fR guesses the top-level Maildir to do its job; if it
|
\fBmu index\fR guesses the top-level Maildir to do its job; if it guesses wrong,
|
||||||
guesses wrongly, you can use the \fI--maildir\fR option to specify the
|
you can use the \fI--maildir\fR option to specify the top-level directory that
|
||||||
top-level directory that should be processed. See the \fBmu-index\fR(1)
|
should be processed. See the \fBmu-index\fR(1) man page for more details.
|
||||||
man page for more details.
|
|
||||||
|
|
||||||
Normally, \fBmu index\fR visits all the directories under the
|
Normally, \fBmu index\fR visits all the directories under the top-level Maildir;
|
||||||
top-level Maildir; however, you can exclude certain directories (say,
|
however, you can exclude certain directories (say, the 'trash' or 'spam'
|
||||||
the 'trash' or 'spam' folders) by creating a file called
|
folders) by creating a file called \fI.noindex\fR in the directory. When
|
||||||
\fI.noindex\fR in the directory. When \fBmu\fR sees such a file, it
|
\fBmu\fR sees such a file, it will exclude this directory and its
|
||||||
will exclude this directory and its sub-directories from indexing.
|
sub-directories from indexing. Also see \fB.noupdate\fR in the \fBmu-index\fR(1)
|
||||||
Also see \fB.noupdate\fR in the \fBmu-index\fR(1) manpage.
|
manpage.
|
||||||
|
|
||||||
.SH SEARCHING YOUR E-MAIL
|
.SH SEARCHING YOUR E-MAIL
|
||||||
|
|
||||||
After you have indexed your mail, you can start searching it. By
|
After you have indexed your mail, you can start searching it. By default, the
|
||||||
default, the search results are printed on standard output.
|
search results are printed on standard output. Alternatively, the output can
|
||||||
Alternatively, the output can take the form of Maildir with symbolic
|
take the form of Maildir with symbolic links to the found messages. This enables
|
||||||
links to the found messages. This enables integration with e-mail
|
integration with e-mail clients; see the \fBmu-find\fR(1) man page for details,
|
||||||
clients; see the \fBmu-find\fR(1) man page for details, the syntax of the
|
the syntax of the search parameters and so on. Here, we just give some examples
|
||||||
search parameters and so on. Here, we just give some examples for
|
for common cases.
|
||||||
common cases.
|
|
||||||
|
You can use the \fBmu fields\fR and \fBmu flags\fR command to get information
|
||||||
|
about all possible fields and flags.
|
||||||
|
|
||||||
First, let's search for all messages sent to Julius (Caesar) regarding
|
First, let's search for all messages sent to Julius (Caesar) regarding
|
||||||
fruit:
|
fruit:
|
||||||
|
@ -84,15 +85,14 @@ This should return something like:
|
||||||
2008-07-31T21:57:25 EEST John Milton <jm@example.com> Fere libenter homines id quod volunt credunt
|
2008-07-31T21:57:25 EEST John Milton <jm@example.com> Fere libenter homines id quod volunt credunt
|
||||||
.fi
|
.fi
|
||||||
|
|
||||||
This means there is a message to 'julius' with 'fruit' somewhere in
|
This means there is a message to 'julius' with 'fruit' somewhere in the message.
|
||||||
the message. In this case, it's a message from John Milton. Note that
|
In this case, it's a message from John Milton. Note that the date format depends
|
||||||
the date format depends on your the language/locale you are using.
|
on your the language/locale you are using.
|
||||||
|
|
||||||
How do we know that the message was sent to Julius Caesar? Well, it's
|
How do we know that the message was sent to Julius Caesar? Well, it's not
|
||||||
not visible from the results above, because the default fields that
|
visible from the results above, because the default fields that are shown are
|
||||||
are shown are date/sender/subject. However, we can change this using
|
date/sender/subject. However, we can change this using the \fI--fields\fR
|
||||||
the \fI--fields\fR parameter (see the \fBmu-find\fR(1) man page for the
|
parameter (try \fBmu fields\fR to see all the details):
|
||||||
details):
|
|
||||||
|
|
||||||
.nf
|
.nf
|
||||||
\fB$ mu find --fields="t s" t:julius fruit\fR
|
\fB$ mu find --fields="t s" t:julius fruit\fR
|
||||||
|
|
|
@ -14,7 +14,8 @@ customized for the mu/mu4e use-case.
|
||||||
In this article, we give a structured but informal overview of the query
|
In this article, we give a structured but informal overview of the query
|
||||||
language and provide examples.
|
language and provide examples.
|
||||||
|
|
||||||
As a companion to this, we recommend the \fBmu fields\fR command to get an up-to-date list of the available fields.
|
As a companion to this, we recommend the \fBmu fields\fR and \fBmu flags\fR
|
||||||
|
commands to get an up-to-date list of the available fields and flags.
|
||||||
|
|
||||||
\fBNOTE:\fR if you use queries on the command-line (say, for \fBmu find\fR), you
|
\fBNOTE:\fR if you use queries on the command-line (say, for \fBmu find\fR), you
|
||||||
need to quote any characters that would otherwise be interpreted by the shell,
|
need to quote any characters that would otherwise be interpreted by the shell,
|
||||||
|
@ -131,26 +132,27 @@ take quite a bit longer than 'normal' queries.
|
||||||
.SH FIELDS
|
.SH FIELDS
|
||||||
|
|
||||||
We already saw a number of search fields, such as \fBsubject:\fR and
|
We already saw a number of search fields, such as \fBsubject:\fR and
|
||||||
\fBbody:\fR. Here is the full table, a shortcut character and a description.
|
\fBbody:\fR. For the full table, see \fBmu fields\fR.
|
||||||
.EX1
|
.EX1
|
||||||
cc,c Cc (carbon-copy) recipient(s)
|
|
||||||
bcc,h Bcc (blind-carbon-copy) recipient(s)
|
bcc,h Bcc (blind-carbon-copy) recipient(s)
|
||||||
from,f Message sender
|
|
||||||
to,t To: recipient(s)
|
|
||||||
subject,s Message subject
|
|
||||||
body,b Message body
|
body,b Message body
|
||||||
maildir,m Maildir
|
cc,c Cc (carbon-copy) recipient(s)
|
||||||
modified,k Last modification time
|
changed,k Last change to message file (range)
|
||||||
msgid,i Message-ID
|
date,d Send date (range)
|
||||||
prio,p Message priority (\fIlow\fR, \fInormal\fR or \fIhigh\fR)
|
|
||||||
flag,g Message Flags
|
|
||||||
date,d Date range
|
|
||||||
size,z Message size range
|
|
||||||
embed,e Search inside embedded text parts
|
embed,e Search inside embedded text parts
|
||||||
file,j Attachment filename
|
file,j Attachment filename
|
||||||
mime,y MIME-type of one or more message parts
|
flag,g Message Flags
|
||||||
tag,x Tags for the message
|
from,f Message sender
|
||||||
list,v Mailing list (e.g. the List-Id value)
|
list,v Mailing list (e.g. the List-Id value)
|
||||||
|
maildir,m Maildir
|
||||||
|
mime,y MIME-type of one or more message parts
|
||||||
|
msgid,i Message-ID
|
||||||
|
prio,p Message priority (\fIlow\fR, \fInormal\fR or \fIhigh\fR)
|
||||||
|
size,z Message size range
|
||||||
|
subject,s Message subject
|
||||||
|
tag,x Tags for the message
|
||||||
|
thread,w Thread a message belongs to
|
||||||
|
to,t To: recipient(s)
|
||||||
|
|
||||||
The \fBmu fields\fR command is recommended to get the latest version.
|
The \fBmu fields\fR command is recommended to get the latest version.
|
||||||
.EX2
|
.EX2
|
||||||
|
@ -313,9 +315,9 @@ Find all messages with either Frodo or Sam:
|
||||||
Frodo OR Sam
|
Frodo OR Sam
|
||||||
.EX2
|
.EX2
|
||||||
|
|
||||||
Find all messages with the 'wombat' as subject, and 'capibara' anywhere:
|
Find all messages with the 'wombat' as subject, and 'capybara' anywhere:
|
||||||
.EX1
|
.EX1
|
||||||
subject:wombat and capibara
|
subject:wombat and capybara
|
||||||
.EX2
|
.EX2
|
||||||
|
|
||||||
Find all messages in the 'Archive' folder from Fred:
|
Find all messages in the 'Archive' folder from Fred:
|
||||||
|
@ -341,14 +343,13 @@ mime:image/*
|
||||||
|
|
||||||
.SH CAVEATS
|
.SH CAVEATS
|
||||||
|
|
||||||
With current Xapian versions, the apostroph character is considered
|
With current Xapian versions, the apostroph character is considered part of a
|
||||||
part of a word. Thus, you cannot find \fID'Artagnan\fR by searching
|
word. Thus, you cannot find \fID'Artagnan\fR by searching for \fIArtagnan\fR.
|
||||||
for \fIArtagnan\fR. So, include the apostroph in search or use a
|
So, include the apostroph in search or use a regexp search.
|
||||||
regexp search.
|
|
||||||
|
|
||||||
Matching on spaces has changed compared to the old query-parser; this
|
Matching on spaces has changed compared to the old query-parser; this applies
|
||||||
applies e.g. to Maildirs that have spaces in their name, such as
|
e.g. to Maildirs that have spaces in their name, such as \fISent Items\fR. See
|
||||||
\fISent Items\fR. See \fBMAILDIR\fR above.
|
\fBMAILDIR\fR above.
|
||||||
|
|
||||||
.SH AUTHOR
|
.SH AUTHOR
|
||||||
|
|
||||||
|
@ -357,3 +358,5 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
|
|
||||||
.BR mu-find (1)
|
.BR mu-find (1)
|
||||||
|
.BR mu-flags (1)
|
||||||
|
.BR mu-fields (1)
|
||||||
|
|
Loading…
Reference in New Issue