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

Merge pull request #2652 from a3a3el/more-man-page-fixes

Browse Source 
More man page fixes
This commit is contained in:
Dirk-Jan C. Binnema
2024-03-07 09:57:38 +02:00
committed by GitHub
parent d9390159bb 721aadc140
commit 06134d3909
19 changed files with 83 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
man/meson.build
View File

@ -55,6 +55,7 @@ man_orgs=[
'mu-info.1.org', 'mu-info.1.org',
'mu-init.1.org', 'mu-init.1.org',
'mu-mkdir.1.org', 'mu-mkdir.1.org',
'mu-move.1.org',
'mu-query.7.org', 'mu-query.7.org',
'mu-remove.1.org', 'mu-remove.1.org',
'mu-server.1.org', 'mu-server.1.org',
@ -81,6 +82,7 @@ foreach src : man_orgs
expr_tmpl = ''.join([ expr_tmpl = ''.join([
'(progn', '(progn',
' (require \'ox-man)', ' (require \'ox-man)',
' (setq org-export-with-sub-superscripts \'{})',
' (org-export-to-file \'man "@0@"))']) ' (org-export-to-file \'man "@0@"))'])
expr = expr_tmpl.format(org.substring(0,-4)) expr = expr_tmpl.format(org.substring(0,-4))
sectiondir = join_paths(mandir, 'man' + section) sectiondir = join_paths(mandir, 'man' + section)

2
man/mu-add.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
~mu add~ - add one or more messages to the database mu-add - add one or more messages to the database
* SYNOPSIS * SYNOPSIS

2
man/mu-bookmarks.5.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
bookmarks - file with bookmarks (shortcuts) for mu search expressions mu-bookmarks - file with bookmarks (shortcuts) for mu search expressions
* DESCRIPTION * DESCRIPTION

8
man/mu-cfind.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
*mu cfind* is the *mu* command to find contacts in the *mu* database and export them mu-cfind - find contacts in the *mu* database and export them
for use in other programs. for use in other programs.
* SYNOPSIS * SYNOPSIS
@ -49,6 +49,7 @@ The regular expressions are basic case-insensitive PCRE, see *pcre(3)*.
** --format=plain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv ** --format=plain|mutt-alias|mutt-ab|wl|org-contact|bbdb|csv
sets the output format to the given value. The following are available: sets the output format to the given value. The following are available:
#+ATTR_MAN: :disable-caption t
| --format= | description | | --format= | description |
|-------------+-----------------------------------| |-------------+-----------------------------------|
| plain | default, simple list | | plain | default, simple list |
@ -61,12 +62,12 @@ sets the output format to the given value. The following are available:
| json | JSON format | | json | JSON format |
[1] *CSV is not fully standardized, but *mu cfind* follows some common practices: [1] *CSV* is not fully standardized, but *mu cfind* follows some common practices:
any double-quote is replaced by a double-double quote (thus, "hello" become any double-quote is replaced by a double-double quote (thus, "hello" become
""hello"", and fields with commas are put in double-quotes. Normally, this ""hello"", and fields with commas are put in double-quotes. Normally, this
should only apply to name fields. should only apply to name fields.
** --personal,-p only show addresses seen in messages where one of 'my' e-mail ** --personal,-p only show addresses seen in messages where one of `my' e-mail
addresses was seen in one of the address fields; this is to exclude addresses addresses was seen in one of the address fields; this is to exclude addresses
only seen in mailing-list messages. See the ~--my-address~ parameter to *mu init*. only seen in mailing-list messages. See the ~--my-address~ parameter to *mu init*.
@ -112,6 +113,7 @@ With ~--format=json~, the matching contacts come out as a JSON array, e.g.,
Each contact has the following fields: Each contact has the following fields:
#+ATTR_MAN: :disable-caption t
| property | description | | property | description |
|---------------+--------------------------------------------------------------------------| |---------------+--------------------------------------------------------------------------|
| ~email~ | the email-address | | ~email~ | the email-address |

22
man/mu-easy.7.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
mu easy - a quick introduction to mu mu-easy - a quick introduction to mu
* DESCRIPTION * DESCRIPTION
@ -54,7 +54,7 @@ can use the =--maildir= option to specify the top-level directory that should be
processed. See the *mu-index(1)* man page for more details. processed. See the *mu-index(1)* man page for more details.
Normally, *mu index* visits all the directories under the top-level Maildir; Normally, *mu index* visits all the directories under the top-level Maildir;
however, you can exclude certain directories (say, the 'trash' or 'spam' however, you can exclude certain directories (say, the `trash' or `spam'
folders) by creating a file called =.noindex= in the directory. When *mu* sees such folders) by creating a file called =.noindex= in the directory. When *mu* sees such
a file, it will exclude this directory and its sub-directories from indexing. a file, it will exclude this directory and its sub-directories from indexing.
Also see *.noupdate* in the *mu-index(1)* manpage. Also see *.noupdate* in the *mu-index(1)* manpage.
@ -83,7 +83,7 @@ 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
#+end_example #+end_example
This means there is a message to 'julius' with 'fruit' somewhere in the message. 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 In this case, it's a message from John Milton. Note that the date format depends
on your the language/locale you are using. on your the language/locale you are using.
@ -96,7 +96,7 @@ date/sender/subject. However, we can change this using the =--fields= parameter
$ mu find --fields="t s" t:julius fruit $ mu find --fields="t s" t:julius fruit
#+end_example #+end_example
In other words, display the 'To:'-field (t) and the subject (s). This should In other words, display the `To:'-field (t) and the subject (s). This should
return something like: return something like:
#+begin_example #+begin_example
Julius Caesar <jc@example.com> Fere libenter homines id quod volunt credunt Julius Caesar <jc@example.com> Fere libenter homines id quod volunt credunt
@ -121,9 +121,9 @@ from Socrates. This could 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
#+end_example #+end_example
What if we want to see some of the body of the message? You can get a 'summary' What if we want to see some of the body of the message? You can get a `summary'
of the first lines of the message using the =--summary-len= option, which will of the first lines of the message using the =--summary-len= option, which will
'summarize' the first =n= lines of the message: `summarize' the first =n= lines of the message:
#+begin_example #+begin_example
$ mu find --summary-len=3 napoleon m:/archive $ mu find --summary-len=3 napoleon m:/archive
@ -206,7 +206,7 @@ for:
#+end_example #+end_example
and get mails about soccer, Socrates, society, and so on. Note, it's important and get mails about soccer, Socrates, society, and so on. Note, it's important
to quote the search query, otherwise the shell will interpret to quote the search query, otherwise the shell will interpret
the '*'. the `*'.
You can also search for messages with a certain attachment using their You can also search for messages with a certain attachment using their
filename, for example: filename, for example:
@ -214,7 +214,7 @@ filename, for example:
#+begin_example #+begin_example
*$ mu find 'file:pic*'* *$ mu find 'file:pic*'*
#+end_example #+end_example
will get you all messages with an attachment starting with 'pic'. will get you all messages with an attachment starting with `pic'.
If you want to find attachments with a certain MIME-type, you can use the If you want to find attachments with a certain MIME-type, you can use the
following: following:
@ -232,9 +232,9 @@ Get all messages with image attachments:
#+end_example #+end_example
Note that (1) the '*' wildcard can only be used as the rightmost thing in a Note that (1) the `*' wildcard can only be used as the rightmost thing in a
search query, and (2) that you need to quote the search term, because search query, and (2) that you need to quote the search term, because
otherwise your shell will interpret the '*' (expanding it to all files in the otherwise your shell will interpret the `*' (expanding it to all files in the
current directory -- probably not what you want). current directory -- probably not what you want).
* DISPLAYING MESSAGES * DISPLAYING MESSAGES
@ -282,7 +282,7 @@ your contacts.
$ mu cfind julius $ mu cfind julius
#+end_example #+end_example
will find all contacts with 'julius' in either name or e-mail address. Note that will find all contacts with `julius' in either name or e-mail address. Note that
*mu cfind* accepts a =regular expression= (as per *pcre(3)*) *mu cfind* accepts a =regular expression= (as per *pcre(3)*)
*mu cfind* also supports a =--format==-parameter, which sets the output to some *mu cfind* also supports a =--format==-parameter, which sets the output to some

8
man/mu-extract.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
*mu extract* is the *mu* command to display and save message parts mu-extract - display and save message parts
(attachments), and open them with other tools. (attachments), and open them with other tools.
* SYNOPSIS * SYNOPSIS
@ -27,7 +27,7 @@ with filenames matching that pattern will be extracted. The regular expressions
are basic PCRE, and are case-sensitive by default; see *pcre(3)* for more details. are basic PCRE, and are case-sensitive by default; see *pcre(3)* for more details.
Without any options, *mu extract* simply outputs the list of leaf MIME-parts in Without any options, *mu extract* simply outputs the list of leaf MIME-parts in
the message. Only 'leaf' MIME-parts (including RFC822 attachments) are the message. Only `leaf' MIME-parts (including RFC822 attachments) are
considered, *multipart/** etc. are ignored. considered, *multipart/** etc. are ignored.
Without a filename parameter, ~mu extract~ reads a message from standard-input. In Without a filename parameter, ~mu extract~ reads a message from standard-input. In
@ -66,7 +66,7 @@ expressions are basic PCRE, and are case-sensitive by default; see *pcre(3)* for
more details. more details.
** --play ** --play
Try to 'play' (open) the attachment with the default application for the Try to `play' (open) the attachment with the default application for the
particular file type. On MacOS, this uses the *open* program, on other platforms particular file type. On MacOS, this uses the *open* program, on other platforms
it uses *xdg-open*. You can choose a different program by setting the it uses *xdg-open*. You can choose a different program by setting the
*MU_PLAY_PROGRAM* environment variable. *MU_PLAY_PROGRAM* environment variable.
@ -86,7 +86,7 @@ the same name:
$ mu extract --parts=3,4 --overwrite msgfile $ mu extract --parts=3,4 --overwrite msgfile
#+end_example #+end_example
To extract all files ending in '.jpg' (case-insensitive): To extract all files ending in `.jpg' (case-insensitive):
#+begin_example #+begin_example
$ mu extract msgfile '.*\.jpg' $ mu extract msgfile '.*\.jpg'
#+end_example #+end_example

21
man/mu-find.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
*mu find* - find e-mail messages in the *mu* database. mu-find - find e-mail messages in the *mu* database.
* SYNOPSIS * SYNOPSIS
@ -25,7 +25,7 @@ For example:
$ mu find subject:snow and date:2009.. $ mu find subject:snow and date:2009..
#+end_example #+end_example
would find all messages in 2009 with 'snow' in the subject field, e.g: would find all messages in 2009 with `snow' in the subject field, e.g:
#+begin_example #+begin_example
2009-03-05 17:57:33 EET Lucia <lucia@example.com> running in the snow 2009-03-05 17:57:33 EET Lucia <lucia@example.com> running in the snow
@ -63,7 +63,7 @@ For example:
$ mu find subject:snow --fields "d f s" $ mu find subject:snow --fields "d f s"
#+end_example #+end_example
lists the date, subject and sender of all messages with 'snow' in the their lists the date, subject and sender of all messages with `snow' in the their
subject. subject.
The table of replacement characters is superset of the list mentions for search The table of replacement characters is superset of the list mentions for search
@ -82,12 +82,12 @@ parameters, such as:
For the complete list, try the command: ~mu info fields~. For the complete list, try the command: ~mu info fields~.
The message flags are described in *mu-query(7)*. As an example, a message which The message flags are described in *mu-query(7)*. As an example, a message which
is 'seen', has an attachment and is signed would have 'asz' as its corresponding is `seen', has an attachment and is signed would have `asz' as its corresponding
output string, while an encrypted new message would have 'nx'. output string, while an encrypted new message would have `nx'.
** -s, --sortfield=<field> and -z,--reverse ** -s, --sortfield=<field> and -z,--reverse
specify the field to sort the search results by and the direction (i.e., specify the field to sort the search results by and the direction (i.e.,
'reverse' means that the sort should be reverted - Z-A). Examples include: `reverse' means that the sort should be reverted - Z-A). Examples include:
#+begin_example #+begin_example
cc,c Cc (carbon-copy) recipient(s) cc,c Cc (carbon-copy) recipient(s)
@ -164,7 +164,7 @@ This is assuming the GNU *date* command.
** --exec=<command> ** --exec=<command>
the ~--exec~ coption causes the =command= to be executed on each matched message; the ~--exec~ coption causes the =command= to be executed on each matched message;
for example, to see the raw text of all messages matching 'milkshake', you could for example, to see the raw text of all messages matching `milkshake', you could
use: use:
#+begin_example #+begin_example
$ mu find milkshake --exec='less' $ mu find milkshake --exec='less'
@ -188,10 +188,10 @@ common occurrence when using e.g. Gmail together with *offlineimap*.
** -r, --include-related ** -r, --include-related
include messages being referred to by the matched messages -- i.e.. include include messages being referred to by the matched messages -- i.e.. include
messages that are part of the same message thread as some matched messages. This messages that are part of the same message thread as some matched messages. This
is useful if you want Gmail-style 'conversations'. is useful if you want Gmail-style `conversations'.
** -t, --threads ** -t, --threads
show messages in a 'threaded' format -- that is, with indentation and arrows show messages in a `threaded' format -- that is, with indentation and arrows
showing the conversation threads in the list of matching messages. When using showing the conversation threads in the list of matching messages. When using
this, sorting is chronological (by date), based on the newest message in a this, sorting is chronological (by date), based on the newest message in a
thread. thread.
@ -206,7 +206,7 @@ message, as in the following table:
| other | |-> | |*> | |=> | | other | |-> | |*> | |=> |
#+end_example #+end_example
Here, an 'orphan' is a message without a parent message (in the list of Here, an `orphan' is a message without a parent message (in the list of
matches), and a duplicate is a message whose message-id was already seen before; matches), and a duplicate is a message whose message-id was already seen before;
not this may not really be the same message, if the message-id was copied. not this may not really be the same message, if the message-id was copied.
@ -289,6 +289,7 @@ taking the total number for 10 test runs.
2. time (repeat 10 mu find "" -n 50000 --include-related --threads > /dev/null) 2. time (repeat 10 mu find "" -n 50000 --include-related --threads > /dev/null)
#+ATTR_MAN: :disable-caption t
| release | time 1 (sec) | time 2 (sec) | | release | time 1 (sec) | time 2 (sec) |
|---------------+--------------+--------------| |---------------+--------------+--------------|
| 1.4 | 8.9s | 59.3s | | 1.4 | 8.9s | 59.3s |

