diff options
author | G. Branden Robinson <g.branden.robinson@gmail.com> | 2020-09-03 23:49:58 +1000 |
---|---|---|
committer | G. Branden Robinson <g.branden.robinson@gmail.com> | 2020-09-06 04:50:39 +1000 |
commit | 533fa381ba78f2da8fd1411d0b682e94a43b91b0 (patch) | |
tree | 12a9d04a86278f44720d161c6f9495ae69f70163 /contrib/gperl | |
parent | 4e101bce45f0d7f07856aad8fd62616743738297 (diff) | |
download | groff-git-533fa381ba78f2da8fd1411d0b682e94a43b91b0.tar.gz |
man pages: Fix clarity and style issues.
* man/groff.7.man (Escape Sequences/Escape short reference) <\k>: Fix
garbage characters left over from earlier edit.
* src/roff/troff/troff.1.man (Options) <-c>: Note that -c also disables
SGR escape output to terminal devices.
* src/roff/troff/troff.1.man (Options) <-C>: Note that -C implies -c.
* src/roff/troff/troff.1.man (Options) <-r>: Say "roff" instead of
"troff" when we mean the general language.
* src/preproc/tbl/tbl.1.man (Description/Global options) <nokeep>:
(Description/Table format specification) <n, N>:
Prefix "tbl" with "@g@" when GNU tbl is meant.
* src/preproc/tbl/tbl.1.man (Description/Table format specification)
<n, N>: Prefix "eqn" with "@g@" when GNU eqn is meant.
* src/preproc/tbl/tbl.1.man (Description/Column specifiers) <d, D>:
Write literal circumflex as "\[ha]", not "^".
* src/preproc/tbl/tbl.1.man (Description/Column specifiers) <m, M>:
Recast description to say what it does first, instead of meandering
around to it four senetences later. Reduce status of "GNU tbl
extension" to parenthetical, in parallel with other usage in the page.
* contrib/chem/chem.1.man:
* contrib/gperl/gperl.1.man:
* src/devices/grodvi/grodvi.1.man:
* src/preproc/tbl/tbl.1.man:
* src/roff/groff/groff.1.man:
Write literal apostrophe as "\[aq]", not "'".
* src/roff/troff/troff.1.man:
src/preproc/tbl/tbl.1.man:
Quote word-like literals that begin with an alphanumeric character (as
opposed to those prefixed with a punctuation sigil like escapes and
requests) so that they are easier to distinguish in contexts even when
font changes are unavailable; consider, e.g., screen readers.
* src/preproc/tbl/tbl.1.man:
Conversely, unquote word-like literals that begin with a
non-alphanumeric character, such as \$1, if they qualify for setting
in bold.
* src/preproc/tbl/tbl.1.man:
Say "terminal" instead of "TTY".
* src/roff/troff/troff.1.man:
Disfavor sesquipedialian constructions such as "This so-and-so will
frobnicate the following glorms: A, B, and C." in favor of the more
economical "So-and-so frobnicates glorms A, B, and C." Further, the
"so-and-so" is often omitted from the former; bad technical writers
tend to place immense faith in the reader's ability to disambiguate
vague pronouns. As Kerrisk recently noted on the linux-man mailing
list:
'In the preceding sentence, "it" is used three times, with two
*different* referents. That's quite hard on the reader.'
I don't recall anything that bad in the groff man page corpus, but we
certainly have our howlers.
* src/roff/troff/troff.1.man:
Prefix roff request names with a period.
* contrib/pdfmark/pdfroff.1.man (Synopsis):
* man/groff.7.man (Escape Sequences/Special characters):
* src/roff/troff/troff.1.man (Options):
Escape hyphens used as command-line dashes and in glyph names.
* src/preproc/tbl/tbl.1.man:
Add comma after "e.g".
The Latin abbreviations "e.g.", "etc.", and "i.e." ALWAYS take commas
afterwards. ...unless you're on the "mention" side of the use/mention
dichotomy as I just was. :) If it seems grammatical to omit the
comma, for instance at the end of a sentence, you're using the
abbreviation wrongly. One should never end an independent clause; it
is nauseous to begin such a clause with one, as well. As a check,
replace each abbreviation with "for example", "and so on", and "that
is", respectively; if you'd need a comma in English, you need it when
popping Latin off the stack, too. Some style authorities advocate
these very replacements in formal writing; I am not quite as
passionate. I think we can retain Latin abbreviations if we use them
properly and not to excess.
* src/preproc/tbl/tbl.1.man:
When independent clauses are separated by a colon, uncapitalize the
second. Only sentences receive first-letter capitalization.
* src/preproc/tbl/tbl.1.man:
Use em-dash correctly. An en-dash is not a substitute for an em-dash,
and takes NO spaces around itself.
* src/preproc/tbl/tbl.1.man:
Hyphenate attributive phrases like "largest-width".
* contrib/chem/chem.1.man:
* src/preproc/tbl/tbl.1.man:
* src/roff/troff/troff.1.man:
Set program names and man page titles in italics.
* src/preproc/tbl/tbl.1.man:
Set tbl keywords in bold, as "major topics of the subject under
discussion".
* src/devices/grodvi/grodvi.1.man:
Replace \space escapes in macro arguments with quoted arguments or the
\~ escape.
* src/devices/grodvi/grodvi.1.man:
Protect TeX language/macro keywords from hyphenation.
* contrib/chem/chem.1.man:
Add non-printing break points in URLs.
* src/preproc/tbl/tbl.1.man:
Break input lines after commas, colons, and semicolons.
* src/preproc/tbl/tbl.1.man:
Set multi-word parentheticals on their own input line(s).
* src/preproc/tbl/tbl.1.man:
Comment-annotate cases where a reference to a normally @g@-prefixed
command name shouldn't get the @g@. (This happens when speaking
generally [typically of *roffs], of AT&T tools, or "GNU" already
qualifies the context [often to note extensions].)
Diffstat (limited to 'contrib/gperl')
-rw-r--r-- | contrib/gperl/gperl.1.man | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/contrib/gperl/gperl.1.man b/contrib/gperl/gperl.1.man index 5ba7cb873..fa4c0e66e 100644 --- a/contrib/gperl/gperl.1.man +++ b/contrib/gperl/gperl.1.man @@ -401,7 +401,7 @@ could look like that: .EX before \&.Perl start -my $result = 'some data'; +my $result = \[aq]some data\[aq]; print $result; \&.Perl stop .ds string_var after |