getopt::usaginator(3pm) [debian man page]

Getopt::Usaginator(3pm) 				User Contributed Perl Documentation				   Getopt::Usaginator(3pm)

NAME

       Getopt::Usaginator - Conjure up a usage function for your applications

VERSION

       version 0.0012

SYNOPSIS

	   use Getopt::Usaginator <<_END_;

	       Usage: xyzzy <options>

	       --derp	       Derp derp derp
	       --durp	       Durp durp durp
	       -h, --help      This usage

	   _END_

	   # The 'usage' subroutine is now installed

	   ...

	   $options = parse_options( @ARGV ); # Not supplied by Usaginator

	   usage if $options{help}; # Print usage and exit with status 0

	   if ( ! $options{derp} ) {
	       # Print warning and usage and exit with status -1
	       usage "You should really derp";
	   }

	   if ( $options{durp} ) {
	       # Print warning and usage and exit with status 2
	       usage 2 => "--durp is not ready yet";
	   }

	   ...

	   usage 3 # Print usage and exit with status 3

DESCRIPTION

       Getopt::Usaginator is a tool for creating a handy usage subroutine for commandline applications

       It does not do any option parsing, but is best paired with Getopt::Long or any of the other myriad of option parsers

USAGE

   use Getopt::Usaginator <usage>
       Install a "usage" subroutine configured with the <usage> text

   $code = Getopt::Usaginator->usaginator( <usage> )
       Return a subroutine configured with the <usage> text

   ...
       More advanced usage is possible, peek under the hood for more information

	   perldoc -m Getopt::Usaginator

       An example:

	   use Getopt::Usaginator
	       # Called with the error
	       error => sub { ... },
	       # Called when usage printing is needed
	       usage => sub { ... },
	       ...
	   ;

An example with Getopt::Long parsing
	   use Getopt::Usaginator ...

	   sub run {
	       my $self = shift;
	       my @arguments = @_;

	       usage 0 unless @arguments;

	       my ( $help );
	       {
		   local @ARGV = @arguments;
		   GetOptions(
		       'help|h|?' => $help,
		   );
	       }

	       usage 0 if $help;

	       ...
	   }

AUTHOR

	 Robert Krimen <robertkrimen@gmail.com>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2010 by Robert Krimen.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.10.1							    2010-06-05						   Getopt::Usaginator(3pm)

AppConfig::Getopt(3pm)					User Contributed Perl Documentation				    AppConfig::Getopt(3pm)

NAME

       AppConfig::Getopt - Perl5 module for processing command line arguments via delegation to Getopt::Long.

SYNOPSIS

	   use AppConfig::Getopt;

	   my $state  = AppConfig::State->new(\%cfg);
	   my $getopt = AppConfig::Getopt->new($state);

	   $getopt->parse(@args);	      # read args

OVERVIEW

       AppConfig::Getopt is a Perl5 module which delegates to Johan Vroman's Getopt::Long module to parse command line arguments and update values
       in an AppConfig::State object accordingly.

       AppConfig::Getopt is distributed as part of the AppConfig bundle.

DESCRIPTION

   USING THE AppConfig::Getopt MODULE
       To import and use the AppConfig::Getopt module the following line should appear in your Perl script:

	   use AppConfig::Getopt;

       AppConfig::Getopt is used automatically if you use the AppConfig module and create an AppConfig::Getopt object through the getopt() method.

       AppConfig::Getopt is implemented using object-oriented methods.	A new AppConfig::Getopt object is created and initialised using the new()
       method.	This returns a reference to a new AppConfig::Getopt object.  A reference to an AppConfig::State object should be passed in as the
       first parameter:

	   my $state  = AppConfig::State->new();
	   my $getopt = AppConfig::Getopt->new($state);

       This will create and return a reference to a new AppConfig::Getopt object.

   PARSING COMMAND LINE ARGUMENTS
       The "parse()" method is used to read a list of command line arguments and update the state accordingly.

       The first (non-list reference) parameters may contain a number of configuration strings to pass to Getopt::Long::Configure.  A reference to
       a list of arguments may additionally be passed or @ARGV is used by default.

	   $getopt->parse();			   # uses @ARGV
	   $getopt->parse(@myargs);
	   $getopt->parse(qw(auto_abbrev debug));  # uses @ARGV
	   $getopt->parse(qw(debug), @myargs);

       See Getopt::Long for details of the configuartion options available.

       A Getopt::Long specification string is constructed for each variable defined in the AppConfig::State.  This consists of the name, any
       aliases and the ARGS value for the variable.

       These specification string are then passed to Getopt::Long, the arguments are parsed and the values in the AppConfig::State updated.

       See AppConfig for information about using the AppConfig::Getopt module via the getopt() method.

AUTHOR

       Andy Wardley, <abw@wardley.org>

COPYRIGHT

       Copyright (C) 1997-2007 Andy Wardley.  All Rights Reserved.

       Copyright (C) 1997,1998 Canon Research Centre Europe Ltd.

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

ACKNOWLEDGMENTS

       Many thanks are due to Johan Vromans for the Getopt::Long module.  He was kind enough to offer assistance and access to early releases of
       his code to enable this module to be written.

SEE ALSO

       AppConfig, AppConfig::State, AppConfig::Args, Getopt::Long

perl v5.12.4							    2007-05-30						    AppConfig::Getopt(3pm)