Commit Graph
8 Commits
Author SHA1 Message Date
John MacFarlane a6fe02f46a Man writer: improvements to code and code blocks.
The aim here (see #9020) is to produce more standard and more
portable man pages.  To that end:

- We revert the fanciness introduced in #7506, which employs a
  custom font name V and a macro that makes this act like boldface
  in a terminal and monospace in other formats.  Unfortunately,
  this code uses a mechanism that is not portable (and does not
  work in mandoc).

- Instead of using V for inline code, we simply use CR.
  Note that `\f[CR]` is emitted instead of plain `\f[C]`,
  because there is no C font in man.  (This produces warnings
  in recent versions of groff.)

- For code blocks, we now use the `.EX` and `.EE` macros,
  together with `.IP` for spacing and indentation.  This gives
  more standard code that can be better interpreted e.g. by mandoc.
2023-08-25 21:35:47 -07:00
John MacFarlane 87716265c1 Man writer: don't emit .hy...
regardless of setting of `hyphenate` variable.  See #9020.
2023-08-24 21:24:33 -07:00
John MacFarlane c6cf78a033 Improve on fix to #7506.
Don't boldface code in output formats that can represent
it as monospace.

Define aliases for VI, VB, VBI as well.
2022-01-15 12:57:26 -08:00
John MacFarlane c40727bfbb Man writer: use custom font V for inline code.
The V font is defined conditionally, so that it renders
like CB in output formats that support that, and like B
in those that don't (e.g. the terminal).

We could just redefine C, but this would affect code
blocks, too, and putting them all in boldface looks ugly,
I think.

Possible drawback: fragments created by pandoc's man
writer will presuppose a nonstandard V font.

Closes #7506.
Supersedes 253467a549.
2022-01-15 12:39:19 -08:00
John MacFarlane 1b18278288 man template: change tbl comment to '\" t.
This is what is specified in groff_man(7).
Closes #6803.
2020-11-03 12:54:02 -08:00
John MacFarlane da5b6d5c0b Update man template to avoid bad wraps.
The contents of the .TH line cannot wrap.
Closes #5929.
2019-11-24 09:55:04 -08:00
John MacFarlane c20f1635c9 Remove misleading comment in man, ms templates. 2019-07-04 19:26:24 +02:00
John MacFarlane e390d754ef Merge commit '9e52ac6bb02afd7b4ed5dad61021a1fa33051203' as 'data/templates' 2017-02-20 20:52:00 +01:00