grotty.man revision 104868
179550Sru.ig 269631Sru$FreeBSD: head/contrib/groff/src/devices/grotty/grotty.man 104868 2002-10-11 08:54:44Z ru $ 3104868SruCopyright (C) 1989-2000, 2001, 2002 Free Software Foundation, Inc. 418099Spst 518099SpstPermission is granted to make and distribute verbatim copies of 618099Spstthis manual provided the copyright notice and this permission notice 718099Spstare preserved on all copies. 818099Spst 918099SpstPermission is granted to copy and distribute modified versions of this 1018099Spstmanual under the conditions for verbatim copying, provided that the 1118099Spstentire resulting derived work is distributed under the terms of a 1218099Spstpermission notice identical to this one. 1318099Spst 1418099SpstPermission is granted to copy and distribute translations of this 1518099Spstmanual into another language, under the above conditions for modified 1618099Spstversions, except that this permission notice may be included in 1718099Spsttranslations approved by the Free Software Foundation instead of in 1818099Spstthe original English. 1918099Spst.. 20104868Sru. 21104868Sru. 2218099Spst.TH GROTTY @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@" 2318099Spst.SH NAME 2418099Spstgrotty \- groff driver for typewriter-like devices 25104868Sru. 26104868Sru. 2718099Spst.SH SYNOPSIS 2818099Spst.B grotty 2918099Spst[ 30104868Sru.B \-bBcdfhiouUv 3118099Spst] [ 3218099Spst.BI \-F dir 3318099Spst] [ 34104868Sru.IR files \|.\|.\|.\& 3518099Spst] 3669631Sru.PP 3769631SruIt is possible to have whitespace between the 3869631Sru.B \-F 3969631Sruoption and its parameter. 40104868Sru. 41104868Sru. 4218099Spst.SH DESCRIPTION 4318099Spst.B grotty 4418099Spsttranslates the output of GNU 4518099Spst.B troff 4618099Spstinto a form suitable for typewriter-like devices. 4718099SpstNormally 4818099Spst.B grotty 4975590Srushould be invoked by using the 5018099Spst.B groff 5118099Spstcommand 5218099Spstwith a 5318128Spst.BR \-Tascii , 5469631Sru.BR \-Tkoi8-r , 5569631Sru.B \-Tlatin1 5618099Spstor 5769631Sru.B \-Tutf8 5869631Sruoption on ASCII based systems, and with 5969631Sru.B \-Tcp1047 60104868Sruand 61104868Sru.B \-Tutf8 6269631Sruon EBCDIC based hosts. 6318099SpstIf no files are given, 6418099Spst.B grotty 6518099Spstwill read the standard input. 6618099SpstA filename of 6718099Spst.B \- 6818099Spstwill also cause 6918099Spst.B grotty 7018099Spstto read the standard input. 7118099SpstOutput is written to the standard output. 7218099Spst.LP 73104868SruBy default, 7418099Spst.B grotty 75104868Sruemits SGR escape sequences (from ISO 6429, also called ANSI color escapes) 76104868Sruto change text attributes (bold, italic, colors). 77104868SruThis makes it possible to have eight different \M[green]background\M[] 78104868Sruand \m[red]foreground\m[] colors; additionally, bold and italic 79104868Sruattributes can be used \f[BI]at the same time\f[] (by using the BI font). 80104868Sru.LP 81104868SruThe following colors are defined in 82104868Sru.BR tty.tmac : 83104868Srublack, white, red, green, blue, yellow, magenta, cyan. 84104868SruUnknown colors are mapped to the default color (which is dependent on the 85104868Srusettings of the terminal; in most cases, this is black for the foreground 86104868Sruand white for the background). 87104868Sru.LP 88104868SruUse the 89104868Sru.B \-c 90104868Sruswitch to revert to the old behaviour, printing a bold character 9118099Spst.I c 92104868Sruwith the sequence 9318099Spst.RI ` c 9418099Spst.SM BACKSPACE 9518099Spst.IR c ' 96104868Sruand an italic character 9718099Spst.I c 9818099Spstby the sequence 9918099Spst.RB ` _ 10018099Spst.SM BACKSPACE 10118099Spst.IR c '. 102104868SruAt the same time, color output is disabled. 103104868SruThe same effect can be achieved by setting either the 104104868Sru.B GROFF_NO_SGR 105104868Sruenvironment variable or using the `sgr' X command (see below). 106104868Sru.LP 107104868SruFor SGR support, it is necessary to use the 108104868Sru.B \-R 109104868Sruoption of 110104868Sru.BR less (1) 111104868Sruto disable the interpretation of 112104868Sru.BR grotty 's 113104868Sruold output format. 114104868SruConsequently, all programs which use 115104868Sru.B less 116104868Sruas the pager program have to pass this option to it. 117104868SruFor 118104868Sru.BR man (1) 119104868Sruin particular, either add 120104868Sru.B \-R 121104868Sruto the 122104868Sru.B $PAGER 123104868Sruenvironment variable, e.g.\& 124104868Sru.RS 125104868Sru.LP 126104868Sru.B PAGER="/usr/bin/less -R" 127104868Sru.br 128104868Sru.B export PAGER 129104868Sru.RE 130104868Sru.LP 131104868Sruor use the 132104868Sru.B \-P 133104868Sruoption of 134104868Sru.B man 135104868Sruto set the pager executable and its options, or modify the configuration 136104868Srufile of 137104868Sru.B man 138104868Sruin a similar fashion. 139104868Sru.LP 140104868Sru.BR grotty 's 141104868Sruold output format can be displayed on a terminal 14218099Spstby piping through 14318099Spst.BR ul (1). 14418099SpstPagers such as 14518099Spst.BR more (1) 14618099Spstor 14718099Spst.BR less (1) 14818099Spstare also able to display these sequences. 14918099SpstUse either 15018099Spst.B \-B 15118099Spstor 15218099Spst.B \-U 15318099Spstwhen piping into 15418099Spst.BR less (1); 15518099Spstuse 15618099Spst.B \-b 15718099Spstwhen piping into 15818099Spst.BR more (1). 15918099SpstThere is no need to filter the output through 16018099Spst.BR col (1) 16118099Spstsince 16218099Spst.B grotty 16318099Spstnever outputs reverse line feeds. 16418099Spst.LP 16518099SpstThe font description file may contain a command 16618099Spst.IP 16718099Spst.BI internalname\ n 16818099Spst.LP 16918099Spstwhere 17018099Spst.I n 17118099Spstis a decimal integer. 17218099SpstIf the 01 bit in 17318099Spst.I n 17418099Spstis set, 17518099Spstthen the font will be treated as an italic font; 17618099Spstif the 02 bit is set, 17718099Spstthen it will be treated as a bold font. 17818099SpstThe code field in the font description field gives the 17918099Spstcode which will be used to output the character. 18018099SpstThis code can also be used in the 181104868Sru.B \[rs]N 18218099Spstescape sequence in 18318099Spst.BR troff . 184104868Sru. 185104868Sru. 18618099Spst.SH OPTIONS 18718099Spst.TP 188104868Sru.B \-b 189104868SruSuppress the use of overstriking for bold characters. 190104868SruIgnored if 191104868Sru.B \-c 192104868Sruisn't used. 193104868Sru. 194104868Sru.TP 195104868Sru.B \-B 196104868SruUse only overstriking for bold-italic characters. 197104868SruIgnored if 198104868Sru.B \-c 199104868Sruisn't used. 200104868Sru. 201104868Sru.TP 202104868Sru.B \-c 203104868SruUse 204104868Sru.BR grotty 's 205104868Sruold output format (see above). 206104868SruThis also disables color output. 207104868Sru. 208104868Sru.TP 209104868Sru.B \-d 210104868SruIgnore all 211104868Sru.B \[rs]D 212104868Srucommands. 213104868SruWithout this 214104868Sru.B grotty 215104868Sruwill render 216104868Sru.B \[rs]D'l\|.\|.\|.\&' 217104868Srucommands that have at least one zero argument 218104868Sru(and so are either horizontal or vertical) 219104868Sruusing 220104868Sru.BR \- , 221104868Sru.BR | , 222104868Sruand 223104868Sru.B + 224104868Srucharacters. 225104868Sru. 226104868Sru.TP 227104868Sru.B \-f 228104868SruUse form feeds in the output. 229104868SruA form feed will be output at the end of each page that has no output 230104868Sruon its last line. 231104868Sru. 232104868Sru.TP 23318099Spst.BI \-F dir 23475590SruPrepend directory 23518099Spst.IB dir /dev name 23675590Sruto the search path for font and device description files; 23718099Spst.I name 23818099Spstis the name of the device, usually 23918128Spst.BR ascii , 24069631Sru.BR koi8-r , 24169631Sru.BR latin1 , 24269631Sru.BR utf8 , 24318099Spstor 24469631Sru.BR cp1047 . 24518099Spst.TP 24618099Spst.B \-h 24718099SpstUse horizontal tabs in the output. 24818099SpstTabs are assumed to be set every 8 columns. 249104868Sru. 25018099Spst.TP 251104868Sru.B \-i 252104868SruUse escape sequences to set the italic text attribute instead of the 253104868Sruunderline attribute for italic fonts (`I' and `BI'). 254104868SruNote that most terminals (including xterm) don't support this. 255104868SruIgnored if 256104868Sru.B \-c 257104868Sruis active. 258104868Sru. 25918099Spst.TP 260104868Sru.B \-o 261104868SruSuppress overstriking (other than for bold or underlined characters in 262104868Srucase the old output format has been activated with 263104868Sru.BR \-c ). 264104868Sru. 26518099Spst.TP 26618099Spst.B \-u 26718099SpstSuppress the use of underlining for italic characters. 268104868SruIgnored if 269104868Sru.B \-c 270104868Sruisn't used. 271104868Sru. 27218099Spst.TP 27318099Spst.B \-U 27418099SpstUse only underlining for bold-italic characters. 275104868SruIgnored if 276104868Sru.B \-c 277104868Sruisn't used. 278104868Sru. 27918099Spst.TP 280104868Sru.B \-v 281104868SruPrint the version number. 282104868Sru. 283104868Sru. 284104868Sru.SH USAGE 28518099Spst.B grotty 286104868Sruunderstands a single X command produced using the 287104868Sru.B \[rs]X 288104868Sruescape sequence. 28918099Spst.TP 290104868Sru.BI \[rs]X'tty:\ sgr\ n ' 291104868SruIf 292104868Sru.I n 293104868Sruis non-zero or missing, enable SGR output (this is the default), otherwise 294104868Sruuse the old drawing scheme for bold and underline. 295104868Sru. 296104868Sru. 297104868Sru.SH ENVIRONMENT 298104868Sru.TP 299104868Sru.B GROFF_NO_SGR 300104868SruIf set, the old drawing scheme for bold and underline (using the 301104868Srubackspace character) is active. 302104868SruColors are disabled. 303104868Sru. 304104868Sru. 30518099Spst.SH FILES 30618099Spst.TP 30769631Sru.B @FONTDIR@/devascii/DESC 30818099SpstDevice description file for 30969631Sru.B ascii 31018099Spstdevice. 311104868Sru. 31218099Spst.TP 31369631Sru.BI @FONTDIR@/devascii/ F 31418099SpstFont description file for font 31518099Spst.I F 31618099Spstof 31769631Sru.B ascii 31818099Spstdevice. 31918099Spst.TP 32069631Sru.B @FONTDIR@/devkoi8-r/DESC 32169631SruDevice description file for 32269631Sru.B koi8-r 32369631Srudevice. 32469631Sru.TP 32569631Sru.BI @FONTDIR@/devkoi8-r/ F 32669631SruFont description file for font 32769631Sru.I F 32869631Sruof 32969631Sru.B koi8-r 33069631Srudevice. 331104868Sru. 33269631Sru.TP 33369631Sru.B @FONTDIR@/devlatin1/DESC 33469631SruDevice description file for 33569631Sru.B latin1 33669631Srudevice. 337104868Sru. 33869631Sru.TP 33969631Sru.BI @FONTDIR@/devlatin1/ F 34069631SruFont description file for font 34169631Sru.I F 34269631Sruof 34369631Sru.B latin1 34469631Srudevice. 345104868Sru. 34669631Sru.TP 34769631Sru.B @FONTDIR@/devutf8/DESC 34869631SruDevice description file for 34969631Sru.B utf8 35069631Srudevice. 351104868Sru. 35269631Sru.TP 35369631Sru.BI @FONTDIR@/devutf8/ F 35469631SruFont description file for font 35569631Sru.I F 35669631Sruof 35769631Sru.B utf8 35869631Srudevice. 359104868Sru. 36069631Sru.TP 36169631Sru.B @FONTDIR@/devcp1047/DESC 36269631SruDevice description file for 36369631Sru.B cp1047 36469631Srudevice. 365104868Sru. 36669631Sru.TP 36769631Sru.BI @FONTDIR@/devcp1047/ F 36869631SruFont description file for font 36969631Sru.I F 37069631Sruof 37169631Sru.B cp1047 37269631Srudevice. 373104868Sru. 37469631Sru.TP 37575590Sru.B @MACRODIR@/tty.tmac 37618099SpstMacros for use with 37718099Spst.BR grotty . 378104868Sru. 37918099Spst.TP 38075590Sru.B @MACRODIR@/tty-char.tmac 38175590SruAdditional klugdey character definitions for use with 38218099Spst.BR grotty . 38369631Sru.LP 38469631SruNote that on EBCDIC hosts, only files for the 38569631Sru.B cp1047 38669631Srudevice will be installed. 387104868Sru. 388104868Sru. 38918099Spst.SH BUGS 39018099Spst.LP 39118099Spst.B grotty 39218099Spstis intended only for simple documents. 39318099Spst.LP 39418099SpstThere is no support for fractional horizontal or vertical motions. 39518099Spst.LP 39618099SpstThere is no support for 397104868Sru.B \[rs]D 39818099Spstcommands 39918099Spstother than horizontal and vertical lines. 40018099Spst.LP 401104868SruCharacters above the first line (ie with a vertical position of\~0) 40218099Spstcannot be printed. 403104868Sru.LP 404104868SruColor handling is different compared to 405104868Sru.BR grops (@MAN1EXT@). 406104868Sru.B \[rs]M 407104868Srudoesn't set the fill color for closed graphic objects (which 408104868Sru.B grotty 409104868Srudoesn't support anyway) but changes the background color of the character 410104868Srucell, affecting all subsequent operations. 411104868Sru. 412104868Sru. 41318099Spst.SH "SEE ALSO" 41418099Spst.BR groff (@MAN1EXT@), 41518099Spst.BR @g@troff (@MAN1EXT@), 41618099Spst.BR groff_out (@MAN5EXT@), 41718099Spst.BR groff_font (@MAN5EXT@), 41818099Spst.BR groff_char (@MAN7EXT@), 41918099Spst.BR ul (1), 42069631Sru.BR more (1), 421104868Sru.BR man (1), 42269631Sru.BR less (1) 42379550Sru. 42479550Sru.\" Local Variables: 42579550Sru.\" mode: nroff 42679550Sru.\" End: 427