内容

名称

podchecker - 检查 POD 格式文档文件的语法

语法

podchecker [-help] [-man] [-(no)warnings] [file ...]

选项和参数

-help

打印简短的帮助信息并退出。

-man

打印手册页并退出。

-warnings -nowarnings

打开/关闭警告打印。重复 -warnings 会提高警告级别,即打印更多警告。目前提高到级别 2 会标记未转义的“<,>”字符。

file

要进行语法检查的 POD 文件的路径名(默认为标准输入)。

描述

podchecker 将读取给定的输入文件,查找 POD 文档中的 POD 语法错误,并将找到的任何错误打印到 STDERR。最后,它将打印一条状态消息,指示找到的错误数。

忽略目录,打印一条适当的警告消息。

podchecker 调用由 Pod::Checker 导出的 podchecker() 函数。有关更多详细信息,请参见 Pod::Checker 中的“podchecker()”

返回值

如果所有指定的 POD 文件都正常,podchecker 返回 0(零)退出状态。

错误

如果至少有一个给定的 POD 文件具有语法错误,podchecker 返回退出状态 1。

状态 2 表示至少一个指定的文件不包含任何 POD 命令。

状态 1 覆盖状态 2。如果您想要明确的结果,请仅使用一个参数调用 podchecker

另请参见

Pod::SimplePod::Checker

作者

请使用 http://rt.cpan.org 报告错误。

Brad Appleton <[email protected]>,Marek Rouchal <[email protected]>

基于 Tom Christiansen <[email protected]> 编写的 Pod::Text::pod2text(1) 的代码。