NAME

Getopt::optparse - optparse style processing of command line options

This library supports both single and double dash options. An equal sign must be used.

SYNOPSIS

    use Getopt::optparse;
    my $parser = Getopt::optparse->new();
    $parser->add_option(
        '--hostname', 
        {
            dest    => 'hostname',
            help    => 'Remote hostname',
            default => 'localhost.localdomain'
        }
    );
    $parser->add_option( 
        '--global', {
            dest    => 'global',
            action  => 'store_true',
            help    => 'Show global',
            default => 0
        }
    );
    $parser->add_option(
        '--username', 
        {
            dest   => 'username',
            action => 'append',
            help   => 'Usernames to analyze'
        }
    );
    $parser->add_option(
        '-v', 
        {
            dest   => 'verbose',
            action => 'count',
            help   => 'Increment verbosity'
        }
    );

    my $options = $parser->parse_args();
    printf("Hostname is: %s\n", $options->{hostname});
    printf("Username is: %s\n", $options->{username});

    if ($options->{global}) {
    }

    for my $uname (@{$options->{username}}) {
        print $uname, "\n";
    }

DESCRIPTION

Library which allows Python optparse style processing of command line options.

CONSTRUCTOR

$parser = Getopt::optparse->new( \%options )

Construct a new Getopt::optparse object and return it. Hash reference argument may be provided though none are required.

METHODS

The following methods are available:

Getopt::optparse->add_option( 'optionname', {option_attributes} )

Add option to be parsed from command line. Accepts two arguments. Both are required:

    $parser->add_option(
        '--hostname',
        {
            dest => 'hostname',
            help => 'Remote hostname',
            default => 'localhost.localdomain'
        }
    )

Option Name

Value to be parsed from command line. --hostname in the above example. This library uses only double dash.

Option Attributes. A hash reference.

These may include:

dest

Name of key were parsed option will be stored.

default (optional)

Value of dest if no option is parsed on command line.

help (optional)

Text message displayed when --help is found on command line.

action (optional)

The following actions are supported.

store_true

Using this makes dest true or false. (0 or 1). If the option is found.

append

Using this appends each occurrance of an option to an array reference.

count

using this increments dest by one for every occurrence.

Getopt::optparse->parse_args()

Parse added options from command line and return their values as a hash reference.

    my $options = $parser->parse_args();

    printf("Hostname is: %s\n", $options->{hostname});

    for my $uname (@{$options->{username}}) {
        print $uname, "\n";
    }

AUTHOR

Matt Hersant <matt_hersant@yahoo.com>