Perlゼミ

  1. Perl
  2. モジュール
  3. here

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

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;
Perlの書籍
  • 業務に役立つPerl

    ログ解析など日本語を含むテキスト処理の実践!
    この私、Perlゼミの作者が執筆しています。
    ご購入、口コミ歓迎。
  • Perlの書籍 »
自己紹介
木本裕紀

「こっ、こしゃくな。
このPerオタクめ~!」

Twitter
フォロー、いいね、リツート、コメント歓迎

Youtube

チャンネル登録、いいね、コメント歓迎

kimoto.yuki@gmail.com
応援メッセージ、質問、間違い報告歓迎

木本システム株式会社
ご紹介キャンペーン実施中です。契約金額の10%をご紹介料としてお支払い。

(例)30万円のシステム開発委託契約が、1年続いたら、36万円がもらえる!!!