=head1 名前

Pod::Html - podファイルをHTMLに変換するためのモジュール

=head1 概要

    use Pod::Html;
    pod2html([options]);

=head1 説明

pod形式(L<perlpod>参照)から
HTML形式に変換する. 
目次とクロスリファレンスは自動生成され, クロスリファレンスできる項目の
キャッシュを保持します.

=head1 引数

Pod::Htmlは次の引数をとります:

=over 4

=item backlink

    --backlink="Back to Top"

``Topに戻る''リンクをすべての <code>head1</code> 見出しの前に加えます(
最初のところは除きます).
デフォルトではbacklinkは生成されません.

=item cachedir

    --cachedir=name

アイテムとディレクトリのキャッシュを指定したディレクトリに作成する.

=item css

    --css=stylesheet

カスケードスタイルシートのURLを指定します. 
またデフォルトでは出力されるすべての HTML/CSS <code>style</code> 属性を
(衝突をさけるために)無効化します.

=item flush

    --flush

アイテム・ディレクトリキャッシュをフラッシュします.

=item header

    --header
    --noheader

C<名前>セクションのテキストをヘッダ・フッタブロックとして作成します. 
デフォルトでは生成されません.

=item help

    --help

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

=item hiddendirs

    --hiddendirs
    --nohiddendirs

Include hidden directories in the search for POD's in podpath if recurse
is set.
The default is not to traverse any directory whose name begins with C<.>.
See L</podpath> and L</recurse>.



[This option is for backward compatibility only.
It's hard to imagine that one would usefully create a module with a
name component beginning with C<.>.]


=item htmldir

    --htmldir=name

生成されたHTMLが置かれるディレクトリを設定します. 
これはほかのファイルの相対リンクを生成するときにも使用されます. 
これが Pod::Html にドキュメントツリーのルートを教えるものになるので, 
これを指定しないと, すべてのリンクは絶対位置となります.

=item htmlroot

    --htmlroot=name

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

=item 索引

    --index
    --noindex

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

=item infile

    --infile=name

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

=item libpods

    --libpods=name:...:name

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

=item netscape

    --netscape
    --nonetscape

<strong>廃止されています</strong>, なんの影響もでません.
後位互換のためにのみ残されています.

=item outfile

    --outfile=name

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

=item podpath

    --podpath=name:...:name

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

=item podroot

    --podroot=name

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

=item quiet

    --quiet
    --noquiet

I<たいていは意味のない>警告メッセージの表示を抑制します. 
それらのメッセージはデフォルトでは表示されますが, 
C<verbose> モードで表示されるものと同じではありません.

=item recurse

    --recurse
    --norecurse

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

=item title

    --title=title

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

=item verbose

    --verbose
    --noverbose

状況メッセージを表示する. デフォルトでは表示されません.

=back

=head1 例

    pod2html("pod2html",
	     "--podpath=lib:ext:pod:vms",
	     "--podroot=/usr/src/perl",
	     "--htmlroot=/perl/nmanual",
	     "--libpods=perlfunc:perlguts:perlvar:perlrun:perlop",
	     "--recurse",
	     "--infile=foo.pod",
	     "--outfile=/perl/nmanual/foo.html");

=head1 環境

デフォルトのオプションとして C<$Config{pod2html}> が使われます.

=head1 著者

Tom Christiansen, E<lt>tchrist@perl.comE<gt>.


=head1 関連項目

L<perlpod>


=head1 著作権

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

=head1 和訳

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

原典: perl VERSION 5.8.0.
翻訳日: 2007-09-06.
(perl-5.8.0, 2003-05-18).