contrib/groff/grodvi/grodvi.man

   1 .ig \"-*- nroff -*-
   2 Copyright (C) 1989-1995 Free Software Foundation, Inc.
   3
   4 Permission is granted to make and distribute verbatim copies of
   5 this manual provided the copyright notice and this permission notice
   6 are preserved on all copies.
   7
   8 Permission is granted to copy and distribute modified versions of this
   9 manual under the conditions for verbatim copying, provided that the
  10 entire resulting derived work is distributed under the terms of a
  11 permission notice identical to this one.
  12
  13 Permission is granted to copy and distribute translations of this
  14 manual into another language, under the above conditions for modified
  15 versions, except that this permission notice may be included in
  16 translations approved by the Free Software Foundation instead of in
  17 the 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
  29 grodvi \- 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 .SH DESCRIPTION
  42 .B grodvi
  43 is a driver for
  44 .B groff
  45 that produces \*(tx dvi format.
  46 Normally it should be run by
  47 .BR groff\ \-Tdvi .
  48 This will run
  49 .BR @g@troff\ \-Tdvi ;
  50 it will also input the macros
  51 .BR @MACRODIR@/tmac.dvi ;
  52 if the input is being preprocessed with
  53 .B @g@eqn
  54 it will also input
  55 .BR @FONTDIR@/devdvi/eqnchar .
  56 .LP
  57 The dvi file generated by
  58 .B grodvi
  59 can be printed by any correctly-written dvi driver.
  60 The troff drawing primitives are implemented
  61 using the tpic version 2 specials.
  62 If the driver does not support these, the
  63 .B \eD
  64 commands will not produce any output.
  65 .LP
  66 There is an additional drawing command available:
  67 .TP
  68 .BI \eD'R\  dh\ dv '
  69 Draw a rule (solid black rectangle), with one corner
  70 at the current position, and the diagonally opposite corner
  71 at the current position
  72 .RI +( dh , dv ).
  73 Afterwards the current position will be at the opposite corner.  This
  74 produces a rule in the dvi file and so can be printed even with a
  75 driver that does not support the tpic specials unlike the other
  76 .B \eD
  77 commands.
  78 .LP
  79 The groff command
  80 .BI \eX' anything '
  81 is translated into the same command in the dvi file as would be
  82 produced by
  83 .BI \especial{ anything }
  84 in \*(tx;
  85 .I anything may not contain a newline.
  86 .LP
  87 Font files for
  88 .B grodvi
  89 can be created from tfm files using
  90 .BR tfmtodit (@MAN1EXT@).
  91 The font description file should contain the following
  92 additional commands:
  93 .Tp \w'\fBinternalname'u+2n
  94 .BI internalname\   name
  95 The name of the tfm file (without the
  96 .B .tfm
  97 extension) is
  98 .IR name .
  99 .TP
 100 .BI checksum\  n
 101 The checksum in the tfm file is
 102 .IR n .
 103 .TP
 104 .BI designsize\  n
 105 The designsize in the tfm file is
 106 .IR n .
 107 .LP
 108 These are automatically generated by
 109 .B tfmtodit.
 110 .LP
 111 In
 112 .B troff
 113 the
 114 .B \eN
 115 escape sequence can be used to access characters by their position
 116 in the corresponding tfm file;
 117 all characters in the tfm file can be accessed this way.
 118 .SH OPTIONS
 119 .TP
 120 .B \-d
 121 Do not use tpic specials to implement drawing commands.
 122 Horizontal and vertical lines will be implemented by rules.
 123 Other drawing commands will be ignored.
 124 .TP
 125 .B \-v
 126 Print the version number.
 127 .TP
 128 .BI \-w n
 129 Set the default line thickness to
 130 .I n
 131 thousandths of an em.
 132 .TP
 133 .BI \-F dir
 134 Search directory
 135 .IB dir /devdvi
 136 for font and device description files.
 137 .SH FILES
 138 .TP
 139 .B @FONTDIR@/devdvi/DESC
 140 Device description file.
 141 .TP
 142 .B @FONTDIR@/devdvi/ F
 143 Font description file for font
 144 .IR F .
 145 .TP
 146 .B @MACRODIR@/tmac.dvi
 147 Macros for use with
 148 .BR grodvi .
 149 .SH BUGS
 150 Dvi files produced by
 151 .B grodvi
 152 use a different resolution (57816 units per inch) to those produced by
 153 \*(tx.
 154 Incorrectly written drivers which assume the resolution used by \*(tx,
 155 rather than using the resolution specified in the dvi file will not
 156 work with grodvi.
 157 .LP
 158 When using the
 159 .B \-d
 160 option with boxed tables,
 161 vertical and horizontal lines can sometimes protrude by one pixel.
 162 This is a consequence of the way \*(tx requires that the heights
 163 and widths of rules be rounded.
 164 .SH "SEE ALSO"
 165 .BR tfmtodit (@MAN1EXT@),
 166 .BR groff (@MAN1EXT@),
 167 .BR @g@troff (@MAN1EXT@),
 168 .BR @g@eqn (@MAN1EXT@),
 169 .BR groff_out (@MAN5EXT@),
 170 .BR groff_font (@MAN5EXT@),
 171 .BR groff_char (@MAN7EXT@)