perldoc

最終更新日時:2007-03-07 18:02:14
Perl

perldoc は Perl 用のドキュメント(POD:Plain Old Document ファイル)を表示するためのツールです。
標準でついてくるライブラリだけでなく、たいていの CPAN モジュールも perldoc に対応したドキュメントとなっているので、perl を使うのであれば必ず使うことになるでしょう。
Perl 関連の man ページだと考えればよいと思います。

使用方法


使用方法は下記のような感じです。

 % perldoc perlre
 % perldoc DBD::Pg
 % perldoc ~/doc/MD5.pm


日本語対応について


perldoc はデフォルトでは日本語対応していません。
が、perldoc 自体が Perl で書かれており、内部で nroff を呼び出すことでドキュメントを整形しているのでこの部分を変更すれば簡単に日本語対応することが可能です。

以下、Perl5.6.1 の例です。
perldoc を以下のように2カ所変更します。

 #$opt_n = "nroff" if !$opt_n;
 $opt_n = "groff -mandocj -Tnippon" if !$opt_n;
 
 ...
 
 #my $cmd = catfile($bindir, 'pod2man') . " --lax $file | $opt_n -man";
 my $cmd = catfile($bindir, 'pod2man') . " --lax $file | $opt_n";


これで EUC-JP な Perl ドキュメントは正しく表示されるようになります。
もし、Shift-JIS 等のドキュメントが混在している場合には、nkf -e 等を上記の $opt_n に含めておくとよいかもしれません。

モジュールの日本語 POD ファイルが以下のサイトで公開されています。
perldoc.jp

お問い合わせは 掲示板 にて。