groff before CVS: release 1.06
[s-roff.git] / grodvi / grodvi.man
blobfe1fced70b887280074887d3b322b21c0f3892da
1 .\" -*- nroff -*-
2 .ie t .ds tx T\h'-.1667m'\v'.224m'E\v'-.224m'\h'-.125m'X
3 .el .ds tx TeX
4 .\" Like TP, but if specified indent is more than half
5 .\" the current line-length - indent, use the default indent.
6 .de Tp
7 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
8 .el .TP "\\$1"
9 ..
10 .TH GRODVI @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
11 .SH NAME
12 grodvi \- convert groff output to TeX dvi format
13 .SH SYNOPSIS
14 .B grodvi
16 .B \-dv
17 ] [
18 .BI \-w n
19 ] [
20 .BI \-F dir
21 ] [
22 .IR files \|.\|.\|.
24 .SH DESCRIPTION
25 .B grodvi
26 is a driver for
27 .B groff
28 that produces \*(tx dvi format.
29 Normally it should be run by
30 .BR groff\ \-Tdvi .
31 This will run
32 .BR @g@troff\ \-Tdvi ;
33 it will also input the macros
34 .BR @MACRODIR@/tmac.dvi ;
35 if the input is being preprocessed with
36 .B @g@eqn
37 it will also input
38 .BR @FONTDIR@/devdvi/eqnchar .
39 .LP
40 The dvi file generated by
41 .B grodvi
42 can be printed by any correctly-written dvi driver.
43 The troff drawing primitives are implemented
44 using the tpic version 2 specials.
45 If the driver does not support these, the
46 .B \eD
47 commands will not produce any output.
48 .LP
49 There is an additional drawing command available:
50 .TP
51 .BI \eD'R\  dh\ dv '
52 Draw a rule (solid black rectangle), with one corner
53 at the current position, and the diagonally opposite corner
54 at the current position 
55 .RI +( dh , dv ).
56 Afterwards the current position will be at the opposite corner.  This
57 produces a rule in the dvi file and so can be printed even with a
58 driver that does not support the tpic specials unlike the other
59 .B \eD
60 commands.
61 .LP
62 The groff command
63 .BI \eX' anything '
64 is translated into the same command in the dvi file as would be
65 produced by
66 .BI \especial{ anything }
67 in \*(tx;
68 .I anything may not contain a newline.
69 .LP
70 Font files for
71 .B grodvi
72 can be created from tfm files using
73 .BR tfmtodit (@MAN1EXT@).
74 The font description file should contain the following
75 additional commands:
76 .Tp \w'\fBinternalname'u+2n
77 .BI internalname\   name
78 The name of the tfm file (without the
79 .B .tfm
80 extension) is
81 .IR name .
82 .TP
83 .BI checksum\  n
84 The checksum in the tfm file is
85 .IR n .
86 .TP
87 .BI designsize\  n
88 The designsize in the tfm file is
89 .IR n .
90 .LP
91 These are automatically generated by
92 .B tfmtodit.
93 .LP
95 .B troff
96 the
97 .B \eN
98 escape sequence can be used to access characters by their position
99 in the corresponding tfm file;
100 all characters in the tfm file can be accessed this way.
101 .SH OPTIONS
103 .B \-d
104 Do not use tpic specials to implement drawing commands.
105 Horizontal and vertical lines will be implemented by rules.
106 Other drawing commands will be ignored.
108 .B \-v
109 Print the version number.
111 .BI \-w n
112 Set the default line thickness to
113 .I n
114 thousandths of an em. 
116 .BI \-F dir
117 Search directory
118 .IB dir /devdvi
119 for font and device description files.
120 .SH FILES
122 .B @FONTDIR@/devdvi/DESC
123 Device desciption file.
125 .B @FONTDIR@/devdvi/ F
126 Font description file for font
127 .IR F .
129 .B @MACRODIR@/tmac.dvi
130 Macros for use with
131 .BR grodvi .
132 .SH BUGS
133 Dvi files produced by
134 .B grodvi
135 use a different resolution (57816 units per inch) to those produced by
136 \*(tx.
137 Incorrectly written drivers which assume the resolution used by \*(tx,
138 rather than using the resolution specified in the dvi file will not
139 work with grodvi.
141 When using the
142 .B \-d
143 option with boxed tables,
144 vertical and horizontal lines can sometimes protrude by one pixel.
145 This is a consequence of the way \*(tx requires that the heights
146 and widths of rules be rounded.
147 .SH "SEE ALSO"
148 .BR tfmtodit (@MAN1EXT@),
149 .BR groff (@MAN1EXT@),
150 .BR @g@troff (@MAN1EXT@),
151 .BR @g@eqn (@MAN1EXT@),
152 .BR groff_out (@MAN5EXT@),
153 .BR groff_font (@MAN5EXT@),
154 .BR groff_char (@MAN7EXT@)