update man pages

This commit is contained in:
Dirk-Jan C. Binnema 2022-05-05 01:34:44 +03:00
parent 45aec819f6
commit f32b429084
2 changed files with 52 additions and 49 deletions

View File

@ -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
second.
\fBmu index\fR guesses the top-level Maildir to do its job; if it
guesses wrongly, you can use the \fI--maildir\fR option to specify the
top-level directory that should be processed. See the \fBmu-index\fR(1)
man page for more details.
\fBmu index\fR guesses the top-level Maildir to do its job; if it guesses wrong,
you can use the \fI--maildir\fR option to specify the top-level directory that
should be processed. See the \fBmu-index\fR(1) man page for more details.
Normally, \fBmu index\fR visits all the directories under the
top-level Maildir; however, you can exclude certain directories (say,
the 'trash' or 'spam' folders) by creating a file called
\fI.noindex\fR in the directory. When \fBmu\fR sees such a file, it
will exclude this directory and its sub-directories from indexing.
Also see \fB.noupdate\fR in the \fBmu-index\fR(1) manpage.
Normally, \fBmu index\fR visits all the directories under the top-level Maildir;
however, you can exclude certain directories (say, the 'trash' or 'spam'
folders) by creating a file called \fI.noindex\fR in the directory. When
\fBmu\fR sees such a file, it will exclude this directory and its
sub-directories from indexing. Also see \fB.noupdate\fR in the \fBmu-index\fR(1)
manpage.
.SH SEARCHING YOUR E-MAIL
After you have indexed your mail, you can start searching it. By
default, the search results are printed on standard output.
Alternatively, the output can take the form of Maildir with symbolic
links to the found messages. This enables integration with e-mail
clients; see the \fBmu-find\fR(1) man page for details, the syntax of the
search parameters and so on. Here, we just give some examples for
common cases.
After you have indexed your mail, you can start searching it. By default, the
search results are printed on standard output. Alternatively, the output can
take the form of Maildir with symbolic links to the found messages. This enables
integration with e-mail clients; see the \fBmu-find\fR(1) man page for details,
the syntax of the search parameters and so on. Here, we just give some examples
for 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
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
.fi
This means there is a message to 'julius' with 'fruit' somewhere in
the message. In this case, it's a message from John Milton. Note that
the date format depends on your the language/locale you are using.
This means there is a message to 'julius' with 'fruit' somewhere in the message.
In this case, it's a message from John Milton. Note that the date format depends
on your the language/locale you are using.
How do we know that the message was sent to Julius Caesar? Well, it's
not visible from the results above, because the default fields that
are shown are date/sender/subject. However, we can change this using
the \fI--fields\fR parameter (see the \fBmu-find\fR(1) man page for the
details):
How do we know that the message was sent to Julius Caesar? Well, it's not
visible from the results above, because the default fields that are shown are
date/sender/subject. However, we can change this using the \fI--fields\fR
parameter (try \fBmu fields\fR to see all the details):
.nf
\fB$ mu find --fields="t s" t:julius fruit\fR

View File

@ -14,7 +14,8 @@ customized for the mu/mu4e use-case.
In this article, we give a structured but informal overview of the query
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
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
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
cc,c Cc (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
maildir,m Maildir
modified,k Last modification time
msgid,i Message-ID
prio,p Message priority (\fIlow\fR, \fInormal\fR or \fIhigh\fR)
flag,g Message Flags
date,d Date range
size,z Message size range
cc,c Cc (carbon-copy) recipient(s)
changed,k Last change to message file (range)
date,d Send date (range)
embed,e Search inside embedded text parts
file,j Attachment filename
mime,y MIME-type of one or more message parts
tag,x Tags for the message
flag,g Message Flags
from,f Message sender
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.
.EX2
@ -313,9 +315,9 @@ Find all messages with either Frodo or Sam:
Frodo OR Sam
.EX2
Find all messages with the 'wombat' as subject, and 'capibara' anywhere:
Find all messages with the 'wombat' as subject, and 'capybara' anywhere:
.EX1
subject:wombat and capibara
subject:wombat and capybara
.EX2
Find all messages in the 'Archive' folder from Fred:
@ -341,14 +343,13 @@ mime:image/*
.SH CAVEATS
With current Xapian versions, the apostroph character is considered
part of a word. Thus, you cannot find \fID'Artagnan\fR by searching
for \fIArtagnan\fR. So, include the apostroph in search or use a
regexp search.
With current Xapian versions, the apostroph character is considered part of a
word. Thus, you cannot find \fID'Artagnan\fR by searching for \fIArtagnan\fR.
So, include the apostroph in search or use a regexp search.
Matching on spaces has changed compared to the old query-parser; this
applies e.g. to Maildirs that have spaces in their name, such as
\fISent Items\fR. See \fBMAILDIR\fR above.
Matching on spaces has changed compared to the old query-parser; this applies
e.g. to Maildirs that have spaces in their name, such as \fISent Items\fR. See
\fBMAILDIR\fR above.
.SH AUTHOR
@ -357,3 +358,5 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu-find (1)
.BR mu-flags (1)
.BR mu-fields (1)