grotty.man revision 151503
179550Sru.ig 269631Sru$FreeBSD: head/contrib/groff/src/devices/grotty/grotty.man 151503 2005-10-20 10:53:15Z ru $ 3151503SruCopyright (C) 1989-2000, 2001, 2002, 2003 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. 21151503Sru.do nr grotty_C \n[.C] 22151503Sru.cp 0 23104868Sru. 2418099Spst.TH GROTTY @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@" 2518099Spst.SH NAME 2618099Spstgrotty \- groff driver for typewriter-like devices 27104868Sru. 28104868Sru. 2918099Spst.SH SYNOPSIS 3018099Spst.B grotty 3118099Spst[ 32105083Sru.B \-bBcdfhioruUv 3318099Spst] [ 3418099Spst.BI \-F dir 3518099Spst] [ 36104868Sru.IR files \|.\|.\|.\& 3718099Spst] 3869631Sru.PP 3969631SruIt is possible to have whitespace between the 4069631Sru.B \-F 4169631Sruoption and its parameter. 42104868Sru. 43104868Sru. 4418099Spst.SH DESCRIPTION 4518099Spst.B grotty 4618099Spsttranslates the output of GNU 4718099Spst.B troff 4818099Spstinto a form suitable for typewriter-like devices. 4918099SpstNormally 5018099Spst.B grotty 5175590Srushould be invoked by using the 5218099Spst.B groff 5318099Spstcommand 5418099Spstwith a 5518128Spst.BR \-Tascii , 56119887Sru.BR \-Tlatin1 , 57119887Sru.B \-Tkoi8-r 5818099Spstor 5969631Sru.B \-Tutf8 6069631Sruoption on ASCII based systems, and with 6169631Sru.B \-Tcp1047 62104868Sruand 63104868Sru.B \-Tutf8 6469631Sruon EBCDIC based hosts. 6518099SpstIf no files are given, 6618099Spst.B grotty 6718099Spstwill read the standard input. 6818099SpstA filename of 6918099Spst.B \- 7018099Spstwill also cause 7118099Spst.B grotty 7218099Spstto read the standard input. 7318099SpstOutput is written to the standard output. 7418099Spst.LP 75104868SruBy default, 7618099Spst.B grotty 77104868Sruemits SGR escape sequences (from ISO 6429, also called ANSI color escapes) 78104868Sruto change text attributes (bold, italic, colors). 79104868SruThis makes it possible to have eight different \M[green]background\M[] 80104868Sruand \m[red]foreground\m[] colors; additionally, bold and italic 81104868Sruattributes can be used \f[BI]at the same time\f[] (by using the BI font). 82104868Sru.LP 83104868SruThe following colors are defined in 84104868Sru.BR tty.tmac : 85104868Srublack, white, red, green, blue, yellow, magenta, cyan. 86104868SruUnknown colors are mapped to the default color (which is dependent on the 87104868Srusettings of the terminal; in most cases, this is black for the foreground 88104868Sruand white for the background). 89104868Sru.LP 90104868SruUse the 91104868Sru.B \-c 92104868Sruswitch to revert to the old behaviour, printing a bold character 9318099Spst.I c 94104868Sruwith the sequence 9518099Spst.RI ` c 9618099Spst.SM BACKSPACE 9718099Spst.IR c ' 98104868Sruand an italic character 9918099Spst.I c 10018099Spstby the sequence 10118099Spst.RB ` _ 10218099Spst.SM BACKSPACE 10318099Spst.IR c '. 104104868SruAt the same time, color output is disabled. 105104868SruThe same effect can be achieved by setting either the 106104868Sru.B GROFF_NO_SGR 107104868Sruenvironment variable or using the `sgr' X command (see below). 108104868Sru.LP 109104868SruFor SGR support, it is necessary to use the 110104868Sru.B \-R 111104868Sruoption of 112104868Sru.BR less (1) 113104868Sruto disable the interpretation of 114104868Sru.BR grotty 's 115104868Sruold output format. 116104868SruConsequently, all programs which use 117104868Sru.B less 118104868Sruas the pager program have to pass this option to it. 119104868SruFor 120104868Sru.BR man (1) 121104868Sruin particular, either add 122104868Sru.B \-R 123104868Sruto the 124104868Sru.B $PAGER 125104868Sruenvironment variable, e.g.\& 126104868Sru.RS 127104868Sru.LP 128104868Sru.B PAGER="/usr/bin/less -R" 129104868Sru.br 130104868Sru.B export PAGER 131104868Sru.RE 132104868Sru.LP 133104868Sruor use the 134104868Sru.B \-P 135104868Sruoption of 136104868Sru.B man 137104868Sruto set the pager executable and its options, or modify the configuration 138104868Srufile of 139104868Sru.B man 140104868Sruin a similar fashion. 141104868Sru.LP 142104868Sru.BR grotty 's 143104868Sruold output format can be displayed on a terminal 14418099Spstby piping through 14518099Spst.BR ul (1). 14618099SpstPagers such as 14718099Spst.BR more (1) 14818099Spstor 14918099Spst.BR less (1) 15018099Spstare also able to display these sequences. 15118099SpstUse either 15218099Spst.B \-B 15318099Spstor 15418099Spst.B \-U 15518099Spstwhen piping into 15618099Spst.BR less (1); 15718099Spstuse 15818099Spst.B \-b 15918099Spstwhen piping into 16018099Spst.BR more (1). 16118099SpstThere is no need to filter the output through 16218099Spst.BR col (1) 16318099Spstsince 16418099Spst.B grotty 16518099Spstnever outputs reverse line feeds. 16618099Spst.LP 16718099SpstThe font description file may contain a command 16818099Spst.IP 16918099Spst.BI internalname\ n 17018099Spst.LP 17118099Spstwhere 17218099Spst.I n 17318099Spstis a decimal integer. 17418099SpstIf the 01 bit in 17518099Spst.I n 17618099Spstis set, 17718099Spstthen the font will be treated as an italic font; 17818099Spstif the 02 bit is set, 17918099Spstthen it will be treated as a bold font. 18018099SpstThe code field in the font description field gives the 18118099Spstcode which will be used to output the character. 18218099SpstThis code can also be used in the 183104868Sru.B \[rs]N 18418099Spstescape sequence in 18518099Spst.BR troff . 186104868Sru. 187104868Sru. 18818099Spst.SH OPTIONS 18918099Spst.TP 190104868Sru.B \-b 191104868SruSuppress the use of overstriking for bold characters. 192104868SruIgnored if 193104868Sru.B \-c 194104868Sruisn't used. 195104868Sru. 196104868Sru.TP 197104868Sru.B \-B 198104868SruUse only overstriking for bold-italic characters. 199104868SruIgnored if 200104868Sru.B \-c 201104868Sruisn't used. 202104868Sru. 203104868Sru.TP 204104868Sru.B \-c 205104868SruUse 206104868Sru.BR grotty 's 207104868Sruold output format (see above). 208104868SruThis also disables color output. 209104868Sru. 210104868Sru.TP 211104868Sru.B \-d 212104868SruIgnore all 213104868Sru.B \[rs]D 214104868Srucommands. 215104868SruWithout this 216104868Sru.B grotty 217104868Sruwill render 218104868Sru.B \[rs]D'l\|.\|.\|.\&' 219104868Srucommands that have at least one zero argument 220104868Sru(and so are either horizontal or vertical) 221104868Sruusing 222104868Sru.BR \- , 223104868Sru.BR | , 224104868Sruand 225104868Sru.B + 226104868Srucharacters. 227104868Sru. 228104868Sru.TP 229104868Sru.B \-f 230104868SruUse form feeds in the output. 231104868SruA form feed will be output at the end of each page that has no output 232104868Sruon its last line. 233104868Sru. 234104868Sru.TP 23518099Spst.BI \-F dir 23675590SruPrepend directory 23718099Spst.IB dir /dev name 23875590Sruto the search path for font and device description files; 23918099Spst.I name 24018099Spstis the name of the device, usually 24118128Spst.BR ascii , 242119887Sru.BR latin1 , 24369631Sru.BR koi8-r , 24469631Sru.BR utf8 , 24518099Spstor 24669631Sru.BR cp1047 . 24718099Spst.TP 24818099Spst.B \-h 24918099SpstUse horizontal tabs in the output. 25018099SpstTabs are assumed to be set every 8 columns. 251104868Sru. 25218099Spst.TP 253104868Sru.B \-i 254104868SruUse escape sequences to set the italic text attribute instead of the 255104868Sruunderline attribute for italic fonts (`I' and `BI'). 256104868SruNote that most terminals (including xterm) don't support this. 257104868SruIgnored if 258104868Sru.B \-c 259104868Sruis active. 260104868Sru. 26118099Spst.TP 262104868Sru.B \-o 263104868SruSuppress overstriking (other than for bold or underlined characters in 264104868Srucase the old output format has been activated with 265104868Sru.BR \-c ). 266104868Sru. 26718099Spst.TP 268105083Sru.B \-r 269105083SruUse escape sequences to set the reverse text attribute instead of the 270105083Sruunderline attribute for italic fonts (`I' and `BI'). 271105083SruIgnored if 272105083Sru.B \-c 273105083Sruis active. 274105083Sru. 275105083Sru.TP 27618099Spst.B \-u 27718099SpstSuppress the use of underlining for italic characters. 278104868SruIgnored if 279104868Sru.B \-c 280104868Sruisn't used. 281104868Sru. 28218099Spst.TP 28318099Spst.B \-U 28418099SpstUse only underlining for bold-italic characters. 285104868SruIgnored if 286104868Sru.B \-c 287104868Sruisn't used. 288104868Sru. 28918099Spst.TP 290104868Sru.B \-v 291104868SruPrint the version number. 292104868Sru. 293104868Sru. 294104868Sru.SH USAGE 29518099Spst.B grotty 296104868Sruunderstands a single X command produced using the 297104868Sru.B \[rs]X 298104868Sruescape sequence. 29918099Spst.TP 300104868Sru.BI \[rs]X'tty:\ sgr\ n ' 301104868SruIf 302104868Sru.I n 303104868Sruis non-zero or missing, enable SGR output (this is the default), otherwise 304104868Sruuse the old drawing scheme for bold and underline. 305104868Sru. 306104868Sru. 307104868Sru.SH ENVIRONMENT 308104868Sru.TP 309104868Sru.B GROFF_NO_SGR 310104868SruIf set, the old drawing scheme for bold and underline (using the 311104868Srubackspace character) is active. 312104868SruColors are disabled. 313104868Sru. 314104868Sru. 31518099Spst.SH FILES 31618099Spst.TP 31769631Sru.B @FONTDIR@/devascii/DESC 31818099SpstDevice description file for 31969631Sru.B ascii 32018099Spstdevice. 321104868Sru. 32218099Spst.TP 32369631Sru.BI @FONTDIR@/devascii/ F 32418099SpstFont description file for font 32518099Spst.I F 32618099Spstof 32769631Sru.B ascii 32818099Spstdevice. 32918099Spst.TP 33069631Sru.B @FONTDIR@/devkoi8-r/DESC 33169631SruDevice description file for 33269631Sru.B koi8-r 33369631Srudevice. 33469631Sru.TP 33569631Sru.BI @FONTDIR@/devkoi8-r/ F 33669631SruFont description file for font 33769631Sru.I F 33869631Sruof 33969631Sru.B koi8-r 34069631Srudevice. 341104868Sru. 34269631Sru.TP 34369631Sru.B @FONTDIR@/devlatin1/DESC 34469631SruDevice description file for 34569631Sru.B latin1 34669631Srudevice. 347104868Sru. 34869631Sru.TP 34969631Sru.BI @FONTDIR@/devlatin1/ F 35069631SruFont description file for font 35169631Sru.I F 35269631Sruof 35369631Sru.B latin1 35469631Srudevice. 355104868Sru. 35669631Sru.TP 35769631Sru.B @FONTDIR@/devutf8/DESC 35869631SruDevice description file for 35969631Sru.B utf8 36069631Srudevice. 361104868Sru. 36269631Sru.TP 36369631Sru.BI @FONTDIR@/devutf8/ F 36469631SruFont description file for font 36569631Sru.I F 36669631Sruof 36769631Sru.B utf8 36869631Srudevice. 369104868Sru. 37069631Sru.TP 37169631Sru.B @FONTDIR@/devcp1047/DESC 37269631SruDevice description file for 37369631Sru.B cp1047 37469631Srudevice. 375104868Sru. 37669631Sru.TP 37769631Sru.BI @FONTDIR@/devcp1047/ F 37869631SruFont description file for font 37969631Sru.I F 38069631Sruof 38169631Sru.B cp1047 38269631Srudevice. 383104868Sru. 38469631Sru.TP 38575590Sru.B @MACRODIR@/tty.tmac 38618099SpstMacros for use with 38718099Spst.BR grotty . 388104868Sru. 38918099Spst.TP 39075590Sru.B @MACRODIR@/tty-char.tmac 39175590SruAdditional klugdey character definitions for use with 39218099Spst.BR grotty . 39369631Sru.LP 39469631SruNote that on EBCDIC hosts, only files for the 39569631Sru.B cp1047 39669631Srudevice will be installed. 397104868Sru. 398104868Sru. 39918099Spst.SH BUGS 40018099Spst.LP 40118099Spst.B grotty 40218099Spstis intended only for simple documents. 40318099Spst.LP 40418099SpstThere is no support for fractional horizontal or vertical motions. 40518099Spst.LP 40618099SpstThere is no support for 407104868Sru.B \[rs]D 40818099Spstcommands 40918099Spstother than horizontal and vertical lines. 41018099Spst.LP 411104868SruCharacters above the first line (ie with a vertical position of\~0) 41218099Spstcannot be printed. 413104868Sru.LP 414104868SruColor handling is different compared to 415104868Sru.BR grops (@MAN1EXT@). 416104868Sru.B \[rs]M 417104868Srudoesn't set the fill color for closed graphic objects (which 418104868Sru.B grotty 419104868Srudoesn't support anyway) but changes the background color of the character 420104868Srucell, affecting all subsequent operations. 421104868Sru. 422104868Sru. 42318099Spst.SH "SEE ALSO" 42418099Spst.BR groff (@MAN1EXT@), 42518099Spst.BR @g@troff (@MAN1EXT@), 42618099Spst.BR groff_out (@MAN5EXT@), 42718099Spst.BR groff_font (@MAN5EXT@), 42818099Spst.BR groff_char (@MAN7EXT@), 42918099Spst.BR ul (1), 43069631Sru.BR more (1), 431104868Sru.BR man (1), 43269631Sru.BR less (1) 43379550Sru. 434151503Sru.cp \n[grotty_C] 435151503Sru. 43679550Sru.\" Local Variables: 43779550Sru.\" mode: nroff 43879550Sru.\" End: 439