alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mu: update manpages

Browse Source 
Add some notes about the new query parser, and add a mu-query manpage.
This commit is contained in:
djcb
2017-10-25 23:45:38 +03:00
parent 5d3d9e274f
commit c434fdbd86
5 changed files with 352 additions and 349 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
man/mu-easy.1
View File

@ -6,23 +6,23 @@ mu easy \- a quick introduction to mu
.SH DESCRIPTION
\fBmu\fR is a set of tools for dealing with e-mail messages in Maildirs. There
are many options, which are all described in the man pages for the various
sub-commands. This man pages jumps over all of the details and gives examples
of some common use cases. If the use cases described here do not precisely do
what you want, please check the more extensive information in the man page
about the sub-command you are using -- for example, the mu-index or mu-find
man pages.
\fBmu\fR is a set of tools for dealing with e-mail messages in
Maildirs. There are many options, which are all described in the man
pages for the various sub-commands. This man pages jumps over all of
the details and gives examples of some common use cases. If the use
cases described here do not precisely do what you want, please check
the more extensive information in the man page about the sub-command
you are using -- for example, the mu-index or mu-find man pages.
\fBNOTE\fR: the \fBindex\fR command (and therefore, the ones that depend on
that, such as \fBfind\fR), require that you store your mail in the
Maildir-format. If you don't do so, you can still use the other commands, but
you won't be able to index/search your mail.
\fBNOTE\fR: the \fBindex\fR command (and therefore, the ones that
depend on that, such as \fBfind\fR), require that you store your mail
in the Maildir-format. If you don't do so, you can still use the other
commands, but you won't be able to index/search your mail.
By default, \fBmu\fR uses colorized output when it thinks your terminal is
capable of doing so. If you don't like color, you can use the \fB--nocolor\fR
command-line option, or set the \fBMU_NOCOLOR\fR environment variable to
non-empty.
By default, \fBmu\fR uses colorized output when it thinks your
terminal is capable of doing so. If you don't like color, you can use
the \fB--nocolor\fR command-line option, or set the \fBMU_NOCOLOR\fR
environment variable to non-empty.
.SH INDEXING YOUR E-MAIL
@ -32,32 +32,35 @@ Before you can search e-mails, you'll first need to index them:
\fB$ mu index\fR
.fi
The process can take a few minutes, depending on the amount of mail 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.
The process can take a few minutes, depending on the amount of mail
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 man page for more
details.
\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
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
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 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 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 man page for details, the syntax of the
search parameters and so on. Here, we just give some examples for
common cases.
First, let's search for all messages sent to Julius (Caesar) regarding fruit:
First, let's search for all messages sent to Julius (Caesar) regarding
fruit:
.nf
\fB$ mu find t:julius fruit\fR
@ -69,14 +72,15 @@ 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 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 (see the \fBmu-find\fR man page for the
details):
.nf
\fB$ mu find --fields="t s" t:julius fruit\fR