grodvi.man revision 75584
175584Sru.ig \"-*- nroff -*-
275584SruCopyright (C) 1989-2000 Free Software Foundation, Inc.
375584Sru
475584SruPermission is granted to make and distribute verbatim copies of
575584Sruthis manual provided the copyright notice and this permission notice
675584Sruare preserved on all copies.
775584Sru
875584SruPermission is granted to copy and distribute modified versions of this
975584Srumanual under the conditions for verbatim copying, provided that the
10entire resulting derived work is distributed under the terms of a
11permission notice identical to this one.
12
13Permission is granted to copy and distribute translations of this
14manual into another language, under the above conditions for modified
15versions, except that this permission notice may be included in
16translations approved by the Free Software Foundation instead of in
17the original English.
18..
19.ie t .ds tx T\h'-.1667m'\v'.224m'E\v'-.224m'\h'-.125m'X
20.el .ds tx TeX
21.\" Like TP, but if specified indent is more than half
22.\" the current line-length - indent, use the default indent.
23.de Tp
24.ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
25.el .TP "\\$1"
26..
27.TH GRODVI @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
28.SH NAME
29grodvi \- convert groff output to TeX dvi format
30.SH SYNOPSIS
31.B grodvi
32[
33.B \-dv
34] [
35.BI \-w n
36] [
37.BI \-F dir
38] [
39.IR files \|.\|.\|.
40]
41.PP
42It is possible to have whitespace between a command line option and its
43parameter.
44.SH DESCRIPTION
45.B grodvi
46is a driver for
47.B groff
48that produces \*(tx dvi format.
49Normally it should be run by
50.BR groff\ \-Tdvi .
51This will run
52.BR @g@troff\ \-Tdvi ;
53it will also input the macros
54.BR @MACRODIR@/dvi.tmac ;
55if the input is being preprocessed with
56.B @g@eqn
57it will also input
58.BR @FONTDIR@/devdvi/eqnchar .
59.LP
60The dvi file generated by
61.B grodvi
62can be printed by any correctly-written dvi driver.
63The troff drawing primitives are implemented
64using the tpic version 2 specials.
65If the driver does not support these, the
66.B \eD
67commands will not produce any output.
68.LP
69There is an additional drawing command available:
70.TP
71.BI \eD'R\  dh\ dv '
72Draw a rule (solid black rectangle), with one corner
73at the current position, and the diagonally opposite corner
74at the current position 
75.RI +( dh , dv ).
76Afterwards the current position will be at the opposite corner.  This
77produces a rule in the dvi file and so can be printed even with a
78driver that does not support the tpic specials unlike the other
79.B \eD
80commands.
81.LP
82The groff command
83.BI \eX' anything '
84is translated into the same command in the dvi file as would be
85produced by
86.BI \especial{ anything }
87in \*(tx;
88.I anything may not contain a newline.
89.LP
90Font files for
91.B grodvi
92can be created from tfm files using
93.BR tfmtodit (@MAN1EXT@).
94The font description file should contain the following
95additional commands:
96.Tp \w'\fBinternalname'u+2n
97.BI internalname\   name
98The name of the tfm file (without the
99.B .tfm
100extension) is
101.IR name .
102.TP
103.BI checksum\  n
104The checksum in the tfm file is
105.IR n .
106.TP
107.BI designsize\  n
108The designsize in the tfm file is
109.IR n .
110.LP
111These are automatically generated by
112.B tfmtodit.
113.LP
114In
115.B troff
116the
117.B \eN
118escape sequence can be used to access characters by their position
119in the corresponding tfm file;
120all characters in the tfm file can be accessed this way.
121.SH OPTIONS
122.TP
123.B \-d
124Do not use tpic specials to implement drawing commands.
125Horizontal and vertical lines will be implemented by rules.
126Other drawing commands will be ignored.
127.TP
128.B \-v
129Print the version number.
130.TP
131.BI \-w n
132Set the default line thickness to
133.I n
134thousandths of an em. 
135.TP
136.BI \-F dir
137Prepend directory
138.IB dir /devdvi
139to the search path for font and device description files.
140.SH FILES
141.TP
142.B @FONTDIR@/devdvi/DESC
143Device description file.
144.TP
145.BI @FONTDIR@/devdvi/ F
146Font description file for font
147.IR F .
148.TP
149.B @MACRODIR@/dvi.tmac
150Macros for use with
151.BR grodvi .
152.SH BUGS
153Dvi files produced by
154.B grodvi
155use a different resolution (57816 units per inch) to those produced by
156\*(tx.
157Incorrectly written drivers which assume the resolution used by \*(tx,
158rather than using the resolution specified in the dvi file will not
159work with
160.BR grodvi .
161.LP
162When using the
163.B \-d
164option with boxed tables,
165vertical and horizontal lines can sometimes protrude by one pixel.
166This is a consequence of the way \*(tx requires that the heights
167and widths of rules be rounded.
168.SH "SEE ALSO"
169.BR tfmtodit (@MAN1EXT@),
170.BR groff (@MAN1EXT@),
171.BR @g@troff (@MAN1EXT@),
172.BR groff_out (@MAN5EXT@),
173.BR groff_font (@MAN5EXT@),
174.BR groff_char (@MAN7EXT@)
175