mthl
/
texinfo


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472
							@c
@c This file is part of the ``Texinfo to HTML Converter'' manual
@c which is part of the ``texi2html'' distribution.
@c
@c License:
@c    Copyright (C) 1999, 2000  Free Software Foundation, Inc.
@c
@c    This program is free software; you can redistribute it
@c    and/or modify it under the terms of the GNU General Public
@c    License as published by the Free Software Foundation;
@c    either version 2 of the License, or (at your option) any
@c    later version.
@c
@c    This program is distributed in the hope that it will be
@c    useful, but WITHOUT ANY WARRANTY; without even the implied
@c    warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
@c    PURPOSE.  See the GNU General Public License for more
@c    details.
@c
@c    You should have received a copy of the GNU General
@c    Public License along with this program; if not, write to
@c    the Free Software Foundation, Inc., 59 Temple Place, Suite
@c    330, Boston, MA  02111-1307  USA
@c
@c
@c Revisions:
@c 
@c
@c Author:
@c   Karl Heinz Marbaise <khmarbaise@gmx.de>
@c
@c Description:
@c   Here you can find the description on the
@c   command line options.
@c
@c ========================================================
@chapter Command Line Options

@menu
* OptionDebug::               Debugging.
* OptionDocType::             DocType (HTML)
* OptionCheck::               Checking files.
* OptionExpand::              Expanding info, tex areas etc.
* OptionGlossary::            Glossary.
* OptionInvisible::           Invisible.
* OptionIso::                 Iso.
* OptionInclude::             Include directories.
* OptionTopFile::             Top File.
* OptionTocFile::             Table of content File.
* OptionFrames::              Frames.
* OptionMenu::                Menus.
* OptionNumber::              Number sections.
* OptionSplit::               Splitting.
* OptionSectionNavigation::   Navigation.
* OptionSubDir::              Subdirectory.
* OptionShortExt::            Short extension.
* OptionPrefix::              Prefix.
* OptionOutput::              Output.
* OptionShortRef::            Short Ref.
* OptionIndexSummary::        Index Summary.
* OptionVerbose::             Verbose.
* OptionLanguage::            Language.
* OptionL2H::                 La@TeX{}2HTML.
@end menu


@c --------------------------------------------------------
@node OptionDebug, OptionDocType, Options, Options
@section Debugging
@cindex Debugging
@vindex DEBUG_TOC
@vindex DEBUG_INDEX
@vindex DEBUG_BIB
@vindex DEBUG_GLOSS
@vindex DEBUG_DEF
@vindex DEBUG_HTML
@vindex DEBUG_USER
@vindex DEBUG_L2H
@opindex debug

@option{-debug}

debugging: 0 --- no debugging; other values; see beginning
of texi2html

@var{$DEBUG_TOC}   =  1;
@var{$DEBUG_INDEX} =  2;
@var{$DEBUG_BIB}   =  4;
@var{$DEBUG_GLOSS} =  8;
@var{$DEBUG_DEF}   = 16;
@var{$DEBUG_HTML}  = 32;
@var{$DEBUG_USER}  = 64;
@var{$DEBUG_L2H}   = 128;

@c --------------------------------------------------------
@node OptionDocType, OptionCheck, OptionDebug, Options
@section DocType
@cindex HTML, Doc Type
@opindex doctype
@vindex T2H_DOCTYPE
@option{-doctype}

@example
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
@end example

@c --------------------------------------------------------
@node OptionCheck, OptionExpand, OptionDocType, Options
@section Check
@cindex Texinfo, checking
@opindex check
@vindex T2H_CHECK
@option{-check}
if set, only check files and give the list of all things
that look like untranslated Texinfo commands

@c --------------------------------------------------------
@node OptionExpand, OptionGlossary, OptionCheck, Options
@section Expand
@opindex expand
@vindex T2H_EXPAND
@option{-expand}
if set to @strong{tex} (or, @strong{info}) expand
@code{@@iftex} and @code{@@tex} (or, @code{@@ifinfo})
sections else, neither expand @code{@@iftex}, @code{@@tex},
nor @code{@@ifinfo} sections

