The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

TITLE

test-pod-links - Test a POD file, or literal POD.

SYNOPSIS

 test-pod-links
 test-pod-links fubar.pm
 test-pod-links 'L<Foobar|Foo/bar>'
 test-pod-links -help
 test-pod-links -version

OPTIONS

-check-url

This Boolean option specifies that World Wide Web access is allowed. If disallowed, URL links are not checked, and the CPAN Meta database is not considered when trying to check links to ininstalled modules.

The default is -check_url, but this option can be negated by specifying -nocheck-url.

-dump

If asserted, this Boolean option dumps selected object state after the test has been run. This option is unsupported, and may be changed or retracted without notice.

As of this writing, it displays all the sections in the last file parsed, in ASCIIbetical order.

-help

This option displays the documentation for this script. The script then exits.

-ignore-url

 -ignore-url http://www.google.com/
 -ignore-url <//www.google.com/>i

This option specifies a URL to ignore. It can be specified more than once to ignore more than one URL. If the value begins with an open angle bracket and ends with a close angle bracket followed by zero or more lower-case letters, it is stringy-eval-ed into a Regexp.

-man

If this Boolean option is asserted, man links will be tested if the OS is capable of supporting this. If it is negated (as -noman), such links will not be tested.

The default is true if the host system has a man command, and false otherwise.

-version

This option displays the version of this script. The script then exits.

DETAILS

This Perl script tests the POD specified as its first and only command line argument. This can be either the name of a file, or literal POD. If the argument is the name of a directory, all Perl files in that directory are tested. If no argument is specified, all Perl files in blib/ are tested.

AUTHOR

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

Copyright (C) 2019 by Thomas R. Wyant, III

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full text of the licenses in the directory LICENSES.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.