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

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