% htmldoc options filename1.html ... filenameN.html ENTER % htmldoc options filename.book ENTERThe first form converts the named HTML files to the specified output format immediately. The second form loads the specified
.book file and
displays the HTMLDOC window, allowing a user to make changes and/or
generate the document interactively.
If no output file or directory is specified, then all output is sent to the standard output file.
-d option specifies an output directory for the document files.
This option is not compatible with the PDF output format.
-f option specifies an output file for the document.
-t option specifies the output format for the document and
can be one of the following:
| Format | Description |
|---|---|
| html | Generate one or more indexed HTML files. |
| Generate a PDF file (default version). | |
| pdf11 | Generate a PDF 1.1 file for Acrobat Reader 2.0. |
| pdf12 | Generate a PDF 1.2 file for Acrobat Reader 3.0. |
| pdf13 | Generate a PDF 1.3 file for Acrobat Reader 4.0. |
| ps | Generate one or more PostScript files (default level). |
| ps1 | Generate one or more Level 1 PostScript files. |
| ps2 | Generate one or more Level 2 PostScript files. |
| ps3 | Generate one or more Level 3 PostScript files. |
-v option specifies that progress information should be
sent/displayed to the standard error file.
--batch option specifies a book file that you would like to
generate without the GUI popping up. This option can be combined with other
options to generate the same book in different formats and sizes:
% htmldoc --batch filename.book -f filename.ps ENTER % htmldoc --batch filename.book -f filename.pdf ENTER
--bodycolor option specifies the background color for all
pages in the document. The color can be specified by name or as a 6-digit
hexadecimal number of the form #RRGGBB.
--bodyfont option specifies the default text font used for
text in the document body. The typeface parameter can be one of
the following:
| typeface | Actual Font |
|---|---|
| Arial | Helvetica |
| Courier | Courier |
| Helvetica | Helvetica |
| Monospace | Courier |
| Sans-Serif | Helvetica |
| Serif | Times |
| Symbol | Symbol |
| Times | Times |
--bodyimage option specifies the background image for all
pages in the document. The supported formats are GIF, JPEG, and PNG.
--book option specifies that the input files comprise a
book with chapters and headings.
--bottom option specifies the bottom margin. The default
units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm"
specify inches, centimeters, and millimeters, respectively.
This option is only available when generating PostScript or PDF files.
--browserwidth option specifies the browser width in pixels.
The browser width is used to scale images and pixel measurements when
generating PostScript and PDF files. It does not affect the font size of text.
The default browser width is 680 pixels which corresponds roughly to a 96 DPI display.
This option is only available when generating PostScript or PDF files.
--charset option specifies the 8-bit character set encoding
to use for the entire document. HTMLDOC comes with the following
character set files:
| charset | Character Set |
|---|---|
| iso-8859-1 | ISO-8859-1 |
| iso-8859-2 | ISO-8859-2 |
| iso-8859-3 | ISO-8859-3 |
| iso-8859-4 | ISO-8859-4 |
| iso-8859-5 | ISO-8859-5 |
| iso-8859-6 | ISO-8859-6 |
| iso-8859-7 | ISO-8859-7 |
| iso-8859-8 | ISO-8859-8 |
| iso-8859-9 | ISO-8859-9 |
| iso-8859-14 | ISO-8859-14 |
| iso-8859-15 | ISO-8859-15 |
| koi8-r | KOI8-R |
--color option specifies that color output is desired.
This option is only available when generating PostScript or PDF files.
--compression option specifies that Flate compression
should be performed on the output file(s). The optional
level parameter is a number from 1 (fastest and least
amount of compression) to 9 (slowest and most amount of compression).
This option is only available when generating Level 3 PostScript or PDF files.
--datadir option specifies the location of data files used
by HTMLDOC.
--duplex option specifies that the output should be formatted
for two sided printing.
This option is only available when generating PostScript or PDF files.
Use the --pscommands option to generate PostScript duplex mode
commands.
--effectduration option specifies the duration of a page
transition effect in seconds.
This option is only available when generating PDF files.
The --encryption option enables encryption and security
features for PDF output.
This option is only available when generating PDF files.
--firstpage option specifies the first page that will be
displayed in a PDF file. The page parameter can be one of the
following:
| page | Description |
|---|---|
| p1 | The first page of the document. |
| toc | The first page of the table-of-contents. |
| c1 | The first page of chapter 1. |
This option is only available when generating PDF files.
--fontsize option specifies the base font size for the
entire document in points (1 point = 1/72nd inch).
--fontspacing option specifies the line spacing for the
entire document as a multiplier of the base font size. A spacing
value of 1 makes each line of text the same height as the font.
--footer option specifies the contents of the page
footer. The lcr parameter is a three-character string
representing the left, center, and right footer fields. Each character
can be one of the following:
| lcr | Description |
|---|---|
| . | A period indicates that the field should be blank. |
| / | A slash indicates that the field should be contain the current and total number of pages (n/N). |
| 1 | The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...) |
| a | A lowercase "a" indicates that the field should contain the current page number using lowercase letters. |
| A | An uppercase "A" indicates that the field should contain the current page number using UPPERCASE letters. |
| c | A lowercase "c" indicates that the field should contain the current chapter title. |
| C | An uppercase "C" indicates that the field should contain the current chapter page number. |
| d | A lowercase "d" indicates that the field should contain the current date. |
| D | An uppercase "D" indicates that the field should contain the current date and time. |
| h | An "h" indicates that the field should contain the current heading. |
| i | A lowercase "i" indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...) |
| I | An uppercase "I" indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...) |
| l | A lowercase "l" indicates that the field should contain the logo image. |
| t | A lowercase "t" indicates that the field should contain the document title. |
| t | An uppercase "T" indicates that the field should contain the current time. |
Setting the footer to "..." disables the footer entirely.
--format option specifies the output format for the document and
can be one of the following:
| Format | Description |
|---|---|
| html | Generate one or more indexed HTML files. |
| Generate a PDF file (default version). | |
| pdf11 | Generate a PDF 1.1 file for Acrobat Reader 2.0. |
| pdf12 | Generate a PDF 1.2 file for Acrobat Reader 3.0. |
| pdf13 | Generate a PDF 1.3 file for Acrobat Reader 4.0. |
| ps | Generate one or more PostScript files (default level). |
| ps1 | Generate one or more Level 1 PostScript files. |
| ps2 | Generate one or more Level 2 PostScript files. |
| ps3 | Generate one or more Level 3 PostScript files. |
--gray option specifies that grayscale output is desired.
This option is only available when generating PostScript or PDF files.
--header option specifies the contents of the page
header. The lcr parameter is a three-character string
representing the left, center, and right header fields. See the
--footer option for the list of
formatting characters.
Setting the header to "..." disables the header entirely.
--headfootfont option specifies the font that is used for
the header and footer text. The font parameter can be one of the
following:
This option is only available when generating PostScript or PDF files.
--headfootsize option sets the size of the header and footer
text in points (1 point = 1/72nd inch).
This option is only available when generating PostScript or PDF files.
--headingfont options sets the typeface that is used
for headings in the document. The typeface parameter can
be one of the following:
| typeface | Actual Font |
|---|---|
| Arial | Helvetica |
| Courier | Courier |
| Helvetica | Helvetica |
| Monospace | Courier |
| Sans-Serif | Helvetica |
| Serif | Times |
| Symbol | Symbol |
| Times | Times |
--help option displays all of the available options to the
standard output file.
--helpdir option specifies the location of the on-line help
files.
--jpeg option enables JPEG compression of continuous-tone
images. The optional quality parameter specifies the output
quality from 0 (worst) to 100 (best).
This option is only available when generating Level 2 and Level 3 PostScript or PDF files.
--landscape option specifies that the output should be
in landscape orientation (long edge on top).
This option is only available when generating PostScript or PDF files.
--left option specifies the left margin. The default
units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm"
specify inches, centimeters, and millimeters, respectively.
This option is only available when generating PostScript or PDF files.
--linkcolor option specifies the color of links in HTML
and PDF output. The color can be specified by name or as a 6-digit
hexadecimal number of the form #RRGGBB.
The --links option specifies that PDF output should contain
hyperlinks.
--linkstyle option specifies the style of links in HTML
and PDF output. The style can be "plain" for no decoration or "underline"
to underline links.
--logoimage option specifies the logo image for the
HTML navigation bar and page headers and footers for PostScript and PDF
files. The supported formats are GIF, JPEG, and PNG.
--no-compression option specifies that Flate compresion
should not be performed on the output files.
The --no-encryption option specifies that no encryption/security
features should be enabled in PDF output.
This option is only available when generating PDF files.
The --no-links option specifies that PDF output should not contain
hyperlinks.
--no-numbered option specifies that headings
should not be numbered.
--no-pscommands option specifies that PostScript device
commands should not be written to the output files.
--no-title option specifies that the title page should not
be generated.
--no-toc option specifies that the table-of-contents pages
should not be generated.
--no-truetype option specifies that TrueType fonts should
not be used in PDF output.
--numbered option specifies that headings should be numbered.
--outdir option specifies an output directory for the
document files.
This option is not compatible with the PDF output format.
--outfile option specifies an output file for the document.
The --owner-password option specifies the owner password for
a PDF file. If not specified or the empty string (""), a random password is
generated.
This option is only available when generating PDF files.
--pageduration option specifies the number of seconds that
each page will be displayed in the document.
This option is only available when generating PDF files.
--pageeffect option specifies the page effect to use in
PDF files. The effect parameter can be one of the following:
| effect | Description |
|---|---|
| none | No effect is generated. |
| bi | Box Inward |
| bo | Box Outward |
| d | Dissolve |
| gd | Glitter Down |
| gdr | Glitter Down and Right |
| gr | Glitter Right |
| hb | Horizontal Blinds |
| hsi | Horizontal Sweet Inward |
| hso | Horizontal Sweep Outward |
| vb | Vertical Blinds |
| vsi | Vertical Sweep Inward |
| vso | Vertical Sweep Outward |
| wd | Wipe Down |
| wl | Wipe Left |
| wr | Wipe Right |
| wu | Wipe Up |
This option is only available when generating PDF files.
--pagelayout option specifies the initial page layout in
the PDF viewer. The layout parameter can be one of the following:
| layout | Description |
|---|---|
| single | A single page is displayed. |
| one | A single column is displayed. |
| twoleft | Two columns are displayed with the first page on the left. |
| tworight | Two columns are displayed with the first page on the right. |
This option is only available when generating PDF files.
--pagemode option specifies the initial viewing mode in the
PDF viewer. The mode parameter can be one of the following:
| mode | Description |
|---|---|
| document | The document pages are displayed in a normal window. |
| outline | The document outline and pages are displayed. |
| fullscreen | The document pages are displayed on the entire screen in "slideshow" mode. |
This option is only available when generating PDF files.
The --path option specifies a search path for files that
are loaded by HTMLDOC. It is usually used to get images that use absolute
server paths to load.
Directories are separated by the semicolon (;) so that drive letters and URLs can be specified.
The --permissions option specifies the document permissions.
Multiple options can be specified as needed:
| Permission | Description |
|---|---|
| all | All permissions |
| annotate | User can annotate document |
| copy | User can copy text and images from document |
| modify | User can modify document |
| User can print document | |
| no-annotate | User cannot annotate document |
| no-copy | User cannot copy text and images from document |
| no-modify | User cannot modify document |
| no-print | User cannot print document |
| none | No permissions |
This option is only available when generating PDF files.
--portrait option specifies that the output should be
in portrait orientation (short edge on top).
This option is only available when generating PostScript or PDF files.
--pscommands option specifies that PostScript device
commands should be written to the output files.
This option is only available when generating Level 2 and Level 3 PostScript files.
The --quiet option prevents error messages from being
sent to stderr.
--right option specifies the right margin. The default
units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm"
specify inches, centimeters, and millimeters, respectively.
This option is only available when generating PostScript or PDF files.
--size option specifies the page size. The
size parameter can be one of the following standard sizes:
| size | Description |
|---|---|
| Letter | 8.5x11in (216x279mm) |
| A4 | 8.27x11.69in (210x297mm) |
| Universal | 8.27x11in (210x279mm) |
This option is only available when generating PostScript or PDF files.
Use the --pscommands option to generate PostScript page size
commands.
--textcolor option specifies the default text color
for all pages in the document. The color can be specified by name or as
a 6-digit hexadecimal number of the form #RRGGBB.
--textfont options sets the typeface that is used for
text in the document. The typeface parameter can be one of
the following:
| typeface | Actual Font |
|---|---|
| Arial | Helvetica |
| Courier | Courier |
| Helvetica | Helvetica |
| Monospace | Courier |
| Sans-Serif | Helvetica |
| Serif | Times |
| Symbol | Symbol |
| Times | Times |
--title option specifies that a title page should be
generated.
--titlefile option specifies a HTML file to use for
the title page.
--titleimage option specifies the title image for the
title page. The supported formats are BMP, GIF, JPEG, and PNG.
--tocfooter option specifies the contents of the
table-of-contents footer. The lcr parameter is a
three-character string representing the left, center, and right footer
fields. See the
--footer option for the list of
formatting characters.
Setting the TOC footer to "..." disables the TOC footer
entirely.
--tocheader option specifies the contents of the
table-of-contents header. The lcr parameter is a
three-character string representing the left, center, and right header
fields. See the
--footer option for the list of
formatting characters.
Setting the TOC header to "..." disables the TOC header
entirely.
--toclevels options specifies the number of heading
levels to include in the table-of-contents pages. The
levels parameter is a number from 1 to 6.
--toctitle options specifies the string to display at
the top of the table-of-contents; the default string is "Table of
Contents".
--top option specifies the top margin. The default
units are points (1 point = 1/72nd inch); the suffixes "in", "cm", and "mm"
specify inches, centimeters, and millimeters, respectively.
This option is only available when generating PostScript or PDF files.
--truetype option specifies that TrueType fonts should
be used in PDF output.
The --user-password option specifies the user password for
a PDF file. If not specified or the empty string (""), no password will be
required to view the document.
This option is only available when generating PDF files.
-v option specifies that progress information should be
sent/displayed to the standard error file.
--webpage option specifies that the input files
comprise a web page (or site) and that no title page or
table-of-contents should be generated.
This option is only available when generating PostScript or PDF files.