pod2man - 云端在线

程序：

您的姓名

pod2man - 将 POD 数据转换为格式化的 *roff 输入

概要

豆荚人 [- 中央=绳子[- 日期=绳子[--错误=样式]
[- 固定的=字体[--固定粗体=字体[--固定斜体=字体]
[--固定粗体=字体[- 姓名=姓名[--努尔斯]
[- 官方的[- 引号=报价[- 释放[=版本]]
[- 部分=下一个[--标准错误[--utf8[--详细]
[输入 [产量] ...]

豆荚人 - 帮帮我

商品描述

豆荚人 是 Pod::Man 的前端，使用它从 POD 源生成 *roff 输入。
生成的 *roff 代码适合在终端上使用 恩罗夫(1)、通常
通过 男子(1)，或打印使用 的troff（1）。

输入 是要为 POD 源读取的文件（POD 可以嵌入到代码中）。 如果 输入
没有给出，它默认为“STDIN”。 产量，如果给定，是要写入的文件
格式化输出。 如果 产量 未给出，格式化输出将写入“STDOUT”。
可以同时处理多个 POD 文件 豆荚人 调用（保存模块负载和
编译时间）通过提供多对 输入 和 产量 命令行中的文件。

- 部分, - 释放, - 中央, - 日期和 - 官方的 可用于设置标题和
要使用的页脚； 如果没有给出，Pod::Man 将采用各种默认值。 见下文或
Pod::Man 了解详情。

豆荚人 假设您的 *roff 格式化程序具有名为“CW”的固定宽度字体。 如果你的
被称为其他东西（如“CR”），使用 - 固定的 来指定它。 这一般只
troff 输出打印的问题。 同样，您可以设置用于粗体的字体，
斜体和粗斜体固定宽度输出。

除了明显的 pod 转换，Pod::Man，因此 pod2man 也负责
格式 功能（）, func(n) 和简单的变量引用，如 $foo 或 @bar 这样你就不会
必须为它们使用代码转义； 像 $fred{'stuff'} 这样的复杂表达式仍然需要
不过要逃脱。 它还将不用作连字符的破折号转换为 en
破折号，将长破折号 - 像这样 - 变成适当的破折号，修复“配对引号”，以及
处理其他几个特定于 troff 的调整。 有关完整信息，请参阅 Pod::Man。

配置

-c 绳子, - 中央=绳子
将居中的页眉设置为 绳子. 默认为“用户贡献的 Perl
文档”，但也请参阅 - 官方的 联络一位教师

-d 绳子, - 日期=绳子
将左侧页脚字符串设置为此值。 默认情况下，修改日期为
将使用输入文件，如果输入来自“STDIN”，则使用当前日期，并将
基于UTC（以便无论当地时间如何输出都可以重现
区）。

-错误=样式
设置错误处理方式。 “die”表示对任何 POD 格式抛出异常
错误。 “stderr”表示报告标准错误的错误，但不抛出
例外。 “pod”表示在结果文档中包含一个 POD ERRORS 部分
总结错误。 “none”会尽可能地完全忽略 POD 错误。

默认值为“死”。

- 固定的=字体
用于逐字文本和代码的固定宽度字体。 默认为“CW”。 一些
系统可能需要“CR”来代替。 只对 的troff(1) 输出。

--固定粗体=字体
固定宽度字体的粗体版本。 默认为“CB”。 只对 的troff(1)
输出。

--固定斜体=字体
固定宽度字体的斜体版本（实际上，用词不当，因为大多数
固定宽度字体只有斜体版本，没有斜体版本）。 默认为
“CI”。 只对 的troff(1) 输出。

--固定粗体=字体
固定宽度字体的粗斜体（可能实际上是斜体）版本。 豆荚::人
不假设你有这个，默认为“CB”。 一些系统（如Solaris）
将此字体用作“CX”。 只对 的troff(1) 输出。

-h, - 帮帮我
打印使用信息。

-l, --松懈
不再使用。 豆荚人 用于检查其输入的有效性作为手册页，但
这现在应该由 播客检查器(1) 代替。 接受落后
兼容性; 此选项不再执行任何操作。

-n 姓名, - 姓名=姓名
将手册页的名称设置为 姓名. 如果没有此选项，则设置手册名称
到被转换文件的大写基本名称，除非手册部分是
3，在这种情况下，解析路径以查看它是否是 Perl 模块路径。 如果是，一个
像“.../lib/Pod/Man.pm”这样的路径被转换成像“Pod::Man”这样的名字。 这个选项，
如果给定，则覆盖名称的任何自动确定。

请注意，在以下位置转换多个 POD 文件时，此选项可能没有用
一次。 Unix 手册页命令的约定是手册页标题为
即使命令不是全大写。

从标准输入转换 POD 源时，需要此选项，因为有
否则无法知道使用什么作为手册页的名称。

--努尔斯
通常，带有 URL 的 L<> 格式化代码但锚文本被格式化为同时显示
锚文本和 URL。 换句话说：

升http://example.com/>

格式为：

富http://example.com/>

如果给出此标志，则在给出锚文本时禁止显示 URL，因此此示例
将被格式化为“foo”。 在这种情况下，这可以减少杂乱的输出
其中 URL 不是特别重要。

-o, - 官方的
设置默认标头以指示此页面是标准 Perl 的一部分
释放，如果 - 中央 也没有给出。

-q 报价, - 引号=报价
将用于包围 C<> 文本的引号设置为 报价。 如果 报价 是一个
字符，它同时用作左引号和右引号； 如果 报价 是两个字符，
第一个字符用作左引号，第二个字符用作右引号； 和
if 报价 是四个字符，前两个用作左引号，第二个用作左引号
两个作为正确的报价。

报价 也可以设置为特殊值“none”，在这种情况下没有引号
在 C<> 文本周围添加（但 troff 输出的字体仍然更改）。

-r, - 释放
设置居中的页脚。 默认情况下，这是您运行的 Perl 版本 豆荚人
在下面。 请注意，宏设置的某些系统假定居中的页脚将是
修改日期，并会在前面加上“上次修改：”之类的内容； 如果这是
情况下，您可能需要设置 - 释放 到最后修改日期和 - 日期 以及
版本号。

-s, - 部分
设置“.TH”宏的部分。 标准的节编号约定是
1 用于用户命令，2 用于系统调用，3 用于函数，4 用于设备，5 用于
文件格式，6种用于游戏，7种用于杂信息，8种用于管理员
命令。 然而，这里有很多变化； 一些系统（如 Solaris）使用
4 个用于文件格式，5 个用于其他信息，7 个用于设备。 还有一些
使用 1m 而不是 8，或两者的混合。 关于唯一的部分编号
可靠一致的是 1、2 和 3。

默认情况下，除非文件以“.pm”结尾，否则将使用第 1 节，在这种情况下
第 3 部分将被选中。

--标准错误
默认情况下， 豆荚人 如果在 POD 输入中检测到任何错误，则死亡。 如果 --标准错误 is
给与没有 --错误 标志存在，错误被发送到标准错误，但是 豆荚人
不会中止。 这等效于“--errors=stderr”并且支持向后
兼容性。

-u, --utf8
默认情况下， 豆荚人 产生最保守的可能 *roff 输出来尝试
确保它可以与尽可能多的不同 *roff 实现一起使用。
许多 *roff 实现无法处理非 ASCII 字符，因此这意味着所有非
ASCII 字符被转换为试图创建的 *roff 转义序列
正确重音的字符（至少对于 troff 输出）或“X”。

此选项表示改为输出文字 UTF-8 字符。 如果你的 *roff
实现可以处理它，这是使用的最佳输出格式并避免
包含非 ASCII 字符的文档损坏。 但是，请注意
*许多实现不支持带有文字 UTF-8 字符的 roff 源
甚至可能导致段错误和其他不良行为。

请注意，使用此选项时，您的 POD 源的输入编码必须是
正确声明，除非它是 US-ASCII 或 Latin-1。 没有“=encoding”的 POD 输入
命令将被假定为 Latin-1，如果它实际上是 UTF-8，则输出
将被双重编码。 看 豆荚(1) 有关“=encoding”的更多信息
命令。

-v, --详细
在生成每个输出文件时打印出它的名称。

退出 状态

只要处理的所有文档都会产生某些输出，即使该输出包括
勘误表（使用“--errors=pod”生成的“POD ERRORS”部分）， 豆荚人 将退出
状态 0。如果正在处理的任何文档未生成输出文档，
豆荚人 将以状态 1 退出。如果 POD 文档中存在语法错误
处理和错误处理风格设置为默认的“死”， 豆荚人 将中止
立即退出状态 255。

诊断

If 豆荚人 失败并出现错误，请参阅 Pod::Man 和 Pod::Simple 以了解有关内容的信息
这些错误可能意味着。

示例

pod2man 程序 > program.1
pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3
pod2man --section=7 note.pod > note.7

如果你想连续打印出很多手册页，你可能想设置
C 和 D 寄存器设置连续页编号和偶数/奇数分页，至少在
一些版本的 男子（7）。

troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...

要获取“STDERR”上的索引条目，请打开 F 寄存器，如下所示：

troff-人-rF1 perl.1

索引仅通过“.tm”为每个主要页面、部分、子部分输出消息，
item 和任何“X<>”指令。 有关更多详细信息，请参阅 Pod::Man。

使用 onworks.net 服务在线使用 pod2man