1GROHTML(1) General Commands Manual GROHTML(1)
2
6 grohtml - html driver for groff
7
9 grohtml [ -bhlnprv ] [ -aaa-text-bits ] [ -Ddir ] [ -Fdir ]
10 [ -gaa-graphic-bits ] [ -iresolution ] [ -Iimage-stem ]
11 [ -jfilename ] [ -oimage-vertical-offset ] [ -ssize ]
12 [ -Slevel ] [ -xhtml-dialect ] [ files... ]
13
15 The grohtml front end (which consists of a preprocessor, pre-grohtml,
16 and a device driver, post-grohtml) translates the output of GNU troff
17 to html. Users should always invoke grohtml via the groff command with
18 a -Thtml option. If no files are given, grohtml will read the standard
19 input. A filename of - will also cause grohtml to read the standard
20 input. Html output is written to the standard output. When grohtml is
21 run by groff options can be passed to grohtml using groff's -P option.
22 grohtml invokes groff twice. In the first pass, pictures, equations,
24 and tables are rendered using the ps device, and in the second pass
25 HTML output is generated by the html device.
26 grohtml always writes output in UTF-8 encoding and has built-in enti‐
28 ties for all non-composite unicode characters. In spite of this, groff
29 may issue warnings about unknown special characters if they can't be
30 found during the first pass. Such warnings can be safely ignored
31 unless the special characters appear inside a table or equation.
32
34 -aaa-text-bits
35 Number of bits of antialiasing information to be used by text
36 when generating png images. The default is 4 but valid values
37 are 0, 1, 2, and 4. Note your version of gs needs to support
38 the -dTextAlphaBits and -dGraphicAlphaBits options in order to
39 exploit antialiasing. A value of 0 stops grohtml from issuing
40 antialiasing commands to gs.
41 -b Initialize the background color to white.
43 -Ddir Inform grohtml to place all image files into directory dir.
45 -e This option should not be directly invoked by the user as it is
47 an internal option utilized by groff when -Thtml or -Txhtml is
48 specified. It is used by the grohtml preprocessor to determine
49 whether eqn should attempt to produce MathML (if -Txhtml is
50 specified).
51 -Fdir Prepend directory dir/devname to the search path for font and
53 device description files; name is the name of the device, usu‐
54 ally html.
55 -gaa-graphic-bits
57 Number of bits of antialiasing information to be used by graph‐
58 ics when generating png images. The default is 4 but valid val‐
59 ues are 0, 1, 2, and 4. Note your version of gs needs to sup‐
60 port the -dTextAlphaBits and -dGraphicAlphaBits options in order
61 to exploit antialiasing. A value of 0 stops grohtml from issu‐
62 ing antialiasing commands to gs.
63 -h Generate section and number headings by using <B>...</B> and
65 increasing the font size, rather than using the <Hn>...</Hn>
66 tags.
67 -iresolution
69 Select the resolution for all images. By default this is 100
70 pixels per inch. Example: -i200 indicates 200 pixels per inch.
71 -Istem Determine the image stem name. If omitted grohtml uses
73 grohtml-XXX (XXX is the process ID).
74 -jfilename
76 Inform grohtml to split the html output into multiple files.
77 The filename is the stem and specified section headings (default
78 is level one) start a new file, named filename-n.html.
79 -l Turn off the production of automatic section links at the top of
81 the document.
82 -n Generate simple heading anchors whenever a section/number head‐
84 ing is found. Without the option the anchor value is the tex‐
85 tual heading. This can cause problems when a heading contains a
86 ‘?’ on older versions of some browsers (Netscape). This flag is
87 automatically turned on if a heading contains an image.
88 -overtical-offset
90 Specify the vertical offset of images in points.
91 -p Display page rendering progress to stderr. grohtml only dis‐
93 plays a page number when an image is required.
94 -r Turn off the automatic header and footer line (html rule).
96 -s size
98 Set the base point size of the source file. Thereafter when
99 this point size is used in the source it will correspond to the
100 html base size. Every increase of two points in the source will
101 yield a <big> tag, and conversely when a decrease of two points
102 is seen a <small> tag is emitted.
103 -Slevel
105 When splitting html output, split at the heading level (or
106 higher) defined by level.
107 -v Print the version number.
109 -V Create an XHTML or HTML validator button at the bottom of each
111 page of the document.
112 -xdialect
114 Select HTML dialect. Currently, dialect should be either the
115 digit 4 or the letter x which indicates whether grohtml should
116 generate HTML 4 or XHTML, respectively. This option should not
117 be directly invoked by the user as it is an internal option uti‐
118 lized by groff when -Thtml or -Txhtml is specified.
119 -y Produce a right-justified groff signature at the end of the doc‐
121 ument. This is only generated if the -V flag is also specified.
122
124 There are styles called R, I, B, and BI mounted at font positions 1
125 to 4.
126
128 grohtml is dependent upon the png utilities (pnmcut, pnmcrop, pnmtopng)
129 and GhostScript (gs). pnmtopng (version 2.37.6 or greater) and pnmcut
130 from the netpbm package (version 9.16 or greater) will work also. It
131 is also dependent upon psselect from the PSUtils package. Images are
132 generated whenever a table, picture, equation or line is encountered.
133
135 grohtml uses temporary files. See the groff(1) man page for details
136 where such files are created.
137
139 GROFF_FONT_PATH
140 A list of directories in which to search for the devname direc‐
141 tory in addition to the default ones. See troff(1) and
142 groff_font(5) for more details.
143
145 Grohtml has been completely redesigned and rewritten. It is still beta
146 code.
147
149 afmtodit(1), groff(1), troff(1), psbb(1), groff_out(5), groff_font(5),
150 groff_char(7)
151
153 Copyright © 1999-2014 Free Software Foundation, Inc.
154 Permission is granted to make and distribute verbatim copies of this
156 manual provided the copyright notice and this permission notice are
157 preserved on all copies.
158 Permission is granted to copy and distribute modified versions of this
160 manual under the conditions for verbatim copying, provided that the
161 entire resulting derived work is distributed under the terms of a per‐
162 mission notice identical to this one.
163 Permission is granted to copy and distribute translations of this man‐
165 ual into another language, under the above conditions for modified ver‐
166 sions, except that this permission notice may be included in transla‐
167 tions approved by the Free Software Foundation instead of in the origi‐
168 nal English.
169Groff Version 1.22.3 4 November 2014 GROHTML(1)