Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Perldoc::GetOptsOO.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 "Pod::Perldoc::GetOptsOO 3pm"
61 .TH Pod::Perldoc::GetOptsOO 3pm 2026-03-09 "perl v5.42.1" "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 Pod::Perldoc::GetOptsOO \- Customized option parser for Pod::Perldoc
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use Pod::Perldoc::GetOptsOO ();
72 \&
73 \& Pod::Perldoc::GetOptsOO::getopts( $obj, \e@args, $truth )
74 \& or die "wrong usage";
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 Implements a customized option parser used for
79 Pod::Perldoc.
80 .PP
81 Rather like Getopt::Std\*(Aqs getopts:
82 .ie n .IP "Call Pod::Perldoc::GetOptsOO::getopts($object, \e@ARGV, $truth)" 4
83 .el .IP "Call Pod::Perldoc::GetOptsOO::getopts($object, \e@ARGV, \f(CW$truth\fR)" 4
84 .IX Item "Call Pod::Perldoc::GetOptsOO::getopts($object, @ARGV, $truth)"
85 .PD 0
86 .ie n .IP "Given \-n, if there\*(Aqs a opt_n_with, it\*(Aqll call $object\->opt_n_with( ARGUMENT ) (e.g., ""\-n foo"" => $object\->opt_n_with(\*(Aqfoo\*(Aq). Ditto ""\-nfoo"")" 4
87 .el .IP "Given \-n, if there\*(Aqs a opt_n_with, it\*(Aqll call \f(CW$object\fR\->opt_n_with( ARGUMENT ) (e.g., ""\-n foo"" => \f(CW$object\fR\->opt_n_with(\*(Aqfoo\*(Aq). Ditto ""\-nfoo"")" 4
88 .IX Item "Given -n, if there's a opt_n_with, it'll call $object->opt_n_with( ARGUMENT ) (e.g., ""-n foo"" => $object->opt_n_with('foo'). Ditto ""-nfoo"")"
89 .ie n .IP "Otherwise (given \-n) if there\*(Aqs an opt_n, we\*(Aqll call it $object\->opt_n($truth) (Truth defaults to 1)" 4
90 .el .IP "Otherwise (given \-n) if there\*(Aqs an opt_n, we\*(Aqll call it \f(CW$object\fR\->opt_n($truth) (Truth defaults to 1)" 4
91 .IX Item "Otherwise (given -n) if there's an opt_n, we'll call it $object->opt_n($truth) (Truth defaults to 1)"
92 .ie n .IP "Otherwise we try calling $object\->handle_unknown_option(\*(Aqn\*(Aq) (and we increment the error count by the return value of it)" 4
93 .el .IP "Otherwise we try calling \f(CW$object\fR\->handle_unknown_option(\*(Aqn\*(Aq) (and we increment the error count by the return value of it)" 4
94 .IX Item "Otherwise we try calling $object->handle_unknown_option('n') (and we increment the error count by the return value of it)"
95 .IP "If there\*(Aqs no handle_unknown_option, then we just warn, and then increment the error counter" 4
96 .IX Item "If there's no handle_unknown_option, then we just warn, and then increment the error counter"
97 .PD
98 .PP
99 The return value of Pod::Perldoc::GetOptsOO::getopts is true if no errors,
100 otherwise it\*(Aqs false.
101 .SH "SEE ALSO"
102 .IX Header "SEE ALSO"
103 Pod::Perldoc
104 .SH "COPYRIGHT AND DISCLAIMERS"
105 .IX Header "COPYRIGHT AND DISCLAIMERS"
106 Copyright (c) 2002\-2007 Sean M. Burke.
107 .PP
108 This library is free software; you can redistribute it and/or modify it
109 under the same terms as Perl itself.
110 .PP
111 This program is distributed in the hope that it will be useful, but
112 without any warranty; without even the implied warranty of
113 merchantability or fitness for a particular purpose.
114 .SH AUTHOR
115 .IX Header "AUTHOR"
116 Current maintainer: Mark Allen \f(CW\*(C`<[email protected]>\*(C'\fR
117 .PP
118 Past contributions from:
119 brian d foy \f(CW\*(C`<[email protected]>\*(C'\fR
120 Adriano R. Ferreira \f(CW\*(C`<[email protected]>\*(C'\fR,
121 Sean M. Burke \f(CW\*(C`<[email protected]>\*(C'\fR