| blob | d8693e37a5de5c1c162b08357325c8d9d7dcd9b5 |
1 .ig
2 Copyright (C) 1999-2000, 2001, 2002 Free Software Foundation, Inc.
4 Permission is granted to make and distribute verbatim copies of this
5 manual provided the copyright notice and this permission notice are
6 preserved on all copies.
8 Permission is granted to copy and distribute modified versions of this
9 manual under the conditions for verbatim copying, provided that the
10 entire resulting derived work is distributed under the terms of a
11 permission notice identical to this one.
13 Permission is granted to copy and distribute translations of this
14 manual into another language, under the above conditions for modified
15 versions, except that this permission notice may be included in
16 translations approved by the Free Software Foundation instead of in
17 the original English.
18 ..
19 .\" Like TP, but if specified indent is more than half
20 .\" the current line-length - indent, use the default indent.
21 .de Tp
22 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
23 .el .TP "\\$1"
24 ..
25 .TH GROHTML @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
26 .SH NAME
27 grohtml \- html driver for groff
28 .SH SYNOPSIS
29 .nr a \n(.j
30 .ad l
31 .nr i \n(.i
32 .in +\w'\fBgrohtml 'u
33 .ti \niu
34 .B grohtml
35 .de OP
36 .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
37 .el .RB "[\ " "\\$1" "\ ]"
38 ..
39 .OP \-vhlrn
40 .OP \-D dir
41 .OP \-F dir
42 .OP \-i resolution
43 .OP \-I image-stem
44 .OP \-o image-vertical-offset
45 .OP \-a aa-text-bits
46 .OP \-a aa-graphic-bits
47 .RI "[\ " files\|.\|.\|. "\ ]"
48 .br
49 .ad \na
50 .SH DESCRIPTION
51 The
52 .B grohtml
53 front end (which consists of a preprocessor,
54 .BR pre-grohtml ,
55 and a device driver,
56 .BR post-grohtml )
57 translates the output of GNU
58 .B troff
59 to html.
60 Users should always invoke
61 .B grohtml
62 via the groff command with a
63 .B \-Thtml
64 option.
65 If no files are given,
66 .B grohtml
67 will read the standard input.
68 A filename of
69 .B \-
70 will also cause
71 .B grohtml
72 to read the standard input.
73 Html output is written to the standard output.
74 When
75 .B grohtml
76 is run by
77 .B groff
78 options can be passed to
79 .B grohtml
80 using
81 .BR groff 's
82 .B \-P
83 option.
84 .SH OPTIONS
85 .TP
86 .BI \-a aa-text-bits
87 Number of bits of antialiasing information to be used by
88 .I text
89 when generating png images.
90 The default is\~4 but legal values are 0, 1, 2, and\~4.
91 Note your version of
92 .B gs
93 needs to support the
94 .B \%\-dTextAlphaBits
95 and
96 .B \%\-dGraphicAlphaBits
97 options in order to exploit antialiasing.
98 A value of\~0 stops
99 .B grohtml
100 from issuing antialiasing commands to
101 .BR gs .
102 .TP
103 .BI \-g aa-graphic-bits
104 Number of bits of antialiasing information to be used by
105 .I graphics
106 when generating png images.
107 The default is\~4 but legal values are 0, 1, 2, and\~4.
108 Note your version of
109 .B gs
110 needs to support the
111 .B \%\-dTextAlphaBits
112 and
113 .B \%\-dGraphicAlphaBits
114 options in order to exploit antialiasing.
115 A value of\~0 stops
116 .B grohtml
117 from issuing antialiasing commands to
118 .BR gs .
119 .TP
120 .B -b
121 Initialize the background color to white.
122 .TP
123 .B -h
124 Generates section and number headings by using
125 .BR <B> .\|.\|. </B>
126 and increasing the font size, rather than using the
127 .BI <H n >\c
128 \&.\|.\|.\c
129 .BI </H n >
130 tags.
131 .TP
132 .B -l
133 Turns off the production of automatic section links at the top of the document.
134 .TP
135 .B -r
136 Turns off the automatic header and footer line (html rule).
137 .TP
138 .B -n
139 Generate simple heading anchors whenever a section/number heading is found.
140 Without the option the anchor value is the textual heading.
141 This can cause problems when a heading contains a `?' on some browsers
142 (netscape).
143 This flag is automatically turned on if a heading contains an image.
144 .TP
145 .B -p
146 Display page rendering progress to stderr.
147 .B grohtml
148 only displays a page number when an image is required.
149 .TP
150 .BI \-F dir
151 Prepend directory
152 .IB dir /dev name
153 to the search path for font and device description files;
154 .I name
155 is the name of the device, usually
156 .BR html .
157 .TP
158 .BI \-i resolution
159 Select the resolution for all images.
160 By default this is 100 pixels per inch.
161 Example: -i200 indicates 200 pixels per inch.
162 .TP
163 .BI \-I stem
164 Determine the image stem name.
165 If omitted grohtml uses
166 .BI grohtml- XXX
167 .RI ( XXX
168 is the process ID).
169 .TP
170 .BI \-o vertical-offset
171 Specify the vertical offset of images in points.
172 .TP
173 .BI \-D dir
174 Inform
175 .B grohtml
176 to place all image files into directory
177 .IR dir .
178 .TP
179 .B \-v
180 Print the version number.
181 .
182 .SH USAGE
183 There are styles called
184 .BR R ,
185 .BR I ,
186 .BR B ,
187 and
188 .B BI
189 mounted at font positions 1 to 4.
190 .SH DEPENDENCIES
191 .B grohtml
192 is dependent upon the png utilities
193 .RB ( \&\%pnmcut ,\ \%pnmcrop ,\ \%pnmtopng )
194 and GhostScript
195 .RB ( gs ).
196 .B \%pnmtopng
197 (version 2.37.6 or greater)
198 and
199 .B \%pnmcut
200 from the netpbm package (version 9.16 or greater) will work also.
201 It is also dependent upon
202 .B \%psselect
203 from the
204 .B PSUtils
205 package.
206 Images are generated whenever a table, picture, equation or line is
207 encountered.
208 .SH BUGS
209 .B Grohtml
210 has been completely redesigned and rewritten.
211 It is still alpha code.
212 .SH "SEE ALSO"
213 .BR afmtodit (@MAN1EXT@),
214 .BR groff (@MAN1EXT@),
215 .BR @g@troff (@MAN1EXT@),
216 .BR psbb (@MAN1EXT@),
217 .BR groff_out (@MAN5EXT@),
218 .BR groff_font (@MAN5EXT@),
219 .BR groff_char (@MAN7EXT@)
220 .
221 .\" Local Variables:
222 .\" mode: nroff
223 .\" End: