One Hat Cyber Team

Edit File: Test::Pod.3pm

.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "2018-04-19" "perl v5.32.1" "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 \s-1POD\s0 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 \s-1POD\s0 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(CW\*(C`all_pod_files()\*(C'\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 \s-1POD\s0 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[, \s-1TESTNAME\s0 ] )"
.IX Subsection "pod_file_ok( FILENAME[, TESTNAME ] )"
\&\f(CW\*(C`pod_file_ok()\*(C'\fR will okay the test if the \s-1POD\s0 parses correctly.  Certain
conditions are not reported yet, such as a file with no pod in it at all.
.PP
When it fails, \f(CW\*(C`pod_file_ok()\*(C'\fR will show any pod checking errors as
diagnostics.
.PP
The optional second argument \s-1TESTNAME\s0 is the name of the test.  If it
is omitted, \f(CW\*(C`pod_file_ok()\*(C'\fR chooses a default test name \*(L"\s-1POD\s0 test
for \s-1FILENAME\*(R".\s0
.SS "all_pod_files_ok( [@entries] )"
.IX Subsection "all_pod_files_ok( [@entries] )"
Checks all the files under \f(CW@entries\fR for valid \s-1POD.\s0 It runs
\&\fBall_pod_files()\fR on directories and assumes everything else to be a file to
be tested. It calls the \f(CW\*(C`plan()\*(C'\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 \s-1POD\s0 files in
files in the \fIblib\fR directory if it exists, or the \fIlib\fR directory if not.
A \s-1POD\s0 file matches the conditions specified below in \*(L"all_pod_files\*(R".
.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 \s-1POD\s0 files in \fI\f(CI@dirs\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 \fI\s-1CVS\s0\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 \s-1POD\s0 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 \*(L"perl\*(R" on it.
.IP "\(bu" 4
Any file that ends in \fI.bat\fR and has a first line with \*(L"\-\-*\-Perl\-*\-\-\*(R" 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 <http://github.com/perl-pod/test-pod/>. Feel free to fork and
contribute, or to clone <git://github.com/perl\-pod/test\-pod.git> and send
patches!
.PP
Found a bug? Please post <http://github.com/perl-pod/test-pod/issues> or
email <mailto:bug-test-pod@rt.cpan.org> a report!
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "David E. Wheeler <david@justatheory.com>" 4
.IX Item "David E. Wheeler <david@justatheory.com>"
Current maintainer.
.ie n .IP "Andy Lester ""<andy at petdance.com>""" 4
.el .IP "Andy Lester \f(CW<andy at petdance.com>\fR" 4
.IX Item "Andy Lester <andy at petdance.com>"
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.