| blob | 7b10427abf8b867398ff6b9daebbcf611a23c8c9 |
1 .ig
2 @ @L_D_HTML@.1
4 Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
6 Copyright (C) 1999 - 2004, 2006 - 2007
7 Free Software Foundation, Inc.
9 Permission is granted to make and distribute verbatim copies of this
10 manual provided the copyright notice and this permission notice are
11 preserved on all copies.
13 Permission is granted to copy and distribute modified versions of this
14 manual under the conditions for verbatim copying, provided that the
15 entire resulting derived work is distributed under the terms of a
16 permission notice identical to this one.
18 Permission is granted to copy and distribute translations of this
19 manual into another language, under the above conditions for modified
20 versions, except that this permission notice may be included in
21 translations approved by the Free Software Foundation instead of in
22 the original English.
23 ..
24 .
25 .
26 .\" Like TP, but if specified indent is more than half
27 .\" the current line-length - indent, use the default indent.
28 .de Tp
29 . ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
30 . el .TP "\\$1"
31 ..
32 .
33 .
34 .TH @U_D_HTML@ @MAN1EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@"
35 .
36 .
37 .SH NAME
38 @L_D_HTML@ \- html driver for @T_ROFF@
39 .
40 .
41 .SH SYNOPSIS
42 .nr a \n(.j
43 .ad l
44 .nr i \n(.i
45 .in +\w'\fB@L_D_HTML@ 'u
46 .ti \niu
47 .B @L_D_HTML@
48 .
49 .de OP
50 . ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
51 . el .RB "[\ " "\\$1" "\ ]"
52 ..
53 .
54 .OP \-bhlnprv
55 .OP \-a \%aa-text-bits
56 .OP \-D dir
57 .OP \-F dir
58 .OP \-g \%aa-graphic-bits
59 .OP \-i \%resolution
60 .OP \-I \%image-stem
61 .OP \-j \%filename
62 .OP \-o \%image-vertical-offset
63 .OP \-s size
64 .OP \-S level
65 .OP \-x \%html-dialect
66 .RI "[\ " files\|.\|.\|. "\ ]"
67 .br
68 .ad \na
69 .
70 .
71 .SH DESCRIPTION
72 The
73 .B @L_D_HTML@
74 front end (which consists of a preprocessor,
75 .BR @L_D_PREHTML@ ,
76 and a device driver,
77 .BR @L_D_POSTHTML@ )
78 translates the output of @L_TROFF@ to html.
79 Users should always invoke
80 .B @L_D_HTML@
81 via the @L_ROFF@ command with a
82 .B \-Thtml
83 option.
84 If no files are given,
85 .B @L_D_HTML@
86 will read the standard input.
87 A filename of
88 .B \-
89 will also cause usage of the standard input.
90 Html output is written to the standard output.
91 When run via
92 .B @L_ROFF@
93 options can be passed to using
94 .BR @L_ROFF@ 's
95 .B \-P
96 option.
97 .
98 .
99 .SH OPTIONS
100 .TP
101 .BI \-a aa-text-bits
102 Number of bits of antialiasing information to be used by
103 .I text
104 when generating png images.
105 The default is\~4 but valid values are 0, 1, 2, and\~4.
106 Note your version of
107 .B gs
108 needs to support the
109 .B \%\-dTextAlphaBits
110 and
111 .B \%\-dGraphicAlphaBits
112 options in order to exploit antialiasing.
113 A value of\~0 stops issuing antialiasing commands to
114 .BR gs .
115 .
116 .TP
117 .B \-b
118 Initialize the background color to white.
119 .
120 .TP
121 .BI \-D dir
122 Place all image files into directory
123 .IR dir .
124 .
125 .TP
126 .B \-e
127 This option should not be directly invoked by the user as it is
128 an internal option utilized by
129 .B @L_ROFF@
130 when
131 .B \-Thtml
132 or
133 .B \-Txhtml
134 is specified.
135 It is used by the
136 .B @L_DHTML@
137 preprocessor to determine whether
138 .B eqn
139 should attempt to produce MathML (if
140 .B \-Txhtml
141 is specified).
142 .
143 .TP
144 .BI \-F dir
145 Prepend directory
146 .IB dir /dev name
147 to the search path for font and device description files;
148 .I name
149 is the name of the device, usually
150 .BR html .
151 .
152 .TP
153 .BI \-g aa-graphic-bits
154 Number of bits of antialiasing information to be used by
155 .I graphics
156 when generating png images.
157 The default is\~4 but valid values are 0, 1, 2, and\~4.
158 Note your version of
159 .B gs
160 needs to support the
161 .B \%\-dTextAlphaBits
162 and
163 .B \%\-dGraphicAlphaBits
164 options in order to exploit antialiasing.
165 Stop issuing antialiasing commands to
166 .BR gs .
167 .
168 .TP
169 .B \-h
170 Generate section and number headings by using
171 .BR <B> .\|.\|. </B>
172 and increasing the font size, rather than using the
173 .BI <H n >\c
174 \&.\|.\|.\c
175 .BI </H n >
176 tags.
177 .
178 .TP
179 .BI \-i resolution
180 Select the resolution for all images.
181 By default this is 100 pixels per inch.
182 Example:
183 .B \-i200
184 indicates 200 pixels per inch.
185 .
186 .TP
187 .BI \-I stem
188 Determine the image stem name.
189 If omitted @L_D_HTML@ uses
190 .BI \%@L_D_HTML@ - XXX
191 .RI ( XXX
192 is the process ID).
193 .
194 .TP
195 .BI \-j filename
196 Split the html output into multiple files.
197 The
198 .I filename
199 is the stem and specified section headings
200 (default is level one) start a new file, named
201 .IR filename-n.html .
202 .
203 .TP
204 .B \-l
205 Turn off the production of automatic section links at the top of the
206 document.
207 .
208 .TP
209 .B \-n
210 Generate simple heading anchors whenever a section/number heading is found.
211 Without the option the anchor value is the textual heading.
212 This can cause problems when a heading contains a `?' on older versions of
213 some browsers (Netscape).
214 This flag is automatically turned on if a heading contains an image.
215 .
216 .TP
217 .BI \-o vertical-offset
218 Specify the vertical offset of images in points.
219 .
220 .TP
221 .B \-p
222 Display page rendering progress to stderr.
223 Only a page number is displayed when an image is required.
224 .
225 .TP
226 .B \-r
227 Turn off the automatic header and footer line (html rule).
228 .
229 .TP
230 .B \-s size
231 Set the base point size of the source file.
232 Thereafter when this point size is used in the source it will correspond
233 to the html base size.
234 Every increase of two points in the source will yield a
235 .B <big>
236 tag, and conversely when a decrease of two points is seen a
237 .B <small>
238 tag is emitted.
239 .
240 .TP
241 .BI \-S level
242 When splitting html output,
243 split at the heading level (or higher) defined by
244 .IR level .
245 .
246 .TP
247 .B \-v
248 Print the version number.
249 .
250 .TP
251 .B \-V
252 Create an XHTML or HTML validator button at the bottom of each page of
253 the document.
254 .
255 .TP
256 .BI \-x dialect
257 Select HTML dialect.
258 Currently,
259 .I dialect
260 should be either the digit\~\c
261 .B 4
262 or the letter\~\c
263 .B x
264 which indicates whether
265 HTML\~4 or XHTML, respectively, is to be generated.
266 This option should not be directly invoked by the user as it is
267 an internal option utilized by
268 .B @L_ROFF@
269 when
270 .B \-Thtml
271 or
272 .B \-Txhtml
273 is specified.
274 .
275 .TP
276 .B \-y
277 Produce a right-justified @L_ROFF@ signature at the end of the document.
278 This is only generated if the
279 .B \-V
280 flag is also specified.
281 .
282 .
283 .SH USAGE
284 There are styles called
285 .BR R ,
286 .BR I ,
287 .BR B ,
288 and
289 .B BI
290 mounted at font positions 1 to\~4.
291 .
292 .
293 .SH DEPENDENCIES
294 .B @L_D_HTML@
295 depends upon the png utilities
296 .RB ( \%pnmcut ,
297 .BR \%pnmcrop ,
298 .BR \%pnmtopng )
299 and GhostScript
300 .RB ( gs ).
301 .B \%pnmtopng
302 (version 2.37.6 or greater)
303 and
304 .B \%pnmcut
305 from the netpbm package (version 9.16 or greater) will work also.
306 It is also dependent upon
307 .B \%psselect
308 from the
309 .B PSUtils
310 package.
311 Images are generated whenever a table, picture, equation or line is
312 encountered.
313 .
314 .
315 .SH ENVIRONMENT
316 .TP
317 .SM
318 .B @U_ROFF@_FONT_PATH
319 A list of directories in which to search for the
320 .BI dev name
321 directory in addition to the default ones.
322 .
323 See
324 .BR @L_TROFF@ (@MAN1EXT@)
325 and
326 .BR \%@L_ROFF@-font (@MAN5EXT@)
327 for more details.
328 .
329 .
330 .SH "SEE ALSO"
331 .BR @L_AFMTODIT@ (@MAN1EXT@),
332 .BR @L_ROFF@ (@MAN1EXT@),
333 .BR @L_TROFF@ (@MAN1EXT@),
334 .BR @L_ROFF@-out (@MAN5EXT@),
335 .BR @L_ROFF@-font (@MAN5EXT@),
336 .BR @L_ROFF@-char (@MAN7EXT@)
337 .
338 .\" s-ts-mode