查看perl及其模块

Perl本身自带了很丰富的文档，如果把它们都打印出来，恐怕要耗费大量纸墨。我们试图清点过，但数到2000页左右的时候就数不清了（不用担心，我们用虚拟打印机计算页面数量，这样不会对树木造成威胁，挺环保的）。

Perl文档中包含大量有价值的信息，这些文档绝对值得仔细品读，哪怕只花一点功夫，学会如何从这些文档中查找所需的资料也是值得的。要从这些文档中迅速找到需要的内容，除了要具备相关的知识外，得力的工具也必不可少。

1. perldoc文档阅读器

perldoc这个命令能搜索Perl安装目录树中内嵌文档的Perl模块文件（扩展名为.pm）、.pod结尾的POD文档（见条款82），以及已安装的各种Perl工具的文档。该命令会将它找到的文档格式化后显示出来。让我们先从阅读perldoc自身的文档开始吧：

  1. % perldoc perldoc   
  2. PERLDOC(1) User Contributed Perl Documentation   
  3.  
  4. NAME   
  5.       C<perldoc> - Look up Perl documentation in pod format.   
  6.  
  7. SYNOPSIS  
  8.       C<perldoc> [-h] [-v] [-t] [-u] [-m] [-l]   
  9. ……省略了剩余内容…… 

一般来说，将文档的名称作为参数传递给perldoc命令，即可查阅该文档。比如下面，给定文档名称perltoc，就会显示所有内置文档的目录：

  1. % perldoc perltoc 

你也许会对perlsyn文档的内容感兴趣，该文档主要描述Perl的基本语法：

  1. % perldoc perlsyn 

如果想阅读关于Perl内置函数的用法，可以查看perlfunc文档：

  1. % perldoc perlfunc 

至少得把perlfunc文档通读一遍，才能大致了解Perl都能提供些什么功能。当然，不需要把它们都记下来，只要在大脑中有个印象就够了。比如说，只要知道Perl有个内置函数可以处理/etc/passwd文件，但具体是哪个，可以到perlfunc文档里找。要是觉得滚动这么长的页面太过麻烦，只要记得内置函数的名字，就可以用-f开关指定，直接阅读该函数相关的内容：

  1. % perldoc -f split 

也可以用perldoc来阅读模块内嵌的文档，只需提供模块名作为参数即可：

  1. % perldoc Pod::Simple 

如果想了解这个模块安装在什么地方，可以用-l（小写的L）开关打印该模块的路径：

  1. % perldoc -l Pod::Simple 

如果要查看模块源代码，可以用-m开关：

  1. % perldoc -m Pod::Simple 

Perl文档还包括了FAQ，可以在其中找到许多常见问题的解答。虽然有个在线版本可以阅读，但命令行的perldoc有个好处，就是可以用-q开关搜索相关主题，非常方便。比如有关随机数的处理，可以试试这个：

  1. % perldoc -q random 

2. 在线文档

在写本书时，http://perldoc.perl.org/是最好的Perl在线文档站点。它包含了Perl最近几个版本的核心文档（包括HTML和PDF格式），不只如此，它还会记录你曾经看过哪些文档。

但该站点并不提供所有模块的文档。想要看到所有模块的文档，可以到CPAN Search（http://search.cpan.org/）和Kobes's Search（http://kobesearch.cpan.org/）这两个站点去看看。这两个站点都提供CPAN的网页查询界面。许多人甚至觉得直接访问以上站点，比阅读本机附带的文档还要方便。

CPAN Search很有用，尤其是它在每个模块页面中都提供了其他工具链接。其中一个工具有类似grep的功能，用它可以方便地在某个模块不同的发行版本中搜索特定内容。比如想要跟踪某个出错信息来自哪个模块中的哪个文件，就可以用它来试一试。

AnnoCPAN（http://annocpan.org/）是另一个提供模块文档的站点。但它的出发点是让任何人都有机会对模块文档本身添加评注，或是给作者或其他用户留言。这个功能在文档信息不全或者不正确、不完整的情况下显得特别有用。

3. 本地文档

在本地也能够实现部分和CPAN Search站点类似的功能。借助CPAN::Mini::Webserver模块，我们可以在本地搭建一台Web服务器，然后通过浏览器查阅自己的MiniCPAN库（见条款66）。如果运行的是Apache Web服务器，你还可以用Apache::Perldoc模块，在Web界面中调用本地的perldoc命令。

此外，Pod::POM::Web模块也能让你以Web方式查看本地文档。以mod_perl或者CGI脚本的形式在Apache上运行都没问题，或者干脆直接使用其内置的Web服务器：

  1. % perl -MPod::POM::Web -e "Pod::POM::Web->server
posted @ 2016-10-31 16:29  nkwy2012  阅读(4039)  评论(0)  编辑  收藏  举报