POD::PERLDOC::GETOPTSOO(3pm)
π NAME π
Okay bestie, this is Pod::Perldoc::GetOptsOO from the Perl Programmers Reference Guide β the customized option parser for Pod::Perldoc. Itβs giving very specific, very useful option-parsing energy, and yes, weβre gonna get into all of it. π
β¨ SYNOPSIS β¨
use Pod::Perldoc::GetOptsOO ();
Pod::Perldoc::GetOptsOO::getopts( $obj, \@args, $truth )
or die "wrong usage";
π DESCRIPTION π
Okay so Pod::Perldoc::GetOptsOO implements a customized option parser used for Pod::Perldoc. Itβs rather like Getopt::Stdβs getopts, but with its own little rules, and hereβs the whole tea:
Call Pod::Perldoc::GetOptsOO::getopts($object, \@ARGV, $truth) β thatβs the main character call. π«
- Given
-n, if thereβs aopt_n_with, itβll call$object->opt_n_with( ARGUMENT )(e.g.,"-n foo"=>$object->opt_n_with('foo'). Ditto"-nfoo") - Otherwise (given
-n) if thereβs anopt_n, weβll call it$object->opt_n($truth)(Truth defaults to1) - Otherwise we try calling
$object->handle_unknown_option('n')(and we increment the error count by the return value of it) - If thereβs no
handle_unknown_option, then we just warn, and then increment the error counter
The return value of Pod::Perldoc::GetOptsOO::getopts is true if no errors, otherwise itβs false. Slay. β
π SEE ALSO π
Pod::Perldoc β thatβs the one. Go read it, bestie. π
π COPYRIGHT AND DISCLAIMERS π
Copyright (c) 2002-2007 Sean M. Burke. π
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. So yes, free software vibes. π
This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. Thatβs the legal disclaimer, no cap. β οΈ
π AUTHOR π
Current maintainer: Mark Allen <mallen@cpan.org> π
Past contributions from: brian d foy <bdfoy@cpan.org>, Adriano R. Ferreira <ferreira@cpan.org>, Sean M. Burke <sburke@cpan.org> π
Later, bestie! This page is chilling with perl v5.42.3 and dated 2026-11-03 β mwah πβ¨
π¦ where this page comes from
- alpine 3.24: perl-doc 5.42.3-r0 Β· Artistic-1.0-Perl OR GPL-1.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms