Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pod::perldoc::getoptsoo(3pm) [osx man page]

Pod::Perldoc::GetOptsOO(3pm)				 Perl Programmers Reference Guide			      Pod::Perldoc::GetOptsOO(3pm)

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 Pod::Perldoc.

       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

       Pod::Perldoc

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 v5.16.2							    2012-10-11					      Pod::Perldoc::GetOptsOO(3pm)

Check Out this Related Man Page

Pod::Perldoc::ToChecker(3pm)				 Perl Programmers Reference Guide			      Pod::Perldoc::ToChecker(3pm)

NAME

       Pod::Perldoc::ToChecker - let Perldoc check Pod for errors

SYNOPSIS

	 % perldoc -o checker SomeFile.pod
	 No Pod errors in SomeFile.pod
	 (or an error report)

DESCRIPTION

       This is a "plug-in" class that allows Perldoc to use Pod::Simple::Checker as a "formatter" class (or if that is not available, then
       Pod::Checker), to check for errors in a given Pod file.

       This is actually a Pod::Simple::Checker (or Pod::Checker) subclass, and inherits all its options.

SEE ALSO

       Pod::Simple::Checker, Pod::Simple, Pod::Checker, Pod::Perldoc

COPYRIGHT AND DISCLAIMERS

       Copyright (c) 2002 Sean M. Burke.  All rights reserved.

       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 v5.18.2							    2014-01-06					      Pod::Perldoc::ToChecker(3pm)
Man Page