MAN page from openSUSE Leap 15 perl-Pod-Parser-1.63-lp150.1.2.noarch.rpm

Pod::Find

Section: User Contributed Perl Documentation (3)
Updated: 2016-03-08
Index

NAME

Pod::Find - find POD documents in directory trees

SYNOPSIS

  use Pod::Find qw(pod_find simplify_name);  my %pods = pod_find({ -verbose => 1, -inc => 1 });  foreach(keys %pods) {     print "found library POD `$pods{$_}' in $_\n";  }  print "podname=",simplify_name('a/b/c/mymodule.pod'),"\n";  $location = pod_where( { -inc => 1 }, "Pod::Find" );

DESCRIPTION

NOTE: This module is considered legacy; modern Perl releases (5.18 andhigher) are going to remove Pod-Parser from core and use Pod-Simplefor all things POD.

Pod::Find provides a set of functions to locate POD files. Note thatno function is exported by default to avoid pollution of your namespace,so be sure to specify them in the use statement if you need them:

  use Pod::Find qw(pod_find);

From this version on the typical SCM (software configuration management)directories are ignored. These are: RCS, CVS, SCCS, .svn, .hg, .git, .sync

pod_find( { %opts } , @directories )

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

E.g. when searching in $HOME/perl5lib, the file$HOME/perl5lib/MyModule.pm would get the POD name MyModule,whereas $HOME/perl5lib/Myclass/Subclass.pm would beMyclass::Subclass. The name information can be used for PODtranslators.

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 nameis found, e.g. CPAN.pm in different directories. This usuallyindicates duplicate occurrences of modules in the @INC search path.

OPTIONS The first argument for pod_find may be a hash referencewith options. The rest are either directories that are searchedrecursively or files. The POD names of files are the plain basenameswith 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 includesstripping Perl-like extensions, omitting subdirectories that are numericbut do not match the current Perl interpreter's version id, suppressingsite_perl as a module hierarchy name etc.
-script => 1: Search for PODs in the current Perl interpreter's installation scriptdir. This is taken from the local Config module.
-inc => 1: Search for PODs in the current Perl interpreter's @INC paths. Thisautomatically considers paths specified in the "PERL5LIB" environmentas this is included in @INC by the Perl interpreter itself.

simplify_name( $str )

The function simplify_name is equivalent to basename, but alsostrips Perl-like extensions (.pm, .pl, .pod) and extensions like.bat, .cmd on Win32 and OS/2, or .com on VMS, respectively.

pod_where( { %opts }, $pod )

Returns the location of a pod document given a search directoryand 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 theConfig module.
-dirs => [ $dir1, $dir2, ... ]: Reference to an array of search directories. These are searched in orderbefore looking in @INC (if -inc). Current directory is used ifnone 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 directorynames in the selected directory. (eg on unix 'A::B' is converted to'A/B'). Additionally, '.pm', '.pl' and '.pod' are appended to thesearch automatically if required.

A subdirectory pod/ is also checked if it exists in any of the givensearch directories. This ensures that e.g. perlfunc isfound.

It is assumed that if a module name is supplied, that that namematches 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.

contains_pod( $file , $verbose )

Returns true if the supplied filename (not POD module) contains some podinformation.

AUTHOR

Please report bugs using <http://rt.cpan.org>.

Marek Rouchal <marekrAATTcpan.org>,heavily borrowing code from Nick Ing-Simmons' PodToHtml.

Tim Jenness <t.jennessAATTjach.hawaii.edu> provided"pod_where" and "contains_pod".

Pod::Find is part of the Pod::Parser distribution.

Index

NAME

SYNOPSIS

DESCRIPTION

pod_find( { %opts } , @directories )
simplify_name( $str )
pod_where( { %opts }, $pod )
contains_pod( $file , $verbose )

AUTHOR

SEE ALSO

This document was created byman2html,using the manual pages.