PODをHTMLに変換して読む

Perlで書かれたソースコード中のドキュメント部分を読んでいたら

  • I<app_dir>とか
  • B<mt_dir>
  • ==head1 Hoge->hoge()

なんて表記が出てくる。いわゆるPOD（Plain Old Documentation）なんだけど、ちょと読みにくい。形式がHTMLと似ているから何かうまいやり方があるんだろうといろいろ調べてみたら、他のフォーマットに変換できるようになっているらしい。Podそれ自体がひとつのマークアップ言語とのこと。


てことで

$ pod2html hoge.pm > hoge_pod.html

コマンドpod2htmlに変換させたいPOD(もしくはPODを含むモジュール）と生成するファイル名を渡すと、PodがHTMLに変換されます。これで整形されたPodドキュメントをブラウザ上で眺めることが出来るようになります。（ソース部分は除外されます）これだとプリントアウトも奇麗で簡単。長いPodを読むときは変換した方がいい感じ。

他にも

  • pod2latex
  • pod2man
  • pod2text
  • pod2usage
  • podchecker
  • podselect

といったコマンドがあるようです。