perldocとは
Perlのドキュメントを参照するコマンドです。
たとえば、perldocコマンド自身のドキュメントは以下のコマンドで参照できます。
ぶっちゃけ、Perlの全てはperldocコマンドで知ることが出来ると言っても過言ではないです。
CLIで全て完結するので、マウスを持つと禁断症状が出るよう調教されている方でも安心して利用できます。
perldoc perldoc
Perlのドキュメントを読む
以下のコマンドでPerlのドキュメントが参照できます。
perldoc perl
だいたいどんな内容が見れるのか興味がある方はこちら。
http://perldoc.perl.org/perl.html
http://perldoc.jp/docs/perl/5.16.1/perl.pod
perldoc.jpとは
しれっとperldoc.jpのリンクを滲ませましたがperldocの内容を日本語に翻訳するプロジェクトが存在します。それがperldoc.jpです。
有志の方々の努力により保守・運用されている、大変有難いものです。ドキュメントの原文と共に是非活用してください。
http://perldoc.jp/
便利情報
Perl入学式で講師も務めた @xtetsuji さんがChromeで使える便利テクニックを紹介しています。http://post.tetsuji.jp/2014/01/perldoc-jp-shortcut-to-search/
こちらも是非ご活用下さい！
Perlモジュールのドキュメントを読む
モジュールのドキュメントを読むにはモジュール名をperldocに指定するだけです。簡単ですね！
ただし、perldocはインストール済のモジュールについてしか利用出来ない点をご注意下さい。
perldoc File::Spec
Perlモジュールのソースコードを読む
モジュールのソースコードを読むにはモジュール名をperldocに-mオプションと共に指定するだけです。簡単ですね！
perldoc -m File::Spec
Perlモジュールのファイルパスを知る
モジュールのソースコードのファイルパスを知るにはモジュール名をperldocに-lmオプションと共に指定するだけです。簡単ですね！
perldoc -lm File::Spec
Perlの組み込み関数のドキュメントを読む
Perlの組み込み関数について知るには関数名をperldocに-fオプションと共に指定するだけです。簡単ですね！
perldoc -f print
Perlの特殊変数のドキュメントを読む
Perlには実は特殊変数というものがあります。システムの状態やPerlの設定をGlobal変数として設定出来るものです。
たとえばlocalと組み合わせて、特定のスコープだけでreadline(<>)の区切り文字を変更するなど、ちょっと周りくどい処理が実現できます。
Perlの特殊変数について知るにはperldocに-vオプションと共に指定するだけです。簡単ですね！
あるいはperldoc perlvarとすると全ての特殊変数が参照できます。
他人のPerlコードを読んでいるさなか、謎の変数が出現したとき、それは特殊変数かもしれません。是非調べて真相を確かめてみてください。
perldoc -v '$@'
おまけ(cpandocについて)
Pod::Cpandocというモジュールをインストールするとcpandocというコマンドが利用出来るようになります。
cpanm Pod::Cpandoc
これは、perldocのwrapperになっており、まだインストールされていないperlモジュールについてもドキュメントを参照したり、ソースコードを参照したりすることが出来ます。
とりあえず入れておくとなにかと便利なモジュールです。是非活用しましょう。
まとめ
perldocとperldoc.jpの紹介でした。
プログラミング言語、あるいはモジュールについて、それらのドキュメント以上に詳細かつ正確な文書は基本的にありません。
Perlを書いていて分からないことがあったときは是非perldocあるいはperldoc.jpを参考にするとより正確な理解が出来る為、おすすめです。
それでも分からなければ、是非Perl入学式、あるいはPerl Beginners、あるいは最寄りの地域PM(Perl Mongers)に足を運んでみてください。きっと、Perlの達人がノウハウと共に理解に役立つ話を惜しみなく教えてくれることでしょう。
なお、来週にはGotanda.pm #3が開催されるようです。私が主催しております。良ければご参加下さい！