Manual Pages for UNIX Darwin command on man Pod::Find

Pod::Find(3pm) Perl Programmers Reference Guide Pod::Find(3pm)

NAME

Pod::Find - find POD documents in directory trees

SYNOPSIS

use Pod::Find qw(podfind simplifyname);

my %pods = podfind({ -verbose => 1, -inc => 1 });

foreach(keys %pods) {

print "found library POD `$pods{$}' in $\n";

} print "podname=",simplifyname('a/b/c/mymodule.pod'),"\n";

$location = podwhere( { -inc => 1 }, "Pod::Find" );

DESCRIPTION

PPoodd::::FFiinndd provides a set of functions to locate POD files. Note that

no function is exported by default to avoid pollution of your names-

pace, so be sure to specify them in the uussee statement if you need them:

use Pod::Find qw(podfind);

From this version on the typical SCM (software configuration manage-

ment) files/directories like RCS, CVS, SCCS, .svn are ignored.

""ppooddffiinndd(( {{ %%ooppttss }} ,, @@ddiirreeccttoorriieess ))""

The function ppooddffiinndd searches for POD documents in a given set of files and/or directories. It returns a hash with the file names as keys and the POD name as value. The POD name is derived from the file name and its position in the directory tree.

E.g. when searching in $HOME/perl5lib, the file $HOME/perl5lib/MyMod-

ule.pm would get the POD name MyModule, whereas

$HOME/perl5lib/Myclass/Subclass.pm would be Myclass::Subclass. The name

information can be used for POD translators. Only text files containing at least one valid POD command are found. A warning is printed if more than one POD file with the same POD name is found, e.g. CPAN.pm in different directories. This usually indicates duplicate occurrences of modules in the @INC search path. OOPPTTIIOONNSS The first argument for ppooddffiinndd may be a hash reference with options. The rest are either directories that are searched recursively or files. The POD names of files are the plain basenames with any

Perl-like extension (.pm, .pl, .pod) stripped.

"-verbose => 1"

Print progress information while scanning.

"-perl => 1"

Apply Perl-specific heuristics to find the correct PODs. This

includes stripping Perl-like extensions, omitting subdirectories

that are numeric but do not match the current Perl interpreter's version id, suppressing siteperl as a module hierarchy name etc.

"-script => 1"

Search for PODs in the current Perl interpreter's installation ssccrriippttddiirr. This is taken from the local Config module.

"-inc => 1"

Search for PODs in the current Perl interpreter's @INC paths. This

automatically considers paths specified in the "PERL5LIB" environ-

ment as this is prepended to @INC by the Perl interpreter itself.

""ssiimmpplliiffyynnaammee(( $$ssttrr ))""

The function ssiimmpplliiffyynnaammee is equivalent to bbaasseennaammee, but also strips

Perl-like extensions (.pm, .pl, .pod) and extensions like .bat, .cmd on

Win32 and OS/2, or .com on VMS, respectively.

""ppooddwwhheerree(( {{ %%ooppttss }},, $$ppoodd ))""

Returns the location of a pod document given a search directory and a module (e.g. "File::Find") or script (e.g. "perldoc") name. Options:

"-inc => 1"

Search @INC for the pod and also the "scriptdir" defined in the Config module.

"-dirs => [ $dir1, $dir2, ... ]"

Reference to an array of search directories. These are searched in

order before looking in @INC (if -iinncc). Current directory is used

if none are specified.

"-verbose => 1"

List directories as they are searched Returns the full path of the first occurrence to the file. Package names (eg 'A::B') are automatically converted to directory names in the

selected directory. (eg on unix 'A::B' is converted to 'A/B'). Addi-

tionally, '.pm', '.pl' and '.pod' are appended to the search automati-

cally if required. A subdirectory pod/ is also checked if it exists in any of the given search directories. This ensures that e.g. perlfunc is found. It is assumed that if a module name is supplied, that that name matches

the file name. Pods are not opened to check for the 'NAME' entry.

A check is made to make sure that the file that is found does contain some pod documentation.

""ccoonnttaaiinnssppoodd(( $$ffiillee ,, $$vveerrbboossee ))""

Returns true if the supplied filename (not POD module) contains some pod information. AUTHOR Please report bugs using . Marek Rouchal , heavily borrowing code from Nick

Ing-Simmons' PodToHtml.

Tim Jenness provided "podwhere" and "con-

tainspod".