NAME
SYNOPSIS
DESCRIPTION
OPTIONS
FILES
ENVIRONMENT
PROBLEMS
AUTHOR
SEE ALSO

NAME

latex2html - Translate LaTeX files to HTML (HyperText Markup Language)

SYNOPSIS

latex2html [ -help | -h ] [ -version | -V ]

latex2html [ -split num ] [ -link num ] [ -toc_depth num ] [ -(no)toc_stars ] [ -(no)short_extn ] [ -iso_language lang ] [ -(no)validate ] [ -(no)latex ] [ -(no)djgpp ] [ -(no)fork ] [ -(no)external_images ] [ -(no)ascii_mode ] [ -(no)lcase_tags ] [ -(no)ps_images ] [ -font_size size ] [ -(no)tex_defs ] [ -(no)navigation ] [ -(no)top_navigation ] [ -(no)buttom_navigation ] [ -(no)auto_navigation ] [ -(no)index_in_navigation ] [ -(no)contents_in_navigation ] [ -(no)next_page_in_navigation ] [ -(no)previous_page_in_navigation ] [ -(no)footnode ] [ -(no)numbered_footnotes ] [ -prefix output_filename_prefix ] [ -(no)auto_prefix ] [ -long_titles num ] [ -(no)custom_titles ] [ -title|-t top_page_title ] [ -(no)rooted ] [ -rootdir output_directory ] [ -dir output_directory ] [ -mkdir ] [ -address author_address | -noaddress ] [ -(no)subdir ] [ -info 0 | 1 | string ] [ -(no)auto_link ] [ -reuse num | -noreuse ] [ -(no)antialias_text ] [ -(no)antialias ] [ -(no)transparent ] [ -(no)white ] [ -(no)discard ] [ -image_type type ] [ -(no)images ] [ -accent_images type | -noaccent_images ] [ -style style ] [ -(no)parbox_images ] [ -(no)math ] [ -(no)math_parsing ] [ -(no)latin ] [ -(no)entities ] [ -(no)local_icons ] [ -(no)scalable_fonts ] [ -(no)images_only ] [ -(no)show_section_numbers ] [ -(no)show_init ] [ -init_file Perl_file ] [ -up_url up_URL ] [ -up_title up_title ] [ -down_url down_URL ] [ -down_title down_title ] [ -prev_url prev_URL ] [ -prev_title prev_title ] [ -index index_URL ] [ -biblio biblio_URL ] [ -contents toc_URL ] [ -external_file external_aux_file ] [ -(no)short_index ] [ -(no)unsegment ] [ -(no)debug ] [ -tmp path ] [ -(no)ldump ] [ -(no)timing ] [ -verbosity num ] [ -html_version num ] [ -(no)strict ] file.tex [ file2.tex ... ]

DESCRIPTION

LaTeX2HTML is a Perl program that translates LaTeX source files into HTML. For each source file given as an argument the translator will create a directory containing the corresponding HTML files.

OPTIONS

Many options can be specified in a true/false manner. This is indicated by (no), e.g. to enable passing unknown environments to LaTeX, say ``-latex'', to disable the feature say ``-nolatex'' or ``-no_latex'' (portability mode).

-help | -h

Print this online manual and exit.

-version | -V

Print the LaTeX2HTML release and version information and exit.

-split num

Stop making separate files at this depth (say ``-split 0'' for one huge HTML file).

-link num

Stop showing child nodes at this depth.

-toc_depth num

MISSING_DESCRIPTION

-(no)toc_stars

MISSING_DESCRIPTION

-(no)short_extn

If this is set all HTML file will have extension .htm instead of .html. This is helpful when shipping the document to PC systems.

-iso_language lang

MISSING_DESCRIPTION

-(no)validate

When this is set true, the HTML validator specified in l2hconf.pm will run.

-(no)latex

Pass unknown environments to LaTeX. This is the default.

-(no)djgpp

Specify this switch if you are running DJGPP on DOS and need to avoid running out of filehandles.

-(no)fork

Enable/disable forking. The default is reasonable for this platform.

-(no)external_images

If set, leave the images outside the document.

-(no)ascii_mode

This is different from -noimages. If this is set, LaTeX2HTML will show textual tags rather than images, both in navigation panel and text (Eg. [Up] instead the up icon). You could use this feature to create simple text from your document, eg. with 'Save as... Text' from Netscape or with lynx -dump.

-(no)lcase_tags

writes out HTML tag names using lowercase letters, rather than uppercase.

-(no)ps_images

If set, use links to external postscript images rather than inlined bitmaps.

-font_size size

