Chapter 8 - Command-Line Reference

This chapter describes all of the command-line options supported by HTMLDOC.

Basic Usage

The basic command-line usage for HTMLDOC is: The 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.

Options

The following command-line options are recognized by HTMLDOC.

-d directory

The -d option specifies an output directory for the document files.

This option is not compatible with the PDF output format.

-f filename

The -f option specifies an output file for the document.

-t format

The -t option specifies the output format for the document and can be one of the following:
FormatDescription
htmlGenerate one or more indexed HTML files.
pdfGenerate a PDF file (default version).
pdf11Generate a PDF 1.1 file for Acrobat Reader 2.0.
pdf12Generate a PDF 1.2 file for Acrobat Reader 3.0.
pdf13Generate a PDF 1.3 file for Acrobat Reader 4.0.
psGenerate one or more PostScript files (default level).
ps1Generate one or more Level 1 PostScript files.
ps2Generate one or more Level 2 PostScript files.
ps3Generate one or more Level 3 PostScript files.

-v

The -v option specifies that progress information should be sent/displayed to the standard error file.

--bodycolor color

The --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 typeface

The --bodyfont option specifies the default text font used for text in the document body. The typeface parameter can be one of the following:
typefaceActual Font
ArialHelvetica
CourierCourier
HelveticaHelvetica
MonospaceCourier
Sans-SerifHelvetica
SerifTimes
SymbolSymbol
TimesTimes

--bodyimage filename

The --bodyimage option specifies the background image for all pages in the document. The supported formats are GIF, JPEG, and PNG.

--book

The --book option specifies that the input files comprise a book with chapters and headings.

--bottom margin

The --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 pixels

The --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 charset

The --charset option specifies the 8-bit character set encoding to use for the entire document. HTMLDOC comes with the following character set files:
charsetCharacter Set
8859-1ISO-8859-1
8859-2ISO-8859-2
8859-3ISO-8859-3
8859-4ISO-8859-4
8859-5ISO-8859-5
8859-6ISO-8859-6
8859-7ISO-8859-7
8859-8ISO-8859-8
8859-9ISO-8859-9
8859-14ISO-8859-14
8859-15ISO-8859-15

--color

The --color option specifies that color output is desired.

This option is only available when generating PostScript or PDF files.

--compression[=level]

The --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 directory

The --datadir option specifies the location of data files used by HTMLDOC.

--duplex

The --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 seconds

The --effectduration option specifies the duration of a page transition effect in seconds.

This option is only available when generating PDF files.

--firstpage page

The --firstpage option specifies the first page that will be displayed in a PDF file. The page parameter can be one of the following:
pageDescription
p1The first page of the document.
tocThe first page of the table-of-contents.
c1The first page of chapter 1.

This option is only available when generating PDF files.

--fontsize size

The --fontsize option specifies the base font size for the entire document in points (1 point = 1/72nd inch).

--fontspacing spacing

The --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 lcr

The --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:
lcrDescription
.A period indicates that the field should be blank.
1The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...)
cAn "c" indicates that the field should contain the current chapter.
hAn "h" indicates that the field should contain the current heading.
iA lowercase I indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...)
IAn uppercase I indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...)
lA lowercase L indicates that the field should contain the logo image.
tA "t" indicates that the field should contain the document title.

Setting the footer to "..." disables the footer entirely.

This option is only available when generating PostScript or PDF files.

--format format

The --format option specifies the output format for the document and can be one of the following:
FormatDescription
htmlGenerate one or more indexed HTML files.
pdfGenerate a PDF file (default version).
pdf11Generate a PDF 1.1 file for Acrobat Reader 2.0.
pdf12Generate a PDF 1.2 file for Acrobat Reader 3.0.
pdf13Generate a PDF 1.3 file for Acrobat Reader 4.0.
psGenerate one or more PostScript files (default level).
ps1Generate one or more Level 1 PostScript files.
ps2Generate one or more Level 2 PostScript files.
ps3Generate one or more Level 3 PostScript files.

--gray

The --gray option specifies that grayscale output is desired.

This option is only available when generating PostScript or PDF files.

--header

The --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. Each character can be one of the following:
lcrDescription
.A period indicates that the field should be blank.
1The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...)
cAn "c" indicates that the field should contain the current chapter.
hAn "h" indicates that the field should contain the current heading.
iA lowercase I indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...)
IAn uppercase I indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...)
lA lowercase L indicates that the field should contain the logo image.
tA "t" indicates that the field should contain the document title.

Setting the header to "..." disables the header entirely.

This option is only available when generating PostScript or PDF files.

--headfootfont font

The --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 size

The --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 typeface

The --headingfont options sets the typeface that is used for headings in the document. The typeface parameter can be one of the following:
typefaceActual Font
ArialHelvetica
CourierCourier
HelveticaHelvetica
MonospaceCourier
Sans-SerifHelvetica
SerifTimes
SymbolSymbol
TimesTimes

--help

The --help option displays all of the available options to the standard output file.

--helpdir directory

The --helpdir option specifies the location of the on-line help files.

--jpeg[=quality]

The --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

The --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 margin

The --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.

--logoimage filename

The --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

The --no-compression option specifies that Flate compresion should not be performed on the output files.

--no-pscommands

The --no-pscommands option specifies that PostScript device commands should not be written to the output files.

--no-title

The --no-title option specifies that the title page should not be generated.

--no-toc

The --no-toc option specifies that the table-of-contents pages should not be generated.

--numbered

The --numbered option specifies that headings should be numbered.

--outdir directory

The --outdir option specifies an output directory for the document files.

This option is not compatible with the PDF output format.

--outfile filename

The --outfile option specifies an output file for the document.

--pageduration seconds

The --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 effect

The --pageeffect option specifies the page effect to use in PDF files. The effect parameter can be one of the following:
effectDescription
noneNo effect is generated.
biBox Inward
boBox Outward
dDissolve
gdGlitter Down
gdrGlitter Down and Right
grGlitter Right
hbHorizontal Blinds
hsiHorizontal Sweet Inward
hsoHorizontal Sweep Outward
vbVertical Blinds
vsiVertical Sweep Inward
vsoVertical Sweep Outward
wdWipe Down
wlWipe Left
wrWipe Right
wuWipe Up

This option is only available when generating PDF files.

--pagelayout layout

The --pagelayout option specifies the initial page layout in the PDF viewer. The layout parameter can be one of the following:
layoutDescription
singleA single page is displayed.
oneA single column is displayed.
twoleftTwo columns are displayed with the first page on the left.
tworightTwo columns are displayed with the first page on the right.

This option is only available when generating PDF files.

--pagemode mode

The --pagemode option specifies the initial viewing mode in the PDF viewer. The mode parameter can be one of the following:
modeDescription
documentThe document pages are displayed in a normal window.
outlineThe document outline and pages are displayed.
fullscreenThe document pages are displayed on the entire screen in "slideshow" mode.

This option is only available when generating PDF files.

--portrait

The --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

The --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.

--right margin

The --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 size

The --size option specifies the page size. The size parameter can be one of the following standard sizes:
sizeDescription
Letter8.5x11in (216x279mm)
A48.27x11.69in (210x297mm)
Universal8.27x11in (210x279mm)
Custom sizes are specified by the page width and length separated by the letter "x" to select a custom page size. Append the letters "in" for inches, "mm" for millimeters, or "cm" for centimeters.

This option is only available when generating PostScript or PDF files. Use the --pscommands option to generate PostScript page size commands.

--textcolor color

The --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 typeface

The --textfont options sets the typeface that is used for text in the document. The typeface parameter can be one of the following:
typefaceActual Font
ArialHelvetica
CourierCourier
HelveticaHelvetica
MonospaceCourier
Sans-SerifHelvetica
SerifTimes
SymbolSymbol
TimesTimes

--title

The --title option specifies that a title page should be generated.

--titleimage filename

The --titleimage option specifies the title image for the title page. The supported formats are GIF, JPEG, and PNG.

--tocfooter lcr

The --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. Each character can be one of the following:
lcrDescription
.A period indicates that the field should be blank.
1The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...)
cAn "c" indicates that the field should contain the current chapter.
hAn "h" indicates that the field should contain the current heading.
iA lowercase I indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...)
IAn uppercase I indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...)
lA lowercase L indicates that the field should contain the logo image.
tA "t" indicates that the field should contain the document title.

Setting the TOC footer to "..." disables the TOC footer entirely.

This option is only available when generating PostScript or PDF files.

--tocheader lcr

The --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. Each character can be one of the following:
lcrDescription
.A period indicates that the field should be blank.
1The number 1 indicates that the field should contain the current page number in decimal format (1, 2, 3, ...)
cAn "c" indicates that the field should contain the current chapter.
hAn "h" indicates that the field should contain the current heading.
iA lowercase I indicates that the field should contain the current page number in lowercase roman numerals (i, ii, iii, ...)
IAn uppercase I indicates that the field should contain the current page number in uppercase roman numerals (I, II, III, ...)
lA lowercase L indicates that the field should contain the logo image.
tA "t" indicates that the field should contain the document title.

Setting the TOC header to "..." disables the TOC header entirely.

This option is only available when generating PostScript or PDF files.

--toclevels levels

The --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.

--top margin

The --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.

--verbose

The -v option specifies that progress information should be sent/displayed to the standard error file.

--webpage

The --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.