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

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