Also set the braces in `-I{}` in bold, not roman, since they are
literal.
The `lq` and `rq` strings are widely portable.
groff_man_style(7):
Strings
\*(lq
\*(rq interpolate special character escape sequences for left and
right double‐quotation marks, \(lq and \(rq, respectively.
...
A contemporary man page needs none of the above. \*S is
superfluous; type size changes are invisible on terminals, and
macros that change it restore its original value afterward. Better
alternatives exist for the rest; simply use the \[rg], \[lq],
\[rq], and \[tm] special character escape sequences directly.
Unless you are aiming for a pathological level of portability——
perhaps composing a man page for consumption on simulators of 1980s
Unix systems (or Solaris 10 troff, though even it supports
“\(rg”)——avoid using the above strings.
...
Notes
Some tips on composing and troubleshooting your man pages follow.
...
• When and how should I use quotation marks?
As noted above in subsection “Font style macros”, apply quotation
marks to “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”. Multi‐
word literals, such as Unix commands with arguments, when set
inline (as opposed to displayed between EX and EE), should be
quoted to ensure that the boundaries of the literal are clear
even when the material is stripped of font styling by, for
example, copy‐and‐paste operations. groff, Heirloom Doctools
troff, neatroff, and mandoc support all of the special characters
\[oq], \[cq], \[lq], \[rq], \[aq], and \[dq] described in
subsection “Portability” above. DWB, Plan 9, and Solaris 10
troffs do not. Interpolating the strings \*(lq and \*(rq
portably yields directional double quotation marks, if available,
in all these formatters (though neatroff does not supply a man
macro package), but they cannot reliably be used in macro
arguments.
---
xargs/xargs.1 | 26 +++++++++++++++++---------
1 file changed, 17 insertions(+), 9 deletions(-)
diff --git a/xargs/xargs.1 b/xargs/xargs.1
index 916fe9c3..3b7f5f86 100644
--- a/xargs/xargs.1
+++ b/xargs/xargs.1
@@ -154,8 +154,10 @@ .SH OPTIONS
Implies
.B \-x
and
-.B \-L
-1.
+\*(lq\c
+.B "\-L 1\c"
+\*(rq.
+.
.TP
.BR \-i "[\fIreplace-str\fR], " "\-\-replace" [\fI=replace-str\fR]
This option is a synonym for
@@ -166,7 +168,9 @@ .SH OPTIONS
If the
.I replace-str
argument is missing, the effect is the same as
-.BR \-I {}.
+\*(lq\c
+.B \-I{}\c
+\*(rq.
The
.B \-i
option is deprecated; use
@@ -334,15 +338,19 @@ .SH OPTIONS
.B "\-\-"
Delimit the option list.
Later arguments, if any, are treated as operands even if they begin with
-.IR \- .
+\*(lq\-\*(rq.
For example,
-.B xargs \-\- \-\-help
+\*(lq\c
+.B "xargs \-\- \-\-help\c"
+\*(rq
runs the command
.I \-\-help
(found in
.IR PATH )
instead of printing the usage text, and
-.B xargs \-\- \-\-mycommand
+\*(lq\c
+.B "xargs \-\- \-\-mycommand\c"
+\*(rq
runs the command
.I \-\-mycommand
instead of rejecting this as unrecognized option.
@@ -378,8 +386,7 @@ .SH OPTIONS
The exception to this rule is that the special
.I max-args
value
-.I 1
-('\fB\-n\fP\fI1\fP')
+\*(lq\fB\-n\fP\fI1\fP\*(rq)
is ignored after the
.B \-\-replace
option and its aliases
@@ -511,7 +518,8 @@ .SH "HISTORY"
program was invented by Herb Gellis at Bell Labs.
See the Texinfo manual for
.IR findutils ,
-.IR "Finding Files" ,
+chapter
+\*(lqFinding Files\*(rq,
for more information.
.
.SH "BUGS"
--
2.30.2
signature.asc
Description: PGP signature