To set the point size of LaTeX-generated GIF files, specify the desired value (i.e., 10pt, 11pt, 12pt, etc.). The default is to use the point size of the original LaTeX document. This value will be magnified by $FIGURE_SCALE_FACTOR and $MATH_SCALE_FACTOR defined in l2hconf.pm.

-(no)tex_defs

Enable interpretation of raw TeX commands (default). Note: There are many variations of \def that LaTeX2HTML cannot process correctly!

-(no)navigation

Put a navigation panel at the top of each page (default).

-(no)top_navigation

Enables navigation links at the top of each page (default).

-(no)buttom_navigation

Enables navigation links at the buttom of each page.

-(no)auto_navigation

Put navigation links at the top of each page. If the page exceeds $WORDS_IN_PAGE number of words then put one at the bottom of the page.

-(no)index_in_navigation

Put a link to the index page in the navigation panel.

-(no)contents_in_navigation

Put a link to the table of contents in the navigation panel.

-(no)next_page_in_navigation

Put a link to the next logical page in the navigation panel.

-(no)previous_page_in_navigation

Put a link to the previous logical page in the navigation panel.

-(no)footnode

Puts all footnotes onto a separate HTML page, called footnode.html, rather than at the bottom of the page where they are referenced.

-(no)numbered_footnotes

If true, you will get every footnote applied with a subsequent number, else with a generic hyperlink icon.

-prefix output_filename_prefix

Set the output file prefix, prepended to all .html, .gif and .pl files. See also -auto_prefix.

-(no)auto_prefix

Set this to automatically insert the equivalent of -prefix basename-``, where ''basename`` is the base name of the file being translated.

-long_titles num

MISSING_DESCRIPTION

-(no)custom_titles

MISSING_DESCRIPTION

-title|-t top_page_title

