*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->OpenBSD man pages -> podchecker (1)              



NAME    [Toc]    [Back]

       podchecker - check the syntax of POD format documentation

SYNOPSIS    [Toc]    [Back]

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


       -help   Print a brief help message and exit.

       -man    Print the manual page and exit.

       -warnings -nowarnings
               Turn on/off printing of warnings. Repeating -warn-
               ings 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    [Toc]    [Back]

       podchecker 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

       podchecker invokes the podchecker() function exported by
       Pod::Checker Please see "podchecker()" in Pod::Checker for
       more details.

RETURN VALUE    [Toc]    [Back]

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

ERRORS    [Toc]    [Back]

       podchecker 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 unambigouus
       results, call podchecker with one single argument only.

SEE ALSO    [Toc]    [Back]

       Pod::Parser and Pod::Checker

AUTHORS    [Toc]    [Back]

       Please report bugs using <http://rt.cpan.org>.
       Brad Appleton <bradapp@enteract.com>, Marek Rouchal

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

perl v5.8.5                 2002-11-06                          2
[ Back ]
 Similar pages
Name OS Title
chkgrp FreeBSD check the syntax of the group file
perldoc OpenBSD Look up Perl documentation in Pod format.
perldoc IRIX Look up Perl documentation in pod format.
perlpod OpenBSD the Plain Old Documentation format
pod2latex OpenBSD convert pod documentation to latex format
pod2latex Linux convert pod documentation to latex format
perlpodspec OpenBSD Plain Old Documentation: format specification and notes
gendoc Linux Documentation generation from Python source files
checknr OpenBSD check nroff/troff files
checknr FreeBSD check nroff/troff files
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service