2
man/mu-help.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
*mu help* is a *mu* command that gives help information about mu commands. mu-help - show help information about mu commands.
* SYNOPSIS * SYNOPSIS

9
man/mu-index.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
*mu index* -- index e-mail messages stored in Maildirs mu-index - index e-mail messages stored in Maildirs
* SYNOPSIS * SYNOPSIS
@ -50,9 +50,9 @@ below for details.
The first run of *mu index* may take a few minutes if you have a lot of mail (tens The first run of *mu index* may take a few minutes if you have a lot of mail (tens
of thousands of messages). Fortunately, such a full scan needs to be done only of thousands of messages). Fortunately, such a full scan needs to be done only
once; after that it suffices to index the changes, which goes much faster. See once; after that it suffices to index the changes, which goes much faster. See
the 'PERFORMANCE (i,ii,iii)' below for more information. the `PERFORMANCE (i,ii,iii)' below for more information.
The optional 'phase two' of the indexing-process is the removal of messages from The optional `phase two' of the indexing-process is the removal of messages from
the database for which there is no longer a corresponding file in the Maildir. the database for which there is no longer a corresponding file in the Maildir.
If you do not want this, you can use ~-n~, ~--nocleanup~. If you do not want this, you can use ~-n~, ~--nocleanup~.
@ -108,7 +108,7 @@ $ time mu index --quiet
(more than 56818 messages per second) (more than 56818 messages per second)
Note that each test flushes the caches first; a more common use case might be to Note that each test flushes the caches first; a more common use case might be to
run *mu index* when new mail has arrived; the cache may stay quite 'warm' in that run *mu index* when new mail has arrived; the cache may stay quite `warm' in that
case: case:
#+begin_example #+begin_example
@ -183,6 +183,7 @@ too!
Indexing the the same 93000-message mail corpus with the last few releases: Indexing the the same 93000-message mail corpus with the last few releases:
#+ATTR_MAN: :disable-caption t
| release | time (sec) | notes | | release | time (sec) | notes |
|---------------+------------+------------------------------------------| |---------------+------------+------------------------------------------|
| 1.4 | 160s | | | 1.4 | 160s | |

2
man/mu-info.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
~mu info~ - show information mu-info - show information
* SYNOPSIS * SYNOPSIS

10
man/mu-init.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
mu init -- initialize the mu message database mu-init - initialize the mu message database
* SYNOPSIS * SYNOPSIS
@ -27,9 +27,9 @@ performed).
** --my-address=<email-address-or-regex> ** --my-address=<email-address-or-regex>
specifies that some e-mail address is 'my-address' (the option can be used specifies that some e-mail address is `my-address' (the option can be used
multiple times). Any message in which at least one of the contact fields multiple times). Any message in which at least one of the contact fields
contains such an address is considered a 'personal' messages; this can then be contains such an address is considered a `personal' messages; this can then be
used for filtering in *mu-find(1)*, *mu-cfind(1)* and *mu4e*, e.g. to filter-out used for filtering in *mu-find(1)*, *mu-cfind(1)* and *mu4e*, e.g. to filter-out
mailing list messages. mailing list messages.
@ -58,7 +58,7 @@ the number of changes after which they are committed to the database; decreasing
the value reduces the memory requirements, at the cost of make indexing the value reduces the memory requirements, at the cost of make indexing
substantially slower. Usually, the default of 250000 should be fine. substantially slower. Usually, the default of 250000 should be fine.
Batch-size 0 is interpreted as 'use the default'. Batch-size 0 is interpreted as `use the default'.
** --support-ngrams ** --support-ngrams
@ -76,7 +76,7 @@ options.
* NGRAM SUPPORT * NGRAM SUPPORT
*mu*'s underlying Xapian database supports 'ngrams', which improve searching for *mu*'s underlying Xapian database supports `ngrams', which improve searching for
languages/scripts that do not have explicit word breaks, such as Chinese, languages/scripts that do not have explicit word breaks, such as Chinese,
Japanese and Korean. It is fairly intrusive, and influences both indexing and Japanese and Korean. It is fairly intrusive, and influences both indexing and
query-parsing; it is not enabled by default, and is recommended only if you need query-parsing; it is not enabled by default, and is recommended only if you need

2
man/mu-mkdir.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
*mu mkdir* - create a new Maildir mu-mkdir - create a new Maildir
* SYNOPSIS * SYNOPSIS

14
man/mu-move.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
*mu move* - move a message file or change its flags mu-move - move a message file or change its flags
* SYNOPSIS * SYNOPSIS
@ -42,7 +42,7 @@ the source message.
print the target filename(s), but don't change anything. print the target filename(s), but don't change anything.
Note that with the ~--change-name~, the target name is not constant, so you cannot Note that with the ~--change-name~, the target name is not constant, so you cannot
use a dry-run to predict the exact name when doing a 'real' run. use a dry-run to predict the exact name when doing a `real' run.
#+include: "common-options.inc" :minlevel 1 #+include: "common-options.inc" :minlevel 1
@ -52,27 +52,29 @@ use a dry-run to predict the exact name when doing a 'real' run.
man-page, or see http://cr.yp.to/proto/maildir.html) man-page, or see http://cr.yp.to/proto/maildir.html)
The message flags specify the Maildir-metadata for a message and are represented The message flags specify the Maildir-metadata for a message and are represented
by uppercase letters at the end of the message file name for all 'non-new' by uppercase letters at the end of the message file name for all `non-new'
messages, i.e. messages that live in the ~cur/~ sub-directory of a Maildir. messages, i.e. messages that live in the ~cur/~ sub-directory of a Maildir.
#+ATTR_MAN: :disable-caption t
| Flag | Meaning | | Flag | Meaning |
|------+------------------------------------| |------+------------------------------------|
| D | Draft message | | D | Draft message |
| F | Flagged message | | F | Flagged message |
| P | Passed message (i.e., 'forwarded') | | P | Passed message (i.e., `forwarded') |
| R | Replied message | | R | Replied message |
| S | Seen message | | S | Seen message |
| T | Trashed; to be deleted later | | T | Trashed; to be deleted later |
New messages (in the ~new/~ sub-directory) do not have flags encoded in their New messages (in the ~new/~ sub-directory) do not have flags encoded in their
file-name; but we *mu* uses 'N' in the ~--flags~ to represent that: file-name; but we *mu* uses `N' in the ~--flags~ to represent that:
#+ATTR_MAN: :disable-caption t
| Flag | Meaning | | Flag | Meaning |
|------+---------| |------+---------|
| N | New | | N | New |
Thus, changing flags means changing the letters at the end of the message Thus, changing flags means changing the letters at the end of the message
file-name, except when setting or removing the 'N' (new) flag. Setting or file-name, except when setting or removing the `N' (new) flag. Setting or
un-setting the New flag causes the message is to be moved from ~cur/~ to ~new/~ or un-setting the New flag causes the message is to be moved from ~cur/~ to ~new/~ or
vice-versa, respectively. When marking a message as New, it looses the other vice-versa, respectively. When marking a message as New, it looses the other
flags. flags.

