Edit D:\app\Administrator\product\11.2.0\dbhome_1\perl\html\lib\Pod\Find.html
<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Pod::Find - find POD documents in directory trees</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:" /> </head> <body style="background-color: white"> <table border="0" width="100%" cellspacing="0" cellpadding="3"> <tr><td class="block" style="background-color: #cccccc" valign="middle"> <big><strong><span class="block"> Pod::Find - find POD documents in directory trees</span></strong></big> </td></tr> </table> <!-- INDEX BEGIN --> <div name="index"> <p><a name="__index__"></a></p> <ul> <li><a href="#name">NAME</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#description">DESCRIPTION</a></li> <ul> <li><a href="#pod_find_____opts______directories__"><code>pod_find( { %opts } , @directories )</code></a></li> <li><a href="#simplify_name___str__"><code>simplify_name( $str )</code></a></li> <li><a href="#pod_where_____opts_____pod__"><code>pod_where( { %opts }, $pod )</code></a></li> <li><a href="#contains_pod___file____verbose__"><code>contains_pod( $file , $verbose )</code></a></li> </ul> <li><a href="#author">AUTHOR</a></li> <li><a href="#see_also">SEE ALSO</a></li> </ul> <hr name="index" /> </div> <!-- INDEX END --> <p> </p> <h1><a name="name">NAME</a></h1> <p>Pod::Find - find POD documents in directory trees</p> <p> </p> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <pre> 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"; }</pre> <pre> print "podname=",simplify_name('a/b/c/mymodule.pod'),"\n";</pre> <pre> $location = pod_where( { -inc => 1 }, "Pod::Find" );</pre> <p> </p> <hr /> <h1><a name="description">DESCRIPTION</a></h1> <p><strong>Pod::Find</strong> provides a set of functions to locate POD files. Note that no function is exported by default to avoid pollution of your namespace, so be sure to specify them in the <strong>use</strong> statement if you need them:</p> <pre> use Pod::Find qw(pod_find);</pre> <p>From this version on the typical SCM (software configuration management) files/directories like RCS, CVS, SCCS, .svn are ignored.</p> <p> </p> <h2><a name="pod_find_____opts______directories__"><code>pod_find( { %opts } , @directories )</code></a></h2> <p>The function <strong>pod_find</strong> 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.</p> <p>E.g. when searching in <em class="file">$HOME/perl5lib</em>, the file <em class="file">$HOME/perl5lib/MyModule.pm</em> would get the POD name <em>MyModule</em>, whereas <em class="file">$HOME/perl5lib/Myclass/Subclass.pm</em> would be <em>Myclass::Subclass</em>. The name information can be used for POD translators.</p> <p>Only text files containing at least one valid POD command are found.</p> <p>A warning is printed if more than one POD file with the same POD name is found, e.g. <em class="file">CPAN.pm</em> in different directories. This usually indicates duplicate occurrences of modules in the <em>@INC</em> search path.</p> <p><strong>OPTIONS</strong> The first argument for <strong>pod_find</strong> 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.</p> <dl> <dt><strong><a name="verbose_1" class="item"><code>-verbose => 1</code></a></strong> <dd> <p>Print progress information while scanning.</p> </dd> </li> <dt><strong><a name="perl_1" class="item"><code>-perl => 1</code></a></strong> <dd> <p>Apply Perl-specific heuristics to find the correct PODs. This includes stripping Perl-like extensions, omitting subdirectories that are numeric but do <em>not</em> match the current Perl interpreter's version id, suppressing <em class="file">site_perl</em> as a module hierarchy name etc.</p> </dd> </li> <dt><strong><a name="script_1" class="item"><code>-script => 1</code></a></strong> <dd> <p>Search for PODs in the current Perl interpreter's installation <strong>scriptdir</strong>. This is taken from the local <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/Config.html">Config</a> module.</p> </dd> </li> <dt><strong><a name="inc_1" class="item"><code>-inc => 1</code></a></strong> <dd> <p>Search for PODs in the current Perl interpreter's <em>@INC</em> paths. This automatically considers paths specified in the <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlrun.html#perl5lib"><code>PERL5LIB</code></a> environment as this is prepended to <em>@INC</em> by the Perl interpreter itself.</p> </dd> </li> </dl> <p> </p> <h2><a name="simplify_name___str__"><code>simplify_name( $str )</code></a></h2> <p>The function <strong>simplify_name</strong> is equivalent to <strong>basename</strong>, but also strips Perl-like extensions (.pm, .pl, .pod) and extensions like <em class="file">.bat</em>, <em class="file">.cmd</em> on Win32 and OS/2, or <em class="file">.com</em> on VMS, respectively.</p> <p> </p> <h2><a name="pod_where_____opts_____pod__"><code>pod_where( { %opts }, $pod )</code></a></h2> <p>Returns the location of a pod document given a search directory and a module (e.g. <code>File::Find</code>) or script (e.g. <code>perldoc</code>) name.</p> <p>Options:</p> <dl> <dt><strong><a name="inc_12" class="item"><a href="#inc_1"><code>-inc => 1</code></a></a></strong> <dd> <p>Search @INC for the pod and also the <code>scriptdir</code> defined in the <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/Config.html">Config</a> module.</p> </dd> </li> <dt><strong><a name="dirs_dir1_dir2" class="item"><code>-dirs => [ $dir1, $dir2, ... ]</code></a></strong> <dd> <p>Reference to an array of search directories. These are searched in order before looking in <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlvar.html#_inc"><code>@INC</code></a> (if <strong>-inc</strong>). Current directory is used if none are specified.</p> </dd> </li> <dt><strong><a name="verbose_12" class="item"><a href="#verbose_1"><code>-verbose => 1</code></a></a></strong> <dd> <p>List directories as they are searched</p> </dd> </li> </dl> <p>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'). Additionally, '.pm', '.pl' and '.pod' are appended to the search automatically if required.</p> <p>A subdirectory <em class="file">pod/</em> is also checked if it exists in any of the given search directories. This ensures that e.g. <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perlfunc.html">perlfunc</a> is found.</p> <p>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.</p> <p>A check is made to make sure that the file that is found does contain some pod documentation.</p> <p> </p> <h2><a name="contains_pod___file____verbose__"><code>contains_pod( $file , $verbose )</code></a></h2> <p>Returns true if the supplied filename (not POD module) contains some pod information.</p> <p> </p> <hr /> <h1><a name="author">AUTHOR</a></h1> <p>Please report bugs using <a href="http://rt.cpan.org">http://rt.cpan.org</a>.</p> <p>Marek Rouchal <<a href="mailto:marekr@cpan.org">marekr@cpan.org</a>>, heavily borrowing code from Nick Ing-Simmons' PodToHtml.</p> <p>Tim Jenness <<a href="mailto:t.jenness@jach.hawaii.edu">t.jenness@jach.hawaii.edu</a>> provided <code>pod_where</code> and <code>contains_pod</code>.</p> <p> </p> <hr /> <h1><a name="see_also">SEE ALSO</a></h1> <p><a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/Pod/Parser.html">the Pod::Parser manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/Pod/Checker.html">the Pod::Checker manpage</a>, <a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/pod/perldoc.html">the perldoc manpage</a></p> <table border="0" width="100%" cellspacing="0" cellpadding="3"> <tr><td class="block" style="background-color: #cccccc" valign="middle"> <big><strong><span class="block"> Pod::Find - find POD documents in directory trees</span></strong></big> </td></tr> </table> </body> </html>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de