Debian Codegraph @

upstream/mageia-cauldron/man3pm/Getopt::Long::Parser.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Getopt::Long::Parser 3pm"
61 .TH Getopt::Long::Parser 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Getopt::Long::Parser \- Getopt::Long object\-oriented interface
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 5
71 \& use Getopt::Long::Parser;
72 \& my $p = Getopt::Long::Parser\->new;
73 \& $p\->configure( %options );
74 \& if ( $p\->getoptions( @options ) ) { ... }
75 \& if ( $p\->getoptionsfromarray( \e@array, @options ) ) { ... }
76 .Ve
77 .PP
78 Configuration options can be passed to the constructor:
79 .PP
80 .Vb 1
81 \& my $p = Getopt::Long::Parser\->new( config => [ %options ] );
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 \&\f(CW\*(C`Getopt::Long::Parser\*(C'\fR is an object\-oriented interface to
86 Getopt::Long. See its documentation for configuration and use.
87 .PP
88 Note that \f(CW\*(C`Getopt::Long\*(C'\fR and \f(CW\*(C`Getopt::Long::Parser\*(C'\fR are not
89 object\-oriented.
90 \&\f(CW\*(C`Getopt::Long::Parser\*(C'\fR emulates an object\-oriented interface,
91 which should be okay for most purposes.
92 .SH CONSTRUCTOR
93 .IX Header "CONSTRUCTOR"
94 .Vb 1
95 \& my $p = Getopt::Long::Parser\->new( %options );
96 .Ve
97 .PP
98 The constructor takes an optional hash with parameters.
99 .IP config 4
100 .IX Item "config"
101 An array reference with configuration settings.
102 See "Configuring Getopt::Long" in Getopt::Long for all possible settings.
103 .SH METHODS
104 .IX Header "METHODS"
105 In the examples, \f(CW$p\fR is assumed to be the result of a call to the constructor.
106 .SS configure
107 .IX Subsection "configure"
108 .Vb 1
109 \& $p\->configure( %settings );
110 .Ve
111 .PP
112 Update the current config settings.
113 See "Configuring Getopt::Long" in Getopt::Long for all possible settings.
114 .SS getoptionsfromarray
115 .IX Subsection "getoptionsfromarray"
116 .Vb 1
117 \& my $res = $p\->getoptionsfromarray( $aref, @opts );
118 .Ve
119 .SS getoptions
120 .IX Subsection "getoptions"
121 .Vb 1
122 \& my $res = $p\->getoptions( @opts );
123 .Ve
124 .PP
125 The same as \f(CW\*(C`getoptionsfromarray( \e@ARGV, @opts )\*(C'\fR.
126 .SH "SEE ALSO"
127 .IX Header "SEE ALSO"
128 Getopt::Long
129 .SH AUTHOR
130 .IX Header "AUTHOR"
131 Johan Vromans <[email protected]>
132 .SH "COPYRIGHT AND DISCLAIMER"
133 .IX Header "COPYRIGHT AND DISCLAIMER"
134 This program is Copyright 1990,2015,2023 by Johan Vromans.
135 This program is free software; you can redistribute it and/or
136 modify it under the same terms as Perl.