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

man: change quoting style

Browse Source 
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
2024-03-02 13:25:56 +00:00
parent c76aa53156
commit 721aadc140
9 changed files with 54 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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