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

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