.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.15)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Test::Pod::No404s 3pm"
.TH Test::Pod::No404s 3pm "2011-03-05" "perl v5.10.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::No404s \- Checks POD for http 404 links
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        #!/usr/bin/perl
\&        use strict; use warnings;
\&
\&        use Test::More;
\&
\&        eval "use Test::Pod::No404s";
\&        if ( $@ ) {
\&                plan skip_all => \*(AqTest::Pod::No404s required for testing POD\*(Aq;
\&        } else {
\&                all_pod_files_ok();
\&        }
.Ve
.SH "ABSTRACT"
.IX Header "ABSTRACT"
Using this test module will check your \s-1POD\s0 for any http 404 links.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module looks for any http(s) links in your \s-1POD\s0 and verifies that they will not return a 404. It uses LWP::UserAgent for the heavy
lifting, and simply lets you know if it failed to retrieve the document. More specifically, it uses \f(CW$response\fR\->is_error as the \*(L"test.\*(R"
.PP
Normally, you wouldn't want this test to be run during end-user installation because they might have no internet! It is \s-1HIGHLY\s0 recommended
that this be used only for module authors' \s-1RELEASE_TESTING\s0 phase. To do that, just modify the synopsis to add an env check :)
.SH "Methods"
.IX Header "Methods"
.ie n .SS "all_pod_files_ok( [ @files ] )"
.el .SS "all_pod_files_ok( [ \f(CW@files\fP ] )"
.IX Subsection "all_pod_files_ok( [ @files ] )"
This function is what you will usually run. It automatically finds any \s-1POD\s0 in your distribution and runs checks on them.
.PP
Accepts an optional argument: an array of files to check. By default it checks all \s-1POD\s0 files it can find in the distribution. Every file it finds
is passed to the \f(CW\*(C`pod_file_ok\*(C'\fR function.
.SS "pod_file_ok( \s-1FILENAME\s0, [ \s-1TESTNAME\s0 ] )"
.IX Subsection "pod_file_ok( FILENAME, [ TESTNAME ] )"
\&\f(CW\*(C`pod_file_ok()\*(C'\fR will okay the test if there is no http(s) links present in the \s-1POD\s0 or if all links are not an error. Furthermore, if the \s-1POD\s0 was
malformed as reported by Pod::Simple, the test will fail and not attempt to check the links.
.PP
When it fails, \f(CW\*(C`pod_file_ok()\*(C'\fR will show any failing links 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"404 test for \s-1FILENAME\s0\*(R".
.SH "EXPORT"
.IX Header "EXPORT"
Automatically exports the two subs.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
LWP::UserAgent
.PP
Pod::Simple
.PP
Test::Pod
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Test::Pod::No404s
.Ve
.SS "Websites"
.IX Subsection "Websites"
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/Test\-Pod\-No404s>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/Test\-Pod\-No404s>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/Test\-Pod\-No404s>
.IP "\(bu" 4
\&\s-1CPAN\s0 Forum
.Sp
<http://cpanforum.com/dist/Test\-Pod\-No404s>
.IP "\(bu" 4
\&\s-1RT:\s0 \s-1CPAN\s0's Request Tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test\-Pod\-No404s>
.IP "\(bu" 4
\&\s-1CPANTS\s0 Kwalitee
.Sp
<http://cpants.perl.org/dist/overview/Test\-Pod\-No404s>
.IP "\(bu" 4
\&\s-1CPAN\s0 Testers Results
.Sp
<http://cpantesters.org/distro/T/Test\-Pod\-No404s.html>
.IP "\(bu" 4
\&\s-1CPAN\s0 Testers Matrix
.Sp
<http://matrix.cpantesters.org/?dist=Test\-Pod\-No404s>
.IP "\(bu" 4
Git Source Code Repository
.Sp
<http://github.com/apocalypse/perl\-test\-pod\-no404s>
.SS "Bugs"
.IX Subsection "Bugs"
Please report any bugs or feature requests to \f(CW\*(C`bug\-test\-pod\-no404s at rt.cpan.org\*(C'\fR, or through
the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test\-Pod\-No404s>.  I will be
notified, and then you'll automatically be notified of progress on your bug as I make changes.
.SH "AUTHOR"
.IX Header "AUTHOR"
Apocalypse <apocal@cpan.org>
.PP
Thanks to the author of Test::Pod for the basic framework of this module!
.PP
Thanks to the \s-1POE\s0 guys for finding 404 links in their \s-1POD\s0, and was the inspiration for this module.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2010 by Apocalypse
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.