SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from CentOS 8 perl-Pod-Checker-1.73-395.module_el8.0.0+50+c3b345cd.noarch.rpm

PODCHECKER

Section: User Contributed Perl Documentation (1)
Updated: 2019-06-25
Index 

NAME

podchecker - check the syntax of POD format documentation files 

SYNOPSIS

podchecker [-help] [-man] [-(no)warnings] [file ...] 

OPTIONS AND ARGUMENTS

-help
Print a brief help message and exit.
-man
Print the manual page and exit.
-warnings -nowarnings
Turn on/off printing of warnings. Repeating -warnings increases thewarning level, i.e. more warnings are printed. Currently increasing tolevel two causes flagging of unescaped ``<,>'' characters.
file
The pathname of a POD file to syntax-check (defaults to standard input).
 

DESCRIPTION

podchecker will read the given input files looking for PODsyntax errors in the POD documentation and will print any errorsit find to STDERR. At the end, it will print a status messageindicating the number of errors found.

Directories are ignored, an appropriate warning message is printed.

podchecker invokes the podchecker() function exported by Pod::CheckerPlease see ``podchecker()'' in Pod::Checker for more details. 

RETURN VALUE

podchecker returns a 0 (zero) exit status if all specifiedPOD files are ok. 

ERRORS

podchecker returns the exit status 1 if at least one ofthe given POD files has syntax errors.

The status 2 indicates that at least one of the specified files does not contain any POD commands.

Status 1 overrides status 2. If you want unambiguousresults, call podchecker with one single argument only. 

SEE ALSO

Pod::Simple and Pod::Checker 

AUTHORS

Please report bugs using <http://rt.cpan.org>.

Brad Appleton <bradappAATTenteract.com>,Marek Rouchal <marekrAATTcpan.org>

Based on code for Pod::Text::pod2text(1) written byTom Christiansen <tchristAATTmox.perl.com>


 

Index

NAME
SYNOPSIS
OPTIONS AND ARGUMENTS
DESCRIPTION
RETURN VALUE
ERRORS
SEE ALSO
AUTHORS

This document was created byman2html,using the manual pages.