groff before CVS: release 1.05
[s-roff.git] / man / grotty.man
blobba25beb5d2f78cb4aa08b08a03bddb5645b0c01c
1 .\" -*- nroff -*-
2 .TH GROTTY @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
3 .SH NAME
4 grotty \- groff driver for typewriter-like devices
5 .SH SYNOPSIS
6 .B grotty
8 .B \-hfbuodBUv
9 ] [
10 .BI \-F dir
11 ] [
12 .IR files \|.\|.\|.
14 .SH DESCRIPTION
15 .B grotty
16 translates the output of
17 .B gtroff
18 into a form suitable for typewriter-like devices.
19 Normally
20 .B grotty
21 should invoked by using the groff command
22 with a
23 .B \-Tascii
25 .B \-Tlatin1
26 option.
27 If no files are given,
28 .B grotty
29 will read the standard input.
30 A filename of
31 .B \-
32 will also cause
33 .B grotty
34 to read the standard input.
35 Output is written to the standard output.
36 .LP
37 Normally
38 .B grotty
39 prints a bold character
40 .I c
41 using the sequence
42 .RI ` c
43 .SM BACKSPACE
44 .IR c '
45 and a italic character
46 .I c
47 by the sequence
48 .RB ` _
49 .SM BACKSPACE
50 .IR c '.
51 These sequences can be displayed on a terminal
52 by piping through
53 .BR ul (1).
54 Pagers such as
55 .BR more (1)
57 .BR less (1)
58 are also able to display these sequences.
59 Use either
60 .B \-B
62 .B \-U
63 when piping into
64 .BR less (1);
65 use
66 .B \-b
67 when piping into
68 .BR more (1).
69 There is no need to filter the output through
70 .BR col (1)
71 since
72 .B grotty
73 never outputs reverse line feeds.
74 .LP
75 The font description file may contain a command
76 .IP
77 .BI internalname\  n
78 .LP
79 where
80 .I n
81 is a decimal integer.
82 If the 01 bit in
83 .I n
84 is set,
85 then the font will be treated as an italic font;
86 if the 02 bit is set,
87 then it will be treated as a bold font.
88 The code field in the font description field gives the
89 code which will be used to output the character.
90 This code can also be used in the
91 .B \eN
92 escape sequence in
93 .BR gtroff .
94 .SH OPTIONS
95 .TP
96 .BI \-F dir
97 Search the directory
98 .IB dir /dev name
99 for font and device description files;
100 .I name
101 is the name of the device, usually
102 .B ascii
104 .BR latin1 .
106 .B \-h
107 Use horizontal tabs in the output.
108 Tabs are assumed to be set every 8 columns.
110 .B \-f
111 Use form feeds in the output.
112 A form feed will be output at the end of each page that has no output
113 on its last line.
115 .B \-b
116 Suppress the use of overstriking for bold characters.
118 .B \-u
119 Suppress the use of underlining for italic characters.
121 .B \-B
122 Use only overstriking for bold, italic characters.
124 .B \-U
125 Use only underlining for bold, italic characters.
127 .B \-o
128 Suppress overstriking (other than for bold or underlined characters).
130 .B \-d
131 Ignore all
132 .B \eD
133 commands.
134 Without this
135 .B grotty
136 will render
137 .B \eD'l\|.\|.\|.'
138 commands that have at least at least one zero argument
139 (and so are either horizontal or vertical)
140 using
141 .BR \- ,
142 .B |
144 .B +
145 characters.
147 .B \-v
148 Print the version number.
149 .SH FILES
151 .B @FONTDIR@/devascii/DESC
152 Device desciption file for
153 .B ascii
154 device.
156 .B @FONTDIR@/devascii/ F
157 Font description file for font
158 .I F
160 .B ascii device.
162 .B @FONTDIR@/devlatin1/DESC
163 Device desciption file for
164 .B latin1
165 device.
167 .B @FONTDIR@/devlatin1/ F
168 Font description file for font
169 .I F
171 .B latin1 device.
173 .B @MACRODIR@/tmac.tty
174 Macros for use with
175 .BR grotty .
176 .SH BUGS
178 .B grotty
179 is intended only for simple documents.
181 There is no support for fractional horizontal or vertical motions.
183 There is no support for
184 .B \eD
185 commands
186 other than horizontal and vertical lines.
188 Characters above the first line (ie with a vertical position of 0)
189 cannot be printed.
190 .SH "SEE ALSO"
191 .BR groff (@MAN1EXT@),
192 .BR gtroff (@MAN1EXT@),
193 .BR groff_out (@MAN5EXT@),
194 .BR groff_font (@MAN5EXT@),
195 .BR ul (1),
196 .BR more (1),
197 .BR less (1)
199 .I "Groff Character Names"