mirror of https://github.com/djcb/mu.git
man: change quoting style
The man-page sources use single quotes to quote text. However, this can be
problematic in man-pages because if a single quote appears at the beginning of a
line the following word is interpreted by troff as a macro. For example, this
paragraph in mu-easy.7:
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 \fI\-\-summary\-len\fP option, which will
'summarize' the first \fIn\fP lines of the message:
elicits this warning:
$ man --warnings obj-x86_64-linux-gnu/man/mu-easy.7 >/dev/null
troff:<standard input>:166: warning: macro 'summarize'' not defined
and gets truncated:
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 op‐
tion, which will
One could adjust the line-wrapping to move the quoted text away from the
beginning of the line, but that is fragile. Another possibility would be to use
the troff escape-sequences for open and close quotes (`\(oq` and `\(cq`
respectively), but ox-man is being used precisely to avoid having to handle
troff directly. Instead use back-ticks for left quotes. Thus:
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 \fI\-\-summary\-len\fP option, which will
`summarize' the first \fIn\fP lines of the message:
which is rendered correctly:
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 op-
tion, which will `summarize' the first n lines of the message:
Signed-off-by: Jeremy Sowden <azazel@debian.org>
This commit is contained in:
Jeremy Sowden
parent
c76aa53156
commit
721aadc140
|
|
@ -67,7 +67,7 @@ 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
|
||||
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
|
||||
only seen in mailing-list messages. See the ~--my-address~ parameter to *mu init*.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
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
|
||||
a file, it will exclude this directory and its sub-directories from indexing.
|
||||
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
|
||||
#+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
|
||||
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
|
||||
#+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:
|
||||
#+begin_example
|
||||
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
|
||||
#+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
|
||||
'summarize' the first =n= lines of the message:
|
||||
`summarize' the first =n= lines of the message:
|
||||
|
||||
#+begin_example
|
||||
$ mu find --summary-len=3 napoleon m:/archive
|
||||
|
|
@ -206,7 +206,7 @@ for:
|
|||
#+end_example
|
||||
and get mails about soccer, Socrates, society, and so on. Note, it's important
|
||||
to quote the search query, otherwise the shell will interpret
|
||||
the '*'.
|
||||
the `*'.
|
||||
|
||||
You can also search for messages with a certain attachment using their
|
||||
filename, for example:
|
||||
|
|
@ -214,7 +214,7 @@ filename, for example:
|
|||
#+begin_example
|
||||
*$ mu find 'file:pic*'*
|
||||
#+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
|
||||
following:
|
||||
|
|
@ -232,9 +232,9 @@ Get all messages with image attachments:
|
|||
#+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
|
||||
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).
|
||||
|
||||
* DISPLAYING MESSAGES
|
||||
|
|
@ -282,7 +282,7 @@ your contacts.
|
|||
$ mu cfind julius
|
||||
#+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* also supports a =--format==-parameter, which sets the output to some
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
** --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
|
||||
it uses *xdg-open*. You can choose a different program by setting the
|
||||
*MU_PLAY_PROGRAM* environment variable.
|
||||
|
|
@ -86,7 +86,7 @@ the same name:
|
|||
$ mu extract --parts=3,4 --overwrite msgfile
|
||||
#+end_example
|
||||
|
||||
To extract all files ending in '.jpg' (case-insensitive):
|
||||
To extract all files ending in `.jpg' (case-insensitive):
|
||||
#+begin_example
|
||||
$ mu extract msgfile '.*\.jpg'
|
||||
#+end_example
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ For example:
|
|||
$ mu find subject:snow and date:2009..
|
||||
#+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
|
||||
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"
|
||||
#+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.
|
||||
|
||||
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~.
|
||||
|
||||
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
|
||||
output string, while an encrypted new message would have 'nx'.
|
||||
is `seen', has an attachment and is signed would have `asz' as its corresponding
|
||||
output string, while an encrypted new message would have `nx'.
|
||||
|
||||
** -s, --sortfield=<field> and -z,--reverse
|
||||
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
|
||||
cc,c Cc (carbon-copy) recipient(s)
|
||||
|
|
@ -164,7 +164,7 @@ This is assuming the GNU *date* command.
|
|||
|
||||
** --exec=<command>
|
||||
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:
|
||||
#+begin_example
|
||||
$ mu find milkshake --exec='less'
|
||||
|
|
@ -188,10 +188,10 @@ common occurrence when using e.g. Gmail together with *offlineimap*.
|
|||
** -r, --include-related
|
||||
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
|
||||
is useful if you want Gmail-style 'conversations'.
|
||||
is useful if you want Gmail-style `conversations'.
|
||||
|
||||
** -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
|
||||
this, sorting is chronological (by date), based on the newest message in a
|
||||
thread.
|
||||
|
|
@ -206,7 +206,7 @@ message, as in the following table:
|
|||
| other | |-> | |*> | |=> |
|
||||
#+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;
|
||||
not this may not really be the same message, if the message-id was copied.
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
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
|
||||
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.
|
||||
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)
|
||||
|
||||
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:
|
||||
|
||||
#+begin_example
|
||||
|
|
|
|||
|
|
@ -27,9 +27,9 @@ performed).
|
|||
|
||||
** --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
|
||||
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
|
||||
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
|
||||
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
|
||||
|
||||
|
|
@ -76,7 +76,7 @@ options.
|
|||
|
||||
* 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,
|
||||
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
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ the source message.
|
|||
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
|
||||
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
|
||||
|
||||
|
|
@ -52,7 +52,7 @@ 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)
|
||||
|
||||
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.
|
||||
|
||||
#+ATTR_MAN: :disable-caption t
|
||||
|
|
@ -60,13 +60,13 @@ messages, i.e. messages that live in the ~cur/~ sub-directory of a Maildir.
|
|||
|------+------------------------------------|
|
||||
| D | Draft message |
|
||||
| F | Flagged message |
|
||||
| P | Passed message (i.e., 'forwarded') |
|
||||
| P | Passed message (i.e., `forwarded') |
|
||||
| R | Replied message |
|
||||
| S | Seen message |
|
||||
| T | Trashed; to be deleted later |
|
||||
|
||||
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 |
|
||||
|
|
@ -74,7 +74,7 @@ file-name; but we *mu* uses 'N' in the ~--flags~ to represent that:
|
|||
| N | New |
|
||||
|
||||
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
|
||||
vice-versa, respectively. When marking a message as New, it looses the other
|
||||
flags.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ quote any characters that would otherwise be interpreted by the shell, such as
|
|||
* TERMS
|
||||
|
||||
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.
|
||||
|
||||
Some example queries:
|
||||
|
|
@ -36,13 +36,13 @@ subject:capybara
|
|||
maildir:/inbox
|
||||
#+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:
|
||||
#+begin_example
|
||||
to:vacation or subject:vacation or body:vacation or ...
|
||||
#+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=.
|
||||
|
||||
If terms contain whitespace, they need to be quoted:
|
||||
|
|
@ -80,7 +80,7 @@ subject:chip AND subject:dale
|
|||
#+end_example
|
||||
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
|
||||
|
||||
|
|
@ -93,9 +93,9 @@ subject:/h.llo/ # match hallo, hello, ...
|
|||
subject:/
|
||||
#+end_example
|
||||
|
||||
Note the difference between 'maildir:/foo' and 'maildir:/foo/'; the former
|
||||
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'
|
||||
Note the difference between `maildir:/foo' and `maildir:/foo/'; the former
|
||||
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'
|
||||
etc.
|
||||
|
||||
Wildcards are another mechanism for matching where a term with a rightmost ***
|
||||
|
|
@ -171,10 +171,10 @@ an open range.
|
|||
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
|
||||
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).
|
||||
|
||||
You can use '/' , '.', '-', ':' and 'T' to make dates more human-readable.
|
||||
You can use `/' , `.', `-', `:' and `T' to make dates more human-readable.
|
||||
|
||||
Some examples:
|
||||
#+begin_example
|
||||
|
|
@ -185,13 +185,13 @@ date:2015-06-01..
|
|||
date:2016..2016
|
||||
#+end_example
|
||||
|
||||
You can also use the special 'dates' *now* and *today*:
|
||||
You can also use the special `dates' *now* and *today*:
|
||||
#+begin_example
|
||||
date:20170505..now
|
||||
date:today..
|
||||
#+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,
|
||||
*h* for hours, *d* for days, *w* for week, *m* for months and *y* for years. Some
|
||||
examples:
|
||||
|
|
@ -222,7 +222,7 @@ available:
|
|||
f,flagged Flagged
|
||||
l,list Mailing-list message
|
||||
n,new New message (in new/ Maildir)
|
||||
p,passed Passed ('Handled')
|
||||
p,passed Passed (`Handled')
|
||||
r,replied Replied
|
||||
s,seen Seen
|
||||
t,trashed Marked for deletion
|
||||
|
|
@ -259,8 +259,8 @@ find it (and all the other messages in that same maildir) with:
|
|||
maildir:/lists/running
|
||||
#+end_example
|
||||
|
||||
Note the starting '/'. If you want to match mails in the 'root' maildir, you can
|
||||
do with a single '/':
|
||||
Note the starting `/'. If you want to match mails in the `root' maildir, you can
|
||||
do with a single `/':
|
||||
#+begin_example
|
||||
maildir:/
|
||||
#+end_example
|
||||
|
|
@ -287,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
|
||||
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
|
||||
bee AND bird
|
||||
#+end_example
|
||||
|
|
@ -297,12 +297,12 @@ Find all messages with either Frodo or Sam:
|
|||
Frodo OR Sam
|
||||
#+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
|
||||
subject:wombat and capybara
|
||||
#+end_example
|
||||
|
||||
Find all messages in the 'Archive' folder from Fred:
|
||||
Find all messages in the `Archive' folder from Fred:
|
||||
#+begin_example
|
||||
from:fred and maildir:/Archive
|
||||
#+end_example
|
||||
|
|
@ -322,7 +322,7 @@ Find all messages with attached images:
|
|||
mime:image/*
|
||||
#+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
|
||||
hallo and (lang:nl or lang:de)
|
||||
#+end_example
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ in them.
|
|||
|
||||
~mu~'s main purpose is to enable searching of e-mail messages. It
|
||||
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
|
||||
queried.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue