commit 084bc219b75ea0c30e09320dbf60d8742e108e48
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Fri Sep 13 15:03:29 2024 -0500
Commit: Fabian Greffrath <fabian@greffrath.com>
CommitDate: Wed Jul 2 08:24:12 2025 +0200
man/default.cfg.template: Improve example format
Use `EX` and `EE` macros to turn off filling, obviating the need for
repeated `br` requests.
I must admit at the outset that these macros are extensions to the
original man(7) dialect of Seventh Edition Unix in 1979.
groff_man_style(7):
.EX
.EE Begin and end example. After .EX, filling is disabled and a
constant‐width (monospaced) font is selected. Calling .EE
enables filling and restores the previous font.
Example regions are useful for formatting code, shell
sessions, and text file contents. An example region is not
a “literal mode” of any sort: special character escape
sequences must still be used to produce correct glyphs for
', -, \, ^, `, and ~ (see subsection “Portability” below).
Sentence endings are still detected and additional inter‐
sentence space applied. If the amount of additional inter‐
sentence spacing is altered, the rendering of, for instance,
regular expressions using . or ? followed by multiple spaces
can change. Use the dummy character escape sequence \&
before the spaces.
.EX and .EE are extensions introduced in Ninth Edition Unix.
Documenter’s Workbench, Heirloom Doctools, and Plan 9
troffs, and mandoc (since 1.12.2) also support them.
Solaris troff does not.
"Solaris troff" means the AT&T System V-descended troff program that
Solaris shipped up through version 10 of that operating system. Solaris
11 adopted groff as its troff, and therefore handles these extensions
fine. (Its groff is pretty old, but not older than these macros, which
date to 2009 [or 1986 in Bell Labs Research Unix].)
---
man/default.cfg.template | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/man/default.cfg.template b/man/default.cfg.template
index b3cfdb4a..5d07322a 100644
--- a/man/default.cfg.template
+++ b/man/default.cfg.template
@@ -27,13 +27,12 @@ of a string type, the value is surrounded by quotes (").
For example:
.RS
.PP
+.EX
integer_value 1
-.br
integer_value2 1
-.br
floating_point_value 4.2
-.br
string_value "hello world"
+.EE
.RE
.PP
Invalid lines or comments in the file will be ignored, but it is advisable