/contrib/groff/src/devices/grohtml/grohtml.man

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 293 lines · 290 code · 3 blank · 0 comment · 0 complexity · a90b574a59cce4e70e52c71877bcc8f9 MD5 · raw file

  1. .ig
  2. Copyright (C) 1999-2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
  3. Permission is granted to make and distribute verbatim copies of this
  4. manual provided the copyright notice and this permission notice are
  5. 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. .
  18. .\" Like TP, but if specified indent is more than half
  19. .\" the current line-length - indent, use the default indent.
  20. .de Tp
  21. . ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
  22. . el .TP "\\$1"
  23. ..
  24. .
  25. .
  26. .TH GROHTML @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
  27. .
  28. .
  29. .SH NAME
  30. grohtml \- html driver for groff
  31. .
  32. .
  33. .SH SYNOPSIS
  34. .nr a \n(.j
  35. .ad l
  36. .nr i \n(.i
  37. .in +\w'\fBgrohtml 'u
  38. .ti \niu
  39. .B grohtml
  40. .
  41. .de OP
  42. . ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
  43. . el .RB "[\ " "\\$1" "\ ]"
  44. ..
  45. .
  46. .OP \-bhlnprv
  47. .OP \-a \%aa-text-bits
  48. .OP \-D dir
  49. .OP \-F dir
  50. .OP \-g \%aa-graphic-bits
  51. .OP \-i \%resolution
  52. .OP \-I \%image-stem
  53. .OP \-j \%filename
  54. .OP \-o \%image-vertical-offset
  55. .OP \-s size
  56. .OP \-S level
  57. .RI "[\ " files\|.\|.\|. "\ ]"
  58. .br
  59. .ad \na
  60. .
  61. .
  62. .SH DESCRIPTION
  63. The
  64. .B grohtml
  65. front end (which consists of a preprocessor,
  66. .BR pre-grohtml ,
  67. and a device driver,
  68. .BR post-grohtml )
  69. translates the output of GNU
  70. .B troff
  71. to html.
  72. Users should always invoke
  73. .B grohtml
  74. via the groff command with a
  75. .B \-Thtml
  76. option.
  77. If no files are given,
  78. .B grohtml
  79. will read the standard input.
  80. A filename of
  81. .B \-
  82. will also cause
  83. .B grohtml
  84. to read the standard input.
  85. Html output is written to the standard output.
  86. When
  87. .B grohtml
  88. is run by
  89. .B groff
  90. options can be passed to
  91. .B grohtml
  92. using
  93. .BR groff 's
  94. .B \-P
  95. option.
  96. .
  97. .
  98. .SH OPTIONS
  99. .TP
  100. .BI \-a aa-text-bits
  101. Number of bits of antialiasing information to be used by
  102. .I text
  103. when generating png images.
  104. The default is\~4 but valid values are 0, 1, 2, and\~4.
  105. Note your version of
  106. .B gs
  107. needs to support the
  108. .B \%\-dTextAlphaBits
  109. and
  110. .B \%\-dGraphicAlphaBits
  111. options in order to exploit antialiasing.
  112. A value of\~0 stops
  113. .B grohtml
  114. from issuing antialiasing commands to
  115. .BR gs .
  116. .
  117. .TP
  118. .B \-b
  119. Initialize the background color to white.
  120. .
  121. .TP
  122. .BI \-D dir
  123. Inform
  124. .B grohtml
  125. to place all image files into directory
  126. .IR dir .
  127. .
  128. .TP
  129. .BI \-F dir
  130. Prepend directory
  131. .IB dir /dev name
  132. to the search path for font and device description files;
  133. .I name
  134. is the name of the device, usually
  135. .BR html .
  136. .
  137. .TP
  138. .BI \-g aa-graphic-bits
  139. Number of bits of antialiasing information to be used by
  140. .I graphics
  141. when generating png images.
  142. The default is\~4 but valid values are 0, 1, 2, and\~4.
  143. Note your version of
  144. .B gs
  145. needs to support the
  146. .B \%\-dTextAlphaBits
  147. and
  148. .B \%\-dGraphicAlphaBits
  149. options in order to exploit antialiasing.
  150. A value of\~0 stops
  151. .B grohtml
  152. from issuing antialiasing commands to
  153. .BR gs .
  154. .
  155. .TP
  156. .B \-h
  157. Generate section and number headings by using
  158. .BR <B> .\|.\|. </B>
  159. and increasing the font size, rather than using the
  160. .BI <H n >\c
  161. \&.\|.\|.\c
  162. .BI </H n >
  163. tags.
  164. .
  165. .TP
  166. .BI \-i resolution
  167. Select the resolution for all images.
  168. By default this is 100 pixels per inch.
  169. Example:
  170. .B \-i200
  171. indicates 200 pixels per inch.
  172. .
  173. .TP
  174. .BI \-I stem
  175. Determine the image stem name.
  176. If omitted grohtml uses
  177. .BI \%grohtml- XXX
  178. .RI ( XXX
  179. is the process ID).
  180. .
  181. .TP
  182. .BI \-j filename
  183. Inform
  184. .B grohtml
  185. to split the html output into multiple files.
  186. The
  187. .I filename
  188. is the stem and specified section headings
  189. (default is level one) start a new file, named
  190. .IR filename-n.html .
  191. .
  192. .TP
  193. .B \-l
  194. Turn off the production of automatic section links at the top of the
  195. document.
  196. .
  197. .TP
  198. .B \-n
  199. Generate simple heading anchors whenever a section/number heading is found.
  200. Without the option the anchor value is the textual heading.
  201. This can cause problems when a heading contains a `?' on older versions of
  202. some browsers (Netscape).
  203. This flag is automatically turned on if a heading contains an image.
  204. .
  205. .TP
  206. .BI \-o vertical-offset
  207. Specify the vertical offset of images in points.
  208. .
  209. .TP
  210. .B \-p
  211. Display page rendering progress to stderr.
  212. .B grohtml
  213. only displays a page number when an image is required.
  214. .
  215. .TP
  216. .B \-r
  217. Turn off the automatic header and footer line (html rule).
  218. .
  219. .TP
  220. .B \-s size
  221. Set the base point size of the source file.
  222. Thereafter when this point size is used in the source it will correspond
  223. to the html base size.
  224. Every increase of two points in the source will yield a
  225. .B <big>
  226. tag, and conversely when a decrease of two points is seen a
  227. .B <small>
  228. tag is emitted.
  229. .
  230. .TP
  231. .BI \-S level
  232. When splitting html output,
  233. split at the heading level (or higher) defined by
  234. .IR level .
  235. .
  236. .TP
  237. .B \-v
  238. Print the version number.
  239. .
  240. .
  241. .SH USAGE
  242. There are styles called
  243. .BR R ,
  244. .BR I ,
  245. .BR B ,
  246. and
  247. .B BI
  248. mounted at font positions 1 to\~4.
  249. .
  250. .
  251. .SH DEPENDENCIES
  252. .B grohtml
  253. is dependent upon the png utilities
  254. .RB ( \%pnmcut ,
  255. .BR \%pnmcrop ,
  256. .BR \%pnmtopng )
  257. and GhostScript
  258. .RB ( gs ).
  259. .B \%pnmtopng
  260. (version 2.37.6 or greater)
  261. and
  262. .B \%pnmcut
  263. from the netpbm package (version 9.16 or greater) will work also.
  264. It is also dependent upon
  265. .B \%psselect
  266. from the
  267. .B PSUtils
  268. package.
  269. Images are generated whenever a table, picture, equation or line is
  270. encountered.
  271. .
  272. .
  273. .SH BUGS
  274. .B Grohtml
  275. has been completely redesigned and rewritten.
  276. It is still beta code.
  277. .
  278. .
  279. .SH "SEE ALSO"
  280. .BR afmtodit (@MAN1EXT@),
  281. .BR groff (@MAN1EXT@),
  282. .BR @g@troff (@MAN1EXT@),
  283. .BR psbb (@MAN1EXT@),
  284. .BR groff_out (@MAN5EXT@),
  285. .BR groff_font (@MAN5EXT@),
  286. .BR groff_char (@MAN7EXT@)
  287. .
  288. .\" Local Variables:
  289. .\" mode: nroff
  290. .\" End: