NAME

Getopt::EX::Long - Getopt::Long compatible glue module

SYNOPSIS

  use Getopt::EX::Long;
  GetOptions(...);

  or

  require Getopt::EX::Long;
  my $parser = Getopt::EX::Long::Parser->new(
	config   => [ Getopt::Long option ... ],
	exconfig => [ Getopt::EX::Long option ...],
  );

DESCRIPTION

Getopt::EX::Long is almost compatible with Getopt::Long and you can just replace the module declaration and it should work the same as before (see the INCOMPATIBILITY section).

Besides working the same, users can define their own option aliases and write dynamically loaded extension modules. If the command name is example,

~/.examplerc

file is loaded by default. In this rc file, users can define their own options with macro processing. This is useful when the command takes complicated arguments.

Also, special command options preceded by -M are recognized and the corresponding Perl module is loaded. The module is assumed to be under a specific base class. For example,

% example -Mfoo

will load App::example::foo module, by default.

This module is a normal Perl module, so users can write any kind of program. If the module is specified with an initial function call, it is called at the beginning of command execution. Suppose that the module foo is specified like this:

% example -Mfoo::bar(buz=100) ...

Then, after the module foo is loaded, function bar is called with the parameter baz which has value 100.

If the module includes a __DATA__ section, it is interpreted just the same as an rc file. So you can define arbitrary options there. Combined with the startup function call described above, it is possible to control module behavior by user-defined options.

For details about startup files and module specification, read the Getopt::EX::Module documentation.

CONFIG OPTIONS

Config options are set by Getopt::ExConfigure or the exconfig parameter for the Getopt::EX::Long::Parser::new method.

AUTO_DEFAULT

Config options RCFILE and BASECLASS are automatically set based on the name of the command executable. If you don't want this behavior, set AUTO_DEFAULT to 0.

Other options including RCFILE and BASECLASS are passed to Getopt::EX::Loader. Read its documentation for details.

INCOMPATIBILITY

The subroutine GetOptionsFromString is not supported.

SEE ALSO

Getopt::EX, Getopt::EX::Module, Getopt::EX::Loader