| 1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sh \" Subsection heading |
| 6 | .br |
| 7 | .if t .Sp |
| 8 | .ne 5 |
| 9 | .PP |
| 10 | \fB\\$1\fR |
| 11 | .PP |
| 12 | .. |
| 13 | .de Sp \" Vertical space (when we can't use .PP) |
| 14 | .if t .sp .5v |
| 15 | .if n .sp |
| 16 | .. |
| 17 | .de Vb \" Begin verbatim text |
| 18 | .ft CW |
| 19 | .nf |
| 20 | .ne \\$1 |
| 21 | .. |
| 22 | .de Ve \" End verbatim text |
| 23 | .ft R |
| 24 | .fi |
| 25 | .. |
| 26 | .\" Set up some character translations and predefined strings. \*(-- will |
| 27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
| 29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
| 30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
| 31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
| 32 | .tr \(*W-|\(bv\*(Tr |
| 33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 | .ie n \{\ |
| 35 | . ds -- \(*W- |
| 36 | . ds PI pi |
| 37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 | . ds L" "" |
| 40 | . ds R" "" |
| 41 | . ds C` "" |
| 42 | . ds C' "" |
| 43 | 'br\} |
| 44 | .el\{\ |
| 45 | . ds -- \|\(em\| |
| 46 | . ds PI \(*p |
| 47 | . ds L" `` |
| 48 | . ds R" '' |
| 49 | 'br\} |
| 50 | .\" |
| 51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 | .\" output yourself in some meaningful fashion. |
| 55 | .if \nF \{\ |
| 56 | . de IX |
| 57 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 58 | .. |
| 59 | . nr % 0 |
| 60 | . rr F |
| 61 | .\} |
| 62 | .\" |
| 63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 64 | .\" way too many mistakes in technical documents. |
| 65 | .hy 0 |
| 66 | .if n .na |
| 67 | .\" |
| 68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 | . \" fudge factors for nroff and troff |
| 71 | .if n \{\ |
| 72 | . ds #H 0 |
| 73 | . ds #V .8m |
| 74 | . ds #F .3m |
| 75 | . ds #[ \f1 |
| 76 | . ds #] \fP |
| 77 | .\} |
| 78 | .if t \{\ |
| 79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 | . ds #V .6m |
| 81 | . ds #F 0 |
| 82 | . ds #[ \& |
| 83 | . ds #] \& |
| 84 | .\} |
| 85 | . \" simple accents for nroff and troff |
| 86 | .if n \{\ |
| 87 | . ds ' \& |
| 88 | . ds ` \& |
| 89 | . ds ^ \& |
| 90 | . ds , \& |
| 91 | . ds ~ ~ |
| 92 | . ds / |
| 93 | .\} |
| 94 | .if t \{\ |
| 95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 | .\} |
| 102 | . \" troff and (daisy-wheel) nroff accents |
| 103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 | . \" corrections for vroff |
| 113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 | . \" for low resolution devices (crt and lpr) |
| 116 | .if \n(.H>23 .if \n(.V>19 \ |
| 117 | \{\ |
| 118 | . ds : e |
| 119 | . ds 8 ss |
| 120 | . ds o a |
| 121 | . ds d- d\h'-1'\(ga |
| 122 | . ds D- D\h'-1'\(hy |
| 123 | . ds th \o'bp' |
| 124 | . ds Th \o'LP' |
| 125 | . ds ae ae |
| 126 | . ds Ae AE |
| 127 | .\} |
| 128 | .rm #[ #] #H #V #F C |
| 129 | .\" ======================================================================== |
| 130 | .\" |
| 131 | .IX Title "Pod::Find 3" |
| 132 | .TH Pod::Find 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide" |
| 133 | .SH "NAME" |
| 134 | Pod::Find \- find POD documents in directory trees |
| 135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
| 137 | .Vb 5 |
| 138 | \& use Pod::Find qw(pod_find simplify_name); |
| 139 | \& my %pods = pod_find({ -verbose => 1, -inc => 1 }); |
| 140 | \& foreach(keys %pods) { |
| 141 | \& print "found library POD `$pods{$_}' in $_\en"; |
| 142 | \& } |
| 143 | .Ve |
| 144 | .PP |
| 145 | .Vb 1 |
| 146 | \& print "podname=",simplify_name('a/b/c/mymodule.pod'),"\en"; |
| 147 | .Ve |
| 148 | .PP |
| 149 | .Vb 1 |
| 150 | \& $location = pod_where( { -inc => 1 }, "Pod::Find" ); |
| 151 | .Ve |
| 152 | .SH "DESCRIPTION" |
| 153 | .IX Header "DESCRIPTION" |
| 154 | \&\fBPod::Find\fR provides a set of functions to locate \s-1POD\s0 files. Note that |
| 155 | no function is exported by default to avoid pollution of your namespace, |
| 156 | so be sure to specify them in the \fBuse\fR statement if you need them: |
| 157 | .PP |
| 158 | .Vb 1 |
| 159 | \& use Pod::Find qw(pod_find); |
| 160 | .Ve |
| 161 | .PP |
| 162 | From this version on the typical \s-1SCM\s0 (software configuration management) |
| 163 | files/directories like \s-1RCS\s0, \s-1CVS\s0, \s-1SCCS\s0, .svn are ignored. |
| 164 | .ie n .Sh """pod_find( { %opts } , @directories )""" |
| 165 | .el .Sh "\f(CWpod_find( { %opts } , @directories )\fP" |
| 166 | .IX Subsection "pod_find( { %opts } , @directories )" |
| 167 | The function \fBpod_find\fR searches for \s-1POD\s0 documents in a given set of |
| 168 | files and/or directories. It returns a hash with the file names as keys |
| 169 | and the \s-1POD\s0 name as value. The \s-1POD\s0 name is derived from the file name |
| 170 | and its position in the directory tree. |
| 171 | .PP |
| 172 | E.g. when searching in \fI$HOME/perl5lib\fR, the file |
| 173 | \&\fI$HOME/perl5lib/MyModule.pm\fR would get the \s-1POD\s0 name \fIMyModule\fR, |
| 174 | whereas \fI$HOME/perl5lib/Myclass/Subclass.pm\fR would be |
| 175 | \&\fIMyclass::Subclass\fR. The name information can be used for \s-1POD\s0 |
| 176 | translators. |
| 177 | .PP |
| 178 | Only text files containing at least one valid \s-1POD\s0 command are found. |
| 179 | .PP |
| 180 | A warning is printed if more than one \s-1POD\s0 file with the same \s-1POD\s0 name |
| 181 | is found, e.g. \fI\s-1CPAN\s0.pm\fR in different directories. This usually |
| 182 | indicates duplicate occurrences of modules in the \fI@INC\fR search path. |
| 183 | .PP |
| 184 | \&\fB\s-1OPTIONS\s0\fR The first argument for \fBpod_find\fR may be a hash reference |
| 185 | with options. The rest are either directories that are searched |
| 186 | recursively or files. The \s-1POD\s0 names of files are the plain basenames |
| 187 | with any Perl-like extension (.pm, .pl, .pod) stripped. |
| 188 | .ie n .IP """\-verbose => 1""" 4 |
| 189 | .el .IP "\f(CW\-verbose => 1\fR" 4 |
| 190 | .IX Item "-verbose => 1" |
| 191 | Print progress information while scanning. |
| 192 | .ie n .IP """\-perl => 1""" 4 |
| 193 | .el .IP "\f(CW\-perl => 1\fR" 4 |
| 194 | .IX Item "-perl => 1" |
| 195 | Apply Perl-specific heuristics to find the correct PODs. This includes |
| 196 | stripping Perl-like extensions, omitting subdirectories that are numeric |
| 197 | but do \fInot\fR match the current Perl interpreter's version id, suppressing |
| 198 | \&\fIsite_perl\fR as a module hierarchy name etc. |
| 199 | .ie n .IP """\-script => 1""" 4 |
| 200 | .el .IP "\f(CW\-script => 1\fR" 4 |
| 201 | .IX Item "-script => 1" |
| 202 | Search for PODs in the current Perl interpreter's installation |
| 203 | \&\fBscriptdir\fR. This is taken from the local Config module. |
| 204 | .ie n .IP """\-inc => 1""" 4 |
| 205 | .el .IP "\f(CW\-inc => 1\fR" 4 |
| 206 | .IX Item "-inc => 1" |
| 207 | Search for PODs in the current Perl interpreter's \fI@INC\fR paths. This |
| 208 | automatically considers paths specified in the \f(CW\*(C`PERL5LIB\*(C'\fR environment |
| 209 | as this is prepended to \fI@INC\fR by the Perl interpreter itself. |
| 210 | .ie n .Sh """simplify_name( $str )""" |
| 211 | .el .Sh "\f(CWsimplify_name( $str )\fP" |
| 212 | .IX Subsection "simplify_name( $str )" |
| 213 | The function \fBsimplify_name\fR is equivalent to \fBbasename\fR, but also |
| 214 | strips Perl-like extensions (.pm, .pl, .pod) and extensions like |
| 215 | \&\fI.bat\fR, \fI.cmd\fR on Win32 and \s-1OS/2\s0, or \fI.com\fR on \s-1VMS\s0, respectively. |
| 216 | .ie n .Sh """pod_where( { %opts }, $pod )""" |
| 217 | .el .Sh "\f(CWpod_where( { %opts }, $pod )\fP" |
| 218 | .IX Subsection "pod_where( { %opts }, $pod )" |
| 219 | Returns the location of a pod document given a search directory |
| 220 | and a module (e.g. \f(CW\*(C`File::Find\*(C'\fR) or script (e.g. \f(CW\*(C`perldoc\*(C'\fR) name. |
| 221 | .PP |
| 222 | Options: |
| 223 | .ie n .IP """\-inc => 1""" 4 |
| 224 | .el .IP "\f(CW\-inc => 1\fR" 4 |
| 225 | .IX Item "-inc => 1" |
| 226 | Search \f(CW@INC\fR for the pod and also the \f(CW\*(C`scriptdir\*(C'\fR defined in the |
| 227 | Config module. |
| 228 | .ie n .IP """\-dirs => [ $dir1, $dir2, ... ]""" 4 |
| 229 | .el .IP "\f(CW\-dirs => [ $dir1, $dir2, ... ]\fR" 4 |
| 230 | .IX Item "-dirs => [ $dir1, $dir2, ... ]" |
| 231 | Reference to an array of search directories. These are searched in order |
| 232 | before looking in \f(CW@INC\fR (if \fB\-inc\fR). Current directory is used if |
| 233 | none are specified. |
| 234 | .ie n .IP """\-verbose => 1""" 4 |
| 235 | .el .IP "\f(CW\-verbose => 1\fR" 4 |
| 236 | .IX Item "-verbose => 1" |
| 237 | List directories as they are searched |
| 238 | .PP |
| 239 | Returns the full path of the first occurrence to the file. |
| 240 | Package names (eg 'A::B') are automatically converted to directory |
| 241 | names in the selected directory. (eg on unix 'A::B' is converted to |
| 242 | \&'A/B'). Additionally, '.pm', '.pl' and '.pod' are appended to the |
| 243 | search automatically if required. |
| 244 | .PP |
| 245 | A subdirectory \fIpod/\fR is also checked if it exists in any of the given |
| 246 | search directories. This ensures that e.g. perlfunc is |
| 247 | found. |
| 248 | .PP |
| 249 | It is assumed that if a module name is supplied, that that name |
| 250 | matches the file name. Pods are not opened to check for the '\s-1NAME\s0' |
| 251 | entry. |
| 252 | .PP |
| 253 | A check is made to make sure that the file that is found does |
| 254 | contain some pod documentation. |
| 255 | .ie n .Sh """contains_pod( $file , $verbose )""" |
| 256 | .el .Sh "\f(CWcontains_pod( $file , $verbose )\fP" |
| 257 | .IX Subsection "contains_pod( $file , $verbose )" |
| 258 | Returns true if the supplied filename (not \s-1POD\s0 module) contains some pod |
| 259 | information. |
| 260 | .SH "AUTHOR" |
| 261 | .IX Header "AUTHOR" |
| 262 | Please report bugs using <http://rt.cpan.org>. |
| 263 | .PP |
| 264 | Marek Rouchal <marekr@cpan.org>, |
| 265 | heavily borrowing code from Nick Ing\-Simmons' PodToHtml. |
| 266 | .PP |
| 267 | Tim Jenness <t.jenness@jach.hawaii.edu> provided |
| 268 | \&\f(CW\*(C`pod_where\*(C'\fR and \f(CW\*(C`contains_pod\*(C'\fR. |
| 269 | .SH "SEE ALSO" |
| 270 | .IX Header "SEE ALSO" |
| 271 | Pod::Parser, Pod::Checker, perldoc |