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
@ -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
|
||||
|
||||
Reference in New Issue
Block a user