Add built local::lib
[catagits/Gitalist.git] / local-lib5 / man / man1 / scandeps.pl.1p
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
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 "SCANDEPS 1"
132 .TH SCANDEPS 1 "2009-07-19" "perl v5.8.7" "User Contributed Perl Documentation"
133 .SH "NAME"
134 scandeps.pl \- Scan file prerequisites
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 .Vb 6
138 \&    % scandeps.pl *.pm          # Print PREREQ_PM section for *.pm
139 \&    % scandeps.pl \-e 'STRING'   # Scan an one\-liner
140 \&    % scandeps.pl \-B *.pm       # Include core modules
141 \&    % scandeps.pl \-V *.pm       # Show autoload/shared/data files
142 \&    % scandeps.pl \-R *.pm       # Don't recurse
143 \&    % scandeps.pl \-C CACHEFILE  # use CACHEFILE to cache dependencies
144 .Ve
145 .SH "DESCRIPTION"
146 .IX Header "DESCRIPTION"
147 \&\fIscandeps.pl\fR is a simple-minded utility that prints out the
148 \&\f(CW\*(C`PREREQ_PM\*(C'\fR section needed by modules.
149 .PP
150 If you have \fB\s-1CPANPLUS\s0\fR installed, modules that are part of an
151 earlier module's distribution with be denoted with \f(CW\*(C`S\*(C'\fR; modules
152 without a distribution name on \s-1CPAN\s0 are marked with \f(CW\*(C`?\*(C'\fR.
153 .PP
154 Also, if the \f(CW\*(C`\-B\*(C'\fR option is specified, module belongs to a perl
155 distribution on \s-1CPAN\s0 (and thus uninstallable by \f(CW\*(C`CPAN.pm\*(C'\fR or
156 \&\f(CW\*(C`CPANPLUS.pm\*(C'\fR) are marked with \f(CW\*(C`C\*(C'\fR.
157 .PP
158 Finally, modules that has loadable shared object files (usually
159 needing a compiler to install) are marked with \f(CW\*(C`X\*(C'\fR; with the
160 \&\f(CW\*(C`\-V\*(C'\fR flag, those files (and all other files found) will be listed
161 before the main output. Additionally, all module files that the
162 scanned code depends on but were not found (and thus not scanned
163 recursively) are listed. These may include genuinely missing
164 modules or false positives. That means, modules your code does
165 not depend on (on this particular platform) but that were picked
166 up by the heuristic anyway.
167 .SH "OPTIONS"
168 .IX Header "OPTIONS"
169 .IP "\-e \s-1STRING\s0" 4
170 .IX Item "-e STRING"
171 Scan \fI\s-1STRING\s0\fR as a string containing perl code.
172 .IP "\-c" 4
173 .IX Item "-c"
174 Compiles the code and inspects its \f(CW%INC\fR, in addition to static scanning.
175 .IP "\-x" 4
176 .IX Item "-x"
177 Executes the code and inspects its \f(CW%INC\fR, in addition to static scanning.
178 .IP "\-B" 4
179 .IX Item "-B"
180 Include core modules in the output and the recursive search list.
181 .IP "\-R" 4
182 .IX Item "-R"
183 Only show dependencies found in the files listed and do not recurse.
184 .IP "\-V" 4
185 .IX Item "-V"
186 Verbose mode: Output all files found during the process; 
187 show dependencies between modules and availability.
188 .Sp
189 Additionally, warns of any missing dependencies. If you find missing
190 dependencies that aren't really dependencies, you have probably found
191 false positives.
192 .IP "\-C \s-1CACHEFILE\s0" 4
193 .IX Item "-C CACHEFILE"
194 Use \s-1CACHEFILE\s0 to speed up the scanning process by caching dependencies.
195 Creates \s-1CACHEFILE\s0 if it does not exist yet.
196 .SH "SEE ALSO"
197 .IX Header "SEE ALSO"
198 Module::ScanDeps, CPANPLUS::Backend, \s-1PAR\s0
199 .SH "ACKNOWLEDGMENTS"
200 .IX Header "ACKNOWLEDGMENTS"
201 Simon Cozens, for suggesting this script to be written.
202 .SH "AUTHORS"
203 .IX Header "AUTHORS"
204 Audrey Tang <autrijus@autrijus.org>
205 .SH "COPYRIGHT"
206 .IX Header "COPYRIGHT"
207 Copyright 2003, 2004, 2005, 2006 by Audrey Tang <autrijus@autrijus.org>.
208 .PP
209 This program is free software; you can redistribute it and/or modify it
210 under the same terms as Perl itself.
211 .PP
212 See <http://www.perl.com/perl/misc/Artistic.html>