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