1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
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<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
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.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
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
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
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'
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 \
129 .\" ========================================================================
131 .IX Title "Module::Build::ModuleInfo 3"
132 .TH Module::Build::ModuleInfo 3 "2009-12-09" "perl v5.8.7" "User Contributed Perl Documentation"
134 ModuleInfo \- Gather package and POD information from a perl module file
136 .IX Header "DESCRIPTION"
137 .IP "new_from_file($filename, collect_pod => 1)" 4
138 .IX Item "new_from_file($filename, collect_pod => 1)"
139 Construct a \f(CW\*(C`ModuleInfo\*(C'\fR object given the path to a file. Takes an optional
140 argument \f(CW\*(C`collect_pod\*(C'\fR which is a boolean that determines whether
141 \&\s-1POD\s0 data is collected and stored for reference. \s-1POD\s0 data is not
142 collected by default. \s-1POD\s0 headings are always collected.
143 .IP "new_from_module($module, collect_pod => 1, inc => \e@dirs)" 4
144 .IX Item "new_from_module($module, collect_pod => 1, inc => @dirs)"
145 Construct a \f(CW\*(C`ModuleInfo\*(C'\fR object given a module or package name. In addition
146 to accepting the \f(CW\*(C`collect_pod\*(C'\fR argument as described above, this
147 method accepts a \f(CW\*(C`inc\*(C'\fR argument which is a reference to an array of
148 of directories to search for the module. If none are given, the
149 default is \f(CW@INC\fR.
152 Returns the name of the package represented by this module. If there
153 are more than one packages, it makes a best guess based on the
154 filename. If it's a script (i.e. not a *.pm) the package name is
156 .IP "version($package)" 4
157 .IX Item "version($package)"
158 Returns the version as defined by the \f(CW$VERSION\fR variable for the
159 package as returned by the \f(CW\*(C`name\*(C'\fR method if no arguments are
160 given. If given the name of a package it will attempt to return the
161 version of that package if it is specified in the file.
162 .IP "\fIfilename()\fR" 4
163 .IX Item "filename()"
164 Returns the absolute path to the file.
165 .IP "\fIpackages_inside()\fR" 4
166 .IX Item "packages_inside()"
167 Returns a list of packages.
168 .IP "\fIpod_inside()\fR" 4
169 .IX Item "pod_inside()"
170 Returns a list of \s-1POD\s0 sections.
171 .IP "\fIcontains_pod()\fR" 4
172 .IX Item "contains_pod()"
173 Returns true if there is any \s-1POD\s0 in the file.
174 .IP "pod($section)" 4
175 .IX Item "pod($section)"
176 Returns the \s-1POD\s0 data in the given section.
177 .IP "find_module_by_name($module, \e@dirs)" 4
178 .IX Item "find_module_by_name($module, @dirs)"
179 Returns the path to a module given the module or package name. A list
180 of directories can be passed in as an optional parameter, otherwise
181 \&\f(CW@INC\fR is searched.
183 Can be called as either an object or a class method.
184 .IP "find_module_dir_by_name($module, \e@dirs)" 4
185 .IX Item "find_module_dir_by_name($module, @dirs)"
186 Returns the entry in \f(CW@dirs\fR (or \f(CW@INC\fR by default) that contains
187 the module \f(CW$module\fR. A list of directories can be passed in as an
188 optional parameter, otherwise \f(CW@INC\fR is searched.
190 Can be called as either an object or a class method.
193 Ken Williams <kwilliams@cpan.org>, Randy W. Sims <RandyS@ThePierianSpring.org>
195 .IX Header "COPYRIGHT"
196 Copyright (c) 2001\-2006 Ken Williams. All rights reserved.
198 This library is free software; you can redistribute it and/or
199 modify it under the same terms as Perl itself.
201 .IX Header "SEE ALSO"
202 \&\fIperl\fR\|(1), Module::Build(3)