@c $T2H_EXPAND = "info";

@c --------------------------------------------------------
@node OptionGlossary, OptionInvisible, OptionExpand, Options
@section Glossary
@cindex HTML, Glossary
@cindex Texinfo, Glossary
@opindex glossary
@vindex T2H_USE_GLOSSARY
@option{-glossary}
if set, uses section named @strong{Footnotes} for glossary

@c --------------------------------------------------------
@node OptionInvisible, OptionIso, OptionGlossary, Options
@section Invisible
@cindex Mark, invisible
@cindex invisible, Mark
@opindex invisible
@vindex T2H_INVISIBLE_MARK
@option{-invisible}
@var{$T2H_INVISIBLE_MARK} is the text used to create
invisible destination anchors for index links (you can for
instance use the @file{invisible.xbm} file shipped with
this program). This is a workaround for a known bug of many
@acronym{WWW} browsers, including Netscape. For me, it
works fine without it --- on the contrary: if there, it
inserts space between headers and start of text (obachman
3/99)

@example
$T2H_INVISIBLE_MARK = "";
# $T2H_INVISIBLE_MARK = '&#160;';
@end example

@c --------------------------------------------------------
@node OptionIso, OptionInclude, OptionInvisible, Options
@section Iso
@cindex ISO8859
@cindex Copyright
@opindex iso
@vindex T2H_USE_ISO
@option{-iso}

if set, ISO8859 characters are used for special symbols
(like Copyright @code{@copyright{}}, etc)

$T2H_USE_ISO = 0;

@c --------------------------------------------------------
@node OptionInclude, OptionTopFile, OptionIso, Options
@section Include Directory
@vindex Include directories
@opindex I
@vindex T2H_INCLUDE_DIRS
@option{-I}

list directories where @code{@@include} files are searched for
(besides the directory of the doc file) additional
@option{-I} args are add to this list.

@@T2H_INCLUDE_DIRS = (".");

@c --------------------------------------------------------
@node OptionTopFile, OptionTocFile, OptionInclude, Options
@section Top File
@cindex Top Level file
@cindex HTML, index.html
@opindex top_file
@vindex T2H_TOP_FILE
@option{-top_file}
uses file of this name for top-level file
extension is manipulated appropriately, if necessary.
If empty, @file{<basename of document>.html} is used.
Typically, you would set this to @file{index.html}.

$T2H_TOP_FILE = "";

@c --------------------------------------------------------
@node OptionTocFile, OptionFrames, OptionTopFile, Options
@section Table Of content File
@cindex Table of content file
@opindex toc_file
@vindex T2H_TOC_FILE
@option{-toc_file}
uses file of this name for table of contents.  File extension
is manipulated appropriately, if necessary. If empty,
@file{<basename of document>_toc.html} is used.

$T2H_TOC_FILE = "";

@c --------------------------------------------------------
@node OptionFrames, OptionMenu, OptionTocFile, Options
@section Frames
@vindex HTML, frames
@vindex HTML 4.0, frames
@opindex frames
@vindex T2H_FRAMES
@option{-frames}
if set, output two additional files which use HTML 4.0
@b{frames}.

$T2H_FRAMES = 0;

@c --------------------------------------------------------
@node OptionMenu, OptionNumber, OptionFrames, Options
@section Menus
@cindex HTML, menu
@cindex Texinfo, menu
@opindex menu
@opindex nomenu
@vindex T2H_SHOW_MENU
@option{-menu} or @option{-nomenu} if set, show the Texinfo
menus

$T2H_SHOW_MENU = 1;

@c --------------------------------------------------------
@node OptionNumber, OptionSplit, OptionMenu, Options
@section Number sections
@cindex Section numbering
@opindex number
@opindex nonumber
@vindex T2H_NUMBER_SECTIONS
@option{-number} @option{-nonumber}
if set, number sections and show section names and numbers
in references and menus

@c Just think about it?
@c @defvar $T2H_NUMBER_SECTIONS
@c @c = 1;
@c @end defvar

@c --------------------------------------------------------
@node OptionSplit, OptionSectionNavigation, OptionNumber, Options
@section Split
@cindex HTML, split
@cindex File, split
@opindex split
@vindex T2H_SPLIT
@option{-split section|chapter|none}
if set to @strong{section} (resp. @strong{chapter}) create one
@acronym{HTML} file per (sub)section (resp. chapter) and
separate pages for Top, ToC, Overview, Index, Glossary,
About.  Otherwise, create a monolithic @acronym{HTML} file that
contains the whole document.

#$T2H_SPLIT = 'section';
$T2H_SPLIT = undef;

@c --------------------------------------------------------
@node OptionSectionNavigation, OptionSubDir, OptionSplit, Options
@section Section navigation
@cindex HTML, Navigation
@opindex section_navigation
@opindex no-section_navigation
@vindex T2H_SECTION_NAVIGATION
@option{-section_navigation}|
@option{-no-section_navigation}

if set, then navigation panels are printed at the beginning
of each section and, possibly at the end (depending on
whether or not there were more than 
@var{$T2H_WORDS_IN_PAGE} words on page). This is most useful
if you do not want to have section navigation on
@option{-split chapter}

@c @vindex T2H_SECTION_NAVIGATION
@c @defvar $T2H_SECTION_NAVIGATION
@c = 1;
@c @end defvar

@c --------------------------------------------------------
@node OptionSubDir, OptionShortExt, OptionSectionNavigation, Options
@section Subdirectory
@cindex Subdirectory
@vindex T2H_SUBDIR
@option{-subdir}
If set, then put result files in the specified directory.
If not set, then result files are put into the current directory.

@c #$T2H_SUBDIR = 'html';
@var{$T2H_SUBDIR} = undef;

@c --------------------------------------------------------
@node OptionShortExt, OptionPrefix, OptionSubDir, Options
@section Short extension
@cindex HTML, .htm extension
@cindex HTML, .html extension
@cindex extension, .html
@cindex extension, .htm
@vindex T2H_SHORTEXTN
@opindex short_extn
@option{-short_extn}
If this is set, then all @acronym{HTML} files will have extension
@file{.htm} instead of @file{.html}. This is helpful when
shipping the document to DOS-based systems.
@var{$T2H_SHORTEXTN} = 0;

@c --------------------------------------------------------
@node OptionPrefix, OptionOutput, OptionShortExt, Options
@section Prefix
@cindex Prefix
@vindex T2H_PREFIX
@opindex prefix
@option{-prefix}
Set the output file prefix, prepended to all @file{.html},
@file{.gif} and @file{.pl} files.
By default, this is the basename of the document

@var{$T2H_PREFIX} = "";

@c --------------------------------------------------------
@node OptionOutput, OptionShortRef, OptionPrefix, Options
@section Output filename
@cindex Output filename
@cindex Filename, output
@vindex T2H_OUT
@opindex o
@opindex out_file

@option{-o filename}|@option{-out_file}
If set, generate monolithic document output @acronym{HTML}
into @file{filename}.

@c --------------------------------------------------------
@node OptionShortRef, OptionIndexSummary, OptionOutput, Options
@section Short Cross References
@cindex References, short
@cindex sections without numbers
@vindex T2H_SHORT_REF
@opindex short_ref
@option{-short_ref}
if set cross-references are given without section numbers

@c --------------------------------------------------------
@node OptionIndexSummary, OptionVerbose, OptionShortRef, Options
@section Index Summary
@cindex Index, Summary
@cindex Summary Index
@cindex HTML, Index
@vindex T2H_IDX_SUMMARY
@opindex idx_sum
@option{-idx_sum}
If value is set, then for each @code{@@prinindex $what}
@file{$docu_name_$what.idx} is created which contains lines of the
form @strong{$key\t$ref} sorted alphabetically (case
matters).

@c --------------------------------------------------------
@node OptionVerbose, OptionLanguage, OptionIndexSummary, Options
@section Verbose output
@cindex Output, verbose
@cindex Verbose output
@cindex Debugging, verbose output
@vindex T2H_VERBOSE
@opindex verbose
@option{-verbose}
if set, chatter about what we are doing.

@c --------------------------------------------------------
@node OptionLanguage, OptionL2H, OptionVerbose, Options
@section Language Support
@cindex Language Support
@cindex Support different languages
@vindex $T2H_LANG
@vindex $T2H_WORDS
@opindex lang
@option{-lang}
For page titles, use
@code{$T2H_WORDS->@{$T2H_LANG@}->@{...@}} as title. To add
a new language, supply list of titles (see @var{$T2H_WORDS}),
and use ISO 639 language codes (see e.g.@: perl module
@file{Locale-Codes-1.02.tar.gz} for definitions).

If you don't give a @option{-lang} then we got it from the
Texinfo source file (@@documentlanguage
@c Put a table with the language codes here!
@c Or better put a reference into the Texinfo
@c Manual, which has a table of ISO 639-Codes.
@c
@c Currently the @xref etc. does not work with
@c external documents, cause we don't know
@c reference (anchor) value or there is no way
@c to get it.
@c The following reference does only work correctly
@c in Info!!!
@pxref{documentlanguage,,,Texinfo}). If there is no
@code{@@documentlanguage} we use the default @code{en} for
the language.
@c
@c put some information about Month names etc. here
@c $MONTH_NAMES !!
@c Supplemental should be a naming scheme for variables in
@c different languages (MONTH_NAMES_DE etc.)
@c --------------------------------------------------------
@node OptionL2H, , OptionLanguage, Options
@section La@TeX{}2HTML for @code{@@math} and @code{@@tex}
@cindex La@TeX{}2HTML
@cindex Conversion of @@math and @@tex
@cindex @@tex
@cindex @@math
@vindex T2H_L2H
@opindex l2h
@option{-l2h}
if set, uses @command{latex2html} for generation of math
content.

@menu
* OptionL2HL2H::    Where to find La@TeX{}2HTML.
* OptionL2HSkip::   Skip calling La@TeX{}2HTML.
* OptionL2Htmp::    Temporary files for La@TeX{}2HTML.
@end menu

@c --------------------------------------------------------
@node OptionL2HL2H, OptionL2HSkip, OptionL2H, OptionL2H
@subsection Where to find @command{latex2html}
@cindex location, La@TeX{}2HTML
@cindex La@TeX{}2HTML, location
@vindex T2H_L2H_L2H
@opindex l2h_l2h
@option{-l2h_l2h}
name/location of @command{latex2html} program.

@c --------------------------------------------------------
@node OptionL2HSkip, OptionL2Htmp, OptionL2HL2H, OptionL2H
@subsection Skip calling La@TeX{}2HTML
@cindex La@TeX{}2HTML, skip calling
@vindex T2H_L2H_SKIP
@opindex l2h_skip
@option{-l2h_skip}
If set, skips actual call to @command{latex2html}: tries to
reuse previously generated content, instead.

@c --------------------------------------------------------
@node OptionL2Htmp, , OptionL2HSkip, OptionL2H
@subsection Temporary files for La@TeX{}2HTML
@cindex Temporary, La@TeX{}2HTML
@cindex La@TeX{}2HTML, Temporary files
@vindex T2H_L2H_TMP
@opindex l2h_tmp
@option{-l2h_tmp}
If set, l2h uses this directory for temporary files.  The
path leading to this directory may not contain a dot (i.e.,
a @samp{.}); otherwise, l2h will fail.