1Getopt::Long::DescriptiUvsee:r:OCpotnst(r3i)buted Perl DGoectuompetn:t:aLtoinogn::Descriptive::Opts(3)
2
3
4
6 Getopt::Long::Descriptive::Opts - object representing command line
7 switches
8
10 version 0.110
11
13 This class is the base class of all $opt objects returned by
14 Getopt::Long::Descriptive. In general, you do not want to think about
15 this class, look at it, or alter it. Seriously, it's pretty dumb.
16
17 Every call to "describe_options" will return a object of a new subclass
18 of this class. It will have a method for the canonical name of each
19 option possible given the option specifications.
20
21 Method names beginning with an single underscore are public, and are
22 named that way to avoid conflict with automatically generated methods.
23 Methods with multiple underscores (in case you're reading the source)
24 are private.
25
27 This library should run on perls released even a long time ago. It
28 should work on any version of perl released in the last five years.
29
30 Although it may work on older versions of perl, no guarantee is made
31 that the minimum required version will not be increased. The version
32 may be increased for any reason, and there is no promise that patches
33 will be accepted to lower the minimum required perl.
34
36 Achtung! All methods beginning with an underscore are experimental as
37 of today, 2009-12-12. They are likely to be formally made permanent
38 soon.
39
40 _specified
41 This method returns true if the given name was specified on the command
42 line.
43
44 For example, if @ARGS was ""--foo --bar 10"" and "baz" is defined by a
45 default, "_specified" will return true for foo and bar, and false for
46 baz.
47
48 _specified_opts
49 This method returns an opt object in which only explicitly specified
50 values are defined. Values which were set by defaults will appear
51 undef.
52
53 _complete_opts
54 This method returns the opts object with all values, including those
55 set by defaults. It is probably not going to be very often-used.
56
58 • Hans Dieter Pearcey <hdp@cpan.org>
59
60 • Ricardo Signes <rjbs@semiotic.systems>
61
63 This software is copyright (c) 2005 by Hans Dieter Pearcey.
64
65 This is free software; you can redistribute it and/or modify it under
66 the same terms as the Perl 5 programming language system itself.
67
68
69
70perl v5.36.0 2022-07-22Getopt::Long::Descriptive::Opts(3)