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

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 434 lines · 431 code · 3 blank · 0 comment · 0 complexity · ab7af015a81f19ac9bfcb5253245e795 MD5 · raw file

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