名前

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

概要

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

説明

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

引数

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

backlink

    --backlink="Back to Top"

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

cachedir

    --cachedir=name

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

css

    --css=stylesheet

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

flush

    --flush

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

header

    --header
    --noheader

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

help

    --help

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

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 .. See "podpath" and "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 ..]

htmldir

    --htmldir=name

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

htmlroot

    --htmlroot=name

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

索引

    --index
    --noindex

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

infile

    --infile=name

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

libpods

    --libpods=name:...:name

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

netscape

    --netscape
    --nonetscape

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

outfile

    --outfile=name

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

podpath

    --podpath=name:...:name

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

podroot

    --podroot=name

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

quiet

    --quiet
    --noquiet

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

recurse

    --recurse
    --norecurse

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

title

    --title=title

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

verbose

    --verbose
    --noverbose

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

例

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

環境

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

著者

Tom Christiansen, <tchrist@perl.com>.

関連項目

perlpod [CPAN]

著作権

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

和訳

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

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

索引