gbranden pushed a commit to branch master
in repository groff.
commit 1ebe5a5619ce1f02a0b24c920ddd1e3219a42108
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat May 17 17:57:57 2025 -0500
groff_man*(7): Migrate to `\[xx]` escape form.
...from `\(xx` in page source and illustrations of escape sequence
syntax.
A few years of experience corresponding with man page maintainers in
other projects has persuaded me that the proportion thereof who are
concerned with page portability to AT&T troff is low. The only
surviving instances appear to be Plan 9 troff and Solaris 10 troff.
(I don't think DWB 3.3 troff is anyone's "daily driver", but it's
valuable for research and testing purposes.)
Nevertheless in a subsequent commit I'll add a Q&A item to
groff_man_style(7)'s "Notes" section covering this topic.
---
tmac/groff_man.7.man.in | 430 ++++++++++++++++++++++++------------------------
1 file changed, 215 insertions(+), 215 deletions(-)
diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index b8f05d4df..2527f2ddd 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -9,12 +9,12 @@ Consider this ghastly example:
If no scaling unit is given,
the
.I man
-package assumes \(lqn\(rq\c
+package assumes \[lq]n\[rq]\c
_ifstyle()dnl
; that is,
-approximately the width of the letter \(lqn\(rq in the font current when
-the macro is called
-(see section \(lqMeasurements\(rq in
+approximately the width of the letter \[lq]n\[rq] in the font current
+when the macro is called
+(see section \[lq]Measurements\[rq] in
.MR groff @MAN7EXT@ )\c
_endif()dnl
\&.
@@ -127,7 +127,7 @@ document formatting system.
It is used to compose manual pages
.\" We use an unbreakable space \~ here to keep the phrase intact for
.\" its introduction; in subsequent discussion, that is not important.
-(\(lqman\~pages\(rq)
+(\[lq]man\~pages\[rq])
like the one you are reading.
.
This document presents the macros thematically;
@@ -208,12 +208,12 @@ We discuss other macros
.BR SB ,
and
.BR UC )
-in subsection \(lqDeprecated features\(rq below.
+in subsection \[lq]Deprecated features\[rq] below.
.
.
.P
Throughout Unix documentation,
-a manual entry is referred to simply as a \(lqman page\(rq,
+a manual entry is referred to simply as a \[lq]man page\[rq],
regardless of its length,
without gendered implication,
and irrespective of the macro package selected for its composition.
@@ -226,7 +226,7 @@ A man page employs the Unix line-ending convention
.
Some basic Latin characters have special meaning to
.I roff;
-see subsection \(lqPortability\(rq below.
+see subsection \[lq]Portability\[rq] below.
.
.
.\" ====================================================================
@@ -235,8 +235,8 @@ see subsection \(lqPortability\(rq below.
.
.I groff
is a programming system for typesetting:
-we thus often use the verb \(lqto set\(rq in the sense
-\(lqto typeset\(rq.
+we thus often use the verb \[lq]to set\[rq] in the sense
+\[lq]to typeset\[rq].
.
The formatter
.MR @g@troff @MAN1EXT@
@@ -258,12 +258,12 @@ at
or
.B \e:
escape sequences
-(see subsection \(lqPortability\(rq below),
+(see subsection \[lq]Portability\[rq] below),
or at predetermined locations
if automatic hyphenation is enabled
(see the
.B \-rHY
-option in section \(lqOptions\(rq below).
+option in section \[lq]Options\[rq] below).
.
An output line may be supplemented with
.I "inter-sentence space,"
@@ -292,7 +292,7 @@ document can contain
which start with a dot
.RB ( .\& )
or neutral apostrophe
-.RB ( \(aq ).
+.RB ( \[aq] ).
.
All other input lines are
.I "text lines"
@@ -318,7 +318,7 @@ words that follow its name.
.
A newline,
unless escaped
-(see subsection \(lqPortability\(rq below),
+(see subsection \[lq]Portability\[rq] below),
marks the end of the macro call.
.
A control line with no macro name on it is called an
@@ -382,10 +382,10 @@ characters must be double-quoted to be interpreted
correctly.
_endif()dnl
If you require an empty macro argument,
specify it as a pair of neutral double quotes
-.RB ( \(dq\^\(dq ).
+.RB ( \[dq]\^\[dq] ).
_ifstyle()dnl
.
-See section \(lqNotes\(rq below for examples of cases where better
+See section \[lq]Notes\[rq] below for examples of cases where better
alternatives to empty arguments in macro calls are available.
_endif()dnl
.
@@ -398,7 +398,7 @@ We identify some macros as
to the set originally implemented.
.
They are not supported everywhere;
-see subsection \(lqUse of extensions\(rq
+see subsection \[lq]Use of extensions\[rq]
below.
_endif()dnl
.
@@ -451,7 +451,7 @@ Populate the page header and footer.
_ifstyle()dnl
.
.I roff
-systems refer to these collectively as \(lqtitles\(rq.
+systems refer to these collectively as \[lq]titles\[rq].
_endif()dnl
.
Together,
@@ -464,7 +464,7 @@ can uniquely identify a
document on the system.
_ifstyle()dnl
.
-This use of \(lqsection\(rq has nothing to do with the section headings
+This use of \[lq]section\[rq] has nothing to do with the section headings
otherwise discussed in this page;
it arises from the organizational scheme of printed and bound Unix
manuals.
@@ -602,7 +602,7 @@ use of an italic style in
is mapped to the bold-italic style if available in the font family.
.
The inset level is reset to 1;
-see subsection \(lqHorizontal and vertical spacing\(rq below.
+see subsection \[lq]Horizontal and vertical spacing\[rq] below.
.
Text lines after the call are set as an ordinary paragraph
.RB ( P ).
@@ -615,7 +615,7 @@ and ordering of sections follows a set of common practices,
as does much of the layout of material within sections.
.
For example,
-a section called \(lqName\(rq or \(lqNAME\(rq must exist,
+a section called \[lq]Name\[rq] or \[lq]NAME\[rq] must exist,
must be the first section after the
.B TH
call,
@@ -664,7 +664,7 @@ use of an italic style in
is mapped to the bold-italic style if available in the font family.
.
The inset level is reset to 1;
-see subsection \(lqHorizontal and vertical spacing\(rq below.
+see subsection \[lq]Horizontal and vertical spacing\[rq] below.
.
Text lines after the call are set as an ordinary paragraph
.RB ( P ).
@@ -696,18 +696,18 @@ shell sessions,
and text file contents.
.
An example region is not
-a \(lqliteral mode\(rq
+a \[lq]literal mode\[rq]
of any sort:
special character escape sequences must still be used to produce correct
glyphs for
-.BR \(aq ,
+.BR \[aq] ,
.BR \- ,
-.BR \(rs ,
-.BR \(ha ,
-.BR \(ga ,
+.BR \[rs] ,
+.BR \[ha] ,
+.BR \[ga] ,
and
-.B \(ti
-(see subsection \(lqPortability\(rq below).
+.B \[ti]
+(see subsection \[lq]Portability\[rq] below).
.
Sentence endings are still detected and additional inter-sentence space
applied.
@@ -722,7 +722,7 @@ or
followed by multiple spaces can change.
.
Use the dummy character escape sequence
-.B \(rs&
+.B \[rs]&
before the spaces.
.
.
@@ -840,12 +840,12 @@ follow the break with a default amount of vertical space,
which can be changed by the deprecated
.B PD
macro;
-see subsection \(lqHorizontal and vertical spacing\(rq below.
+see subsection \[lq]Horizontal and vertical spacing\[rq] below.
.
They also reset the type size and font style to defaults
.RB ( TQ
again excepted);
-see subsection \(lqFont style macros\(rq below.
+see subsection \[lq]Font style macros\[rq] below.
.
.
.TP
@@ -878,7 +878,7 @@ is not.
Set an indented paragraph with a leading unindented tag.
.
The macro plants a one-line input trap that honors the
-.B \(rsc
+.B \[rs]c
escape sequence;
text on the next line becomes the tag,
set without indentation.
@@ -891,10 +891,10 @@ and by the amount of the
register otherwise.
.
If the tag,
-plus the \(lqtag spacing\(rq stored in the
+plus the \[lq]tag spacing\[rq] stored in the
.B TS
register
-(see section \(lqOptions\(rq below)
+(see section \[lq]Options\[rq] below)
is wider than the indentation,
the package breaks the line after the tag.
_ifstyle()dnl
@@ -999,9 +999,9 @@ and
to set a paragraph with a short
.I mark
that is not semantically important,
-such as a bullet (\(bu)\(emobtained with the
+such as a bullet (\[bu])\[em]obtained with the
.B \e(bu
-special character escape sequence\(emor list enumerator,
+special character escape sequence\[em]or list enumerator,
as seen in this very paragraph.
.RE \" Move left margin back to IP indentation.
.RE \" Move left margin back to standard position.
@@ -1124,19 +1124,19 @@ of synopsis syntax one may encounter.
.EX
\&.SY groff
\&.RB [ \e\-abcCeEgGijklNpRsStUVXzZ ]
-\&.RB [ \e\-d\e\(ti\ec
+\&.RB [ \e\-d\e\[ti]\ec
\&.IR ctext ]
-\&.RB [ \e\-d\e\(ti\ec
+\&.RB [ \e\-d\e\[ti]\ec
\&.IB string =\ec
\&.IR text ]
-\&.RB [ \e\-D\e\(ti\ec
+\&.RB [ \e\-D\e\[ti]\ec
\&.IR fallback\-encoding ]
.EE
.
.I "(and so on similarly)"
.
.EX
-\&.RI [ file\e\(ti .\e|.\e|.]
+\&.RI [ file\e\[ti] .\e|.\e|.]
\&.YS
\&.
\&.
@@ -1153,14 +1153,14 @@ of synopsis syntax one may encounter.
\&.P
\&.SY groff
\&.B \e\-v
-\&.RI [ option\e\(ti .\e|.\e|.\e&]
-\&.RI [ file\e\(ti .\e|.\e|.]
+\&.RI [ option\e\[ti] .\e|.\e|.\e&]
+\&.RI [ file\e\[ti] .\e|.\e|.]
\&.YS
\&.
\&.SY groff
\&.B \e\-\e\-version
-\&.RI [ option\e\(ti .\e|.\e|.\e&]
-\&.RI [ file\e\(ti .\e|.\e|.]
+\&.RI [ option\e\[ti] .\e|.\e|.\e&]
+\&.RI [ file\e\[ti] .\e|.\e|.]
\&.YS
.EE
.
@@ -1246,7 +1246,7 @@ produces the following output.
Several features of the above example are of note.
.
.
-.IP \(bu 3n
+.IP \[bu] 3n
The empty request (.),
which does nothing,
vertically spaces the input file for readability by the document
@@ -1256,16 +1256,16 @@ Do not put blank (empty) lines in a man page source
document.
.
Some
.MR man 1
-programs \(lqsqueeze\(rq multiple blank output lines into one.
+programs \[lq]squeeze\[rq] multiple blank output lines into one.
.
.
-.IP \(bu
+.IP \[bu]
Command and option names are presented in
.B bold
to cue the user that they should be input literally.
.
.
-.IP \(bu
+.IP \[bu]
Option dashes are specified with the
.B \e\-
escape sequence;
@@ -1274,14 +1274,14 @@ facilitate copy-and-paste from the rendered man page to
a shell prompt
or text file.
.
.
-.IP \(bu
+.IP \[bu]
Option arguments and command operands are presented in
.I italics
-(but see subsection \(lqFont style macros\(rq below regarding terminals)
+(but see subsection \[lq]Font style macros\[rq] below regarding terminals)
to cue the user that they must be replaced with appropriate input.
.
.
-.IP \(bu
+.IP \[bu]
Symbols that are neither to be typed literally nor replaced at the
user's discretion appear in the roman style;
brackets surround optional arguments,
@@ -1292,22 +1292,22 @@ Where whitespace separates optional arguments,
a space precedes the ellipsis.
.
.
-.IP \(bu
+.IP \[bu]
The non-breaking adjustable space escape sequence
-.B \e\(ti
+.B \e\[ti]
prevents the output line from breaking within the option brackets;
-see subsection \(lqPortability\(rq below.
+see subsection \[lq]Portability\[rq] below.
.
.
-.IP \(bu
+.IP \[bu]
The output line continuation escape sequence
.B \ec
is used with font style alternation macros to allow all three font
styles to be set without (breakable) space among them;
-see subsection \(lqPortability\(rq below.
+see subsection \[lq]Portability\[rq] below.
.
.
-.IP \(bu
+.IP \[bu]
The dummy character escape sequence
.B \e&
follows the ellipsis when further text is to follow after space on the
@@ -1318,7 +1318,7 @@ sentence
.\" end-of-sentence detection, and a newline...
and causing additional inter-sentence space to be placed after it.
.
-See subsection \(lqPortability\(rq below.
+See subsection \[lq]Portability\[rq] below.
.
.
.P
@@ -1331,13 +1331,13 @@ as follows.
.RS
.EX
\&.P
-\&.B void *\(rsc
+\&.B void *\[rs]c
\&.SY bsearch (
-\&.BI const\(rs\(tivoid\(rs\(ti* key ,
-\&.BI const\(rs\(tivoid\(rs\(ti* base ,
-\&.BI size_t\(rs\(ti nmemb ,
-\&.BI int\(rs\(ti(* compar )\(rsc
-\&.B (const\(rs\(tivoid\(rs\(ti*, const\(rs\(tivoid\(rs\(ti*));
+\&.BI const\[rs]\[ti]void\[rs]\[ti]* key ,
+\&.BI const\[rs]\[ti]void\[rs]\[ti]* base ,
+\&.BI size_t\[rs]\[ti] nmemb ,
+\&.BI int\[rs]\[ti](* compar )\[rs]c
+\&.B (const\[rs]\[ti]void\[rs]\[ti]*, const\[rs]\[ti]void\[rs]\[ti]*));
\&.YS
.EE
.RE
@@ -1543,7 +1543,7 @@ Identify
.I address
as an RFC 6068
.I addr-spec
-for a \(lqmailto:\(rq URI with the text between the two macro
+for a \[lq]mailto:\[rq] URI with the text between the two macro
calls as the link text.
.
An argument to
@@ -1584,8 +1584,8 @@ for more information.
.
.
.IP
-displays as \(lqContact Fred Foonly \(lafred\:.foonly@\:fubar\:.net\(ra
-for more information.\(rq.
+displays as \[lq]Contact Fred Foonly \[la]fred\:.foonly@\:fubar\:.net\[ra]
+for more information.\[rq].
_endif()dnl
.
.
@@ -1638,11 +1638,11 @@ home page
.
.
.IP
-displays as \(lqThe GNU Project of the Free Software Foundation hosts
+displays as \[lq]The GNU Project of the Free Software Foundation hosts
the
.I groff
home page
-\(lahttps://\:www\:.gnu\:.org/\:software/\:groff/\(ra.\(rq.
+\[la]https://\:www\:.gnu\:.org/\:software/\:groff/\[ra].\[rq].
_endif()dnl
.
.
@@ -1827,7 +1827,7 @@ it is hidden from readers using such devices.
Observe what is
.I not
prescribed for setting in bold or italics above:
-elements of \(lqsynopsis language\(rq such as ellipses and brackets
+elements of \[lq]synopsis language\[rq] such as ellipses and brackets
around options;
proper names and adjectives;
titles of anything other than major works of literature;
@@ -1857,7 +1857,7 @@ see the
.BR \e(oq ,
and
.B \e(cq
-escape sequences in subsection \(lqPortability\(rq below.
+escape sequences in subsection \[lq]Portability\[rq] below.
.
.
_endif()dnl
@@ -1886,7 +1886,7 @@ and/or
.B \ef
escape sequences.
.
-See subsection \(lqPortability\(rq
+See subsection \[lq]Portability\[rq]
below for approaches.
_endif()dnl
.
@@ -1903,7 +1903,7 @@ _ifstyle()dnl
.IP
.\" from src/roff/troff/troff.1.man
.EX
-\&.BI \-r\e\(ti register = numeric-expression
+\&.BI \-r\e\[ti] register = numeric-expression
.EE
.RE
.
@@ -2066,14 +2066,14 @@ If no scaling unit is given,
the
.I man
_ifstyle()dnl
-package assumes \(lqn\(rq;
+package assumes \[lq]n\[rq];
that is,
-roughly the width of a letter \(lqn\(rq in the font current when the
-macro is called\(emsee section \(lqMeasurements\(rq in
+roughly the width of a letter \[lq]n\[rq] in the font current when the
+macro is called\[em]see section \[lq]Measurements\[rq] in
.MR groff @MAN7EXT@ .
_endif()dnl
_ifnotstyle()dnl
-package assumes \(lqn\(rq.
+package assumes \[lq]n\[rq].
_endif()dnl
.
An indentation specified in a call to
@@ -2190,7 +2190,7 @@ the inset amount and indentation.
.TE
.
.
-.IP \(bu
+.IP \[bu]
This indented paragraph is marked with a bullet,
contrasting the inset amount and the indentation;
only the former affects the mark,
@@ -2259,7 +2259,7 @@ and the deprecated
The default inter-section and inter-paragraph spacing
is 1v for terminals and 0.4v for typesetters.
_ifstyle()dnl
-\(lqv\(rq is a unit of vertical distance,
+\[lq]v\[rq] is a unit of vertical distance,
where 1v is the distance between adjacent text baselines.
_endif()dnl
.
@@ -2281,12 +2281,12 @@ device.
.SS Registers
.\" ====================================================================
.
-Registers are described in section \(lqOptions\(rq below.
+Registers are described in section \[lq]Options\[rq] below.
.
They can be set not only on the command line but in the site
.I man.local
file as well;
-see section \(lqFiles\(rq below.
+see section \[lq]Files\[rq] below.
.
.
.\" ====================================================================
@@ -2302,16 +2302,16 @@ see
_endif()dnl
.
Others are supported for configuration of rendering parameters;
-see section \(lqOptions\(rq below.
+see section \[lq]Options\[rq] below.
.
.
.TP 8n \" accommodate "\e*(Tm", hand-tuned for PDF
.B \e*R
-interpolates a special character escape sequence for the \(lqregistered
-sign\(rq glyph,
+interpolates a special character escape sequence for the \[lq]registered
+sign\[rq] glyph,
.BR \e(rg ,
if available,
-and \(lq(Reg.)\(rq otherwise.
+and \[lq](Reg.)\[rq] otherwise.
.
.
.
@@ -2335,11 +2335,11 @@ respectively.
.
.TP
.B \e*(Tm
-interpolates a special character escape sequence for the \(lqtrade mark
-sign\(rq glyph,
+interpolates a special character escape sequence for the \[lq]trade mark
+sign\[rq] glyph,
.BR \e(tm ,
if available,
-and \(lq(TM)\(rq otherwise.
+and \[lq](TM)\[rq] otherwise.
_ifstyle()dnl
.
.
@@ -2353,19 +2353,19 @@ change it restore its original value afterward.
.
Better alternatives exist for the rest;
simply use the
-.BR \(rs(rg , \" Heirloom Doctools, mandoc, neatmkfn, Plan 9, Solaris
-.BR \(rs(lq , \" Heirloom Doctools, mandoc, neatmkfn, Plan 9
-.BR \(rs(rq , \" Heirloom Doctools, mandoc, neatmkfn, Plan 9
+.BR \[rs][rg] , \" Heirloom Doctools, mandoc, neatmkfn, Plan 9, Solaris
+.BR \[rs][lq] , \" Heirloom Doctools, mandoc, neatmkfn, Plan 9
+.BR \[rs][rq] , \" Heirloom Doctools, mandoc, neatmkfn, Plan 9
and
-.B \(rs(tm \" Heirloom Doctools, mandoc, neatmkfn, Plan 9
+.B \[rs][tm] \" Heirloom Doctools, mandoc, neatmkfn, Plan 9
special character escape sequences directly.
.
-Unless you are aiming for a pathological level of portability\(emperhaps
+Unless you are aiming for a pathological level of portability\[em]perhaps
composing a man page for consumption on simulators of 1980s Unix systems
(or Solaris
.IR troff ,
though even it supports
-.BR \(rs(rg )\(em\c
+.BR \[rs][rg] )\[em]\c
avoid using the above strings.
.
.
@@ -2404,7 +2404,7 @@ You can copy extension macro definitions from
.IR groff ;
see
.I \%an\-ext.tmac
-in section \(lqFiles\(rq below.
+in section \[lq]Files\[rq] below.
.
.
.P
@@ -2419,13 +2419,13 @@ we might put a line
.
in our
.I man
-document at the end of the \(lqName\(rq section,
+document at the end of the \[lq]Name\[rq] section,
test a system for the availability of the
.I "groff man"
.B MR
macro,
remove the line if the macro is present,
-and \(lqinline\(rq a definition otherwise,
+and \[lq]inline\[rq] a definition otherwise,
as follows.
.
(This version is slightly simplified and does not attempt to disable
@@ -2434,15 +2434,15 @@ hyphenation when setting arguments to
.
.RS
.EX
-have_MR=$(echo .pm | troff \-man 2>&1 | grep \(aqMR[[:space:]]\(aq)
+have_MR=$(echo .pm | troff \-man 2>&1 | grep \[aq]MR[[:space:]]\[aq])
if [ \-n "$have_MR" ]
then
- sed \(aq/@DEFINE_MR@/d\(aq myprog.man.in > myprog.man
+ sed \[aq]/@DEFINE_MR@/d\[aq] myprog.man.in > myprog.man
else
- sed \(aqs/@DEFINE_MR@/.de MR\e
+ sed \[aq]s/@DEFINE_MR@/.de MR\e
\&. ie \e\e\e\en(.$=1 .I \e\e\e\e$1\e
\&. el .IR \e\e\e\e$1 (\e\e\e\e$2)\e\e\e\e$3\e
-\&../\(aq myprog.man.in > myprog.man
+\&../\[aq] myprog.man.in > myprog.man
fi
.EE
.RE
@@ -2499,7 +2499,7 @@ uses 80 ens
Readers with low vision may also benefit from the narrower line length.
.
Inspect your documents with
-.RB \(lq "nroff \-t \-r LL=65n \-man" \(rq
+.RB \[lq] "nroff \-t \-r LL=65n \-man" \[rq]
to ensure that their output lines don't overrun.
.
.
@@ -2516,7 +2516,7 @@ control formatting operations.
A request appears on a control line.
.
An escape sequence starts with a backslash
-.RB ( \(rs )
+.RB ( \[rs] )
and can appear anywhere.
.
However,
@@ -2524,7 +2524,7 @@ use of
.I roff
requests
(apart from the empty request
-.RB \(lq . \(rq)\&
+.RB \[lq] . \[rq])\&
risks poor rendering when your page is processed by
.RI non- roff
formatters that attempt to interpret page sources.
@@ -2575,15 +2575,15 @@ even in man pages and usually do not cause portability
problems.
.
Several of these render glyphs corresponding to punctuation code points
in the Unicode basic Latin range
-(U+0020\(enU+007F)
+(U+0020\[en]U+007F)
that are handled specially in
.I roff
input;
the escape sequences below must be used to render them correctly and
portably when documenting material that uses them
-as literals\(emnamely,
+as literals\[em]namely,
any of the set
-.B \(aq \- \(rs \(ha \(ga \(ti
+.B \[aq] \- \[rs] \[ha] \[ga] \[ti]
(apostrophe,
dash or hyphen-minus,
backslash,
@@ -2594,7 +2594,7 @@ tilde).
.
.if n .TP 10n \" "\newline" + 2n
.if t .TP 9n \" we can get away with less on typesetters
-.B \e\(dq
+.B \e\[dq]
Comment.
.
The formatter ignores everything after the double quote to the end of
@@ -2602,7 +2602,7 @@ the input line.
.
Place whole-line comments on a control line
immediately after the empty request
-.RB (\(lq . \(rq).
+.RB (\[lq] . \[rq]).
.
.
.TP
@@ -2678,7 +2678,7 @@ or Documenter's Workbench
.
.
.TP
-.B \e\(ti
+.B \e\[ti]
Adjustable non-breaking space.
.
Use this escape sequence to prevent a break inside a short phrase or
@@ -2689,15 +2689,15 @@ between a numerical quantity and its corresponding
unit(s).
.IP
.EX
Before starting the motor,
-set the output speed to\e\(ti1.
-There are 1,024\e\(tibytes in 1\e\(tiKiB.
-CSTR\e\(ti#8 documents the B\e\(tilanguage.
+set the output speed to\e\[ti]1.
+There are 1,024\e\[ti]bytes in 1\e\[ti]KiB.
+CSTR\e\[ti]#8 documents the B\e\[ti]language.
.EE
.RE
.
.
.IP
-.B \e\(ti
+.B \e\[ti]
is a GNU extension
.\" BEGIN Keep in sync with groff.texi node "Other Differences" and
.\" groff_diff(7).
@@ -2746,7 +2746,7 @@ zero-width on terminals);
a non-breaking space.
.
Used primarily in ellipses
-(\(lq.\e|.\e|.\(rq)\&
+(\[lq].\e|.\e|.\[rq])\&
to space the dots more pleasantly on typesetters.
.
.
@@ -2779,7 +2779,7 @@ The next line is interpreted as usual and can `include' a
macro call
.BI \e newline\/\c
).
.
-.B \(rsc
+.B \[rs]c
is useful when three font styles are
needed in a single word,
as in a command synopsis.
@@ -2858,7 +2858,7 @@ It works reliably as long as the \[lq]ec\[rq] request is
not used,
which should never happen in man pages,
and it is slightly more portable than the more explicit
.B \e(rs
-(\(lqreverse solidus\(rq) special character escape sequence.
+(\[lq]reverse solidus\[rq]) special character escape sequence.
.
.
.TP
@@ -2896,9 +2896,9 @@ As shown above,
it is up to you to account for italic corrections with
.\" Normally we don't quote escape sequences, but these use
.\" potentially-confusing prose punctuation.
-.RB \(lq \^\e\|/\^ \(rq
+.RB \[lq] \^\e\|/\^ \[rq]
and
-.RB \(lq \^\e\^, \(rq,
+.RB \[lq] \^\e\^, \[rq],
which are themselves GNU extensions,
if desired and if supported by your implementation.
.
@@ -2934,16 +2934,16 @@ Several special characters are also widely portable.
.
Except for
.BR \[rs]\- ,
-.BR \[rs](em ,
+.BR \[rs][em] ,
and
-.BR \[rs](ga ,
+.BR \[rs][ga] ,
AT&T
.I troff
did not consistently `define' the characters listed below,
-.\" Only \-, \(em, and \(ga were documented in CSTR #54 (1976). CSTR
-.\" #54 (1992) offers no _comprehensive_ list but shows \(en in its
-.\" PostScript DESC file example. In DWB 3.3, \(aq was supported by the
-.\" "post" device, and \(dq by "pcl" and "Latin1".
+.\" Only \-, \[em], and \[ga] were documented in CSTR #54 (1976). CSTR
+.\" #54 (1992) offers no _comprehensive_ list but shows \[en] in its
+.\" PostScript DESC file example. In DWB 3.3, \[aq] was supported by the
+.\" "post" device, and \[dq] by "pcl" and "Latin1".
but its descendants,
like Plan\~9 or Solaris
.IR troff , \" Plan 9, Solaris
@@ -2976,7 +2976,7 @@ Minus sign.
produces the basic Latin hyphen-minus (U+002D) specifying Unix
command-line options and frequently used in file names.
.
-.RB \(lq \- \(rq
+.RB \[lq] \- \[rq]
is a hyphen in
.IR roff ;
some output devices format it as U+2010
@@ -2988,7 +2988,7 @@ some output devices format it as U+2010
Basic Latin neutral apostrophe.
.
Some output devices format
-.RB \(lq\| \(aq \|\(rq
+.RB \[lq]\| \[aq] \|\[rq]
as a right single quotation mark.
.
.
@@ -2999,7 +2999,7 @@ as a right single quotation mark.
Opening (left) and closing (right) single quotation marks.
.
Use these for paired directional single quotes,
-\(oqlike this\(cq.
+\[oq]like this\[cq].
.
.
.TP
@@ -3008,7 +3008,7 @@ Basic Latin quotation mark
(double quote).
.
Employ it in macro calls to work around interpretation of
-.RB \(oq\| \(dq \|\(cq
+.RB \[oq]\| \[dq] \|\[cq]
as an argument delimiter.
.\" This page prefers double quotes, but not here because they are more
.\" confusing to the eye when another double quote is what is quoted!
@@ -3020,7 +3020,7 @@ as an argument delimiter.
.\" from src/preproc/eqn/eqn.1.man
.EX
\&.TP
-\&.BI \(dqsplit \e(dq\(dq text \e(dq
+\&.BI \[dq]split \e(dq\[dq] text \e(dq
.EE
.RE
.
@@ -3036,14 +3036,14 @@ as an argument delimiter.
Left and right double quotation marks.
.
Use these for paired directional double quotes,
-\(lqlike this\(rq.
+\[lq]like this\[rq].
.
.
.TP
.B \e(em
Em dash.
.
-Use for an interruption\(emsuch as this one\(emin a sentence.
+Use for an interruption\[em]such as this one\[em]in a sentence.
.
.
.TP
@@ -3053,7 +3053,7 @@ En dash.
Use to separate the ends of a range,
as between numbers;
for example,
-\(lqthe digits 1\(en9\(rq.
+\[lq]the digits 1\[en]9\[rq].
.
.
.TP
@@ -3061,17 +3061,17 @@ for example,
Basic Latin grave accent.
.
Some output devices format
-.RB \(lq\| \(ga \|\(rq
+.RB \[lq]\| \[ga] \|\[rq]
as a left single quotation mark.
.
.
.TP
.B \e(ha
Basic Latin circumflex accent
-(\(lqhat\(rq).
+(\[lq]hat\[rq]).
.
Some output devices format
-.RB \(lq \(ha \(rq
+.RB \[lq] \[ha] \[rq]
as U+02C6
(modifier letter circumflex accent).
.
@@ -3096,7 +3096,7 @@ above.
Basic Latin tilde.
.
Some output devices format
-.RB \(lq \(ti \(rq
+.RB \[lq] \[ti] \[rq]
as U+02DC
(small tilde).
.
@@ -3120,7 +3120,7 @@ package to format page headers and footers and can be
redefined by the
administrator in a site's
.I man.local
file
-(see section \(lqFiles\(rq below).
+(see section \[lq]Files\[rq] below).
.
The presentation of
.B TH
@@ -3148,13 +3148,13 @@ when drafting replacements.
.TP
.B .BT
Set the page footer text
-(\(lqbottom trap\(rq).
+(\[lq]bottom trap\[rq]).
.
.
.TP
.B .PT
Set the page header text
-(\(lqpage trap\(rq).
+(\[lq]page trap\[rq]).
.
.
.P
@@ -3211,7 +3211,7 @@ System V
The optional
.I release
argument specifies the release number,
-as in \(lqSystem\~V Release\~3\(rq.
+as in \[lq]System\~V Release\~3\[rq].
.
.
.TP
@@ -3319,11 +3319,11 @@ Configure the amount of vertical space between
paragraphs or
The optional argument
.I vertical-space
specifies the amount;
-the default scaling unit is \(lqv\(rq.
+the default scaling unit is \[lq]v\[rq].
.
Without an argument,
inter-paragraph spacing resets to its default value;
-see subsection \(lqHorizontal and vertical spacing\(rq above.
+see subsection \[lq]Horizontal and vertical spacing\[rq] above.
.
.
.IP
@@ -3364,8 +3364,8 @@ is deprecated.
.B SM
without an argument,
followed immediately by
-.RB \(lq B
-.IR text \(rq,
+.RB \[lq] B
+.IR text \[rq],
produces the same output more portably.
.
The macros' order is interchangeable;
@@ -3670,7 +3670,7 @@ at verbosity level
.IR n ,
where
.I n
-is an integer in the range 0\(en3,
+is an integer in the range 0\[en]3,
inclusive;
.B 0
disables the messages and is the default.
@@ -3710,7 +3710,7 @@ Enable double-sided layout,
formatting footers for even and odd pages differently;
see the description of
.B TH
-in subsection \(lqDocument structure macros\(rq above.
+in subsection \[lq]Document structure macros\[rq] above.
.
.
.TP
@@ -3724,14 +3724,14 @@ the page text is broken before writing the footer.
.
Ignored if continuous rendering is enabled.
.
-The default is \(lq\-0.5i\~\-\~1v\(rq.
+The default is \[lq]\-0.5i\~\-\~1v\[rq].
.
.
.TP
.BI \-dHF= heading-font
Select the font used for section and subsection headings;
the default is
-.RB \(lq B \(rq
+.RB \[lq] B \[rq]
(bold style of the default family).
.
Any valid argument to
@@ -3769,7 +3769,7 @@ and the inset amount used by
.
The default is 7n on terminals and 7.2n on typesetters.
.
-Use only integer multiples of unit \(lqn\(rq on terminals for consistent
+Use only integer multiples of unit \[lq]n\[rq] on terminals for consistent
indentation.
.
.
@@ -3785,7 +3785,7 @@ and 6.5i on typesetters.
Set the line length for titles.
_ifstyle()dnl
.
-(\(lqTitles\(rq is the
+(\[lq]Titles\[rq] is the
.I roff
term for headers and footers.)
_endif()dnl
@@ -3807,7 +3807,7 @@ calls and topics named in
.B MR
calls;
the default is
-.RB \(lq I \(rq
+.RB \[lq] I \[rq]
(italic style of the default family).
.
Any valid argument to
@@ -3846,7 +3846,7 @@ acceptable values are 10,
11,
or 12 points.
.
-See subsection \(lqFont style macros\(rq above for the default.
+See subsection \[lq]Font style macros\[rq] above for the default.
.
.
.TP
@@ -3895,8 +3895,8 @@ as
.IR p c,
and so forth.
.
-The register tracking the suffixed page letter uses format \(lqa\(rq
-(see the \(lqaf\(rq request in
+The register tracking the suffixed page letter uses format \[lq]a\[rq]
+(see the \[lq]af\[rq] request in
.MR groff @MAN7EXT@ ).
.
_ifstyle()dnl
@@ -3973,7 +3973,7 @@ packages prior to
.B TH
or
.B Dd
-calls are \(lqclobbered\(rq by the reloading process.
+calls are \[lq]clobbered\[rq] by the reloading process.
.
If you want to provide your own definition of an extension macro to
ensure its availability,
@@ -3995,7 +3995,7 @@ and are ignored if the formatter is GNU
.
They are written to be compatible with AT&T
.I troff \" AT&T
-and permissively licensed\(emnot copylefted.
+and permissively licensed\[em]not copylefted.
.
To reduce the risk of name space collisions,
string and register names begin only with
@@ -4019,7 +4019,7 @@ above.
Further,
it is wise to `define' such page-local macros
(if at all)
-after the \(lqName\(rq section to accommodate timid
+after the \[lq]Name\[rq] section to accommodate timid
.MR makewhatis 8
or
.MR mandb 8
@@ -4094,7 +4094,7 @@ program may lack permission to open such files.
Some tips on composing and troubleshooting your man pages follow.
.
.
-.IP \(bu 2n
+.IP \[bu] 2n
What's the difference between a man page topic and identifier?
.
.
@@ -4107,7 +4107,7 @@ and
are often presented together.
.
Moreover,
-multiple programming languages have functions named \(lqprintf\(rq,
+multiple programming languages have functions named \[lq]printf\[rq],
and may document these in a man page.
.
The identifier is intended to
@@ -4124,16 +4124,16 @@ man page identifiers.
.
Thus,
you can type
-.RB \(lq "man fprintf" \|\(rq,
+.RB \[lq] "man fprintf" \|\[rq],
and other pages can refer to it,
without knowing whether the installed document uses
-\(lqprintf\|\(rq,
-\(lqfprintf\|\(rq,
-or even \(lqc_printf\|\(rq
+\[lq]printf\|\[rq],
+\[lq]fprintf\|\[rq],
+or even \[lq]c_printf\|\[rq]
as an identifier.
.
.
-.IP \(bu 2n
+.IP \[bu] 2n
Some ASCII characters look funny or copy and paste wrong.
.
.
@@ -4147,7 +4147,7 @@ like AT&T
before it,
maps several keycaps to code points
outside the Unicode basic Latin range
-(historically \(lqASCII\(rq)
+(historically \[lq]ASCII\[rq])
because that usually results in better typography in the general case.
.
When documenting GNU/Linux command or C language syntax,
@@ -4161,14 +4161,14 @@ this translation is sometimes not desirable.
.TS
Cb Cb
RfCR LfCR.
-To get a \(lqliteral\(rq.\|.\|. .\|.\|.should be input.
+To get a \[lq]literal\[rq].\|.\|. .\|.\|.should be input.
_
-\(aq \(rs(aq
-\- \(rs\-
-\(rs \(rs(rs
-\(ha \(rs(ha
-\(ga \(rs(ga
-\(ti \(rs(ti
+\[aq] \[rs][aq]
+\- \[rs]\-
+\[rs] \[rs][rs]
+\[ha] \[rs][ha]
+\[ga] \[rs][ga]
+\[ti] \[rs][ti]
_
.TE
.
@@ -4176,25 +4176,25 @@ _
.IP
If a neutral double quote (") is needed in a macro argument,
you can use
-.B \(rs(dq
+.B \[rs][dq]
to get it.
.
Do
.I not
use
-.B \(rs(aq
+.B \[rs][aq]
for an ordinary apostrophe
-(as in \(lqcan't\(rq)
+(as in \[lq]can't\[rq])
or
-.B \(rs\-
+.B \[rs]\-
for an ordinary hyphen
-(as in \(lqword-aligned\(rq).
+(as in \[lq]word-aligned\[rq]).
.
.\" slack wording for managing stranded lines in PS/PDF output
-.\"Review subsection \(lqPortability\(rq above.
+.\"Review subsection \[lq]Portability\[rq] above.
.
.
-.IP \(bu
+.IP \[bu]
Do I ever need to use an empty macro argument ("")?
.
.
@@ -4213,21 +4213,21 @@ Cb Cb
LfCR LfCR.
Instead of.\|.\|.\& \&.\|.\|.should be considered.
_
-\&.TP \(dq\(dq .TP
+\&.TP \[dq]\[dq] .TP
_
-\&.BI \(dq\(dq \fIitalic-text bold-text .IB \fIitalic-text bold-text
+\&.BI \[dq]\[dq] \fIitalic-text bold-text .IB \fIitalic-text bold-text
_
-\&.TH foo 1 \(dq\(dq \(dqfoo 1.2.3\(dq .TH foo 1 \
-\f(CIyyyy\fP-\f(CImm\fP-\f(CIdd\fP \(dqfoo 1.2.3\(dq
+\&.TH foo 1 \[dq]\[dq] \[dq]foo 1.2.3\[dq] .TH foo 1 \
+\f(CIyyyy\fP-\f(CImm\fP-\f(CIdd\fP \[dq]foo 1.2.3\[dq]
_
-\&.IP \(dq\(dq 4n .IP
+\&.IP \[dq]\[dq] 4n .IP
_
-\&.IP \(dq\(dq 4n .RS 4n
+\&.IP \[dq]\[dq] 4n .RS 4n
\fIparagraph .P
\fR.\|.\|. \fIparagraph
\fR.\|.\|. .RE
_
-\&.B one two \(dq\(dq three .B one two three
+\&.B one two \[dq]\[dq] three .B one two three
.TE
.
.
@@ -4245,7 +4245,7 @@ a page maintainer keeps both up to date.
.IP
.B IP
is sometimes ill-understood and misused,
-especially when no mark argument is supplied\(eman indentation argument
+especially when no mark argument is supplied\[em]an indentation argument
is not required.
.
By setting an explicit indentation,
@@ -4269,7 +4269,7 @@ In the last example,
the empty argument does have a subtly different effect than its
suggested replacement:
the empty argument causes an additional space character to be
-interpolated between the arguments \(lqtwo\(rq and \(lqthree\(rq\(embut
+interpolated between the arguments \[lq]two\[rq] and \[lq]three\[rq]\[em]but
it is a regular breaking space,
so it can be discarded at the end of an output line.
.
@@ -4278,7 +4278,7 @@ particularly with space,
which can be overlooked in source and rendered forms.
.
.
-.IP \(bu
+.IP \[bu]
.B RS
doesn't indent relative to my indented paragraph.
.
@@ -4335,7 +4335,7 @@ to end the indented region before starting the next
tagged paragraph
(at the appropriate nesting level).
.
.
-.IP \(bu
+.IP \[bu]
.B RE
doesn't move the inset back to the expected level.
.
@@ -4350,7 +4350,7 @@ unlike
inset
.I amount.
.
-.RB \(lq .RE\~1 \(rq
+.RB \[lq] .RE\~1 \[rq]
goes to the level before any
.B RS
macros were called,
@@ -4381,7 +4381,7 @@ calls have no effect until
is used again.
.
.
-.IP \(bu
+.IP \[bu]
Do I need to keep typing the indentation in a series of
.B IP
calls?
@@ -4390,7 +4390,7 @@ calls?
.IP
Not if you don't want to change it.
.
-Review subsection \(lqHorizontal and vertical spacing\(rq above.
+Review subsection \[lq]Horizontal and vertical spacing\[rq] above.
.
.
.IP
@@ -4401,15 +4401,15 @@ Cb Cb
LfCR LfCR.
Instead of.\|.\|. .\|.\|.should be considered.
_
-\&.IP \(rs(bu 4n .IP \(rs(bu 4n
+\&.IP \[rs][bu] 4n .IP \[rs][bu] 4n
\fIparagraph \fIparagraph
-\&.IP \(rs(bu 4n .IP \(rs(bu
+\&.IP \[rs][bu] 4n .IP \[rs][bu]
\fIanother-paragraph \fIanother-paragraph
_
.TE
.
.
-.IP \(bu
+.IP \[bu]
Why doesn't the package provide a string to insert an ellipsis?
.
.
@@ -4497,18 +4497,18 @@ Dots and space are universally supported.
.
.br
.ne 4v
-.IP \(bu
+.IP \[bu]
When and how should I use quotation marks?
.
.
.IP
-As noted above in subsection \(lqFont style macros\(rq,
+As noted above in subsection \[lq]Font style macros\[rq],
apply quotation marks to
-\(lqbrief specimens of literal text,
+\[lq]brief specimens of literal text,
such as article titles,
inline examples,
mentions of individual characters or short strings,
-and (sub)section headings in man pages\(rq.
+and (sub)section headings in man pages\[rq].
.
Multi-word literals,
such as Unix commands with arguments,
@@ -4531,14 +4531,14 @@ Heirloom Doctools
and
.I mandoc
support all of the special characters
-.BR \[rs](oq ,
-.BR \[rs](cq ,
-.BR \[rs](lq ,
-.BR \[rs](rq ,
-.BR \[rs](aq ,
+.BR \[rs][oq] ,
+.BR \[rs][cq] ,
+.BR \[rs][lq] ,
+.BR \[rs][rq] ,
+.BR \[rs][aq] ,
and
-.B \[rs](dq
-described in subsection \(lqPortability\(rq above.
+.B \[rs][dq]
+described in subsection \[lq]Portability\[rq] above.
.
Solaris\~10,
DWB,
@@ -4550,9 +4550,9 @@ do not.
.IP
Historically,
man pages used
-.B \(ga
+.B \[ga]
and
-.B \(aq
+.B \[aq]
exclusively for directional single quotation marks.
.
However,
@@ -4563,9 +4563,9 @@ have chosen to override the meanings of these characters
in man pages,
remapping them to their Unicode Basic Latin code points.
.
Unfortunately,
-.B \(ga
+.B \[ga]
and
-.B \(aq
+.B \[aq]
are the
.I only
reliable means of obtaining directional single quotation marks in AT&T
@@ -4591,8 +4591,8 @@ call as follows.
.RS
.EX
\&.ie \[rs]n(.g \[rs]{\[rs]
-\&. ds oq \[rs](oq\[rs]"
-\&. ds cq \[rs](cq\[rs]"
+\&. ds oq \[rs][oq]\[rs]"
+\&. ds cq \[rs][cq]\[rs]"
\&.\[rs]}
\&.el \[rs]{\[rs]
\&. ds oq \[ga]\[rs]"
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
