htmldoc(1) Easy Software Products htmldoc(1)
NNAAMMEE
htmldoc - convert html source files into html, postscript,
or pdf.
SSYYNNOOPPSSIISS
htmldoc [options] filename1.html [ ... filenameN.html ]
htmldoc [options] -
htmldoc [filename.book]
DDEESSCCRRIIPPTTIIOONN
_H_T_M_L_D_O_C converts HTML source files into indexed HTML,
PostScript, or Portable Document Format (PDF) files that
can be viewed online or printed. With no options a PDF
document is produced on stdout.
The second form of _H_T_M_L_D_O_C reads HTML source from stdin,
which allows you to use _H_T_M_L_D_O_C as a filter.
The third form of _H_T_M_L_D_O_C launches a graphical interface
that allows you to change options and generate documents
interactively.
CCOOMMMMOONN MMIISSTTAAKKEESS
There are two types of HTML files - structured documents
using headings (H1, H2, etc.) which _H_T_M_L_D_O_C calls "books",
and unstructured documents that do not use headings which
_H_T_M_L_D_O_C calls "web pages".
A very common mistake is to try converting a web page
using:
htmldoc -f filename.pdf filename.html
which will likely produce a PDF file with no pages. To
convert web page files you mmuusstt use the _-_-_w_e_b_p_a_g_e or
_-_-_c_o_n_t_i_n_u_o_u_s options at the command-line or choose _W_e_b
_P_a_g_e or _C_o_n_t_i_n_u_o_u_s in the input tab of the GUI.
OOPPTTIIOONNSS
The following command-line options are supported by _H_T_M_L_-
_D_O_C:
--batch _f_i_l_e_n_a_m_e_._b_o_o_k
Generates the specified book file without opening the
GUI.
--bodycolor _c_o_l_o_r
Specifies the background color for all pages.
--bodyfont _{_c_o_u_r_i_e_r_,_t_i_m_e_s_,_h_e_l_v_e_t_i_c_a_}
--textfont _{_c_o_u_r_i_e_r_,_t_i_m_e_s_,_h_e_l_v_e_t_i_c_a_}
Specifies the default typeface for all normal text.
--bodyimage _f_i_l_e_n_a_m_e
Specifies the background image that is tiled on all
pages.
--book
Specifies that the HTML sources are structured (head-
ings, chapters, etc.)
--bottom _m_a_r_g_i_n
Specifies the bottom margin in points (no suffix or
##pt), inches (##in), centimeters (##cm), or millime-
ters (##mm).
--charset _{_8_8_5_9_-_1_._._._8_8_5_9_-_1_5_}
Specifies the ISO character set to use for the out-
put.
--color
Specifies that PostScript or PDF output should be in
color.
--continuous
Specifies that the HTML sources are unstructured
(plain web pages.) No page breaks are inserted
between each file or URL in the output.
--datadir _d_i_r_e_c_t_o_r_y
Specifies the location of the _H_T_M_L_D_O_C data files,
usually _/_u_s_r_/_s_h_a_r_e_/_h_t_m_l_d_o_c or _C_:_\_P_r_o_g_r_a_m _F_i_l_e_s_\_H_T_M_L_-
_D_O_C.
--duplex
Specifies that the output should be formatted for
double-sided printing.
--effectduration _{ _0_._1_._._1_0_._0 _}
Specifies the duration in seconds of PDF page transi-
tion effects.
--embedfonts
Specifies that fonts should be embedded in PDF and
PostScript output.
--encryption
Enables encryption of PDF files.
--fontsize _s_i_z_e
Specifies the default font size for body text.
--fontspacing _s_p_a_c_i_n_g
Specifies the default line spacing for body text. The
line spacing is a multiplier for the font size, so a
value of 1.2 will provide an additional 20% of space
between the lines.
--footer _f_f_f
Sets the page footer to use on body pages. See the
_H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
--format _f_o_r_m_a_t
-t _f_o_r_m_a_t
Specifies the output format: html, ps or ps2
(PostScript Level 2), ps1 (PostScript Level 1), ps3
(PostScript Level 3), pdf11 (PDF 1.1/Acrobat 2.0),
pdf12 (PDF 1.2/Acrobat 3.0), pdf or pdf13 (PDF
1.3/Acrobat 4.0), or pdf14 (PDF 1.4/Acrobat 5.0).
--gray
Specifies that PostScript or PDF output should be
grayscale.
--header _f_f_f
Sets the page header to use on body pages. See the
_H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
--headfootfont _f_o_n_t
Sets the font to use on headers and footers.
--headfootsize _s_i_z_e
Sets the size of the font to use on headers and foot-
ers.
--headingfont _t_y_p_e_f_a_c_e
Sets the typeface to use for headings.
--help
Displays a summary of command-line options.
--helpdir _d_i_r_e_c_t_o_r_y
Specifies the location of the _H_T_M_L_D_O_C on-line help
files, usually _/_u_s_r_/_s_h_a_r_e_/_d_o_c_/_h_t_m_l_d_o_c or _C_:_\_P_r_o_g_r_a_m
_F_i_l_e_s_\_H_T_M_L_D_O_C_\_D_O_C.
--jpeg_[_=_q_u_a_l_i_t_y_]
Sets the JPEG compression level to use for large
images. A value of 0 disables JPEG compression.
--left _m_a_r_g_i_n
Specifies the left margin in points (no suffix or
##pt), inches (##in), centimeters (##cm), or millime-
ters (##mm).
--linkcolor _c_o_l_o_r
Sets the color of links.
--links
Enables generation of links in PDF files (default).
--linkstyle _{_p_l_a_i_n_,_u_n_d_e_r_l_i_n_e_}
Sets the style of links.
--logoimage _f_i_l_e_n_a_m_e
Specifies an image to be used as a logo in the header
or footer in a PostScript or PDF document, and in the
navigation bar of a HTML document.
--no-compression
Disables compression of PostScript or PDF files.
--no-duplex
Disables double-sided printing.
--no-embedfonts
Specifies that fonts should not be embedded in PDF
and PostScript output.
--no-encryption
Disables document encryption.
--no-jpeg
Disables JPEG compression of large images.
--no-links
Disables generation of links in a PDF document.
--no-numbered
Disables automatic heading numbering.
--no-pscommands
Disables generation of PostScript setpagedevice com-
mands.
--no-strict
Disables strict HTML input checking.
--no-title
Disables generation of a title page.
--no-toc
Disables generation of a table of contents.
--numbered
Numbers all headings in a document.
--nup _p_a_g_e_s
Sets the number of pages that are placed on each out-
put page. Valid values are 1, 2, 4, 6, 9, and 16.
--outdir _d_i_r_e_c_t_o_r_y
-d _d_i_r_e_c_t_o_r_y
Specifies that output should be sent to a directory
in multiple files. (Not compatible with PDF output)
--outfile _f_i_l_e_n_a_m_e
-f _f_i_l_e_n_a_m_e
Specifies that output should be sent to a single
file.
--owner-password _p_a_s_s_w_o_r_d
Sets the owner password for encrypted PDF files.
--pageduration _{_1_._0_._._6_0_._0_}
Sets the view duration of a page in a PDF document.
--pageeffect _e_f_f_e_c_t
Specifies the page transition effect for all pages;
this attribute is ignored by all Adobe PDF viewers...
--pagelayout _{_s_i_n_g_l_e_,_o_n_e_,_t_w_o_l_e_f_t_,_t_w_o_r_i_g_h_t_}
Specifies the initial layout of pages for a PDF file.
--pagemode _{_d_o_c_u_m_e_n_t_,_o_u_t_l_i_n_e_s_,_f_u_l_l_s_c_r_e_e_n_}
Specifies the initial viewing mode for a PDF file.
--path
Specifies a search path for files in a document.
--permissions _p_e_r_m_i_s_s_i_o_n
Specifies document permissions for encrypted PDF
files. Multiple _-_-_p_e_r_m_i_s_s_i_o_n_s options are required to
grant or deny specific permissions. The following
values are understood: all, none, annotate, no-anno-
tate, copy, no-copy, modify, no-modify, print, and
no-print.
--pscommands
Specifies that PostScript setpagedevice commands
should be included in the output.
--quiet
Suppresses all messages, even error messages.
--right _m_a_r_g_i_n
Specifies the right margin in points (no suffix or
##pt), inches (##in), centimeters (##cm), or millime-
ters (##mm).
--size _p_a_g_e_s_i_z_e
Specifies the page size using a standard name or in
points (no suffix or ##x##pt), inches (##x##in), cen-
timeters (##x##cm), or millimeters (##x##mm). The
standard sizes that are currently recognized are
"letter" (8.5x11in), "legal" (8.5x14in), "a4"
(210x297mm), and "universal" (8.27x11in).
--strict
Enables strict HTML input checking.
--textcolor _c_o_l_o_r
Specifies the default color of all text.
--title
Enables the generation of a title page.
--titlefile _f_i_l_e_n_a_m_e
--titleimage _f_i_l_e_n_a_m_e
Specifies the file to use for the title page. If the
file is an image then the title page is automatically
generated using the document meta data and title
image.
--tocfooter _f_f_f
Sets the page footer to use on table-of-contents
pages. See the _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
--tocheader _f_f_f
Sets the page header to use on table-of-contents
pages. See the _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
--toclevels _l_e_v_e_l_s
Sets the number of levels in the table-of-contents.
--toctitle _s_t_r_i_n_g
Sets the title for the table-of-contents.
--top _m_a_r_g_i_n
Specifies the top margin in points (no suffix or
##pt), inches (##in), centimeters (##cm), or millime-
ters (##mm).
--user-password _p_a_s_s_w_o_r_d
Specifies the user password for encryption of PDF
files.
--verbose
-v
Provides verbose messages.
--version
Displays the current version number.
--webpage
Specifies that the HTML sources are unstructured
(plain web pages.) A page break is inserted between
each file or URL in the output.
HHEEAADDEERR//FFOOOOTTEERR FFOORRMMAATTSS
The header and footer of each page can contain up to three
preformatted values. These values are specified using a
single character for the left, middle, and right of the
page, resulting in the _f_f_f notation shown previously.
Each character can be one of the following:
blank
/
n/N arabic page numbers (1/3, 2/3, 3/3)
:
c/C arabic chapter page numbers (1/2, 2/2, 1/4, 2/4,
...)
1
arabic numbers (1, 2, 3, ...)
a
lowercase letters
A
uppercase letters
c
current chapter heading
C
current chapter page number (arabic)
d
current date
D
current date and time
h
current heading
i
lowercase roman numerals
I
uppercase roman numerals
l
logo image
t
title text
T
current time
SSEEEE AALLSSOO
HTMLDOC Software Users Manual
http://www.easysw.com/htmldoc
AAUUTTHHOORR
Michael Sweet (mike@easysw.com), Easy Software Products
TTRRAADDEEMMAARRKKSS
PostScript is a trademark that may be registered in some
countries and Adobe is a registered trademark of Adobe
Systems Incorporated.
CCOOPPYYRRIIGGHHTTSS
Portable Document Format Copyright 1993-1999 by Adobe Sys-
tems Incorporated.
HTMLDOC is copyright 1997-2002 by Easy Software Products.
This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any
later version.
This program is based in part on the work of the Indepen-
dent JPEG Group.
NNOO WWAARRRRAANNTTYY
This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more
details.
8 August 2002 HTMLDOC 1.8.21 htmldoc(1)