pod2html

(源代码, CPAN)

内容

名称
概要
描述
参数
作者
错误
参见
版权

#名称

pod2html - 将 .pod 文件转换为 .html 文件

#概要

pod2html --help --htmldir=<name> --htmlroot=<URL>
         --infile=<name> --outfile=<name>
         --podpath=<name>:...:<name> --podroot=<name>
         --cachedir=<name> --flush --recurse --norecurse
         --quiet --noquiet --verbose --noverbose
         --index --noindex --backlink --nobacklink
         --header --noheader --poderrors --nopoderrors
         --css=<URL> --title=<name>

#描述

将文件从 pod 格式（参见 perlpod）转换为 HTML 格式。

#参数

pod2html 接受以下参数

#backlink

--backlink
--nobacklink

将 =head1 指令转换为指向 HTML 文件顶部的链接。--nobacklink（默认行为）不会创建这些反向链接。

#cachedir

--cachedir=name

指定用于存储缓存的目录。默认目录是当前工作目录。

#css

--css=URL

指定要从生成的 HTML 文件中链接的级联样式表的 URL。默认情况下没有样式表。

#flush

--flush

刷新缓存。

#header

--header
--noheader

创建包含“名称”部分文本的页眉和页脚块。--noheader（默认行为）不会创建页眉或页脚块。

#help

--help

显示使用信息。

#htmldir

--htmldir=name

设置生成的 HTML 文件中所有交叉引用将相对于其的目录。不传递此参数会导致所有链接都为绝对链接，因为这是告诉 Pod::Html 文档树根的值。

不要在同一个 pod2html 调用中使用此参数和 --htmlroot；它们是互斥的。

#htmlroot

--htmlroot=URL

设置 HTML 文件的基准 URL。当进行交叉引用时，HTML 根目录将被附加到 URL。

如果需要相对链接，请勿使用此选项：请改用 --htmldir。

不要同时将此选项和 --htmldir 传递给 pod2html；它们是互斥的。

#index

--index

在 HTML 文件顶部生成索引（默认行为）。

#noindex

--noindex

不要在 HTML 文件顶部生成索引。

#infile

--infile=name

指定要转换的 pod 文件。如果没有指定 infile，则从 STDIN 获取输入。

#outfile

--outfile=name

指定要创建的 HTML 文件。如果没有指定 outfile，则输出到 STDOUT。

#poderrors

--poderrors
--nopoderrors

如果 infile 中存在任何 POD 错误，则在 outfile 中包含一个“POD ERRORS”部分（默认行为）。--nopoderrors 不会创建此“POD ERRORS”部分。

#podpath

--podpath=name:...:name

指定 podroot 的哪些子目录包含 pod 文件，这些文件的 HTML 转换形式可以在交叉引用中链接。

#podroot

--podroot=name

指定查找库 pod 的基准目录。

#quiet

--quiet
--noquiet

不要显示大部分无害的警告消息。--noquiet -- 这是默认行为 -- 确实会显示这些大部分无害的警告消息（但这与“详细”模式不同）。

#recurse

--recurse
--norecurse

递归进入 podpath 中指定的子目录（默认行为）。--norecurse 不会递归进入这些子目录。

#title

--title=title

指定生成的 HTML 文件的标题。

#verbose

--verbose
--noverbose

显示进度消息。--noverbose -- 这是默认行为 -- 不会显示这些进度消息。

#AUTHOR

Tom Christiansen, <[email protected]>.

#BUGS

有关翻译器中已知错误的列表，请参见 Pod::Html。

#另请参阅

perlpod，Pod::Html

#版权

本程序在 Artistic 许可证下发布。