珀尔多克

#名称

perldoc—以Pod格式查找Perl文档。

#简介

perldoc[-h][-D][-t][-u][-m][-l][-u][-F][-i][-V][-T][-r][-d目标文件][-o格式名][-M格式ClassName][-w格式化程序选项：值][-n nroff替换][-X][-L语言代码]PageName|ModuleName|ProgramName|URL

示例：

perldoc-f内置函数perldoc-Lit-f内置函数perldoc-q常见问题关键词perldoc-L fr-q常见问题关键词perldoc-v PerlVariableperldoc—一种PerlAPI

有关开关的更多说明，请参见下文。

#描述

珀尔多克查找以.pod格式嵌入到perl安装树或perl脚本中的文档，并使用各种格式器显示它。这主要用于perl库模块的文档。

您的系统可能还为这些模块安装了手册页，在这种情况下，您可能只需使用man（1）命令。

如果您正在查找Perl库模块文档的目录，请参阅珀尔托克第页。

#选项

#-小时

打印出摘要小时帮助消息。

#-D类

D类描述搜索中的项目d日详细信息。

#-t吨

使用纯文本显示文档t吨ext转换器，而不是nroff。这可能会更快，但看起来可能不会那么好看。

#-u个

跳过真正的Pod格式，只显示原始的Pod源代码(U型已通知）

#-米模块

显示整个模块：包括代码和未格式化的pod文档。如果文档没有详细解释您需要的函数，并且您希望直接检查代码，那么这可能很有用；perldoc将为您找到该文件，并将其交给他人显示。

#-我

显示于我y找到的模块的文件名。

#-U型

当以超级用户身份运行时，不要尝试出于安全考虑放弃特权。此选项隐含于-F类.

注释：有关更多信息，请参阅下面的标题“安全”。

#-F类

将参数视为文件名；不会在目录中执行搜索。暗示-U型如果以超级用户身份运行。

#-（f） 珀尔func

这个-（f）选项后跟perl内置函数的名称将从中提取此函数的文档珀尔func.

例子：

perldoc-f冲刺

#-q个 perlfaq-search-regexp

这个-q个选项采用正则表达式作为参数。它将搜索q个perlfaq[1-9]中的问号标题，并打印与正则表达式匹配的条目。

例子：

perldoc-q洗牌

#-一个 佩拉皮func

这个-一个选项后跟perl-api函数的名称将从中提取此函数的文档珀拉皮.

例子：

perldoc——一种新的HV

#-v（v） 佩尔瓦尔

这个-v（v）选项后跟Perl预定义变量的名称将从中提取此变量的文档佩尔瓦尔.

示例：

perldoc-v“$”perldoc-v@+perldoc-v数据

#-T型

这指定输出不发送到寻呼机，而是直接发送到STDOUT。

#-d日 目的地名称

这指定输出既不发送到寻呼机也不发送到STDOUT，而是保存到指定的文件名。例子：perldoc-oLaTeX-dtextwrapdocs.tex文本：：包装

#-o个 输出格式名称

这指定您希望Perldoc尝试为您指定的输出格式使用Pod格式化类。例如：-阿曼。这实际上只是围绕-M（M）开关；使用-o个格式名称只需通过在不同类名前缀的末尾添加该格式名称（具有不同的大写字母）来查找可加载的类。

例如，-oLaTeX公司当前尝试了以下所有类：Pod:：Perldoc:：ToLaTeX Pod:∶Perldoc：：ToLaTeX Pod:；Perldoc：：ToLaTeX Pod::：Perldoc:：ToLaTeX Pod::Simple:：LaTeX Pod:：Simple::LaTeX Pod:：Simple：：LaTeX Pod:。

#-M（M） 模块名称

这指定了要尝试用于格式化pod的模块。类必须至少提供从文件解析（_F）方法。例如：perldoc-MPod:：perldoc:：ToChecker.

您可以通过使用逗号或分号连接来指定要尝试的几个类，如-MTk：：超级Pod；Tk:：吊舱.

#-w个 选项：值或-w个 选项

这指定了调用格式化程序的选项w个第i条。例如，-w文本大小：15将呼叫$formatter->textsize（15）在格式化程序对象用于格式化对象之前。为了使其有效，格式化程序类必须提供这样的方法，并且您传递的值应该有效。（所以如果文本大小需要一个整数，您需要-w textsize:大，预计会有麻烦。）

你可以使用-w选项名称（没有值）作为-w选项名称：真的。这可能在以下开/关功能的情况下有用：-w页面编号.

您可以使用“=”代替“：”，如：-w文本大小=15。这可能更方便（或更不方便），具体取决于您使用的shell。

#-X（X）

如果存在索引，请使用该索引。这个-X（X）选项查找一个条目，该条目的基本名称与文件中命令行上给定的名称相匹配$Config{archlib}/pod.idx. The播客.idx文件应该包含完全限定的文件名，每行一个。

#-L（左） 语言代码

这允许用户指定语言代码用于所需的语言翻译。如果POD2:：<语言代码>程序包未安装在系统中，该开关将被忽略。所有可用的翻译包都可以在POD2:：命名空间。请参见POD2:：IT（或POD2:：法国)查看如何创建新的本地化POD2:：*文档包并将其集成到播客：：Perldoc.

#PageName|ModuleName|ProgramName|URL

您要查找的项目。嵌套模块（例如文件：：Basename)指定为文件：：Basename或文件/基名。您还可以为页面提供描述性名称，例如珀尔func。对于URL，HTTP和HTTPS是当前支持的唯一类型。

对于“foo”这样的简单名称，当普通搜索无法找到匹配的页面时，也会尝试使用“perl”前缀进行搜索。因此，“perldoc intro”足以找到/呈现“perlintro.pod”。

#-n个 某种物质

指定替换groff

#-第页

递归搜索。

#-我

忽略大小写。

#-V（V）

显示您正在运行的perldoc的版本。

#安全

因为珀尔多克无法正常运行，并且已知存在安全问题，当以超级用户身份运行时，它将尝试通过将有效和真实的ID设置为nobody或nouser的帐户来删除权限，如果不可用，则设置为-2。如果它不能放弃其特权，它将不会运行。

请参阅-单位如果您不希望此行为，但当心如果您选择使用-U型.

自3.26起，使用-F类正如超级用户所暗示的那样-U型因为打开大多数文件和遍历目录需要nobody/nogroup级别以上的权限。

#环境

中的任何开关PERLDOC公司环境变量将在命令行参数之前使用。

有用的值PERLDOC公司包括-奥特姆,-其他文字,-波尔图,-氧毫升等等，这取决于您手头有哪些模块；或者可以使用-MPod:：Perldoc:：ToTerm诸如此类。

珀尔多克还搜索由PERL5LIB公司（或佩利布如果PERL5LIB公司未定义）和路径环境变量。（后者是为了嵌入可执行程序的pods，例如珀尔多克自身可用。）

在以下目录中生成文件。损益或构建。损益存在，珀尔多克将添加.和图书馆首先进入它的搜索路径，只要你不是超级用户，就会添加气泡也是。如果您在构建目录中工作，并且想要通读文档，即使您以前安装了模块的版本，这也非常有帮助。

珀尔多克将按偏好顺序使用中定义的寻呼机PERLDOC_PAGER公司,MANPAGER公司，或PAGER公司在试图自己找寻呼机之前。(MANPAGER公司在以下情况下不使用珀尔多克被告知显示纯文本或未格式化的pod。）

在它的-米模式（显示模块源代码），珀尔多克将尝试使用中设置的寻呼机PERLDOC_SRC_PAGER公司。此命令的一个有用设置是您最喜欢的编辑器，如/usr/bin/nano（不要评判我。）

一个有用的价值PERLDOC_PAGER公司是小于-+C-E.

将PERLDOCDEBUG设置为正整数将使perldoc发出比-D类开关动作；这个数字越高，它发出的能量就越多。

#变化

在3.14_05之前，开关-v（v）用于生成的详细消息珀尔多克操作，现在由启用-D类.

#另请参阅

珍珠贝,播客：：Perldoc

#作者

当前维护人员：Mark Allen<mallen@cpan.org>

过去的贡献者是：brian d foy<bdfoy@cpan.org>阿德里亚诺·R·费雷拉<ferreira@cpan.org>肖恩·伯克（Sean M.Burke）<sburke@cpan.org>肯尼思·阿尔巴诺夫斯基<kjahds@kjahds.com>，安迪·多尔蒂<doughera@lafcol.lafayette.edu>，以及许多其他。