NAME ^

Parrot::Configure::Options - Process command-line options to Configure.pl

SYNOPSIS ^

    use Parrot::Configure::Options qw( process_options );

    $args = process_options( {
        argv            => [ @ARGV ],
        script          => $0,
        parrot_version  => $parrot_version,
        svnid           =>
            '$Id$',
    } );

    @valid_options = get_valid_options();

DESCRIPTION ^

Parrot::Configure::Options exports on demand two subroutines: process_options(), which processes the command-line options provided to Configure.pl; and get_valid_options(), which returns the list of currently valid options.

If you provide Configure.pl with either --help or --version, process_options() will print out the appropriate message and perform a bare return, i.e., the return value will be undef. The calling script -- whether Configure.pl or a test file -- can then check for the definedness of process_options()'s return value and proceed appropriately.

An array of valid command-line option names stored internally is consulted; the program will die if an invalid option is called.

SUBROUTINES ^

process_options() ^

get_valid_options() ^

NOTES ^

The functionality in this package was transferred from Configure.pl by Jim Keenan.

SEE ALSO ^

Configure.pl.


parrot