.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test::Pod 3"
.TH Test::Pod 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Test::Pod \- check for POD errors in files
.SH VERSION
.IX Header "VERSION"
Version 1.52
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\f(CW\*(C`Test::Pod\*(C'\fR lets you check the validity of a POD file, and report
its results in standard \f(CW\*(C`Test::Simple\*(C'\fR fashion.
.PP
.Vb 2
\& use Test::Pod tests => $num_tests;
\& pod_file_ok( $file, "Valid POD file" );
.Ve
.PP
Module authors can include the following in a \fIt/pod.t\fR file and
have \f(CW\*(C`Test::Pod\*(C'\fR automatically find and check all POD files in a
module distribution:
.PP
.Vb 4
\& use Test::More;
\& eval "use Test::Pod 1.00";
\& plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
\& all_pod_files_ok();
.Ve
.PP
You can also specify a list of files to check, using the
\&\f(CWall_pod_files()\fR function supplied:
.PP
.Vb 6
\& use strict;
\& use Test::More;
\& eval "use Test::Pod 1.00";
\& plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
\& my @poddirs = qw( blib script );
\& all_pod_files_ok( all_pod_files( @poddirs ) );
.Ve
.PP
Or even (if you're running under Apache::Test):
.PP
.Vb 4
\& use strict;
\& use Test::More;
\& eval "use Test::Pod 1.00";
\& plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
\&
\& my @poddirs = qw( blib script );
\& use File::Spec::Functions qw( catdir updir );
\& all_pod_files_ok(
\& all_pod_files( map { catdir updir, $_ } @poddirs )
\& );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Check POD files for errors or warnings in a test file, using
\&\f(CW\*(C`Pod::Simple\*(C'\fR to do the heavy lifting.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.SS "pod_file_ok( FILENAME[, TESTNAME ] )"
.IX Subsection "pod_file_ok( FILENAME[, TESTNAME ] )"
\&\f(CWpod_file_ok()\fR will okay the test if the POD parses correctly. Certain
conditions are not reported yet, such as a file with no pod in it at all.
.PP
When it fails, \f(CWpod_file_ok()\fR will show any pod checking errors as
diagnostics.
.PP
The optional second argument TESTNAME is the name of the test. If it
is omitted, \f(CWpod_file_ok()\fR chooses a default test name "POD test
for FILENAME".
.SS "all_pod_files_ok( [@entries] )"
.IX Subsection "all_pod_files_ok( [@entries] )"
Checks all the files under \f(CW@entries\fR for valid POD. It runs
\&\fBall_pod_files()\fR on directories and assumes everything else to be a file to
be tested. It calls the \f(CWplan()\fR function for you (one test for each file),
so you can't have already called \f(CW\*(C`plan\*(C'\fR.
.PP
If \f(CW@entries\fR is empty or not passed, the function finds all POD files in
files in the \fIblib\fR directory if it exists, or the \fIlib\fR directory if not.
A POD file matches the conditions specified below in "all_pod_files".
.PP
If you're testing a module, just make a \fIt/pod.t\fR:
.PP
.Vb 4
\& use Test::More;
\& eval "use Test::Pod 1.00";
\& plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
\& all_pod_files_ok();
.Ve
.PP
Returns true if all pod files are ok, or false if any fail.
.SS "all_pod_files( [@dirs] )"
.IX Xref "all_pod_files"
.IX Subsection "all_pod_files( [@dirs] )"
Returns a list of all the POD files in \fR\f(CI@dirs\fR\fI\fR and in directories below. If
no directories are passed, it defaults to \fIblib\fR if \fIblib\fR exists, or else
\&\fIlib\fR if not. Skips any files in \fICVS\fR, \fI.svn\fR, \fI.git\fR and similar
directories. See \f(CW%Test::Pod::ignore_dirs\fR for a list of them.
.PP
A POD file is:
.IP \(bu 4
Any file that ends in \fI.pl\fR, \fI.PL\fR, \fI.pm\fR, \fI.pod\fR, \fI.psgi\fR or \fI.t\fR.
.IP \(bu 4
Any file that has a first line with a shebang and "perl" on it.
.IP \(bu 4
Any file that ends in \fI.bat\fR and has a first line with "\-\-*\-Perl\-*\-\-" on it.
.PP
The order of the files returned is machine-dependent. If you want them
sorted, you'll have to sort them yourself.
.SH SUPPORT
.IX Header "SUPPORT"
This module is managed in an open GitHub
repository . Feel free to fork and
contribute, or to clone and send
patches!
.PP
Found a bug? Please post or
email a report!
.SH AUTHORS
.IX Header "AUTHORS"
.IP "David E. Wheeler " 4
.IX Item "David E. Wheeler "
Current maintainer.
.ie n .IP "Andy Lester """"" 4
.el .IP "Andy Lester \f(CW\fR" 4
.IX Item "Andy Lester "
Maintainer emeritus.
.IP "brian d foy" 4
.IX Item "brian d foy"
Original author.
.SH ACKNOWLEDGEMENTS
.IX Header "ACKNOWLEDGEMENTS"
Thanks brian d foy for the original code, and to these folks for contributions:
.IP \(bu 4
Andy Lester
.IP \(bu 4
David E. Wheeler
.IP \(bu 4
Paul Miller
.IP \(bu 4
Peter Edwards
.IP \(bu 4
Luca Ferrari
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2006\-2010, Andy Lester; 2010\-2015 David E. Wheeler. Some Rights
Reserved.
.PP
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.