next up previous contents index
Next: Extending the Translator Up: User Manual Previous: User Manual

Command Line Options

   The command line options described below can be used to change the default behavior of LaTeX2HTML. Alternatively, the corresponding environment variables in the initialization file .latex2html-init may be changed, in order to achieve the same result.

 

*-split num
Stop splitting sections into separate files at this depth. A value of 0 will put the document into a single HTML file. The default is 8.
*-link num
Stop revealing child nodes at each node at this depth. (A node is a part/chapter/section/subsection/subsubsection etc.). A value of 0 will show no links to child nodes, a value of 1 will show only the immediate descendents, etc. A value at least as big as that of the -split option will produce a table of contents for the tree structure, rooted at each given node. The default is 4.  
*-nolatex
Disable the mechanism for passing unknown environments to LaTeX for processing. This can be thought of as ``draft mode'' which allows faster translation of the basic document structure and text, without fancy figures, equations or tables.

This option has been superceded by the -no_images option (see below).

*-external_images
Instead of including any generated images inside the document, leave them outside the document and provide hypertext links to them.  
*-ascii_mode
Use only ascii characters and do not include any images in the final output. In ascii mode the output of the translator can be used on character based browsers which do not support inlined images (the <IMG> tag).
*-t top-page-title
Name the document using this title.
*-up_url URL

change_begin
Specifies a universal resource locator (URL) to associate with the UP button of the top-level navigation panel.
*-up_title string
Specifies a title associated with this URL.
*-down_url URL
Specifies a URL for the NEXT button of the bottom-level navigation panel.
*-down_title string
Specifies a title associated with this URL.
*-contents URL
Specifies a URL for the table of contents button for document segments that would not otherwise have one.
*-index URL
Specifies a URL for the index button for document segments that otherwise would not have an index.
*-external_file filename-prefix
Specifies the prefix of the .aux file that this document segment should read. The .aux extension will be appended to this prefix. This file is necessary for document segments to obtain figure and section numbers from LaTeX.


change_end

*-dir output-directory
Redirect the output to this directory.
*-no_subdir
Place the generated HTML files in the current directory. The default behaviour is to create (or reuse) another file directory.
change_begin
 
*-prefix filename-prefix
The filename-prefix  will be prepended to all .gif, .pl and .html files produced, except for the top-level .html file. This will enable multiple products of LaTeX2HTML to peacefully coexist in the same directory. Do not, however, attempt to simultaneously run multiple instances of LaTeX2HTML using the same output directory, or various temporary files will overwrite each other.
*-font_size size
This option provides better control over the font size of environments processed by LaTeX. size must be one of the font sizes that LaTeX recognized; i.e. 10pt, 11pt, 12pt, etc. The default size is the same as the LaTeX document. Whatever size is selected, it will be magnified by the installation variables, $MATH_SCALE_FACTOR or $FIGURE_SCALE_FACTOR.
*-no_tex_defs
If specified, the translator will make no attempt to interpret raw TeX commands. This feature will enable sophisticated authors the ability to insert arbitrary TeX commands in environments that are distined to be processed by LaTeX anyway (e.g. figures, theorems, etc.)


change_end

*-ps_images
Use links to external postscript images rather than inlined GIF images.
*-address author-address
Sign each page with this address.  
*-no_navigation
Disable the mechanism for putting navigation links in each page.
*-top_navigation
Put navigation links at the top of each page.
*-bottom_navigation
Put navigation links at the bottom of each page AS WELL as the top.
*-auto_navigation
Put navigation links at the top of each page. If the page exceeds $WORDS_IN_PAGE number of words (the default is 450) then put one at the bottom of the page as well.
*-index_in_navigation
Put a link to the index page in the navigation panel if there is an index.
*-contents_in_navigation
Put a link to the table of contents in the navigation panel if there is a table of contents.
*-next_page_in_navigation
Put a link to the next logical page in the navigation panel.
*-previous_page_in_navigation
Put a link to the previous logical page in the navigation panel.
*-info string
Generate a new section About this document ... containing information about the document being translated. The default is to generate such a section with information on the original document, the date, the user and the translator. An empty string (or the value 0) disables the creation of this extra section. If a non-empty string is given, it will be placed in the contents of the About this document ... section instead of the default information.
*-reuse reuse_option

change_begin
The reuse_option specifies how or whether image files are to be shared or recycled, and accepts three valid options:
0
Do not ever share or recycle image files. This choice also invokes an interactive session prompting the user about what to do about a pre-existing HTML directory, if it exists.
1
Recycle image files from a previous run if they are available, but do not share identical images that must be created in this run.
2
Recycle image files from a previous run and share identical images from this run. (This is the default).

Section 4.5 provides additional information about image reuse.
*-no_reuse
Do not share or recycle images generated during previous translations. This is equivalent to -reuse 0. (This will enable the initial interactive session during which the user is asked whether to reuse the old directory, delete its contents or quit)


change_end

*-init_file file
Load the specified file. This Perl file will be loaded after loading $HOME/.latex2html-init (if one exists). It can be used to change the default options.
*-no_images
Do not attempt to produce any inlined images. The missing images can be generated "off-line" by restarting LaTeX2HTML with the option -images_only.
*-images_only
Try and convert any inlined images that were left over from previous runs of LaTeX2HTML.
*-show_section_numbers
Show section numbers. By default the section numbers are not shown in order to encourage the use of particular sections as standalone documents. In order to be shown, section titles must be unique and must not contain inlined graphics.
*-html_version version
This specifies the HTML version   to generate. Currently, versions 2.1, 2.2, 3.0 and 3.1 are available. The default version is 2.0.
change_begin
*-vs
Print the current version of LaTeX2HTML.


change_end

*-h
Print out the list of options.


next up previous contents index
Next: Extending the Translator Up: User Manual Previous: User Manual

Bo Milvang-Jensen
Tue May 28 19:03:54 MET DST 1996