名前 NAME

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

概要 SYNOPSIS

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

説明 DESCRIPTION

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

引数 ARGUMENTS

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

backlink

    --backlink="Back to Top"

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

cachedir

    --cachedir=name

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

css

    --css=stylesheet

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

flush

    --flush

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

header

    --header
    --noheader

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

help

    --help

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

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.

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.

索引 index

    --index
    --noindex

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

infile

    --infile=name

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

libpods

    --libpods=name:...:name

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

netscape

    --netscape
    --nonetscape

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

outfile

    --outfile=name

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

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.

podroot

    --podroot=name

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

quiet

    --quiet
    --noquiet

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

recurse

    --recurse
    --norecurse

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

title

    --title=title

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

verbose

    --verbose
    --noverbose

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

例 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");

環境 ENVIRONMENT

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

著者 AUTHOR

Tom Christiansen, <tchrist@perl.com>.

関連項目 SEE ALSO

perlpod [CPAN]

著作権 COPYRIGHT

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

和訳 TRANSALTE TO JAPANESE

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

原典: perl VERSION 5.8.0. 翻訳日: 2003-05-18. Original distribution is perl VERSION 5.8.0. Translated on 2003-05-18.

索引 INDEX