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