diff options
author | G. Branden Robinson <g.branden.robinson@gmail.com> | 2020-01-16 18:29:31 +1100 |
---|---|---|
committer | G. Branden Robinson <g.branden.robinson@gmail.com> | 2020-01-16 18:39:12 +1100 |
commit | 4520668e9ec756ecd6486bc5ce937809e1b4f543 (patch) | |
tree | 7e3b86eb6c944b45407b88167b7ebf2cd7b5c565 /src | |
parent | 9fd6d7b45d9bb19c9bc3348cbe703c64a662b020 (diff) | |
download | groff-git-4520668e9ec756ecd6486bc5ce937809e1b4f543.tar.gz |
grotty(1): Improve content and style.
* Escape hyphen-minus literal.
* Use a stretchable non-breaking space in document identifier ISO 6429.
* Indicate that the supported color list comes from ISO 6429.
* Termine color list with an "and" preceding the final item; it's still
an English sentence.
* Explain why we mention col(1) at all (other implementations).
* Make more clear that -R is a less(1) option.
* Use upright apostrophes in examples of \D escape usage.
* Replace hand-computed page length in example with a trick I contrived
to end the page when we're "done".
* Add bibliographic entry for EMCA-48 (a.k.a. ISO 6429) to "See Also"
section. As Dave Kemper recently pointed out, we should really do
a better job of citing relevant external literature where it is freely
available online--times are better than they used to be.
Diffstat (limited to 'src')
-rw-r--r-- | src/devices/grotty/grotty.1.man | 46 |
1 files changed, 33 insertions, 13 deletions
diff --git a/src/devices/grotty/grotty.1.man b/src/devices/grotty/grotty.1.man index f0a43fe3f..9c878ca39 100644 --- a/src/devices/grotty/grotty.1.man +++ b/src/devices/grotty/grotty.1.man @@ -43,7 +43,7 @@ grotty \- groff driver for typewriter-like (terminal) devices .YS . . -.SY "grotty -c" +.SY "grotty \-c" .OP \-bBdfhouU .OP \-F dir .RI [ file @@ -109,7 +109,7 @@ Output is written to the standard output. By default, .I grotty emits SGR escape sequences -(from ISO 6429, +(from ISO\~6429, popularly called \[lq]ANSI escapes\[rq]) to change text attributes (bold, italic, underline, reverse-video, and colors). @@ -132,9 +132,10 @@ option below. . . .LP -The following colors are defined in +Following ISO\~6429, +the following colors are defined in .IR tty.tmac : -black, white, red, green, blue, yellow, magenta, cyan. +black, white, red, green, blue, yellow, magenta, and cyan. . Unrecognized colors are mapped to the default color, which is dependent on the settings of the terminal. @@ -148,8 +149,8 @@ When paging .IR grotty 's output with .IR less (1), -the program must be instructed to pass SGR sequences through to the -device; +the latter program must be instructed to pass SGR sequences through to +the device; its .B \-R option is one way to achieve this. @@ -227,12 +228,15 @@ option. .I less renders legacy bold and italics without requiring options. . -There is no need to filter the output through -.IR col (1) -since +In contrast to the teletype output drivers of some other +.I roff +implementations, .I grotty never outputs reverse line feeds. . +There is therefore no need to filter its output through +.IR col (1). +. . .\" ==================================================================== .SS "Device control commands" @@ -347,7 +351,7 @@ escapes By default, .I grotty renders -.BR \[rs]D'l \|.\|.\|.\& ' +.BR \[rs]D\[aq]l \|.\|.\|.\& \[aq] commands that have at least one zero argument (and so are either horizontal or vertical) using Unicode box drawing characters @@ -363,7 +367,7 @@ characters In a similar way, .I grotty handles -.BR \[rs]D'p \|.\|.\|.\& ' +.BR \[rs]D\[aq]p \|.\|.\|.\& \[aq] commands which consist entirely of horizontal and vertical lines. . . @@ -622,13 +626,14 @@ not all of which may be supported by a given output device: .LP .RS .EX -\&.pl 15v You might see \ef[B]bold\ef[] and \ef[I]italic\ef[]. Some people see \ef[BI]both\ef[]. If the output device does (not) co\ez\e[ad]operate, you might see \em[red]red\em[]. Black on cyan can have a \eM[cyan]\em[black]prominent\em[]\eM[] -\eD'l 1i 0'\eD'l 0 2i'\eD'l 1i 0' look. +\eD\[aq]l 1i 0\[aq]\eD\[aq]l 0 2i\[aq]\eD\[aq]l 1i 0\[aq] look. +\&.\e" If in nroff mode, end page now. +\&.if n .pl \en[nl]u .EE .RE . @@ -683,6 +688,21 @@ as possible. .SH "See Also" .\" ==================================================================== . +.TP +ECMA-48, \c +\[lq]Control Functions for Coded Character Sets\[rq], \c +5th\~edition, \c +June\~1991, \c +Ecma International. +A gratis version of ISO\~6429, +this document includes a normative description of SGR escape sequences. +Available at +.UR http://\:www.ecma\-international.org/\:publications/\:files/\:\ +ECMA\-ST/\:Ecma\-048.pdf +.UE . +. +. +.LP .IR groff (@MAN1EXT@), .IR @g@troff (@MAN1EXT@), .IR groff_out (@MAN5EXT@), |