内容

#名称

pod2usage - 从文件中的嵌入式 pod 文档打印使用信息

#pod2usage: [-help] [-man] [-exit exitval] [-output outfile] [-verbose level] [-pathlist dirlist] [-formatter module] [-utf8] file

#-help

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

#-man

打印此命令的手册页并退出。

#-exit exitval

要返回的退出状态值。

#-output outfile

要打印到的输出文件。如果使用特殊名称 "-" 或 ">&1" 或 ">&STDOUT"，则使用标准输出。如果使用 ">&2" 或 ">&STDERR"，则使用标准错误。

#-verbose level

要使用的详细程度

1 : print SYNOPSIS only
2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
3 : print the entire manpage (similar to running pod2text)

#-pathlist dirlist

指定一个或多个目录来搜索输入文件，如果输入文件没有提供绝对路径。给定列表中的每个目录路径应在 Unix 上用 ':' 分隔（在 MSWin32 和 DOS 上用 ';' 分隔）。

#-formatter module

要使用的文本格式化程序。默认值为 Pod::Text，或者对于非常旧的 Perl 版本，则为 Pod::PlainText。另一种选择可能是例如 Pod::Text::Termcap。

#-utf8

此选项假定格式化程序（见上文）理解选项“utf8”。它开启了 utf8 输出的生成。

#file

包含要以使用消息格式输出的 pod 文档的文件的路径名。如果省略，则读取标准输入 - 但输出将仅使用 Pod::Text 格式化 - 除非使用 -formatter 指定了特定格式化程序。

pod2usage 将读取给定的输入文件，查找 pod 文档，并打印相应的用法消息。如果未指定输入文件，则读取标准输入。

pod2usage 调用 Pod::Usage 模块中的 pod2usage() 函数。请参阅 "pod2usage()" in Pod::Usage。

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

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