128 lines
3.4 KiB
HTML
128 lines
3.4 KiB
HTML
|
||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<HTML><HEAD><TITLE>Man page of PODCHECKER</TITLE>
|
||
</HEAD><BODY>
|
||
<H1>PODCHECKER</H1>
|
||
Section: Perl Programmers Reference Guide (1)<BR>Updated: 2020-10-19<BR><A HREF="#index">Index</A>
|
||
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<A NAME="lbAB"> </A>
|
||
<H2>NAME</H2>
|
||
|
||
podchecker - check the syntax of POD format documentation files
|
||
<A NAME="lbAC"> </A>
|
||
<H2>SYNOPSIS</H2>
|
||
|
||
|
||
|
||
<B>podchecker</B> [<B>-help</B>] [<B>-man</B>] [<B>-(no)warnings</B>] [<I>file</I> ...]
|
||
<A NAME="lbAD"> </A>
|
||
<H2>OPTIONS AND ARGUMENTS</H2>
|
||
|
||
|
||
|
||
<DL COMPACT>
|
||
<DT id="1"><B>-help</B><DD>
|
||
|
||
|
||
Print a brief help message and exit.
|
||
<DT id="2"><B>-man</B><DD>
|
||
|
||
|
||
Print the manual page and exit.
|
||
<DT id="3"><B>-warnings</B> <B>-nowarnings</B><DD>
|
||
|
||
|
||
Turn on/off printing of warnings. Repeating <B>-warnings</B> increases the
|
||
warning level, i.e. more warnings are printed. Currently increasing to
|
||
level two causes flagging of unescaped ``<,>'' characters.
|
||
<DT id="4"><I>file</I><DD>
|
||
|
||
|
||
The pathname of a <FONT SIZE="-1">POD</FONT> file to syntax-check (defaults to standard input).
|
||
</DL>
|
||
<A NAME="lbAE"> </A>
|
||
<H2>DESCRIPTION</H2>
|
||
|
||
|
||
|
||
<B>podchecker</B> will read the given input files looking for <FONT SIZE="-1">POD</FONT>
|
||
syntax errors in the <FONT SIZE="-1">POD</FONT> documentation and will print any errors
|
||
it find to <FONT SIZE="-1">STDERR.</FONT> At the end, it will print a status message
|
||
indicating the number of errors found.
|
||
<P>
|
||
|
||
Directories are ignored, an appropriate warning message is printed.
|
||
<P>
|
||
|
||
<B>podchecker</B> invokes the <B>podchecker()</B> function exported by <B>Pod::Checker</B>
|
||
Please see ``<B>podchecker()</B>'' in Pod::Checker for more details.
|
||
<A NAME="lbAF"> </A>
|
||
<H2>RETURN VALUE</H2>
|
||
|
||
|
||
|
||
<B>podchecker</B> returns a 0 (zero) exit status if all specified
|
||
<FONT SIZE="-1">POD</FONT> files are ok.
|
||
<A NAME="lbAG"> </A>
|
||
<H2>ERRORS</H2>
|
||
|
||
|
||
|
||
<B>podchecker</B> returns the exit status 1 if at least one of
|
||
the given <FONT SIZE="-1">POD</FONT> files has syntax errors.
|
||
<P>
|
||
|
||
The status 2 indicates that at least one of the specified
|
||
files does not contain <I>any</I> <FONT SIZE="-1">POD</FONT> commands.
|
||
<P>
|
||
|
||
Status 1 overrides status 2. If you want unambiguous
|
||
results, call <B>podchecker</B> with one single argument only.
|
||
<A NAME="lbAH"> </A>
|
||
<H2>SEE ALSO</H2>
|
||
|
||
|
||
|
||
Pod::Simple and Pod::Checker
|
||
<A NAME="lbAI"> </A>
|
||
<H2>AUTHORS</H2>
|
||
|
||
|
||
|
||
Please report bugs using <<A HREF="http://rt.cpan.org">http://rt.cpan.org</A>>.
|
||
<P>
|
||
|
||
Brad Appleton <<A HREF="mailto:bradapp@enteract.com">bradapp@enteract.com</A>>,
|
||
Marek Rouchal <<A HREF="mailto:marekr@cpan.org">marekr@cpan.org</A>>
|
||
<P>
|
||
|
||
Based on code for <B><A HREF="/cgi-bin/man/man2html?1+Pod::Text::pod2text">Pod::Text::pod2text</A>(1)</B> written by
|
||
Tom Christiansen <<A HREF="mailto:tchrist@mox.perl.com">tchrist@mox.perl.com</A>>
|
||
<P>
|
||
|
||
<HR>
|
||
<A NAME="index"> </A><H2>Index</H2>
|
||
<DL>
|
||
<DT id="5"><A HREF="#lbAB">NAME</A><DD>
|
||
<DT id="6"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
||
<DT id="7"><A HREF="#lbAD">OPTIONS AND ARGUMENTS</A><DD>
|
||
<DT id="8"><A HREF="#lbAE">DESCRIPTION</A><DD>
|
||
<DT id="9"><A HREF="#lbAF">RETURN VALUE</A><DD>
|
||
<DT id="10"><A HREF="#lbAG">ERRORS</A><DD>
|
||
<DT id="11"><A HREF="#lbAH">SEE ALSO</A><DD>
|
||
<DT id="12"><A HREF="#lbAI">AUTHORS</A><DD>
|
||
</DL>
|
||
<HR>
|
||
This document was created by
|
||
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
||
using the manual pages.<BR>
|
||
Time: 00:05:24 GMT, March 31, 2021
|
||
</BODY>
|
||
</HTML>
|