31 Oct 2021 03:12:48 UTC
- Distribution: Getopt-Long-Descriptive
- Module version: 0.110
- Source (raw)
- Browse (raw)
- How to Contribute
- Repository (git clone)
- Testers (1054 / 0 / 6)
- KwaliteeBus factor: 2
- 87.37% Coverage
- License: perl_5
- Perl: v5.12.0
- Activity24 month
- Download (33.74KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version++ed by:21 non-PAUSE usersRJBS Ricardo SIGNES 😄
- PERL VERSION
- COPYRIGHT AND LICENSE
Getopt::Long::Descriptive::Opts - object representing command line switches
This class is the base class of all
$optobjects 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_optionswill 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.
This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years.
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
Achtung! All methods beginning with an underscore are experimental as of today, 2009-12-12. They are likely to be formally made permanent soon.
This method returns true if the given name was specified on the command line.
For example, if
--foo --bar 10" and
bazis defined by a default,
_specifiedwill return true for foo and bar, and false for baz.
This method returns an opt object in which only explicitly specified values are defined. Values which were set by defaults will appear undef.
This method returns the opts object with all values, including those set by defaults. It is probably not going to be very often-used.
Hans Dieter Pearcey <email@example.com>
Ricardo Signes <firstname.lastname@example.org>
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.
Module Install Instructions
To install Getopt::Long::Descriptive, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Getopt::Long::Descriptive
For more information on module installation, please visit the detailed CPAN module installation guide.