Curt Tilmes > Pod-Usage-CommandLine > Pod::Usage::CommandLine

Download:
Pod-Usage-CommandLine-0.04.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.04   Source  

NAME ^

Pod::Usage::CommandLine - Add some common command line options from Pod::Usage

SYNOPSIS ^

  use Pod::Usage::CommandLine;

  BEGIN { our $VERSION = '1.0'; }    # NOTE: Set main version in BEGIN block

  # then, use command line options:

  my_program.pl --version
  my_program.pl --help
  my_program.pl -h
  my_program.pl '-?'
  my_program.pl --man
  my_program.pl -m

  # You can also export GetOptions and/or pod2usage if you need them:

  use Pod::Usage::CommandLine qw(GetOptions pod2usage);

  my %opt;
  GetOptions(\%opt, @getopt_long_specs) or pod2usage;

DESCRIPTION ^

Basically a cut/paste from the boilerplate described in Pod::Usage and Getopt::Long so it can be included with a single "use" instead of cut/pasting it.

See Getopt::Long for all the intricacies of specifying options.

Set $VERSION in a BEGIN block as shown above so it will get picked up by the '--version' option.

EXPORTS ^

GetOptions and pod2usage are exported on demand.

SEE ALSO ^

Pod::Usage, Getopt::Long

AUTHOR ^

Curt Tilmes, <ctilmes@cpan.org>

CREDITS ^

Thanks to:

Lars Dieckow <daxim@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright (C) 2008 by Curt Tilmes

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: