Pod::Cpandoc - インストールしていないモジュールでも機能する perldoc
cpandoc File::Find
-- インストール済みの File::Find のドキュメントを表示
cpandoc Acme::BadExample
-- Acme::BadExample をインストールしてなくても動くよ!
cpandoc -v '$?'
-- すべてが標準の perldoc に渡されます
cpandoc -m Acme::BadExample | grep system
-- スクレイピングしてきたモジュールにも(perldoc の)オプションは使えます
vim `cpandoc -l Web::Scraper`
-- もうわかるよね?cpandoc は、インストールされてなくてモジュールのドキュメントが見つからないという場面で、かわりにCPAN をスクレイピングすることでうまく取り持ってくれるということをのぞいては、perldoc と同じように振舞います。
cpandocの重要な機能は、インストールしていないモジュールをスクレイピングすることだけです。 すでにインストールしているモジュールに使えば、インストールされたドキュメントを読めます。 これは、ドキュメントのバージョンとコードのバージョンが一致することを意味します。 cpandoc はあなたがモジュールをインストールするのを早くするちょっといい効用があります。
perldoc を cpandoc にすべて差し替えても無事動き続けます。 差し替え方は、以下の "SNEAKY INSTALL" を参照してください。
環境変数 CPANDOC_FETCH に正の値を設定すると、CPAN へのリクエストを STDERR にメッセージ出力します。
cpanm Pod::Cpandoc
インストールしたら: alias perldoc=cpandoc
もしくは: function perldoc () { cpandoc "$@" }
これで `perldoc Acme::BadExample` が動くよ!cpandoc からオプションを渡される場合でも、perldoc はすべてこれまでと同じように機能します。 cpandoc は @INC からファイルがみつからないときに、CPAN にスクレイピングしにいくだけのサブクラスにすぎないのです。
The sneaky install was inspired by https://github.com/defunkt/hub.
http://tech.bayashi.jp/archives/entry/perl-module/2011/003305.html
Shawn M Moore sartak@gmail.com
Copyright 2011 Shawn M Moore.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.