=head1 NAME
名前

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

=head1 SYNOPSIS
概要

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

=head1 DESCRIPTION
説明

pod形式(L<perlpod>参照)から
HTML形式に変換する. 
目次とクロスリファレンスは自動生成され, クロスリファレンスできる項目の
キャッシュを保持します.
Converts files from pod format (see L<perlpod>) to HTML format.  It
can automatically generate indexes and cross-references, and it keeps
a cache of things it knows how to cross-reference.

=head1 ARGUMENTS
引数

Pod::Htmlは次の引数をとります:
Pod::Html takes the following arguments:

=over 4

=item backlink

    --backlink="Back to Top"

``Topに戻る''リンクをすべての <code>head1</code> 見出しの前に加えます(
最初のところは除きます).
デフォルトではbacklinkは生成されません.
Adds "Back to Top" links in front of every C<head1> heading (except for
the first).  By default, no backlinks are generated.

=item cachedir

    --cachedir=name

アイテムとディレクトリのキャッシュを指定したディレクトリに作成する.
Creates the item and directory caches in the given directory.

=item css

    --css=stylesheet

カスケードスタイルシートのURLを指定します. 
またデフォルトでは出力されるすべての HTML/CSS <code>style</code> 属性を
(衝突をさけるために)無効化します.
Specify the URL of a cascading style sheet.  Also disables all HTML/CSS
C<style> attributes that are output by default (to avoid conflicts).

=item flush

    --flush

アイテム・ディレクトリキャッシュをフラッシュします.
Flushes the item and directory caches.

=item header

    --header
    --noheader

C<名前>セクションのテキストをヘッダ・フッタブロックとして作成します. 
デフォルトでは生成されません.
Creates header and footer blocks containing the text of the C<NAME>
section.  By default, no headers are generated.

=item help

    --help

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

=item htmldir

    --htmldir=name

生成されたHTMLが置かれるディレクトリを設定します. 
これはほかのファイルの相対リンクを生成するときにも使用されます. 
これが Pod::Html にドキュメントツリーのルートを教えるものになるので, 
これを指定しないと, すべてのリンクは絶対位置となります.
Sets the directory in which the resulting HTML file is placed.  This
is used to generate relative links to other files. Not passing this
causes all links to be absolute, since this is the value that tells
Pod::Html the root of the documentation tree.

=item htmlroot

    --htmlroot=name

HTMLの基準URL(base URL)を設定します. 
クロスリファレンスを作成するときにはURLにprepended(?)されます.
Sets the base URL for the HTML files.  When cross-references are made,
the HTML root is prepended to the URL.

=item index

索引

    --index
    --noindex

HTMLファイルの最初に目次を生成します(デフォルト).
Generate an index at the top of the HTML file.  This is the default
behaviour.

=item infile

    --infile=name

変換するpodファイルを指定します. 
指定がなければSTDINが使用されます.
Specify the pod file to convert.  Input is taken from STDIN if no
infile is specified.

=item libpods

    --libpods=name:...:name

リンクすることができる <code>=item</code> を含むページ名のリスト
(たとえば``perlfunc'').
List of page names (eg, "perlfunc") which contain linkable C<=item>s.

=item netscape

    --netscape
    --nonetscape

<strong>廃止されています</strong>, なんの影響もでません.
後位互換のためにのみ残されています.
B<Deprecated>, has no effect. For backwards compatibility only.

=item outfile

    --outfile=name

作成するHTMLファイルを指定します. 
指定がなければSTDOUTに出力されます.
Specify the HTML file to create.  Output goes to STDOUT if no outfile
is specified.

=item podpath

    --podpath=name:...:name

クロスリファレンスでリンクされるコトができる変換されたHTML形式になっているpodファイルを含んでいるpodrootのサブディレクトリを指定します.
Specify which subdirectories of the podroot contain pod files whose
HTML converted forms can be linked to in cross references.

=item podroot

    --podroot=name

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

=item quiet

    --quiet
    --noquiet

I<たいていは意味のない>警告メッセージの表示を抑制します. 
それらのメッセージはデフォルトでは表示されますが, 
C<verbose> モードで表示されるものと同じではありません.
Don't display I<mostly harmless> warning messages.  These messages
will be displayed by default.  But this is not the same as C<verbose>
mode.

=item recurse

    --recurse
    --norecurse

指定した podpath のサブディレクトリを再起的に処理する(デフォルトの振る舞い)
Recurse into subdirectories specified in podpath (default behaviour).

=item title

    --title=title

生成するHTMLの最初ファイルのタイトルの指定.
Specify the title of the resulting HTML file.

=item verbose

    --verbose
    --noverbose

状況メッセージを表示する. デフォルトでは表示されません.
Display progress messages.  By default, they won't be displayed.

=back

=head1 EXAMPLE
例

    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 ENVIRONMENT
環境

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

=head1 AUTHOR
著者

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


=head1 SEE ALSO
関連項目

L<perlpod>


=head1 COPYRIGHT
著作権

このプログラムは Artistic License の元で配布されています.
This program is distributed under the Artistic License.

=head1 TRANSALTE TO JAPANESE
和訳

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

Original distribution is perl VERSION 5.8.0.
Translated on 2003-05-18.

原典: perl VERSION 5.8.0.
翻訳日: 2003-05-18.