Debian Codegraph @

upstream/debian-unstable/man3/Getopt::Long::Parser.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Getopt::Long::Parser 3perl"
58 .TH Getopt::Long::Parser 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Getopt::Long::Parser \- Getopt::Long object oriented interface
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 5
68 \& use Getopt::Long::Parser;
69 \& my $p = Getopt::Long::Parser\->new;
70 \& $p\->configure( ...configuration options... );
71 \& if ( $p\->getoptions( ...options descriptions... ) ) ...
72 \& if ( $p\->getoptionsfromarray( \e@array, ...options descriptions... ) ) ...
73 .Ve
74 .PP
75 Configuration options can be passed to the constructor:
76 .PP
77 .Vb 2
78 \& my $p = Getopt::Long::Parser\->new
79 \& config => [...configuration options...];
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 Getopt::Long::Parser is an object oriented interface to
84 Getopt::Long. See its documentation for configuration and use.
85 .PP
86 Note that Getopt::Long and Getopt::Long::Parser are not object
87 oriented. Getopt::Long::Parser emulates an object oriented interface,
88 which should be okay for most purposes.
89 .SH CONSTRUCTOR
90 .IX Header "CONSTRUCTOR"
91 .Vb 1
92 \& my $p = Getopt::Long::Parser\->new( %options );
93 .Ve
94 .PP
95 The constructor takes an optional hash with parameters.
96 .IP config 4
97 .IX Item "config"
98 An array reference with configuration settings.
99 See "Configuring Getopt::Long" in Getopt::Long for all possible settings.
100 .SH METHODS
101 .IX Header "METHODS"
102 In the examples, \f(CW$p\fR is assumed to be the result of a call to the constructor.
103 .SS configure
104 .IX Subsection "configure"
105 .Vb 1
106 \& $p\->configure( %settings );
107 .Ve
108 .PP
109 Update the current config settings.
110 See "Configuring Getopt::Long" in Getopt::Long for all possible settings.
111 .SS getoptionsfromarray
112 .IX Subsection "getoptionsfromarray"
113 .Vb 1
114 \& $res = $p\->getoptionsfromarray( $aref, @opts );
115 .Ve
116 .SS getoptions
117 .IX Subsection "getoptions"
118 .Vb 1
119 \& $res = $p\->getoptions( @opts );
120 .Ve
121 .PP
122 The same as getoptionsfromarray( \e@ARGV, \f(CW@opts\fR ).
123 .SH "SEE ALSO"
124 .IX Header "SEE ALSO"
125 Getopt::Long
126 .SH AUTHOR
127 .IX Header "AUTHOR"
128 Johan Vromans <[email protected]>
129 .SH "COPYRIGHT AND DISCLAIMER"
130 .IX Header "COPYRIGHT AND DISCLAIMER"
131 This program is Copyright 1990,2015,2023 by Johan Vromans.
132 This program is free software; you can redistribute it and/or
133 modify it under the same terms as Perl.