grotty.man revision 119887
1185363Sjkoshy.ig 2185363Sjkoshy$FreeBSD: head/contrib/groff/src/devices/grotty/grotty.man 119887 2003-09-08 17:46:33Z ru $ 3185363SjkoshyCopyright (C) 1989-2000, 2001, 2002 Free Software Foundation, Inc. 4185363Sjkoshy 5185363SjkoshyPermission is granted to make and distribute verbatim copies of 6185363Sjkoshythis manual provided the copyright notice and this permission notice 7185363Sjkoshyare preserved on all copies. 8185363Sjkoshy 9185363SjkoshyPermission is granted to copy and distribute modified versions of this 10185363Sjkoshymanual under the conditions for verbatim copying, provided that the 11185363Sjkoshyentire resulting derived work is distributed under the terms of a 12185363Sjkoshypermission notice identical to this one. 13185363Sjkoshy 14185363SjkoshyPermission is granted to copy and distribute translations of this 15185363Sjkoshymanual into another language, under the above conditions for modified 16185363Sjkoshyversions, except that this permission notice may be included in 17185363Sjkoshytranslations approved by the Free Software Foundation instead of in 18185363Sjkoshythe original English. 19185363Sjkoshy.. 20185363Sjkoshy. 21185363Sjkoshy. 22185363Sjkoshy.TH GROTTY @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@" 23185363Sjkoshy.SH NAME 24185363Sjkoshygrotty \- groff driver for typewriter-like devices 25185363Sjkoshy. 26185363Sjkoshy. 27185363Sjkoshy.SH SYNOPSIS 28185363Sjkoshy.B grotty 29185363Sjkoshy[ 30185363Sjkoshy.B \-bBcdfhioruUv 31185363Sjkoshy] [ 32185363Sjkoshy.BI \-F dir 33185363Sjkoshy] [ 34185363Sjkoshy.IR files \|.\|.\|.\& 35185363Sjkoshy] 36185363Sjkoshy.PP 37185363SjkoshyIt is possible to have whitespace between the 38185363Sjkoshy.B \-F 39185363Sjkoshyoption and its parameter. 40185363Sjkoshy. 41185363Sjkoshy. 42185363Sjkoshy.SH DESCRIPTION 43185363Sjkoshy.B grotty 44185363Sjkoshytranslates the output of GNU 45185363Sjkoshy.B troff 46185363Sjkoshyinto a form suitable for typewriter-like devices. 47185363SjkoshyNormally 48185363Sjkoshy.B grotty 49185363Sjkoshyshould be invoked by using the 50185363Sjkoshy.B groff 51185363Sjkoshycommand 52185363Sjkoshywith a 53185363Sjkoshy.BR \-Tascii , 54185363Sjkoshy.BR \-Tlatin1 , 55185363Sjkoshy.B \-Tkoi8-r 56185363Sjkoshyor 57185363Sjkoshy.B \-Tutf8 58185363Sjkoshyoption on ASCII based systems, and with 59185363Sjkoshy.B \-Tcp1047 60185363Sjkoshyand 61185363Sjkoshy.B \-Tutf8 62185363Sjkoshyon EBCDIC based hosts. 63185363SjkoshyIf no files are given, 64185363Sjkoshy.B grotty 65185363Sjkoshywill read the standard input. 66185363SjkoshyA filename of 67185363Sjkoshy.B \- 68185363Sjkoshywill also cause 69185363Sjkoshy.B grotty 70185363Sjkoshyto read the standard input. 71185363SjkoshyOutput is written to the standard output. 72185363Sjkoshy.LP 73185363SjkoshyBy default, 74185363Sjkoshy.B grotty 75185363Sjkoshyemits SGR escape sequences (from ISO 6429, also called ANSI color escapes) 76185363Sjkoshyto change text attributes (bold, italic, colors). 77185363SjkoshyThis makes it possible to have eight different \M[green]background\M[] 78185363Sjkoshyand \m[red]foreground\m[] colors; additionally, bold and italic 79185363Sjkoshyattributes can be used \f[BI]at the same time\f[] (by using the BI font). 80185363Sjkoshy.LP 81185363SjkoshyThe following colors are defined in 82185363Sjkoshy.BR tty.tmac : 83185363Sjkoshyblack, white, red, green, blue, yellow, magenta, cyan. 84185363SjkoshyUnknown colors are mapped to the default color (which is dependent on the 85185363Sjkoshysettings of the terminal; in most cases, this is black for the foreground 86185363Sjkoshyand white for the background). 87185363Sjkoshy.LP 88185363SjkoshyUse the 89185363Sjkoshy.B \-c 90185363Sjkoshyswitch to revert to the old behaviour, printing a bold character 91185363Sjkoshy.I c 92185363Sjkoshywith the sequence 93185363Sjkoshy.RI ` c 94185363Sjkoshy.SM BACKSPACE 95185363Sjkoshy.IR c ' 96185363Sjkoshyand an italic character 97185363Sjkoshy.I c 98185363Sjkoshyby the sequence 99185363Sjkoshy.RB ` _ 100185363Sjkoshy.SM BACKSPACE 101185363Sjkoshy.IR c '. 102185363SjkoshyAt the same time, color output is disabled. 103185363SjkoshyThe same effect can be achieved by setting either the 104185363Sjkoshy.B GROFF_NO_SGR 105185363Sjkoshyenvironment variable or using the `sgr' X command (see below). 106185363Sjkoshy.LP 107185363SjkoshyFor SGR support, it is necessary to use the 108185363Sjkoshy.B \-R 109185363Sjkoshyoption of 110185363Sjkoshy.BR less (1) 111185363Sjkoshyto disable the interpretation of 112185363Sjkoshy.BR grotty 's 113185363Sjkoshyold output format. 114185363SjkoshyConsequently, all programs which use 115185363Sjkoshy.B less 116185363Sjkoshyas the pager program have to pass this option to it. 117185363SjkoshyFor 118185363Sjkoshy.BR man (1) 119185363Sjkoshyin particular, either add 120185363Sjkoshy.B \-R 121185363Sjkoshyto the 122.B $PAGER 123environment variable, e.g.\& 124.RS 125.LP 126.B PAGER="/usr/bin/less -R" 127.br 128.B export PAGER 129.RE 130.LP 131or use the 132.B \-P 133option of 134.B man 135to set the pager executable and its options, or modify the configuration 136file of 137.B man 138in a similar fashion. 139.LP 140.BR grotty 's 141old output format can be displayed on a terminal 142by piping through 143.BR ul (1). 144Pagers such as 145.BR more (1) 146or 147.BR less (1) 148are also able to display these sequences. 149Use either 150.B \-B 151or 152.B \-U 153when piping into 154.BR less (1); 155use 156.B \-b 157when piping into 158.BR more (1). 159There is no need to filter the output through 160.BR col (1) 161since 162.B grotty 163never outputs reverse line feeds. 164.LP 165The font description file may contain a command 166.IP 167.BI internalname\ n 168.LP 169where 170.I n 171is a decimal integer. 172If the 01 bit in 173.I n 174is set, 175then the font will be treated as an italic font; 176if the 02 bit is set, 177then it will be treated as a bold font. 178The code field in the font description field gives the 179code which will be used to output the character. 180This code can also be used in the 181.B \[rs]N 182escape sequence in 183.BR troff . 184. 185. 186.SH OPTIONS 187.TP 188.B \-b 189Suppress the use of overstriking for bold characters. 190Ignored if 191.B \-c 192isn't used. 193. 194.TP 195.B \-B 196Use only overstriking for bold-italic characters. 197Ignored if 198.B \-c 199isn't used. 200. 201.TP 202.B \-c 203Use 204.BR grotty 's 205old output format (see above). 206This also disables color output. 207. 208.TP 209.B \-d 210Ignore all 211.B \[rs]D 212commands. 213Without this 214.B grotty 215will render 216.B \[rs]D'l\|.\|.\|.\&' 217commands that have at least one zero argument 218(and so are either horizontal or vertical) 219using 220.BR \- , 221.BR | , 222and 223.B + 224characters. 225. 226.TP 227.B \-f 228Use form feeds in the output. 229A form feed will be output at the end of each page that has no output 230on its last line. 231. 232.TP 233.BI \-F dir 234Prepend directory 235.IB dir /dev name 236to the search path for font and device description files; 237.I name 238is the name of the device, usually 239.BR ascii , 240.BR latin1 , 241.BR koi8-r , 242.BR utf8 , 243or 244.BR cp1047 . 245.TP 246.B \-h 247Use horizontal tabs in the output. 248Tabs are assumed to be set every 8 columns. 249. 250.TP 251.B \-i 252Use escape sequences to set the italic text attribute instead of the 253underline attribute for italic fonts (`I' and `BI'). 254Note that most terminals (including xterm) don't support this. 255Ignored if 256.B \-c 257is active. 258. 259.TP 260.B \-o 261Suppress overstriking (other than for bold or underlined characters in 262case the old output format has been activated with 263.BR \-c ). 264. 265.TP 266.B \-r 267Use escape sequences to set the reverse text attribute instead of the 268underline attribute for italic fonts (`I' and `BI'). 269Ignored if 270.B \-c 271is active. 272. 273.TP 274.B \-u 275Suppress the use of underlining for italic characters. 276Ignored if 277.B \-c 278isn't used. 279. 280.TP 281.B \-U 282Use only underlining for bold-italic characters. 283Ignored if 284.B \-c 285isn't used. 286. 287.TP 288.B \-v 289Print the version number. 290. 291. 292.SH USAGE 293.B grotty 294understands a single X command produced using the 295.B \[rs]X 296escape sequence. 297.TP 298.BI \[rs]X'tty:\ sgr\ n ' 299If 300.I n 301is non-zero or missing, enable SGR output (this is the default), otherwise 302use the old drawing scheme for bold and underline. 303. 304. 305.SH ENVIRONMENT 306.TP 307.B GROFF_NO_SGR 308If set, the old drawing scheme for bold and underline (using the 309backspace character) is active. 310Colors are disabled. 311. 312. 313.SH FILES 314.TP 315.B @FONTDIR@/devascii/DESC 316Device description file for 317.B ascii 318device. 319. 320.TP 321.BI @FONTDIR@/devascii/ F 322Font description file for font 323.I F 324of 325.B ascii 326device. 327.TP 328.B @FONTDIR@/devkoi8-r/DESC 329Device description file for 330.B koi8-r 331device. 332.TP 333.BI @FONTDIR@/devkoi8-r/ F 334Font description file for font 335.I F 336of 337.B koi8-r 338device. 339. 340.TP 341.B @FONTDIR@/devlatin1/DESC 342Device description file for 343.B latin1 344device. 345. 346.TP 347.BI @FONTDIR@/devlatin1/ F 348Font description file for font 349.I F 350of 351.B latin1 352device. 353. 354.TP 355.B @FONTDIR@/devutf8/DESC 356Device description file for 357.B utf8 358device. 359. 360.TP 361.BI @FONTDIR@/devutf8/ F 362Font description file for font 363.I F 364of 365.B utf8 366device. 367. 368.TP 369.B @FONTDIR@/devcp1047/DESC 370Device description file for 371.B cp1047 372device. 373. 374.TP 375.BI @FONTDIR@/devcp1047/ F 376Font description file for font 377.I F 378of 379.B cp1047 380device. 381. 382.TP 383.B @MACRODIR@/tty.tmac 384Macros for use with 385.BR grotty . 386. 387.TP 388.B @MACRODIR@/tty-char.tmac 389Additional klugdey character definitions for use with 390.BR grotty . 391.LP 392Note that on EBCDIC hosts, only files for the 393.B cp1047 394device will be installed. 395. 396. 397.SH BUGS 398.LP 399.B grotty 400is intended only for simple documents. 401.LP 402There is no support for fractional horizontal or vertical motions. 403.LP 404There is no support for 405.B \[rs]D 406commands 407other than horizontal and vertical lines. 408.LP 409Characters above the first line (ie with a vertical position of\~0) 410cannot be printed. 411.LP 412Color handling is different compared to 413.BR grops (@MAN1EXT@). 414.B \[rs]M 415doesn't set the fill color for closed graphic objects (which 416.B grotty 417doesn't support anyway) but changes the background color of the character 418cell, affecting all subsequent operations. 419. 420. 421.SH "SEE ALSO" 422.BR groff (@MAN1EXT@), 423.BR @g@troff (@MAN1EXT@), 424.BR groff_out (@MAN5EXT@), 425.BR groff_font (@MAN5EXT@), 426.BR groff_char (@MAN7EXT@), 427.BR ul (1), 428.BR more (1), 429.BR man (1), 430.BR less (1) 431. 432.\" Local Variables: 433.\" mode: nroff 434.\" End: 435