Pod::Usage - PODドキュメントの出力



  1. Perl

    2. ›


  2. モジュール

    3. ›

  3. here

　Pod::UsageはPODドキュメントの出力するためのモジュールです。ドキュメントを表示してプログラムを終了させるpod2usageという関数を使用することができます。

　関数を使用する場合は明示的にインポートするのがよいでしょう。

# 関数のインポート
use Pod::Usage 'pod2usage';

　pod2usageのもっとも基本的な使い方のサンプルです。ドキュメントの中の「SYNOPSIS」という項目を表示してプログラムを終了します。

# Pod::Usageのもっとも基本的な使い方

=head1 SYNOPSIS

script.pl FILE

=cut

use Pod::Usage 'pod2usage';

# コマンドライン引数
my $file = shift;

# 引数がない場合はSYNOPSISを表示してプログラムを終了
pod2usage() unless $file;

　コマンドライン引数がなかった場合は次のように表示されプログラムは終了します。

Usage:
    script.pl FILE

　Pod::UsageとGetopt::Longを組み合わせたサンプルです。

# Pod::UsageとGetopt::Longを組み合わせる

=head1 SYNOPSIS

script.pl [--force] FILE

=cut

use Pod::Usage 'pod2usage';
use Getopt::Long 'GetOptions';

# コマンドラインオプションの解析
my $force;
GetOptions('force' => \$force) or pod2usage;

my $file = shift;
pod2usage unless $file;