# start of POD documentation
latex2html - LaTeX ファイルを HTML (HyperText Markup Language) に変換
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 ... ]
LaTeX2HTML は、LaTeX ソースファイルを HTML に変換する Perl プログラムです。 引数として与えられたソースファイルに対して、 このプログラムは対応する HTML ファイルを含むディレクトリを作成します。
ON/OFF 方式で指定できるオプションもたくさんあり、 それらは (no) で示しています。 例えば、不明な環境を LaTeX に渡すことを有効にするには "-latex" とし、 その機能を無効にするには "-nolatex" か "-no_latex" (互換モード) とします。
このオンラインマニュアルを表示して終了します。
LaTeX2HTML のリリース番号、バージョン情報を表示して終了します。
個別のファイルへの分離を、この深さでやめます ("-split 0" は一つの巨大な HTML ファイルを作ります)。
子ノードの表示を、この深さでやめます。
tableofcontents による目次に num までの レベルのセクションを入れます。 (訳注: オリジナルは記述なし)
これが ON の場合は、* 付きのセクションコマンド (section* 等) も tableofcontents による目次に入れます。 (訳注: オリジナルは記述なし)
これを ON にすると、すべての HTML ファイルの拡張子は .html ではなく .htm になります。 これは、その文書を PC システムへ送る場合には有用です。
HTML ファイルの DTD エントリに、'EN' の代わりに lang を書き込みます。 (訳注: オリジナルは記述なし。 なお、これは HTML ファイル内の言語とは関係なく、 日本語 HTML ファイルでも通常は 'EN' のままです。)
これが ON の場合は、l2hconf.pm で指定した HTML バリデーター (訳注: HTML コードの適切さをチェックするソフトウェア) を実行します。
不明な環境を LaTeX に渡します。それがデフォルトです。
DOS の上で DJGPP を動かしていて、 かつファイルハンドルの制限を越えた動作を避ける必要がある場合に このオプションを指定します。
フォークを有効/無効にします。デフォルトは、その動作環境で意味のある方です。
これを ON にすると、画像ファイルを文書外に置いたままにします (訳注: 図や数式等の画像を、IMG タグではなく A タグのリンクにします)。
これは、-noimages とは異なります。 これを ON にすると、LaTeX2HTML はナビゲーションパネルとその文字列の 両方で画像ではなくテキスト的なタグを使おうとします (例えば up 用のアイコンの代わりに [Up] と)。 この機能は、あなたの文書から単純なテキスト、 例えば Netscape の 'Save as... Text' や lynx -dump 用のものを生成するのに利用できます (訳注: latex2html-2016 では、このオプションは -external_images も ON にします)。
HTML タグ名を大文字でなく、小文字にして書き出します。
これを ON にすると、インラインビットマップの代わりに、 外部 PostScript 画像をリンクします。 (訳注: GIF/PNG 画像への変換をせず、その手前の ps の作成でやめて、 それを IMG タグでなく A タグでリンクします。)
LaTeX が生成する GIF ファイルのポイントサイズを設定するために、 望ましい値 (例えば 10pt, 11pt, 12pt 等) を指定してください。 デフォルトは、元の LaTeX 文書のポイントサイズを使用します。 この値は、l2hconf.pm で定義される $FIGURE_SCALE_FACTOR と $MATH_SCALE_FACTOR の値でも拡大されます。 (訳注: $DISP_SCALE_FACTOR も。)
生の TeX コマンドの解釈を可能にします (デフォルト)。 注意: \def には色々な変種がありますが、 LaTeX2HTML が正しく処理できないものもたくさんあります！
各ページの上部にナビゲーションパネルを配置します (デフォルト)。
各ページの上部のナビゲーションリンクを有効にします (デフォルト)。
各ページの下部のナビゲーションリンクを有効にします。 (訳注: 上部のナビゲーションリンクには影響を与えません。)
各ページの上部にナビゲーションリンクを置きます。 もし、ページの単語数が $WORDS_IN_PAGE を越えたら、 そのページの下部にもナビゲーションリンクを置きます。 (訳注: 「単語数」は当然空白区切りの語を数えていますので、 空白で区切らない日本語文書の場合は通常どのページも 単語数は非常に小さな値になり、この仕組みは意味がありません。)
ナビゲーションパネルに、索引 (index) ページへのリンクをつけます。
ナビゲーションパネルに、目次 (table of contents) へのリンクをつけます。
ナビゲーションパネルに、論理的に次のページへのリンクをつけます。
ナビゲーションパネルに、論理的に前のページへのリンクをつけます。
すべての脚注 (footnote) を、それを呼び出すページの下につけるのではなく、 一つの独立な HTML ページ footnode.html に置きます。 (訳注: この挙動がデフォルト。なお、 footnote でなく footnode であることに注意。)
これが ON の場合、すべての脚注に連続した番号を割り当てます。 OFF の場合は、一般的なハイパーリンクアイコンをつけます。
.html, .gif, .pl 等のすべての出力ファイルのファイル名の頭につける 接頭辞を設定します。-auto_prefix も参照してください。
これが ON の場合、自動的に-prefix basename- と同等のものを追加します。 ここで、"basename" は、変換されるファイルのファイル名本体 (ベース名) です。
これは、標準的な名前である node1.html, node2.html,... の代わりに、 各 HTML ページのファイル名としてそのページのセクション名の 先頭の num 単語を文字 "_" でつないだものを使用します。 (訳注: オリジナルは記述なし。)
これは、標準的な名前である node1.html, node2.html,... の代わりに、 各 HTML ページのファイル名として custom_title_hook という Perl サブルーチンの返すものを使用します。 このサブルーチンは、.latex2html-init で定義可能です。 (訳注: オリジナルは記述なし。man ファイルより。)
ブラウザのタイトルバーに表示されるタイトルを指定します。
通常のターゲットディレクトリを A タグのリンク先に入れ、 それがルートディレクトリであるようにする (訳注: オリジナルは記述なし。 また、このオプションには問題がかなりあるので使用しない方がよい。)
A タグに入れるルートディレクトリを指定する。 (訳注: オリジナルは記述なし。 また、このオプションには問題がかなりあるので使用しない方がよい。)
LaTeX ファイル名によるディレクトリではなく、 ここで指定したディレクトリ内に結果を出力します。 そのディレクトリは既に存在している必要がありますが、 そうでなければ -mkdir を指定する必要があります。
これは、-dir で指定したディレクトリを、 必要があれば作成することを許可します。
デフォルトのアドレス文字列 ""<名前> <日付>" が気に入らない場合、これで自分の好きな文字列を指定します。 -noaddress は、フッタにアドレス文字列を出さないようにします。 (訳注: latex2html-2017 からはアドレス文字列がでない -noaddress がデフォルトです。)
これを ON にすると (デフォルト)、 LaTeX2HTML は別なファイルディレクトリを作ります (または再利用します)。 OFF の場合は、HTML ファイルを現在のディレクトリに置きます。
0 を指定するかまたは -noinfo とした場合は、 "この文書について" の節 (info page) は作りません。 1 を指定すると (デフォルト)、標準的な info page を作ります。 自前の文字列 (string) を指定した場合は、それを info page として使用します。
デフォルトでは、作成するメインの HTML ファイル (file.html) に index.html という名前の ハードリンクを作りますが (-auto_link)、 -no_auto_link とするとそのハードリンクを作りません。 (訳注: オリジナルは記述なし。)
OFF の場合、前回の実行時に作った画像の再利用も再資源化もしません。 html のサブディレクトリが既に存在すれば、対話型セッションを開始します。 num がゼロでない場合は、 画像を再資源化し、対話型セッションは開きません。 1 を指定すると、前回の実行で作った画像の再資源化のみ行います。 2 を指定すると、前回の実行と今回の画像の再資源化を行います (デフォルト)。
文章要素 (例えば数式や表、{makeimage} 環境内の文字列) を画像化する際、アンチエイリアス処理を行います。
図 (figure) を画像化する際、アンチエイリアス処理を行います。 これは通常「より鋭い」ビットマップ画像を作成します。 (訳注: 「鋭い」は逆のような。)
これを OFF にすると、figure 環境からインライン画像を作成する際に 透明化 (transparent) を行いません。 (訳注: figure 環境だけではなく、地の文や各種数式環境すべての画像生成で 透明化を行いません。)
これを ON にすると、 作成する画像の背景を、アンチエイリアス処理用に白にします。 (訳注: 「アンチエイリアス処理用に」の意味は不明。なお、 -notransparent を指定しないと、 -white としても主に figure 環境の画像しか白背景にはなりません。 すべてを白背景にするには、-notransparent も指定する必要があります。)
これを ON にすると、作成する各画像に対して、その画像が描画され、 要求された画像形式として保存されたら、 その生成用の PostScript ファイルをすぐに廃棄します。 これを使用すると、たくさんの画像がある場合でも ディスク容量を小さく保つことができます。そうでないと、 すべての処理が終わるまで多くのファイルが廃棄されません。
これは、作成するビットマップ画像の形式を指定します。 あなたの設定により、LaTeX2HTML は gif か png 画像を生成できます。 注意: GIF 画像には、その生成に Unisys が特許を持つ アルゴリズムが含まれていることによるある法的な制限があります。 (訳注: その特許は 2004 年に既に失効しています。)
これを OFF にすると、LaTeX2HTML は、インライン画像を一切作ろうとしません。 足りない画像は、LaTeX2HTML を -images_only で再実行することで 別に「オフライン」で生成できます。 (訳注: これは latex2html-97.1 の頃の話で、 現在の latex2html では -images_only で画像の再生成は できなくなっています。)
ISO-Latin フォントに含まれないアクセント付き文字を、 LaTeX を使って画像を作る際に使用する LaTeX コマンドの カンマ区切りのリストを指定します。 (訳注: オリジナルは記述なし。 なお、基本的には、'large' や 'textrm' など、 画像化する際のその文字の大きさや書体などを指定するコマンド列を書きますが、 この設定は個別指定ではなく、対象文字すべてに適用されてしまうことに 注意が必要です。)
style に、作成する HTML ファイル用のスタイルシートの ファイル名を指定します。指定しない場合は、 メインの LaTeX ファイル名に .css をつけたファイル名の スタイルシートファイル (file.css) を作成します。 存在するファイルを指定した場合、 それを書き換えずにスタイルシートとして使用します。 (訳注: オリジナルは記述なし。 また、-style で指定したファイル名のファイルには、 latex2html は何も書き出しませんし、 これを指定しても file.css は作成されます。 style の名前は生成する HTML ファイルの LINK タグ行に その名前を書き出すだけです。)
これを OFF にすると、デフォルトでは画像化する parbox コマンドの 中身を画像化せずにそのまま出力します。 (訳注: オリジナルは記述なし。)
特別な MATH 拡張は、HTML 3.2 規格には準拠しないため、 デフォルトではそれは使用されません。 (訳注: math.pl を -html_version でロードしていなければ、 -math は simple math モード (初心者モード) で、 数式は可能なところはイタリックテキストで表現し、 そうでない場所は画像化 (実際は eqnarray 環境を除いてはほぼ画像化)。 -no_math はプロフェッショナルモード (デフォルト) で、 数式をすべて画像化。 math.pl をロードしている場合 (または ams 関係のスタイルを使用している場合) は、 -no_math (または無指定) は、必要最小限の画像化を行い、 あとはテキストと HTML タグで表現。 -math の場合は MATH タグで表現しようとするが、 出力は完全ではなく、また対応ブラウザも多くはない。)
(訳注: オリジナルは記述なし。 math.pl をロードしていない場合、 あるいは -math の場合は特に効果はないようです。 math.pl をロードして、かつ -no_math の場合、 これの指定がないとき、あるいは -math_parsing のときはは、 数式の画像化は最小限に控えられ、 なるべくテキスト文字や HTML タグで数式が表現されますが、 -no_math_parsing の際は、数式はほぼすべてを画像化します。 ただし、eqnarray*, eqnarray 環境はまるごと画像化するのではなく、 左辺、2 項関係式、右辺のそれぞれに分けて画像化し、 全体を TABLE タグで表現します。)
オプションとしては存在しますが、現在は使用されていません。 (訳注: オリジナルは記述なし。)
これを ON にすると、CHARSET の値によっては、 数字によるパラメータエンティティで表記される特殊記号、数学記号 (math.pl, unicode.pl を使用した場合など) が、 名前によるエンティティ表記に変わる。 (訳注: オリジナルは記述なし。 なお、jarticle 等の日本語文書を処理する場合は、原則機能しない。)
ナビゲーションアイコンを、ドキュメントディレクトリにコピーしたい場合は これを ON にしてください。 そうすると、ドキュメントディレクトリ自体が自己完結的になり、 他のサーバツリーに別の処理なくそのまま移動することができるようになります。
これを ON にすると、画像生成時に latex2html 用の PK フォントを 生成せずにデフォルトプリンタ用の TEX フォントを使用します。 PostScript の TEX フォントが使える場合は指定します。 (訳注: オリジナルは記述なし。 なお、l2hconf.pm を修正しない限り (PK_GENERATION を 1 に)、 このオプションは指定しても指定しなくても ON の状態のままです。)
これを ON にすると、LaTeX2HTML は、 images.tex ファイル内に記述されたインライン画像の作成のみを行います。 このファイルは、以前の実行時に自動的に作成されるものです。 この機能は、このファイル内の「良くない LaTeX」部分を修正する際に有用です。 (訳注: これは latex2html-97.1 の頃の話で、 現在の latex2html では -images_only で画像の再生成は できなくなっています。)
これが ON の場合、セクション番号を示します。 セクション番号は、LaTeX で生成されるものと同じものになります。 セクション番号を隠すことにより、特定のセクション部分を、 独立した文書として使用することができます。 その場合、あるセクションに対する参照は、 セクション番号ではなく、デフォルトの記号で表示されます。
これが ON の場合、初期化ファイルの名前と内容を、 最後の文書情報ページ (「About this document」または「この文書について」) に表示します。 (訳注: オリジナルは記述なし。)
指定した初期化ファイルを読み込みます。 これは、デフォルトの初期化ファイル ($HOME/.latex2html-init、またはカレントディレクトリの .latex2html-init) を読み込んだ後に読み込まれます。 (訳注: オリジナルは記述なし。)
並べて示した 2 つのオプションの両方を設定すると、 変換されたドキュメントの最初のページ/ノードにあるナビゲーションパネルの "Up" (または "Previous" 等) のボタンが up_URL 等を指すようになります。 up_title は、その外部リンクを説明するような文字列と設定してください。 同様に、これらのオプションを、ナビゲーションパネルに 外部ドキュメントへのリンクを作るのに使用することができます。
読み込むべき .aux ファイルのファイル名部分を指定します。 分割文書を処理させる場合は必要になるかもしれません。 (訳注: オリジナルは記述なし。)
これを ON にすると、makeidx.perl は 索引のリファレンスのテキストに体系化された名前を作ります。
これを使うと、分割された文書を、 それが分割されてないかのように変換処理します。
これを ON にすると、あとで検査できるように中間ファイルを残し、 たくさんの診断出力を行います。その出力は、問題を検索する際や、 開発者にバグ報告を送ったりするのに役に立ちます。 一時ファイルには、画像変換の途中で生成される $$_images.tex と $$_images.log も含まれます。 警告: 中間ファイルは、非常に大きい かもしれません。
一時ファイルのパスを指定します。これには、局所的 (訳注: 多分ネットワークファイルシステムではない、ということ) で、速いファイルシステムを指定すべきです。 なぜなら、それは画像生成の際に頻繁に使用されるからです。 デフォルトは、l2hconf.pm で設定されています。
これは、images.tex の LaTeX ダンプ (訳注: images.fmt) を LaTeX2HTML に生成させます。 それは、その後の再実行の際に読み込まれ、 そして images.tex の変換での LaTeX の起動時間をスピードアップします。 これは、1 回目の実行時には時間が余計にかかりますが、 しかしその分 2 回目以降の実行は早くなります。 ダンプファイルには、約 1M byte のディスクスペースが必要となるでしょう。 (訳注: このオプションは、現在の TeX システムに対しては 正常に動作しない可能性が高いので、使用しない方がいいですし、 また現在はほぼ意味がありません。)
これをセットすると、 文書の主な処理を実行し始めるときにメッセージを出力します。 (訳注: オリジナルは記述なし。)
LaTeX2HTML の処理中にスクリーンに表示されるメッセージの量を、 この設定で制御できます。この値を増やすと、より多くの情報が表示されます。 以下は、各レベルで追加情報として表示される対象の一覧です。
0 追加情報はなし
1 セクション系とタイトル
2 環境
3 コマンド名
4 リンク、ラベル、内部分類コードどの HTML バージョンを生成するかを指定します。 現在有効な値は以下のいずれかです: 2.0, 3.0, 3.2, 4.0。 (訳注: latex2html-2016 時点で、4.01, 4.1 も指定可能になっています。) さらに以下の追加オプションを指定できます: math (数式の処理)、 i18n (?), table (表を生成)、frame (フレームを生成)、 latin1...latin9 (ISO-Latin-x エンコードを使用)、 unicode (Unicode 文字を生成)。 複数のオプションは、例えば 4.0,math,frame のように、 ',' で区切って指定します。
このフラグは、strict DTD に沿った HTML を生成 ... する予定ですが、 まだ実装されていません。 (訳注: オリジナルは記述なし。)
このファイルは、環境全体に通用するデフォルト値と LaTeX2HTML の設定値を保持します。 (shige 確認)
これらのファイルには、コマンドラインスイッチを指定するのに似た形で、 全体のデフォルト値を上書きする設定を書くことができます。 (訳注: ただし、指定するのはスイッチそのものではなく、 それに対応する Perl 変数です。)
これは、LaTeX2HTML ライブラリファイルのある場所のパスです。 この環境のインストール時設定では、 LATEX2HTMLDIR は @LATEX2HTMLDIR@ です。 (訳注: 本来インストールされた latex2html スクリプトに含まれている pod ファイルでは、この @LATEX2HTMLDIR@ の部分が、 インストール時の設定のパスに置き換わっているはずです。)
これには、latex2html プログラムが perl モジュールを探す場所を設定します。
これは、別の設定ファイル名です。標準的な設定ファイル名は、 $LATEX2HTMLPLATDIR/l2hconf.pm です。 単にファイル名のみを指定する (その場合は $LATEX2HTMLPLATDIR と $PERL5LIB を検索します) か、または完全なパスを指定します。
標準的なユーザ毎の設定ファイル名は .latex2html-init です。 この環境変数の設定値は、この名前を上書きします。
「ホームディレクトリ」を知らない OS (DOS, WinXX, OS/2... など) で、$L2HINIT_NAME の場所を決定するために使用されます。
texexpand に通信するために内部的に使用されます。
あらゆる TeX インクルードファイルを探すのに使用されます。
さまざまな問題とその改善策に関する情報については、 WWW のオンライン文書か、配布物に含まれる文書を参照してください。 オンラインのバグ報告フォームと、色々なアーカイブは http://www.latex2html.org/ で提供されています。
LaTeX2HTML に関する議論用のメーリングリストもあります: latex2html@tug.org
Nikos Drakos, Computer Based Learning Unit, University of Leeds <nikos@cbl.leeds.ac.uk>。 そして、何人かの人々の寄与、提案、アイデア、解決、サポートと 励ましがありました。
pstoimg スクリプトは、Marek Rouchal <marek@saftsack.fs.uni-bayreuth.de> によるもので、 pstogif ユーティリティを GIF 以外の画像形式も生成できるように 汎用化したものです。 Ross Moore は、それにさまざまなオプションと拡張を追加しました。 そのコードのいくつかは、元々 Phillip Conrad (Perfect Byte, Inc.) が書いて L. Peter Deutsch (Aladdin Enterprises) が修正した PostScript プログラム pstoppm.ps に基づいています。
WWW オンラインドキュメントか、 またはより詳細な情報や例については $LATEX2HTMLDIR/doc/manual.ps ファイルを参照してください。 (訳注: それは今はありませんし、またあってもかなり古いと思います。)
これは、元々 latex2html スクリプト (latex2html.pin) に含まれる pod ファイルを、Shigeharu TAKENO <shige@iee.niit.ac.jp> が日本語訳したものです。訳がもともとついてなかったオプションについては、 オンラインマニュアルから持ってきたり、自前でつけたりしていますし、 ここの説明が古いとか、現在は違う、というものについては訳注をつけたり しています。