名前

pod2html - .pod ファイルを .html に変換する

概要

    pod2html --help --htmlroot=<name> --infile=<name> --outfile=<name>
             --podpath=<name>:...:<name> --podroot=<name>
             --libpods=<name>:...:<name> --recurse --norecurse --verbose
             --index --noindex --title=<name>

説明

pod形式(perlpod [CPAN]参照)から HTML形式に変換する.

引数

pod2html は次の引数をとります:

help

  --help

usageメッセージを表示します.

htmlroot

  --htmlroot=name

HTMLの基準URL(base URL)を設定します. クロスリファレンスを作成するときにはURLの前に付与されます.

infile

  --infile=name

変換するpodファイルを指定します. 指定がなければSTDINが使用されます.

outfile

  --outfile=name

作成するHTMLファイルを指定します. 指定がなければSTDOUTに出力されます.

podroot

  --podroot=name

ライブラリのpodを探す基準ディレクトリ(base directory)を指定します.

podpath

  --podpath=name:...:name

HTML形式に変換してクロスリファレンスでリンクできるpodファイルを含んでいる podrootのサブディレクトリを指定します.

libpods

  --libpods=name:...:name

リンクすることができる =item を含むページ名のリスト (たとえば"perlfunc").

netscape

  --netscape

適切であれば Netscape HTML ディレクティブを使用する.

nonetscape

  --nonetscape

Netscape HTML ディレクティブを使用しない(デフォルト).

索引

  --index

HTMLファイルの最初に目次を生成する(デフォルト).

noindex

  --noindex

HTMLの最初の目次を生成しない.

recurse

  --recurse

指定した podpath のサブディレクトリを再起的に処理する(デフォルトの振る舞い)

norecurse

  --norecurse

podpath で指定されたサブディレクトリから再起処理しない.

title

  --title=title

生成するHTMLの最初ファイルのタイトルの指定.

verbose

  --verbose

状況メッセージを表示する.

著者

Tom Christiansen, <tchrist@perl.com>.

バグ

トランスレータに関する既知のバグに関しては, Pod::Html [CPAN] を参照してください.

関連項目

perlpod [CPAN], Pod::Html [CPAN]

著作権

このプログラムは Artistic License の元で配布されています.

和訳

 山科 氷魚 (YAMASHINA Hio) <hio@hio.jp>

原典: perl VERSION 5.8.0. 翻訳: 2003-05-08, perl-5.8.0.

索引