1GROTTY(1)                   General Commands Manual                  GROTTY(1)
2
3
4

NAME

6       grotty - groff driver for typewriter-like devices
7

SYNOPSIS

9       grotty [ -bBcdfhiouUv ] [ -Fdir ] [ files... ]
10
11       It is possible to have whitespace between the -F option and its parame‐
12       ter.
13

DESCRIPTION

15       grotty translates the output of GNU troff  into  a  form  suitable  for
16       typewriter-like  devices.   Normally  grotty should be invoked by using
17       the groff command with  a  -Tascii,  -Tascii8,  -Tlatin1,  -Tnippon  or
18       -Tutf8  option  on ASCII based systems, and with -Tcp1047 and -Tutf8 on
19       EBCDIC based hosts.  If no files are given, grotty will read the  stan‐
20       dard  input.   A filename of - will also cause grotty to read the stan‐
21       dard input.  Output is written to the standard output.
22
23       By default, grotty emits SGR escape  sequences  (from  ISO  6429,  also
24       called  ANSI  color  escapes)  to change text attributes (bold, italic,
25       colors).  This makes it possible to have eight different background and
26       foreground colors; additionally, bold and italic attributes can be used
27       at the same time (by using the BI font).
28
29       The following colors are defined in tty.tmac: black, white, red, green,
30       blue,  yellow, magenta, cyan.  Unknown colors are mapped to the default
31       color (which is dependent on the settings  of  the  terminal;  in  most
32       cases, this is black for the foreground and white for the background).
33
34       Use the -c switch to revert to the old behaviour, printing a bold char‐
35       acter c with the sequence `c BACKSPACE c' and an italic character c  by
36       the  sequence  `_ BACKSPACE c'.  At the same time, color output is dis‐
37       abled.   The  same  effect  can  be  achieved  by  setting  either  the
38       GROFF_NO_SGR  environment  variable  or  using the `sgr' X command (see
39       below).
40
41       For SGR support, it is necessary to use the -R  option  of  less(1)  to
42       disable  the  interpretation  of  grotty's  old  output format.  Conse‐
43       quently, all programs which use less as the pager program have to  pass
44       this  option  to  it.   For  man(1) in particular, either add -R to the
45       $PAGER environment variable, e.g.
46
47              PAGER="/usr/bin/less -R"
48              export PAGER
49
50       or use the -P option of  man  to  set  the  pager  executable  and  its
51       options, or modify the configuration file of man in a similar fashion.
52
53       grotty's  old  output  format  can be displayed on a terminal by piping
54       through ul(1).  Pagers such as more(1) or less(1) are also able to dis‐
55       play  these  sequences.   Use either -B or -U when piping into less(1);
56       use -b when piping into more(1).  There is no need to filter the output
57       through col(1) since grotty never outputs reverse line feeds.
58
59       The font description file may contain a command
60
61              internalname n
62
63       where n is a decimal integer.  If the 01 bit in n is set, then the font
64       will be treated as an italic font; if the 02 bit is set, then  it  will
65       be  treated  as  a  bold  font.  The code field in the font description
66       field gives the code which will be used to output the character.   This
67       code can also be used in the \N escape sequence in troff.
68

OPTIONS

70       -b     Suppress  the  use of overstriking for bold characters.  Ignored
71              if -c isn't used.
72
73       -B     Use only overstriking for bold-italic characters.  Ignored if -c
74              isn't used.
75
76       -c     Use  grotty's old output format (see above).  This also disables
77              color output.
78
79       -d     Ignore  all  \D  commands.   Without  this  grotty  will  render
80              \D'l...'  commands  that have at least one zero argument (and so
81              are either horizontal or vertical) using -, |, and + characters.
82
83       -f     Use form feeds in the output.  A form feed will be output at the
84              end of each page that has no output on its last line.
85
86       -Fdir  Prepend  directory  dir/devname  to the search path for font and
87              device description files; name is the name of the  device,  usu‐
88              ally ascii, ascii8, latin1, utf8, nippon or cp1047.
89
90       -h     Use  horizontal  tabs in the output.  Tabs are assumed to be set
91              every 8 columns.
92
93       -i     Use escape sequences to set the italic text attribute instead of
94              the  underline  attribute for italic fonts (`I' and `BI').  Note
95              that  most  terminals  (including  xterm)  don't  support  this.
96              Ignored if -c is active.
97
98       -o     Suppress overstriking (other than for bold or underlined charac‐
99              ters in case the old output format has been activated with -c).
100
101       -u     Suppress the use of underlining for italic characters.   Ignored
102              if -c isn't used.
103
104       -U     Use  only underlining for bold-italic characters.  Ignored if -c
105              isn't used.
106
107       -v     Print the version number.
108

USAGE

110       grotty understands a single X command  produced  using  the  \X  escape
111       sequence.
112
113       \X'tty: sgr n'
114              If  n  is  non-zero  or  missing, enable SGR output (this is the
115              default), otherwise use the old  drawing  scheme  for  bold  and
116              underline.
117

ENVIRONMENT

119       GROFF_NO_SGR
120              If set, the old drawing scheme for bold and underline (using the
121              backspace character) is active.  Colors are disabled.
122

FILES

124       /usr/share/groff/1.18.1.4/font/devascii/DESC
125              Device description file for ascii device.
126
127       /usr/share/groff/1.18.1.4/font/devascii/F
128              Font description file for font F of ascii device.
129
130       /usr/share/groff/1.18.1.4/font/devascii8/DESC
131              Device description file for ascii8 device.
132
133       /usr/share/groff/1.18.1.4/font/devlatin1/DESC
134              Device description file for latin1 device.
135
136       /usr/share/groff/1.18.1.4/font/devnippon/DESC
137              Device description file for nippon device.
138
139       /usr/share/groff/1.18.1.4/font/devlatin1/F
140              Font description file for font F of latin1 device.
141
142       /usr/share/groff/1.18.1.4/font/devutf8/DESC
143              Device description file for utf8 device.
144
145       /usr/share/groff/1.18.1.4/font/devutf8/F
146              Font description file for font F of utf8 device.
147
148       /usr/share/groff/1.18.1.4/font/devcp1047/DESC
149              Device description file for cp1047 device.
150
151       /usr/share/groff/1.18.1.4/font/devcp1047/F
152              Font description file for font F of cp1047 device.
153
154       /usr/share/groff/1.18.1.4/tmac/tty.tmac
155              Macros for use with grotty.
156
157       /usr/share/groff/1.18.1.4/tmac/tty-char.tmac
158              Additional klugdey character definitions for use with grotty.
159
160       Note that on EBCDIC hosts, only files for the  cp1047  device  will  be
161       installed.
162

BUGS

164       grotty is intended only for simple documents.
165
166       There is no support for fractional horizontal or vertical motions.
167
168       There  is no support for \D commands other than horizontal and vertical
169       lines.
170
171       Characters above the first line (ie with a vertical position of 0) can‐
172       not be printed.
173
174       Color  handling  is different compared to grops(1).  \M doesn't set the
175       fill color for closed graphic objects  (which  grotty  doesn't  support
176       anyway) but changes the background color of the character cell, affect‐
177       ing all subsequent operations.
178

SEE ALSO

180       groff(1), troff(1), groff_out(5), groff_font(5), groff_char(7),  ul(1),
181       more(1), man(1), less(1)
182
183
184
185Groff Version 1.18.1.4          25 January 2008                      GROTTY(1)
Impressum