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

mu-query.7: some improvements

Browse Source 
Improve the query man-page.
This commit is contained in:
djcb
2018-01-06 14:48:58 +02:00
parent ef8c1960de
commit ffb7118366
1 changed files with 18 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
man/mu-query.7
View File

@ -1,24 +1,25 @@
.TH MU QUERY 7 "26 October 2017" "User Manuals" .TH MU QUERY 7 "28 December 2017" "User Manuals"
.SH NAME .SH NAME
mu query language \- a language for finding messages in a \fBmu\fR database. mu query language \- a language for finding messages in \fBmu\fR
databases.
.SH DESCRIPTION .SH DESCRIPTION
The mu query language is a language that allows for searching in a The mu query language is a language used by \fBmu find\fR and
\fBmu\fR database and is used by \fBmu find\fR and \fBmu4e\fR to find \fBmu4e\fR to find messages in \fBmu\fR's Xapian databases. The
messages. The language is similar to the default query-parser that language is quite similar to Xapian's default query-parser, but is an
\fBmu\fR's underlying Xapian database uses, but is a indepedent independent implementation that is customized for the mu/mu4e
\fBmu\fR-specific implementation. use-case.
In this manpage, we give a structured but informal overview of the In this article, we give a structured but informal overview of the
query language and provide examples. query language and provide examples.
\fBNOTE:\fR t if you use queries on the command-line (say, for \fBmu \fBNOTE:\fR t if you use queries on the command-line (say, for \fBmu
find\fR), you need to quote any characters that would otherwise be find\fR), you need to quote any characters that would otherwise be
interpreted by the shell, such as \fB""\fR, \fB(\fR and \fB)\fR and interpreted by the shell, such as \fB""\fR, \fB(\fR and \fB)\fR and
not to forget, whitespace. whitespace.
.de EX1 .de EX1
.nf .nf
@ -32,8 +33,11 @@ not to forget, whitespace.
.SH TERMS .SH TERMS
The basic building blocks are \fBterms\fR; these are just normal words The basic building blocks of a query are \fBterms\fR; these are just
like 'banana' or 'hello' or prefixed with a field-name. normal words like 'banana' or 'hello', or words prefixed with a
field-name which make them apply to just that field. See
.BR mu find
for all the available fields.
Some example queries: Some example queries:
.EX1 .EX1
@ -43,13 +47,13 @@ maildir:/inbox
.EX2 .EX2
Terms without an explicit field-prefix, (like 'vacation' above) are Terms without an explicit field-prefix, (like 'vacation' above) are
interpreted as something like: interpreted like:
.EX1 .EX1
to:vacation or subject:vacation or body:vacation or ... to:vacation or subject:vacation or body:vacation or ...
.EX2 .EX2
The language is case-insensitive for terms and attempts to flatten any The language is case-insensitive for terms and attempts to 'flatten'
diactrics, so \fIangtrom\fR matches \fIÅngström\fR. any diacritics, so \fIangtrom\fR matches \fIÅngström\fR.
.PP .PP
If terms contain whitespace, they need to be quoted: If terms contain whitespace, they need to be quoted: