## Command Line Arguments

Up: tohtml Next: doctext Previous: Getting Started

To use tohtml, you give it the name of the LaTeX file to process:


tohtml foo.tex

Command-line options to tohtml allow you to change the behavior. The option -default sets a common selection of options:

tohtml -default foo.tex

A complete list of the command-line options follows. Some of these (e.g., -mapref) are discussed in more detail later.

The following options control how the document is divided into individual Web pages.

-nocontents
Suppress the generation of the contents page (which has links to all of the other sections). This is useful for short documents.

-split n
Split the document into separate files, based on the sectioning commands (e.g., \chapter, \section). The value of n indicates where to begin breaking the file: a value of 0 puts chapters into separate files, a value of 2 puts subsections into a separate file, and a value of -1 forces the entire document into a single file (note that any image or graphics files are still separate).

The following options control how tohtml handles various kinds of LaTeX commands.
-citeprefix str
-citesuffix str
Set the prefix and suffix strings used around \cite in text. The default values are [ and ].

-cvtlatex
Convert LaTeX that cannot be represented directly by HTML into bitmaps that are included in the document. If this option is not used, the text is processed as is, with all LaTeX commands removed and text (and arguments to the commands) unchanged.

-cvttables
Convert tabular environments into bitmaps. This produces nicer tables than the default (which attempts to line up columns) but can produce large bitmaps that some systems may not be able to handle.

-cvtmath
Convert math and display math environments into bitmaps. This produces nicer representation of the formatted mathematics, but can produce large bitmaps.

-iftex
Include text in \begin{iftex} to \end{iftex} (for LaTeXInfo documents).

-simplemath
Use italics for expressions in LaTeX math mode that do not involve any special characters. For example, $3$ would be changed into an italic 3, rather than a small bitmap. Not yet available.

-default
Set a common set of options. Equivalent to -cvtlatex -cvttables -cvtmath -iftex -split 2 -useimg.

-basedef filename
Read filename for additional definitions. This lets you define some TeX and LaTeX commands as having a specific behavior when generating HTML files (see section User-defined Replacements).

-userpath pathlist
For each documentstyle option or usepackage name, look in pathlist for a file of the form name.def. For example, \usepackage{refman} will cause tohtml to search for refman.def in pathlist. If -userpath is not given, no files will be searched for. The environment variable DOCTEXT_USERPATH may be used instead of -userpath.

The following options control some aspects of the layout of each page, particularly the presence of the navigation buttons to other pages.
-notopnames
Suppress generation of the links at the top of the page. This is useful when generating a single-page document, in combination with -split -1.

-nonavnames
Suppress generation of the links at the bottom of the page. This is useful when the sections in the document are short.

-nobottomnav
Suppress generation of the links and buttoms at the bottom of each section.

-beginpage filename
Add the HTML in filename to the top of every generated HTML page.

-endpage filename
Add the HTML in filename to the bottom of every generated HTML page. This is particularly useful for adding links to indexes and home pages to a document.

The following command-line arguments control the generation of links to other documents.
-mapref filename
Filename contains a list of mappings from citation keys (the name in a \cite command) to HTML links (see section Building a Map File).

-mapman filename
Filename contains a list of mappings from tokens (currently defined as sequences of letters only) to HTML links (see section Building a Map File).

These commands control details of the generated HTML file.

-gaudy
Use images of colored balls for bullets in itemized lists.

-useimg
Instead of generating the bitmap, uses a file that has the name that would be used for that bitmap. This is useful when making the second run of tohtml. It is meaningful only when -cvtlatex is used.

-basedir dirname
Add an HTML base command to the main file. For example, -basedir "http://www.mcs.anl.gov/mpi" causes

<base href="http://www.mcs.anl.gov/mpi">

to be written to the file.

The following commands are used for debugging the behavior of tohtml itself.
-debugout
Write out information about the generation of output
-debugdef
-debugscan
-debugfile

Up: tohtml Next: doctext Previous: Getting Started