以 perldoc 程式讀文件

作者:   發佈於:  

寫 Perl 程式的人不會不知道 perldoc 程式的重要性了。這程式可以讓你在終端機上閱讀 Perl 語言所提供的文件,同時也可以讀 CPAN 模組中所寫的文件。

基本上的常用的用法有:

perldoc 文件名
perldoc -f 函式名
perldoc -q FAQ關鍵字

其中「函式名」指的是 Perl 5 語言內建的函式,像是 sincosopen 這類的。「FAQ關鍵字」則可以是任意的字,用來查詢內附的 FAQ 文件。例如 perldoc -q sort 就可以看到不少有關排序的問題與解答。

而「文件名」則是泛指內建的文件、模組名稱、或是檔名。像是:

perldoc syn # 讀內建 perlsyn 文件
perldoc data # 讀內建 perldata 文件
perldoc WWW::Mechanize  # 讀 WWW::Mechanize 模組內的文件
perldoc lib/Foo.pm # 讀 Foo.pm 檔案內容中所寫的文件

所有內建的文件列表可以在 perl 這份文件裡看到:

perldoc perl

而那些文件名稱都是 perl 開頭的,像 perlop、perlsub、perlfunc 等等。在 perldoc 指令中可以省略開頭的 perl,只用 op、sub、func 來指定文件名(註:這效果需要升級 Pod::Perldoc 模組到 3.15 版)。這些內建文件除了可以用 perldoc 程式來讀之外,也可以用 UNIX 的 man 程式來讀。但用 man 程式讀的話,就不能省略文件名中的 perl 部份,需要以全名表示。