1htmldoc(1) Easy Software Products htmldoc(1)
2
6 htmldoc - convert html source files into html, postscript, or pdf.
7
10 htmldoc [options] filename1.html [ ... filenameN.html ]
11 htmldoc [options] -
13 htmldoc [filename.book]
15
18 HTMLDOC converts HTML source files into indexed HTML, PostScript, or
19 Portable Document Format (PDF) files that can be viewed online or
20 printed. With no options a HTML document is produced on stdout.
21 The second form of HTMLDOC reads HTML source from stdin, which allows
23 you to use HTMLDOC as a filter.
24 The third form of HTMLDOC launches a graphical interface that allows
26 you to change options and generate documents interactively.
27
29 There are two types of HTML files - structured documents using headings
30 (H1, H2, etc.) which HTMLDOC calls "books", and unstructured documents
31 that do not use headings which HTMLDOC calls "web pages".
32 A very common mistake is to try converting a web page using:
34 htmldoc -f filename.pdf filename.html
36 which will likely produce a PDF file with no pages. To convert web page
38 files you must use the --webpage or --continuous options at the com‐
39 mand-line or choose Web Page or Continuous in the input tab of the GUI.
40
42 The following command-line options are supported by HTMLDOC:
43 --batch filename.book
46 Generates the specified book file without opening the GUI.
47 --bodycolor color
50 Specifies the background color for all pages.
51 --bodyfont {courier,helvetica,monospace,sans,serif,times}
54 --textfont {courier,helvetica,monospace,sans,serif,times}
56 Specifies the default typeface for all normal text.
57 --bodyimage filename
60 Specifies the background image that is tiled on all pages.
61 --book
64 Specifies that the HTML sources are structured (headings, chap‐
65 ters, etc.)
66 --bottom margin
69 Specifies the bottom margin in points (no suffix or ##pt), inches
70 (##in), centimeters (##cm), or millimeters (##mm).
71 --charset {8859-1...8859-15}
74 Specifies the ISO character set to use for the output.
75 --color
78 Specifies that PostScript or PDF output should be in color.
79 --continuous
82 Specifies that the HTML sources are unstructured (plain web
83 pages.) No page breaks are inserted between each file or URL in
84 the output.
85 --datadir directory
88 Specifies the location of the HTMLDOC data files, usually
89 /usr/share/htmldoc or C:\Program Files\HTMLDOC.
90 --duplex
93 Specifies that the output should be formatted for double-sided
94 printing.
95 --effectduration { 0.1..10.0 }
98 Specifies the duration in seconds of PDF page transition effects.
99 --embedfonts
102 Specifies that fonts should be embedded in PDF and PostScript out‐
103 put.
104 --encryption
107 Enables encryption of PDF files.
108 --fontsize size
111 Specifies the default font size for body text.
112 --fontspacing spacing
115 Specifies the default line spacing for body text. The line spacing
116 is a multiplier for the font size, so a value of 1.2 will provide
117 an additional 20% of space between the lines.
118 --footer fff
121 Sets the page footer to use on body pages. See the HEADERS/FOOTERS
122 FORMATS section below.
123 --format format
126 -t format
128 Specifies the output format: html, htmlsep (separate HTML files
129 for each heading in the table-of-contents), ps or ps2 (PostScript
130 Level 2), ps1 (PostScript Level 1), ps3 (PostScript Level 3),
131 pdf11 (PDF 1.1/Acrobat 2.0), pdf12 (PDF 1.2/Acrobat 3.0), pdf or
132 pdf13 (PDF 1.3/Acrobat 4.0), or pdf14 (PDF 1.4/Acrobat 5.0).
133 --gray
136 Specifies that PostScript or PDF output should be grayscale.
137 --header fff
140 Sets the page header to use on body pages. See the HEADERS/FOOTERS
141 FORMATS section below.
142 --headfootfont font
145 Sets the font to use on headers and footers.
146 --headfootsize size
149 Sets the size of the font to use on headers and footers.
150 --headingfont typeface
153 Sets the typeface to use for headings.
154 --help
157 Displays a summary of command-line options.
158 --helpdir directory
161 Specifies the location of the HTMLDOC on-line help files, usually
162 /usr/share/doc/htmldoc or C:\Program Files\HTMLDOC\DOC.
163 --jpeg[=quality]
166 Sets the JPEG compression level to use for large images. A value
167 of 0 disables JPEG compression.
168 --left margin
171 Specifies the left margin in points (no suffix or ##pt), inches
172 (##in), centimeters (##cm), or millimeters (##mm).
173 --linkcolor color
176 Sets the color of links.
177 --links
180 Enables generation of links in PDF files (default).
181 --linkstyle {plain,underline}
184 Sets the style of links.
185 --logoimage filename
188 Specifies an image to be used as a logo in the header or footer in
189 a PostScript or PDF document, and in the navigation bar of a HTML
190 document.
191 Note that you need to use the --header and/or --footer options
193 with the l parameter or use the corresponding HTML page comments
194 to display the logo image in the header or footer.
195 --no-compression
198 Disables compression of PostScript or PDF files.
199 --no-duplex
202 Disables double-sided printing.
203 --no-embedfonts
206 Specifies that fonts should not be embedded in PDF and PostScript
207 output.
208 --no-encryption
211 Disables document encryption.
212 --no-jpeg
215 Disables JPEG compression of large images.
216 --no-links
219 Disables generation of links in a PDF document.
220 --no-numbered
223 Disables automatic heading numbering.
224 --no-pscommands
227 Disables generation of PostScript setpagedevice commands.
228 --no-strict
231 Disables strict HTML input checking.
232 --no-title
235 Disables generation of a title page.
236 --no-toc
239 Disables generation of a table of contents.
240 --numbered
243 Numbers all headings in a document.
244 --nup pages
247 Sets the number of pages that are placed on each output page.
248 Valid values are 1, 2, 4, 6, 9, and 16.
249 --outdir directory
252 -d directory
254 Specifies that output should be sent to a directory in multiple
255 files. (Not compatible with PDF output)
256 --outfile filename
259 -f filename
261 Specifies that output should be sent to a single file.
262 --owner-password password
265 Sets the owner password for encrypted PDF files.
266 --pageduration {1.0..60.0}
269 Sets the view duration of a page in a PDF document.
270 --pageeffect effect
273 Specifies the page transition effect for all pages; this attribute
274 is ignored by all Adobe PDF viewers...
275 --pagelayout {single,one,twoleft,tworight}
278 Specifies the initial layout of pages for a PDF file.
279 --pagemode {document,outlines,fullscreen}
282 Specifies the initial viewing mode for a PDF file.
283 --path
286 Specifies a search path for files in a document.
287 --permissions permission[,permission,...]
290 Specifies document permissions for encrypted PDF files. The fol‐
291 lowing permissions are understood: all, none, annotate, no-anno‐
292 tate, copy, no-copy, modify, no-modify, print, and no-print. Sepa‐
293 rate multiple permissions with commas.
294 --pscommands
297 Specifies that PostScript setpagedevice commands should be
298 included in the output.
299 --quiet
302 Suppresses all messages, even error messages.
303 --referer url
306 Specifies the URL that is passed in the Referer: field of HTTP
307 requests.
308 --right margin
311 Specifies the right margin in points (no suffix or ##pt), inches
312 (##in), centimeters (##cm), or millimeters (##mm).
313 --size pagesize
316 Specifies the page size using a standard name or in points (no
317 suffix or ##x##pt), inches (##x##in), centimeters (##x##cm), or
318 millimeters (##x##mm). The standard sizes that are currently rec‐
319 ognized are "letter" (8.5x11in), "legal" (8.5x14in), "a4"
320 (210x297mm), and "universal" (8.27x11in).
321 --strict
324 Enables strict HTML input checking.
325 --textcolor color
328 Specifies the default color of all text.
329 --title
332 Enables the generation of a title page.
333 --titlefile filename
336 --titleimage filename
338 Specifies the file to use for the title page. If the file is an
339 image then the title page is automatically generated using the
340 document meta data and title image.
341 --tocfooter fff
344 Sets the page footer to use on table-of-contents pages. See the
345 HEADERS/FOOTERS FORMATS section below.
346 --tocheader fff
349 Sets the page header to use on table-of-contents pages. See the
350 HEADERS/FOOTERS FORMATS section below.
351 --toclevels levels
354 Sets the number of levels in the table-of-contents.
355 --toctitle string
358 Sets the title for the table-of-contents.
359 --top margin
362 Specifies the top margin in points (no suffix or ##pt), inches
363 (##in), centimeters (##cm), or millimeters (##mm).
364 --user-password password
367 Specifies the user password for encryption of PDF files.
368 --verbose
371 -v
373 Provides verbose messages.
374 --version
377 Displays the current version number.
378 --webpage
381 Specifies that the HTML sources are unstructured (plain web
382 pages.) A page break is inserted between each file or URL in the
383 output.
384
387 The header and footer of each page can contain up to three preformatted
388 values. These values are specified using a single character for the
389 left, middle, and right of the page, resulting in the fff notation
390 shown previously.
391 Each character can be one of the following:
393 blank
396 /
399 n/N arabic page numbers (1/3, 2/3, 3/3)
400 :
403 c/C arabic chapter page numbers (1/2, 2/2, 1/4, 2/4, ...)
404 1
407 arabic numbers (1, 2, 3, ...)
408 a
411 lowercase letters
412 A
415 uppercase letters
416 c
419 current chapter heading
420 C
423 current chapter page number (arabic)
424 d
427 current date
428 D
431 current date and time
432 h
435 current heading
436 i
439 lowercase roman numerals
440 I
443 uppercase roman numerals
444 l
447 logo image
448 t
451 title text
452 T
455 current time
456
459 HTMLDOC looks for several environment variables which can override the
460 default directories, display additional debugging information, and dis‐
461 able CGI mode:
462 HTMLDOC_DATA
465 This environment variable specifies the location of HTMLDOC's data
466 and fonts directories, normally /usr/share/htmldoc or C:\Program
467 Files\Easy Software Products\HTMLDOC.
468 HTMLDOC_DEBUG
471 This environment variable enables debugging information that is
472 sent to stderr. The value is a list of any of the following key‐
473 words separated by spaces: "all", "links", "memory", "remote‐
474 bytes", "table", "tempfiles", and/or "timing".
475 HTMLDOC_HELP
478 This environment variable specifies the location of HTMLDOC's doc‐
479 umentation directory, normally /usr/share/doc/htmldoc or C:\Pro‐
480 gram Files\Easy Software Products\HTMLDOC\doc.
481 HTMLDOC_NOCGI
484 This environment variable, when set (the value doesn't matter),
485 disables CGI mode. It is most useful for using HTMLDOC on a web
486 server from a scripting language or invocation from a program.
487
490 HTMLDOC Software Users Manual
491 http://www.easysw.com/htmldoc/
493
495 Michael Sweet, Easy Software Products
496
498 PostScript is a trademark that may be registered in some countries and
499 Adobe is a registered trademark of Adobe Systems Incorporated.
500
502 Portable Document Format Copyright 1993-1999 by Adobe Systems Incorpo‐
503 rated.
504 HTMLDOC and <HTML>DOC are the trademark property of Easy Software Prod‐
506 ucts. HTMLDOC is copyright 1997-2005 by Easy Software Products.
507 This program is based in part on the work of the Independent JPEG
509 Group.
510
512 This program is distributed in the hope that it will be useful, but
513 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
514 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5153 November 2005 HTMLDOC 1.8.25 htmldoc(1)