/contrib/groff/src/devices/grodvi/grodvi.man

  1.ig
  2Copyright (C) 1989-2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
  3
  4Permission is granted to make and distribute verbatim copies of
  5this manual provided the copyright notice and this permission notice
  6are preserved on all copies.
  7
  8Permission is granted to copy and distribute modified versions of this
  9manual 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.
 20.do nr grodvi_C \n[.C]
 21.cp 0
 22.
 23.ie t .ds tx T\h'-.1667m'\v'.224m'E\v'-.224m'\h'-.125m'X
 24.el .ds tx TeX
 25.
 26.\" Like TP, but if specified indent is more than half
 27.\" the current line-length - indent, use the default indent.
 28.de Tp
 29.  ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
 30.  el .TP "\\$1"
 31..
 32.
 33.de TQ
 34.  br
 35.  ns
 36.  TP \$1
 37..
 38.
 39.de FT
 40.  if '\\*(.T'dvi' .ft \\$1
 41..
 42.
 43.
 44.TH GRODVI @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
 45.SH NAME
 46grodvi \- convert groff output to TeX dvi format
 47.
 48.
 49.SH SYNOPSIS
 50.B grodvi
 51[
 52.B \-dlv
 53] [
 54.BI \-F dir
 55] [
 56.BI \-p papersize
 57] [
 58.BI \-w n
 59] [
 60.IR files \|.\|.\|.\&
 61]
 62.PP
 63It is possible to have whitespace between a command line option and its
 64parameter.
 65.
 66.
 67.SH DESCRIPTION
 68.B grodvi
 69is a driver for
 70.B groff
 71that produces \*(tx dvi format.
 72.
 73Normally it should be run by
 74.BR groff\ \-Tdvi .
 75.
 76This will run
 77.BR @g@troff\ \-Tdvi ;
 78it will also input the macros in
 79.BR @MACRODIR@/dvi.tmac .
 80.
 81.LP
 82The dvi file generated by
 83.B grodvi
 84can be printed by any correctly-written dvi driver.
 85.
 86The troff drawing primitives are implemented
 87using the tpic version\~2 specials.
 88.
 89If the driver does not support these, the
 90.B \[rs]D
 91commands will not produce any output.
 92.
 93.LP
 94There is an additional drawing command available:
 95.
 96.TP
 97.BI \[rs]D'R\  dh\ dv '
 98Draw a rule (solid black rectangle), with one corner
 99at the current position, and the diagonally opposite corner
100at the current position
101.RI +( dh , dv ).
102.
103Afterwards the current position will be at the opposite corner.
104.
105This produces a rule in the dvi file and so can be printed even with a
106driver that does not support the tpic specials unlike the other
107.B \[rs]D
108commands.
109.
110.LP
111The groff command
112.BI \[rs]X' anything '
113is translated into the same command in the dvi file as would be
114produced by
115.BI \[rs]special{ anything }
116in \*(tx;
117.I anything
118may not contain a newline.
119.
120.LP
121For inclusion of EPS image files,
122.B \-Tdvi
123loads
124.B pspic.tmac
125automatically, providing the
126.B PSPIC
127macro.
128.
129Please check
130.BR groff_tmac (@MAN5EXT@)
131for a detailed description.
132.
133.LP
134Font files for
135.B grodvi
136can be created from tfm files using
137.BR tfmtodit (@MAN1EXT@).
138.
139The font description file should contain the following
140additional commands:
141.
142.Tp \w'\fBinternalname'u+2n
143.BI internalname\   name
144The name of the tfm file (without the
145.B .tfm
146extension) is
147.IR name .
148.
149.TP
150.BI checksum\  n
151The checksum in the tfm file is
152.IR n .
153.
154.TP
155.BI designsize\  n
156The designsize in the tfm file is
157.IR n .
158.
159.LP
160These are automatically generated by
161.B tfmtodit.
162.
163.LP
164The default color for
165.B \[rs]m
166and
167.B \[rs]M
168is black.
169.
170Currently, the drawing color for
171.B \[rs]D
172commands is always black, and fill color values are translated to gray.
173.
174.LP
175In
176.B troff
177the
178.B \[rs]N
179escape sequence can be used to access characters by their position
180in the corresponding tfm file;
181all characters in the tfm file can be accessed this way.
182.
183.LP
184By design, the DVI format doesn't care about physical dimensions of the
185output medium.
186.
187Instead,
188.B grodvi
189emits the equivalent to \*(tx's
190.BI \[rs]special{papersize= width , length }
191on the first page;
192.B dvips
193(and possibly other DVI drivers) then sets the page size accordingly.
194.
195If either the page width or length is not positive, no papersize special
196is output.
197.
198.
199.SH OPTIONS
200.TP
201.B \-d
202Do not use tpic specials to implement drawing commands.
203.
204Horizontal and vertical lines will be implemented by rules.
205.
206Other drawing commands will be ignored.
207.
208.TP
209.BI \-F dir
210Prepend directory
211.IB dir /dev name
212to the search path for font and device description files;
213.I name
214is the name of the device, usually
215.BR dvi .
216.
217.TP
218.B \-l
219Specify landscape orientation.
220.
221.TP
222.BI \-p papersize
223Specify paper dimensions.
224.
225This overrides the
226.BR papersize ,
227.BR paperlength ,
228and
229.B paperwidth
230commands in the
231.B DESC
232file; it accepts the same arguments as the
233.B papersize
234command (see
235.BR groff_font (@MAN5EXT@)
236for details).
237.
238.TP
239.B \-v
240Print the version number.
241.
242.TP
243.BI \-w n
244Set the default line thickness to
245.I n
246thousandths of an em.
247If this option isn't specified, the line thickness defaults to 0.04\~em.
248.
249.
250.SH USAGE
251There are styles called
252.BR R ,
253.BR I ,
254.BR B ,
255and
256.B BI
257mounted at font positions 1 to\ 4.
258The fonts are grouped into families
259.B T
260and
261.B H\ \c
262having members in each of these styles:
263.
264.RS
265.TP
266.B TR
267.FT TR
268CM Roman (cmr10)
269.FT
270.
271.TQ
272.B TI
273.FT TI
274CM Text Italic (cmti10)
275.FT
276.
277.TQ
278.B TB
279.FT TB
280CM Bold Extended Roman (cmbx10)
281.FT
282.
283.TQ
284.B TBI
285.FT TBI
286CM Bold Extended Text Italic (cmbxti10)
287.FT
288.
289.TQ
290.B HR
291.FT HR
292CM Sans Serif (cmss10)
293.FT
294.
295.TQ
296.B HI
297.FT HI
298CM Slanted Sans Serif (cmssi10)
299.FT
300.
301.TQ
302.B HB
303.FT HB
304CM Sans Serif Bold Extended (cmssbx10)
305.FT
306.
307.TQ
308.B HBI
309.FT HBI
310CM Slanted Sans Serif Bold Extended (cmssbxo10)
311.FT
312.RE
313.
314.LP
315There are also the following fonts which are not members of a family:
316.
317.RS
318.TP
319.B CW
320CM Typewriter Text (cmtt10)
321.FT CW
322.FT
323.
324.TQ
325.B CWI
326CM Italic Typewriter Text (cmitt10)
327.FT CWI
328.FT
329.RE
330.
331.LP
332Special fonts are
333.B MI
334(cmmi10),
335.B S
336(cmsy10),
337.B EX
338(cmex10),
339.B SC
340(cmtex10, only for
341.BR CW ),
342and, perhaps surprisingly,
343.BR TR ,
344.BR TI ,
345and
346.BR CW ,
347due to the different font encodings of text fonts.
348.
349For italic fonts,
350.B CWI
351is used instead of
352.BR CW .
353.
354.LP
355Finally, the symbol fonts of the American Mathematical Society are available
356as special fonts
357.B SA
358(msam10) and
359.B SB
360(msbm10).
361.
362These two fonts are not mounted by default.
363.
364.LP
365Using the option
366.B \-mec
367(which loads the file
368.BR ec.tmac )
369provides the EC and TC fonts.
370.
371The design of the EC family is very similar to that of the CM fonts;
372additionally, they give a much better coverage of groff symbols.
373.
374Note that
375.B ec.tmac
376must be called before any language-specific files; it doesn't take care of
377hcode values.
378.
379.
380.SH FILES
381.TP
382.B @FONTDIR@/devdvi/DESC
383Device description file.
384.
385.TP
386.BI @FONTDIR@/devdvi/ F
387Font description file for font
388.IR F .
389.
390.TP
391.B @MACRODIR@/dvi.tmac
392Macros for use with
393.BR grodvi .
394.
395.TP
396.B @MACRODIR@/ec.tmac
397Macros to switch to EC fonts.
398.
399.
400.SH BUGS
401Dvi files produced by
402.B grodvi
403use a different resolution (57816 units per inch) to those produced by
404\*(tx.
405.
406Incorrectly written drivers which assume the resolution used by \*(tx,
407rather than using the resolution specified in the dvi file will not
408work with
409.BR grodvi .
410.
411.LP
412When using the
413.B \-d
414option with boxed tables,
415vertical and horizontal lines can sometimes protrude by one pixel.
416.
417This is a consequence of the way \*(tx requires that the heights
418and widths of rules be rounded.
419.
420.
421.SH "SEE ALSO"
422.BR tfmtodit (@MAN1EXT@),
423.BR groff (@MAN1EXT@),
424.BR @g@troff (@MAN1EXT@),
425.BR groff_out (@MAN5EXT@),
426.BR groff_font (@MAN5EXT@),
427.BR groff_char (@MAN7EXT@),
428.BR groff_tmac (@MAN5EXT@)
429.
430.cp \n[grodvi_C]
431.
432.\" Local Variables:
433.\" mode: nroff
434.\" End: