perldoc

perldoc は perlで書かれたモジュールや組み込み関数のドキュメント(POD)を読むためのコマンドでありフレームワークです。

使い方は簡単で、コマンドラインで以下のように打ちます。

$ perldoc LWP::Simple

組み込みの関数は以下のようにオプション -f で見れます。

$ perldoc -f use

perldoc コマンド自体のドキュメント(POD)を見るには以下のようにします。

$ perldoc perldoc

もしくは、help を表示しても perldoc の使い方を読むことができます。

$ perldoc -h

perldoc の表示で使用されるページャーは、.bashrc などシェルの設定ファイルに記述することで変更できます。

setenv PERLDOC_PAGER='lv'

モジュールのインストールされているパスを表示するには以下のように -l オプションを利用します

$ perldoc -l LWP::Simple

モジュールのソースを表示するには以下のように -m オプションを利用します

$ perldoc -m LWP::Simple

Perlの特殊変数のドキュメントを参照するには、以下のように -v オプションを利用します

$ perldoc -v $!

Perlの長大なドキュメントを読むなら

$ perldoc perltoc

最近は Pod::Cpandoc という、モジュールをインストールしてなければ CPANサイトからドキュメントを引っ張ってきてくれる cpandoc があります。