The title (displayed in the browser's title bar) the document shall get.

-(no)rooted

MISSING_DESCRIPTION

-rootdir output_directory

MISSING_DESCRIPTION

-dir output_directory

Put the result in this directory instead of parallel to the LaTeX file, provided the directory exists, or -mkdir is specified.

-mkdir

Allow directory specified with -dir to be created if necessary.

-address author_address | -noaddress

Supply your own string if you don't like the default ``<Name> <Date>''. -noaddress suppresses the generation of an address footer.

-(no)subdir

If set (default), LaTeX2HTML creates (or reuses) another file directory. When false, the generated HTML files will be placed in the current directory.

-info 0 | 1 | string

-noinfo

If 0 is specified (or -noinfo is used), do not generate an ``About this document...'' section. If 1 is specified (default), the standard info page is generated. If a custom string is given, it is used as the info page.

-(no)auto_link

MISSING_DESCRIPTION

-reuse num | -noreuse

If false, do not reuse or recycle identical images generated in previous runs. If the html subdirectory already exists, start the interactive session. If num is nonzero, do recycle them and switch off the interactive session. If 1, only recycle images generated from previous runs. If 2, recycle images from the current and previous runs (default).

-(no)antialias_text

Use anti-aliasing in the generation of images of typeset material; e.g. mathematics and text, e.g. in tables and {makeimage} environments.

-(no)antialias

Use anti-aliasing in the generation of images of figures. This usually results in ``sharper'' bitmap images.

-(no)transparent

If this is set to false then any inlined images generated from ``figure'' environments will NOT be transparent.

-(no)white

This sets the background of generated images to white for anti-aliasing.

-(no)discard

if true, the PostScript file created for each generated image is discarded immediately after its image has been rendered and saved in the required graphics format. This can lead to significant savings in disk-space, when there are a lot of images, since otherwise these files are not discarded until the end of all processing.

-image_type type

Specify the type of bitmap images to be generated. Depending on your setup, LaTeX2HTML can generate gif or png images. Note: Gif images have certain legal restrictions, as their generation involves an algorithm patented by Unisys.

-(no)images

If false, LaTeX2HTML will not attempt to produce any inlined images. The missing images can be generated ``off-line'' by restarting LaTeX2HTML with -images_only.

-accent_images type | -noaccent_images

MISSING_DESCRIPTION

-style style

MISSING_DESCRIPTION

-(no)parbox_images

MISSING_DESCRIPTION

-(no)math

By default the special MATH extensions are not used since they do not conform with the HTML 3.2 standard.

-(no)math_parsing

MISSING_DESCRIPTION

-(no)latin

MISSING_DESCRIPTION

-(no)entities

MISSING_DESCRIPTION

-(no)local_icons

Set this if you want to copy the navigation icons to each document directory so that the document directory is self-contained and can be dropped into another server tree without further actions.

-(no)scalable_fonts

MISSING_DESCRIPTION

-(no)images_only

When true, LaTeX2HTML will only try to convert the inlined images in the file images.tex which should have been generated automatically during previous runs. This is very useful for correcting ``bad LaTeX'' in this file.

-(no)show_section_numbers

When this is set true, the section numbers are shown. The section numbers should then match those that would have been produced by LaTeX. The correct section numbers are obtained from the $FILE.aux file generated by LaTeX. Hiding the section numbers encourages use of particular sections as standalone documents. In this case the cross reference to a section is shown using the default symbol rather than the section number.

-(no)show_init

MISSING_DESCRIPTION

-init_file Perl_file

MISSING_DESCRIPTION

-up_url up_URL, -up_title up_title

-down_url down_URL, -down_title down_title

-prev_url prev_URL, -prev_title prev_title

-index index_URL,

-contents toc_URL

-biblio biblio_URL

If both of the listed two options are set then the ``Up'' (``Previous'' etc.) button of the navigation panel in the first node/page of a converted document will point to up_URL etc. up_title should be set to some text which describes this external link. Similarly you might use these options to link external documents to your navigation panel.

-external_file external_aux_file

MISSING_DESCRIPTION

-(no)short_index

If this is set then makeidx.perl will construct codified names for the text of index references.

-(no)unsegment

Use this to translate a segmented document as if it were not segmented.

-(no)debug

If this is set then intermediate files are left for later inspection and a lot of diagnostic output is produced. This output may be useful when searching for problems and/or submitting bug reports to the developers. Temporary files include $$_images.tex and $$_images.log created during image conversion. Caution: Intermediate files can be enormous!

-tmp path

Path for temporary files. This should be a local, fast filesystem because it is heavily used during image generation. The default is set in l2hconf.pm.

-(no)ldump

This will cause LaTeX2HTML to produce a LaTeX dump of images.tex which is read in on subsequent runs and speeds up startup time of LaTeX on the images.tex translation. This actually consumes additional time on the first run, but pays off on subsequent runs. The dump file will need about 1 Meg of disk space.

-(no)timing

MISSING_DESCRIPTION

-verbosity num

The amount of message information printed to the screen during processing by LaTeX2HTML is controlled by this setting. By increasing this value, more information is displayed. Here is the type of extra information that is shown at each level:

  0   no extra information
  1   section types and titles
  2   environment
  3   command names
  4   links, labels and internal sectioning codes

-html_version list

Which HTML version should be generated. Currently available are: 2.0, 3.0, 3.2, 4.0. Some additional options that may be added are: math (parse mathematics), i18n (?), table (generate tables), frame (generate frames), latin1...latin9 (use ISO-Latin-x encoding), unicode (generate unicode characters). Separate the options with ',', e.g. 4.0,math,frame.

-(no)strict

MISSING_DESCRIPTION

FILES

$LATEX2HTMLPLATDIR/l2hconf.pm: This file holds the global defaults and configuration settings for LaTeX2HTML.
$HOME/.latex2html-init
./.latex2html-init: These files may contain settings that override the global defaults, just like specifying command line switches.

ENVIRONMENT

LATEX2HTMLDIR: Path where LaTeX2HTML library files are found. On this installation LATEX2HTMLDIR is d:\\Local\\TeXLive\\l2h
PERL5LIB: Set by the latex2html program to find perl modules.
L2HCONFIG: An alternative configuration filename. The standard configuration file is $LATEX2HTMLPLATDIR/l2hconf.pm. You may specify a sole filename (searched for in $LATEX2HTMLPLATDIR (and $PERL5LIB) or a complete path.
L2HINIT_NAME: The standard user-specific configuration filename is .latex2html-init. This environment variable will override this name.
HOME: Evaluated if the system does not know about ``home'' directories (like DOS, WinXX, OS/2, ...) to determine the path to $L2HINIT_NAME.
TEXE_DONT_INCLUDE, TEXE_DO_INCLUDE: Used internally for communication with texexpand.
TEXINPUTS: Used to find TeX includes of all sorts.

PROBLEMS

For information on various problems and remedies see the WWW online documentation or the documents available in the distribution. An online bug reporting form and various archives are available at http://www.latex2html.org/

There is a mailing list for discussing LaTeX2HTML: latex2html@tug.org

AUTHOR

Nikos Drakos, Computer Based Learning Unit, University of Leeds <nikos@cbl.leeds.ac.uk>. Several people have contributed suggestions, ideas, solutions, support and encouragement.

The pstoimg script was written by Marek Rouchal <marek@saftsack.fs.uni-bayreuth.de> as a generalisation of the pstogif utility to allow graphic formats other than GIF to be created. Various options and enhancements have been added by Ross Moore. Some of the code is based upon the pstoppm.ps postscript program originally written by Phillip Conrad (Perfect Byte, Inc.) and modified by L. Peter Deutsch (Aladdin Enterprises).