Perlで開発しているときに, 「このモジュールについて調べたいな...」と思う時があると思います. 皆さんどうしていますか?
metacpan
ブラウザからmetacpanでモジュールを検索してドキュメントを見る, というのがまあ鉄板という気がします. ハイライトがついていたり, リンクがあったら遷移できたりと便利です.
perldoc
コマンド
一方で, 「サクッとターミナルでドキュメントが読めたらいいんだけどな...」という場合は perldoc
コマンドを使うのもアリです.
$ perldoc Teng
但し, perldoc
コマンドの場合, そのモジュールがインストールされている必要があります. 上の例だと, Teng
がインストールされていない場合は, 次のような結果になります:
$ perldoc Teng No documentation found for "Teng".
cpandoc
コマンド
というわけで, Pod::Cpandoc
が提供する cpandoc
コマンドを使いましょう. モジュールがインストールされていない場合, CPANをスクレイピングしていい感じに表示してくれます.
そういう意味で, perldoc
の上位互換的存在なので, 自分は perldoc
を cpandoc
の alias にして使っています.
スペシャルサンクス
ちなみにcpandocを知ったのは, id:toku_bass さんのこのエントリだった気がします. ありがとうございます.