GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PODCHECKER (1)

.ds Aq ’

NAME

podchecker - check the syntax of POD format documentation files

CONTENTS

SYNOPSIS

<B>podcheckerB> [<B>-helpB>] [<B>-manB>] [<B>-(no)warningsB>] [file ...]

OPTIONS AND ARGUMENTS

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

DESCRIPTION

<B>podcheckerB> will read the given input files looking for POD syntax errors in the POD documentation and will print any errors it find to STDERR. At the end, it will print a status message indicating the number of errors found.

Directories are ignored, an appropriate warning message is printed.

<B>podcheckerB> invokes the <B>B>podchecker()<B>B> function exported by <B>Pod::CheckerB> Please see podchecker() in Pod::Checker for more details.

RETURN VALUE

<B>podcheckerB> returns a 0 (zero) exit status if all specified POD files are ok.

ERRORS

<B>podcheckerB> returns the exit status 1 if at least one of the 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 unambiguous results, call <B>podcheckerB> with one single argument only.

SEE ALSO

Pod::Parser and Pod::Checker

AUTHORS

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

Brad Appleton <bradapp@enteract.com>, Marek Rouchal <marekr@cpan.org>

Based on code for <B>B>Pod::Text::pod2text<B>(1)B> written by Tom Christiansen <tchrist@mox.perl.com>

Search for    or go to Top of page |  Section 1 |  Main Index


perl v5.22.1 PODCHECKER (1) 2016-03-18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.