getopt::long::descriptive::opts(3) [osx man page]

Getopt::Long::Descriptive::Opts(3)			User Contributed Perl Documentation			Getopt::Long::Descriptive::Opts(3)

NAME

       Getopt::Long::Descriptive::Opts - object representing command line switches

VERSION

       version 0.092

DESCRIPTION

       This class is the base class of all $opt objects returned by Getopt::Long::Descriptive.	In general, you do not want to think about this
       class, look at it, or alter it.	Seriously, it's pretty dumb.

       Every call to "describe_options" will return a object of a new subclass of this class.  It will have a method for the canonical name of
       each option possible given the option specifications.

       Method names beginning with an single underscore are public, and are named that way to avoid conflict with automatically generated methods.
       Methods with multiple underscores (in case you're reading the source) are private.

METHODS

       Achtung!  All methods beginning with an underscore are experimental as of today, 2009-12-12.  They are likely to be formally made permanent
       soon.

   _specified
       This method returns true if the given name was specified on the command line.

       For example, if @ARGS was ""--foo --bar 10"" and "baz" is defined by a default, "_specified" will return true for foo and bar, and false
       for baz.

   _specified_opts
       This method returns an opt object in which only explicitly specified values are defined.  Values which were set by defaults will appear
       undef.

   _complete_opts
       This method returns the opts object with all values, including those set by defaults.  It is probably not going to be very often-used.

AUTHORS

       o   Hans Dieter Pearcey <hdp@cpan.org>

       o   Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2005 by Hans Dieter Pearcey.

       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.16.2							    2012-07-31					Getopt::Long::Descriptive::Opts(3)

Check Out this Related Man Page

Getopt::Long::Descriptive::Usage(3)			User Contributed Perl Documentation		       Getopt::Long::Descriptive::Usage(3)

NAME

       Getopt::Long::Descriptive::Usage - the usage description for GLD

VERSION

       version 0.096

SYNOPSIS

	 use Getopt::Long::Descriptive;
	 my ($opt, $usage) = describe_options( ... );

	 $usage->text; # complete usage message

	 $usage->die;  # die with usage message

DESCRIPTION

       This document only describes the methods of the Usage object.  For information on how to use Getopt::Long::Descriptive, consult its
       documentation.

METHODS

   new
	 my $usage = Getopt::Long::Descriptive::Usage->new(\%arg);

       You really don't need to call this.  GLD will do it for you.

       Valid arguments are:

	 options     - an arrayref of options
	 leader_text - the text that leads the usage; this may go away!

   text
       This returns the full text of the usage message.

   leader_text
       This returns the text that comes at the beginning of the usage message.

   option_text
       This returns the text describing the available options.

   warn
       This warns with the usage message.

   die
       This throws the usage message as an exception.

	 $usage_obj->die(\%arg);

       Some arguments can be provided

	 pre_text  - text to be prepended to the usage message
	 post_text - text to be appended to the usage message

       The "pre_text" and "post_text" arguments are concatenated with the usage message with no line breaks, so supply this if you need them.

AUTHORS

       o   Hans Dieter Pearcey <hdp@cpan.org>

       o   Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2005 by Hans Dieter Pearcey.

       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.18.2							    2013-10-04				       Getopt::Long::Descriptive::Usage(3)

Linux and UNIX Man Pages

getopt::long::descriptive::opts(3) [osx man page]

Check Out this Related Man Page