39
man/mu-query.7.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
mu query language -- a language for finding messages in *mu* databases. mu-query - a language for finding messages in *mu* databases.
* DESCRIPTION * DESCRIPTION
@ -26,7 +26,7 @@ quote any characters that would otherwise be interpreted by the shell, such as
* TERMS * TERMS
The basic building blocks of a query are *terms*; these are just normal words like The basic building blocks of a query are *terms*; these are just normal words like
'banana' or 'hello', or words prefixed with a field-name which makes them apply `banana' or `hello', or words prefixed with a field-name which makes them apply
to just that field. See *mu info fields* for all the available fields. to just that field. See *mu info fields* for all the available fields.
Some example queries: Some example queries:
@ -36,13 +36,13 @@ subject:capybara
maildir:/inbox maildir:/inbox
#+end_example #+end_example
Terms without an explicit field-prefix, (like 'vacation' above) are interpreted Terms without an explicit field-prefix, (like `vacation' above) are interpreted
like: like:
#+begin_example #+begin_example
to:vacation or subject:vacation or body:vacation or ... to:vacation or subject:vacation or body:vacation or ...
#+end_example #+end_example
The language is case-insensitive for terms and attempts to 'flatten' diacritics, The language is case-insensitive for terms and attempts to `flatten' diacritics,
so =angtrom= matches =Ångström=. so =angtrom= matches =Ångström=.
If terms contain whitespace, they need to be quoted: If terms contain whitespace, they need to be quoted:
@ -80,7 +80,7 @@ subject:chip AND subject:dale
#+end_example #+end_example
are equivalent. For readability, we recommend the second version. are equivalent. For readability, we recommend the second version.
Note that a =pure not= - e.g. searching for *not apples* is quite a 'heavy' query. Note that a =pure not= - e.g. searching for *not apples* is quite a `heavy' query.
* REGULAR EXPRESSIONS AND WILDCARDS * REGULAR EXPRESSIONS AND WILDCARDS
@ -93,9 +93,9 @@ subject:/h.llo/ # match hallo, hello, ...
subject:/ subject:/
#+end_example #+end_example
Note the difference between 'maildir:/foo' and 'maildir:/foo/'; the former Note the difference between `maildir:/foo' and `maildir:/foo/'; the former
matches messages in the '/foo' maildir, while the latter matches all messages in matches messages in the `/foo' maildir, while the latter matches all messages in
all maildirs that match 'foo', such as '/foo', '/bar/cuux/foo', '/fooishbar' all maildirs that match `foo', such as `/foo', `/bar/cuux/foo', `/fooishbar'
etc. etc.
Wildcards are another mechanism for matching where a term with a rightmost *** Wildcards are another mechanism for matching where a term with a rightmost ***
@ -118,6 +118,7 @@ We already saw a number of search fields, such as *subject:* and *body:*. For th
full table with all details, including single-char shortcuts, try the command: full table with all details, including single-char shortcuts, try the command:
~mu info fields~. ~mu info fields~.
#+ATTR_MAN: :disable-caption t
|------------+-----------+--------------------------------| |------------+-----------+--------------------------------|
| field-name | alias | description | | field-name | alias | description |
| bcc | | Blind carbon-copy recipient | | bcc | | Blind carbon-copy recipient |
@ -170,10 +171,10 @@ an open range.
Dates are expressed in local time and using ISO-8601 format (YYYY-MM-DD Dates are expressed in local time and using ISO-8601 format (YYYY-MM-DD
HH:MM:SS); you can leave out the right part and *mu* adds the rest, depending on HH:MM:SS); you can leave out the right part and *mu* adds the rest, depending on
whether this is the beginning or end of the range (e.g., as a lower bound, whether this is the beginning or end of the range (e.g., as a lower bound,
'2015' would be interpreted as the start of that year; as an upper bound as the `2015' would be interpreted as the start of that year; as an upper bound as the
end of the year). end of the year).
You can use '/' , '.', '-', ':' and 'T' to make dates more human-readable. You can use `/' , `.', `-', `:' and `T' to make dates more human-readable.
Some examples: Some examples:
#+begin_example #+begin_example
@ -184,13 +185,13 @@ date:2015-06-01..
date:2016..2016 date:2016..2016
#+end_example #+end_example
You can also use the special 'dates' *now* and *today*: You can also use the special `dates' *now* and *today*:
#+begin_example #+begin_example
date:20170505..now date:20170505..now
date:today.. date:today..
#+end_example #+end_example
Finally, you can use relative 'ago' times which express some time before now and Finally, you can use relative `ago' times which express some time before now and
consist of a number followed by a unit, with units *s* for seconds, *M* for minutes, consist of a number followed by a unit, with units *s* for seconds, *M* for minutes,
*h* for hours, *d* for days, *w* for week, *m* for months and *y* for years. Some *h* for hours, *d* for days, *w* for week, *m* for months and *y* for years. Some
examples: examples:
@ -221,7 +222,7 @@ available:
f,flagged Flagged f,flagged Flagged
l,list Mailing-list message l,list Mailing-list message
n,new New message (in new/ Maildir) n,new New message (in new/ Maildir)
p,passed Passed ('Handled') p,passed Passed (`Handled')
r,replied Replied r,replied Replied
s,seen Seen s,seen Seen
t,trashed Marked for deletion t,trashed Marked for deletion
@ -258,8 +259,8 @@ find it (and all the other messages in that same maildir) with:
maildir:/lists/running maildir:/lists/running
#+end_example #+end_example
Note the starting '/'. If you want to match mails in the 'root' maildir, you can Note the starting `/'. If you want to match mails in the `root' maildir, you can
do with a single '/': do with a single `/':
#+begin_example #+begin_example
maildir:/ maildir:/
#+end_example #+end_example
@ -286,7 +287,7 @@ queries using various logical operators, parentheses and so on, but in the
author's experience, it's usually faster to find a message with a simple query author's experience, it's usually faster to find a message with a simple query
just searching for some words. just searching for some words.
Find all messages with both 'bee' and 'bird' (in any field) Find all messages with both `bee' and `bird' (in any field)
#+begin_example #+begin_example
bee AND bird bee AND bird
#+end_example #+end_example
@ -296,12 +297,12 @@ Find all messages with either Frodo or Sam:
Frodo OR Sam Frodo OR Sam
#+end_example #+end_example
Find all messages with the 'wombat' as subject, and 'capybara' anywhere: Find all messages with the `wombat' as subject, and `capybara' anywhere:
#+begin_example #+begin_example
subject:wombat and capybara subject:wombat and capybara
#+end_example #+end_example
Find all messages in the 'Archive' folder from Fred: Find all messages in the `Archive' folder from Fred:
#+begin_example #+begin_example
from:fred and maildir:/Archive from:fred and maildir:/Archive
#+end_example #+end_example
@ -321,7 +322,7 @@ Find all messages with attached images:
mime:image/* mime:image/*
#+end_example #+end_example
Find all messages written in Dutch or German with the word 'hallo': Find all messages written in Dutch or German with the word `hallo':
#+begin_example #+begin_example
hallo and (lang:nl or lang:de) hallo and (lang:nl or lang:de)
#+end_example #+end_example

3
man/mu-remove.1.org
View File

@ -1,10 +1,9 @@
#+TITLE: MU REMOVE #+TITLE: MU REMOVE
#+MAN_CLASS_OPTIONS: :section-id "@SECTION_ID@" :date "@MAN_DATE@" #+MAN_CLASS_OPTIONS: :section-id "@SECTION_ID@" :date "@MAN_DATE@"
* NAME * NAME
*mu remove* - command to remove messages from the database. mu-remove - remove messages from the database.
* SYNOPSIS * SYNOPSIS

3
man/mu-server.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
mu server - the mu backend for the mu4e e-mail client mu-server - the mu backend for the mu4e e-mail client
* SYNOPSIS * SYNOPSIS
@ -73,6 +73,7 @@ time build/mu/mu server --allow-temp-file --eval '(find :query "\"\"" :include-r
#+end_src #+end_src
(and ~--allow-temp-file~ for 1.11) (and ~--allow-temp-file~ for 1.11)
#+ATTR_MAN: :disable-caption t
| release | time (sec) | | release | time (sec) |
|---------------+------------| |---------------+------------|
| 1.8 | 8.6s | | 1.8 | 8.6s |

2
man/mu-verify.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
mu verify - verify message signatures and display information about them mu-verify - verify message signatures and display information about them
* SYNOPSIS * SYNOPSIS

2
man/mu-view.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
mu view - display an e-mail message file mu-view - display an e-mail message file
* SYNOPSIS * SYNOPSIS

4
man/mu.1.org
View File

@ -3,7 +3,7 @@
* NAME * NAME
~mu~ - a set of tools to deal with Maildirs and message files, in particular to mu - a set of tools to deal with Maildirs and message files, in particular to
index and search e-mail messages. index and search e-mail messages.
* SYNOPSIS * SYNOPSIS
@ -36,7 +36,7 @@ in them.
~mu~'s main purpose is to enable searching of e-mail messages. It ~mu~'s main purpose is to enable searching of e-mail messages. It
does so by periodically scanning a Maildir directory tree and does so by periodically scanning a Maildir directory tree and
analyzing the e-mail messages found (this is called 'indexing'). The analyzing the e-mail messages found (this is called `indexing'). The
results of this analysis are stored in a database, which can then be results of this analysis are stored in a database, which can then be
queried. queried.