Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Pod::Perldoc::GetOptsOO

Name Pod::Perldoc::GetOptsOO
Version 3.28
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/Pod/Perldoc/GetOptsOO.pm
Is Core No
Search CPAN for this module Pod::Perldoc::GetOptsOO
Documentation Pod::Perldoc::GetOptsOO
Module Details Pod::Perldoc::GetOptsOO

NAME

Pod::Perldoc::GetOptsOO - Customized option parser for Pod::Perldoc


SYNOPSIS

    use Pod::Perldoc::GetOptsOO ();
    Pod::Perldoc::GetOptsOO::getopts( $obj, \@args, $truth )
       or die "wrong usage";


DESCRIPTION

Implements a customized option parser used for the Pod::Perldoc manpage.

Rather like Getopt::Std's getopts:

Call Pod::Perldoc::GetOptsOO::getopts($object, \@ARGV, $truth)
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")
Otherwise (given -n) if there's an opt_n, we'll call it $object->opt_n($truth) (Truth defaults to 1)
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.


SEE ALSO

the Pod::Perldoc manpage


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.

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.


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>

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024