1GROHTML(1) General Commands Manual GROHTML(1)
2
6 grohtml - HTML driver for groff
7
9 grohtml [-bhlnprVy] [-a aa-text-bits] [-D dir] [-F dir] [-g aa-graphic-
10 bits] [-i resolution] [-I image-stem] [-j filename] [-o image-
11 vertical-offset] [-s size] [-S level] [-x html-dialect] [file
12 ...]
13 grohtml --help
15 grohtml -v
17 grohtml --version
18
20 The grohtml front end (which consists of a preprocessor, pre-grohtml,
21 and a device driver, post-grohtml) translates the output of GNU troff
22 to HTML. Users should always invoke grohtml via the groff command with
23 a -Thtml option. If no files are given, grohtml will read the standard
24 input. A filename of - will also cause grohtml to read the standard
25 input. Html output is written to the standard output. When grohtml is
26 run by groff options can be passed to grohtml using groff's -P option.
27 grohtml invokes groff twice. In the first pass, pictures, equations,
29 and tables are rendered using the ps device, and in the second pass
30 HTML output is generated by the html device.
31 grohtml always writes output in UTF-8 encoding and has built-in enti‐
33 ties for all non-composite unicode characters. In spite of this, groff
34 may issue warnings about unknown special characters if they can't be
35 found during the first pass. Such warnings can be safely ignored un‐
36 less the special characters appear inside a table or equation.
37
39 -aaa-text-bits
40 Number of bits of antialiasing information to be used by text
41 when generating PNG images. The default is 4 but valid values
42 are 0, 1, 2, and 4. Note your version of gs needs to support
43 the -dTextAlphaBits and -dGraphicAlphaBits options in order to
44 exploit antialiasing. A value of 0 stops grohtml from issuing
45 antialiasing commands to gs.
46 -b Initialize the background color to white.
48 -Ddir Inform grohtml to place all image files into directory dir.
50 -e This option should not be directly invoked by the user as it is
52 an internal option utilized by groff when -Thtml or -Txhtml is
53 specified. It is used by the grohtml preprocessor to determine
54 whether eqn should attempt to produce MathML (if -Txhtml is
55 specified).
56 -Fdir Prepend directory dir/devname to the search path for font and
58 device description files; name is the name of the device, usu‐
59 ally html.
60 -gaa-graphic-bits
62 Number of bits of antialiasing information to be used by graph‐
63 ics when generating PNG images. The default is 4 but valid val‐
64 ues are 0, 1, 2, and 4. Note your version of gs needs to sup‐
65 port the -dTextAlphaBits and -dGraphicAlphaBits options in order
66 to exploit antialiasing. A value of 0 stops grohtml from issu‐
67 ing antialiasing commands to gs.
68 -h Generate section and number headings by using <B>...</B> and in‐
70 creasing the font size, rather than using the <Hn>...</Hn> tags.
71 -iresolution
73 Select the resolution for all images. By default this is 100
74 pixels per inch. Example: -i200 indicates 200 pixels per inch.
75 -Istem Determine the image stem name. If omitted grohtml uses
77 grohtml-XXX (XXX is the process ID).
78 -jfilename
80 Inform grohtml to split the HTML output into multiple files.
81 The filename is the stem and specified section headings (default
82 is level one) start a new file, named filename-n.html.
83 -l Turn off the production of automatic section links at the top of
85 the document.
86 -n Generate simple heading anchors whenever a section/number head‐
88 ing is found. Without the option the anchor value is the tex‐
89 tual heading. This can cause problems when a heading contains a
90 ‘?’a on older versions of some browsers (Netscape). This flag
91 is automatically turned on if a heading contains an image.
92 -overtical-offset
94 Specify the vertical offset of images in points.
95 -p Display page rendering progress to stderr. grohtml only dis‐
97 plays a page number when an image is required.
98 -r Turn off the automatic header and footer line (HTML rule).
100 -s size
102 Set the base point size of the source file. Thereafter when
103 this point size is used in the source it will correspond to the
104 HTML base size. Every increase of two points in the source will
105 yield a <big> tag, and conversely when a decrease of two points
106 is seen a <small> tag is emitted.
107 -Slevel
109 When splitting HTML output, split at the heading level (or
110 higher) defined by level.
111 -v Print the version number.
113 -V Create an XHTML or HTML validator button at the bottom of each
115 page of the document.
116 -xdialect
118 Select HTML dialect. Currently, dialect should be either the
119 digit 4 or the letter x which indicates whether grohtml should
120 generate HTML 4 or XHTML, respectively. This option should not
121 be directly invoked by the user as it is an internal option uti‐
122 lized by groff when -Thtml or -Txhtml is specified.
123 -y Produce a right-justified groff signature at the end of the doc‐
125 ument. This is only generated if the -V flag is also specified.
126
128 There are styles called R, I, B, and BI mounted at font positions 1
129 to 4.
130
132 grohtml is dependent upon the PNG utilities (pnmcut, pnmcrop, pnmtopng)
133 and GhostScript (gs). pnmtopng (version 2.37.6 or greater) and pnmcut
134 from the netpbm package (version 9.16 or greater) will work also. It
135 is also dependent upon psselect from the PSUtils package. Images are
136 generated whenever a table, picture, equation or line is encountered.
137
139 grohtml uses temporary files. See the groff(1) man page for details
140 where such files are created.
141
143 GROFF_FONT_PATH
144 A list of directories in which to search for the devname direc‐
145 tory in addition to the default ones. See troff(1) and
146 groff_font(5) for more details.
147 SOURCE_DATE_EPOCH
149 A timestamp (expressed as seconds since the Unix epoch) to use
150 as the creation timestamp in place of the current time.
151
153 Grohtml has been completely redesigned and rewritten. It is still beta
154 code.
155
157 afmtodit(1), groff(1), troff(1), psbb(1), groff_out(5), groff_font(5),
158 groff_char(7)
159groff 1.22.4 19 January 2023 GROHTML(1)