grotty.man revision 75590 
1.ig \"-*- nroff -*-
2$FreeBSD: head/contrib/groff/src/devices/grotty/grotty.man 75590 2001-04-17 12:28:31Z ru $
3Copyright (C) 1989-2000 Free Software Foundation, Inc.
4
5Permission is granted to make and distribute verbatim copies of
6this manual provided the copyright notice and this permission notice
7are preserved on all copies.
8
9Permission is granted to copy and distribute modified versions of this
10manual under the conditions for verbatim copying, provided that the
11entire resulting derived work is distributed under the terms of a
12permission notice identical to this one.
13
14Permission is granted to copy and distribute translations of this
15manual into another language, under the above conditions for modified
16versions, except that this permission notice may be included in
17translations approved by the Free Software Foundation instead of in
18the original English.
19..
20.TH GROTTY @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
21.SH NAME
22grotty \- groff driver for typewriter-like devices
23.SH SYNOPSIS
24.B grotty
25[
26.B \-hfbuodBUv
27] [
28.BI \-F dir
29] [
30.IR files \|.\|.\|.
31]
32.PP
33It is possible to have whitespace between the
34.B \-F
35option and its parameter.
36.SH DESCRIPTION
37.B grotty
38translates the output of GNU
39.B troff
40into a form suitable for typewriter-like devices.
41Normally
42.B grotty
43should be invoked by using the
44.B groff
45command
46with a
47.BR \-Tascii ,
48.BR \-Tkoi8-r ,
49.B \-Tlatin1
50or
51.B \-Tutf8
52option on ASCII based systems, and with
53.B \-Tcp1047
54on EBCDIC based hosts.
55If no files are given,
56.B grotty
57will read the standard input.
58A filename of
59.B \-
60will also cause
61.B grotty
62to read the standard input.
63Output is written to the standard output.
64.LP
65Normally
66.B grotty
67prints a bold character
68.I c
69using the sequence
70.RI ` c
71.SM BACKSPACE
72.IR c '
73and a italic character
74.I c
75by the sequence
76.RB ` _
77.SM BACKSPACE
78.IR c '.
79These sequences can be displayed on a terminal
80by piping through
81.BR ul (1).
82Pagers such as
83.BR more (1)
84or
85.BR less (1)
86are also able to display these sequences.
87Use either
88.B \-B
89or
90.B \-U
91when piping into
92.BR less (1);
93use
94.B \-b
95when piping into
96.BR more (1).
97There is no need to filter the output through
98.BR col (1)
99since
100.B grotty
101never outputs reverse line feeds.
102.LP
103The font description file may contain a command
104.IP
105.BI internalname\  n
106.LP
107where
108.I n
109is a decimal integer.
110If the 01 bit in
111.I n
112is set,
113then the font will be treated as an italic font;
114if the 02 bit is set,
115then it will be treated as a bold font.
116The code field in the font description field gives the
117code which will be used to output the character.
118This code can also be used in the
119.B \eN
120escape sequence in
121.BR troff .
122.SH OPTIONS
123.TP
124.BI \-F dir
125Prepend directory
126.IB dir /dev name
127to the search path for font and device description files;
128.I name
129is the name of the device, usually
130.BR ascii ,
131.BR koi8-r ,
132.BR latin1 ,
133.BR utf8 ,
134or
135.BR cp1047 .
136.TP
137.B \-h
138Use horizontal tabs in the output.
139Tabs are assumed to be set every 8 columns.
140.TP
141.B \-f
142Use form feeds in the output.
143A form feed will be output at the end of each page that has no output
144on its last line.
145.TP
146.B \-b
147Suppress the use of overstriking for bold characters.
148.TP
149.B \-u
150Suppress the use of underlining for italic characters.
151.TP
152.B \-B
153Use only overstriking for bold-italic characters.
154.TP
155.B \-U
156Use only underlining for bold-italic characters.
157.TP
158.B \-o
159Suppress overstriking (other than for bold or underlined characters).
160.TP
161.B \-d
162Ignore all
163.B \eD
164commands.
165Without this
166.B grotty
167will render
168.B \eD'l\|.\|.\|.'
169commands that have at least at least one zero argument
170(and so are either horizontal or vertical)
171using
172.BR \- ,
173.B |
174and
175.B +
176characters.
177.TP
178.B \-v
179Print the version number.
180.SH FILES
181.TP
182.B @FONTDIR@/devascii/DESC
183Device description file for
184.B ascii
185device.
186.TP
187.BI @FONTDIR@/devascii/ F
188Font description file for font
189.I F
190of
191.B ascii
192device.
193.TP
194.B @FONTDIR@/devkoi8-r/DESC
195Device description file for
196.B koi8-r
197device.
198.TP
199.BI @FONTDIR@/devkoi8-r/ F
200Font description file for font
201.I F
202of
203.B koi8-r
204device.
205.TP
206.B @FONTDIR@/devlatin1/DESC
207Device description file for
208.B latin1
209device.
210.TP
211.BI @FONTDIR@/devlatin1/ F
212Font description file for font
213.I F
214of
215.B latin1
216device.
217.TP
218.B @FONTDIR@/devutf8/DESC
219Device description file for
220.B utf8
221device.
222.TP
223.BI @FONTDIR@/devutf8/ F
224Font description file for font
225.I F
226of
227.B utf8
228device.
229.TP
230.B @FONTDIR@/devcp1047/DESC
231Device description file for
232.B cp1047
233device.
234.TP
235.BI @FONTDIR@/devcp1047/ F
236Font description file for font
237.I F
238of
239.B cp1047
240device.
241.TP
242.B @MACRODIR@/tty.tmac
243Macros for use with
244.BR grotty .
245.TP
246.B @MACRODIR@/tty-char.tmac
247Additional klugdey character definitions for use with
248.BR grotty .
249.LP
250Note that on EBCDIC hosts, only files for the
251.B cp1047
252device will be installed.
253.SH BUGS
254.LP
255.B grotty
256is intended only for simple documents.
257.LP
258There is no support for fractional horizontal or vertical motions.
259.LP
260There is no support for
261.B \eD
262commands
263other than horizontal and vertical lines.
264.LP
265Characters above the first line (ie with a vertical position of 0)
266cannot be printed.
267.SH "SEE ALSO"
268.BR groff (@MAN1EXT@),
269.BR @g@troff (@MAN1EXT@),
270.BR groff_out (@MAN5EXT@),
271.BR groff_font (@MAN5EXT@),
272.BR groff_char (@MAN7EXT@),
273.BR ul (1),
274.BR more (1),
275.BR less (1)
276