/ 
Test-Pod-LinkCheck-Lite-0.013
River stage one • 1 direct dependent • 1 total dependent
/ eg/test-pod-links

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

--add-dir

--add-dir=eg/

This option specifies a directory to add to the search for the targets of external POD links. This option can be specified multiple times. If not specified at all, the default is

--add-dir=blib/script

provided that directory exists.

--allow-redirect-to-index

This Boolean option implies -prohibit-redirect, but sets the corresponding attribute to ALLOW_REDIRECT_TO_INDEX.

--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

--dump=dump.yml

This option produces a YAML dump of the object. There will be three keys in the output: Cache is the cache of external modules referred to, Links are the links to those external modules, and Sections are the sections that can be used as targets to links. The output is written to the specified file.

This option is unsupported, and may be changed or retracted without notice.

-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.

-prohibit-redirect

This Boolean option fails URL links that redirect to a different URL.

-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-2024 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.