--- /dev/null
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. | will give a
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.\"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "Module::ScanDeps 3"
+.TH Module::ScanDeps 3 "2009-11-13" "perl v5.8.7" "User Contributed Perl Documentation"
+.SH "NAME"
+Module::ScanDeps \- Recursively scan Perl code for dependencies
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+Via the command-line program scandeps.pl:
+.PP
+.Vb 4
+\& % scandeps.pl *.pm # Print PREREQ_PM section for *.pm
+\& % scandeps.pl \-e "use utf8" # Read script from command line
+\& % scandeps.pl \-B *.pm # Include core modules
+\& % scandeps.pl \-V *.pm # Show autoload/shared/data files
+.Ve
+.PP
+Used in a program;
+.PP
+.Vb 1
+\& use Module::ScanDeps;
+.Ve
+.PP
+.Vb 5
+\& # standard usage
+\& my $hash_ref = scan_deps(
+\& files => [ 'a.pl', 'b.pl' ],
+\& recurse => 1,
+\& );
+.Ve
+.PP
+.Vb 2
+\& # shorthand; assume recurse == 1
+\& my $hash_ref = scan_deps( 'a.pl', 'b.pl' );
+.Ve
+.PP
+.Vb 7
+\& # App::Packer::Frontend compatible interface
+\& # see App::Packer::Frontend for the structure returned by get_files
+\& my $scan = Module::ScanDeps\->new;
+\& $scan\->set_file( 'a.pl' );
+\& $scan\->set_options( add_modules => [ 'Test::More' ] );
+\& $scan\->calculate_info;
+\& my $files = $scan\->get_files;
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This module scans potential modules used by perl programs, and returns a
+hash reference; its keys are the module names as appears in \f(CW%INC\fR
+(e.g. \f(CW\*(C`Test/More.pm\*(C'\fR); the values are hash references with this structure:
+.PP
+.Vb 7
+\& {
+\& file => '/usr/local/lib/perl5/5.8.0/Test/More.pm',
+\& key => 'Test/More.pm',
+\& type => 'module', # or 'autoload', 'data', 'shared'
+\& used_by => [ 'Test/Simple.pm', ... ],
+\& uses => [ 'Test/Other.pm', ... ],
+\& }
+.Ve
+.PP
+One function, \f(CW\*(C`scan_deps\*(C'\fR, is exported by default. Other
+functions such as (\f(CW\*(C`scan_line\*(C'\fR, \f(CW\*(C`scan_chunk\*(C'\fR, \f(CW\*(C`add_deps\*(C'\fR, \f(CW\*(C`path_to_inc_name\*(C'\fR)
+are exported upon request.
+.PP
+Users of \fBApp::Packer\fR may also use this module as the dependency-checking
+frontend, by tweaking their \fIp2e.pl\fR like below:
+.PP
+.Vb 4
+\& use Module::ScanDeps;
+\& ...
+\& my $packer = App::Packer\->new( frontend => 'Module::ScanDeps' );
+\& ...
+.Ve
+.PP
+Please see App::Packer::Frontend for detailed explanation on
+the structure returned by \f(CW\*(C`get_files\*(C'\fR.
+.Sh "\fBscan_deps\fP"
+.IX Subsection "scan_deps"
+.Vb 6
+\& $rv_ref = scan_deps(
+\& files => \e@files, recurse => $recurse,
+\& rv => \e%rv, skip => \e%skip,
+\& compile => $compile, execute => $execute,
+\& );
+\& $rv_ref = scan_deps(@files); # shorthand, with recurse => 1
+.Ve
+.PP
+This function scans each file in \f(CW@files\fR, registering their
+dependencies into \f(CW%rv\fR, and returns a reference to the updated
+\&\f(CW%rv\fR. The meaning of keys and values are explained above.
+.PP
+If \f(CW$recurse\fR is true, \f(CW\*(C`scan_deps\*(C'\fR will call itself recursively,
+to perform a breadth-first search on text files (as defined by the
+\&\-T operator) found in \f(CW%rv\fR.
+.PP
+If the \f(CW\*(C`\e%skip\*(C'\fR is specified, files that exists as its keys are
+skipped. This is used internally to avoid infinite recursion.
+.PP
+If \f(CW$compile\fR or \f(CW$execute\fR is true, runs \f(CW\*(C`files\*(C'\fR in either
+compile-only or normal mode, then inspects their \f(CW%INC\fR after
+termination to determine additional runtime dependencies.
+.PP
+If \f(CW$execute\fR is an array reference, runs the files contained
+in it instead of \f(CW@files\fR.
+.PP
+If performance of the scanning process is a concern, \f(CW\*(C`cache_file\*(C'\fR can be
+set to a filename. The scanning results will be cached and written to the
+file. This will speed up the scanning process on subsequent runs.
+.PP
+Additionally, an option \f(CW\*(C`warn_missing\*(C'\fR is recognized. If set to true,
+\&\f(CW\*(C`scan_deps\*(C'\fR issues a warning to \s-1STDERR\s0 for every module file that the
+scanned code depends but that wasn't found. Please note that this may
+also report numerous false positives. That is why by default, the heuristic
+silently drops all dependencies it cannot find.
+.Sh "\fBscan_deps_runtime\fP"
+.IX Subsection "scan_deps_runtime"
+Like \fBscan_deps\fR, but skips the static scanning part.
+.Sh "\fBscan_line\fP"
+.IX Subsection "scan_line"
+.Vb 1
+\& @modules = scan_line($line);
+.Ve
+.PP
+Splits a line into chunks (currently with the semicolon characters), and
+return the union of \f(CW\*(C`scan_chunk\*(C'\fR calls of them.
+.PP
+If the line is \f(CW\*(C`_\|_END_\|_\*(C'\fR or \f(CW\*(C`_\|_DATA_\|_\*(C'\fR, a single \f(CW\*(C`_\|_END_\|_\*(C'\fR element is
+returned to signify the end of the program.
+.PP
+Similarly, it returns a single \f(CW\*(C`_\|_POD_\|_\*(C'\fR if the line matches \f(CW\*(C`/^=\ew/\*(C'\fR;
+the caller is responsible for skipping appropriate number of lines
+until \f(CW\*(C`=cut\*(C'\fR, before calling \f(CW\*(C`scan_line\*(C'\fR again.
+.Sh "\fBscan_chunk\fP"
+.IX Subsection "scan_chunk"
+.Vb 2
+\& $module = scan_chunk($chunk);
+\& @modules = scan_chunk($chunk);
+.Ve
+.PP
+Apply various heuristics to \f(CW$chunk\fR to find and return the module
+name(s) it contains. In scalar context, returns only the first module
+or \f(CW\*(C`undef\*(C'\fR.
+.Sh "\fBadd_deps\fP"
+.IX Subsection "add_deps"
+.Vb 2
+\& $rv_ref = add_deps( rv => \e%rv, modules => \e@modules );
+\& $rv_ref = add_deps( @modules ); # shorthand, without rv
+.Ve
+.PP
+Resolves a list of module names to its actual on-disk location, by
+finding in \f(CW@INC\fR and \f(CW@Module::ScanDeps::IncludeLibs\fR;
+modules that cannot be found are skipped.
+.PP
+This function populates the \f(CW%rv\fR hash with module/filename pairs, and
+returns a reference to it.
+.Sh "\fBpath_to_inc_name\fP"
+.IX Subsection "path_to_inc_name"
+.Vb 1
+\& $perl_name = path_to_inc_name($path, $warn)
+.Ve
+.PP
+Assumes \f(CW$path\fR refers to a perl file and does it's best to return the
+name as it would appear in \f(CW%INC\fR. Returns undef if no match was found
+and a prints a warning to \s-1STDERR\s0 if \f(CW$warn\fR is true.
+.PP
+E.g. if \f(CW$path\fR = perl/site/lib/Module/ScanDeps.pm then \f(CW$perl_name\fR
+will be Module/ScanDeps.pm.
+.SH "NOTES"
+.IX Header "NOTES"
+.Sh "\fB@Module::ScanDeps::IncludeLibs\fP"
+.IX Subsection "@Module::ScanDeps::IncludeLibs"
+You can set this global variable to specify additional directories in
+which to search modules without modifying \f(CW@INC\fR itself.
+.Sh "\fB$Module::ScanDeps::ScanFileRE\fP"
+.IX Subsection "$Module::ScanDeps::ScanFileRE"
+You can set this global variable to specify a regular expression to
+identify what files to scan. By default it includes all files of
+the following types: .pm, .pl, .t and .al. Additionally, all files
+without a suffix are considered.
+.PP
+For instance, if you want to scan all files then use the following:
+.PP
+\&\f(CW\*(C`$Module::ScanDeps::ScanFileRE = qr/./\*(C'\fR
+.SH "CAVEATS"
+.IX Header "CAVEATS"
+This module intentially ignores the \fB\s-1BSDPAN\s0\fR hack on FreeBSD \*(-- the
+additional directory is removed from \f(CW@INC\fR altogether.
+.PP
+The static-scanning heuristic is not likely to be 100% accurate, especially
+on modules that dynamically load other modules.
+.PP
+Chunks that span multiple lines are not handled correctly. For example,
+this one works:
+.PP
+.Vb 1
+\& use base 'Foo::Bar';
+.Ve
+.PP
+But this one does not:
+.PP
+.Vb 2
+\& use base
+\& 'Foo::Bar';
+.Ve
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+scandeps.pl is a bundled utility that writes \f(CW\*(C`PREREQ_PM\*(C'\fR section
+for a number of files.
+.PP
+An application of \fBModule::ScanDeps\fR is to generate executables from
+scripts that contains prerequisite modules; this module supports two
+such projects, \s-1PAR\s0 and App::Packer. Please see their respective
+documentations on \s-1CPAN\s0 for further information.
+.SH "AUTHORS"
+.IX Header "AUTHORS"
+Audrey Tang <cpan@audreyt.org>
+.PP
+To a lesser degree: Steffen Mueller <smueller@cpan.org>
+.PP
+Parts of heuristics were deduced from:
+.IP "\(bu" 4
+\&\fBPerlApp\fR by ActiveState Tools Corp <http://www.activestate.com/>
+.IP "\(bu" 4
+\&\fBPerl2Exe\fR by IndigoStar, Inc <http://www.indigostar.com/>
+.PP
+The \fBscan_deps_runtime\fR function is contributed by Edward S. Peschko.
+.PP
+<http://par.perl.org/> is the official website for this module. You
+can write to the mailing list at <par@perl.org>, or send an empty
+mail to <par\-subscribe@perl.org> to participate in the discussion.
+.PP
+Please submit bug reports to <bug\-Module\-ScanDeps@rt.cpan.org>.
+.SH "COPYRIGHT"
+.IX Header "COPYRIGHT"
+Copyright 2002\-2008 by
+Audrey Tang <cpan@audreyt.org>;
+2005\-2009 by Steffen Mueller <smueller@cpan.org>.
+.PP
+This program is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+.PP
+See <http://www.perl.com/perl/misc/Artistic.html>
projects / catagits/Gitalist.git / blobdiff