Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
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 "ExtUtils::Manifest 3" | |
132 | .TH ExtUtils::Manifest 3 "2003-08-18" "perl v5.8.0" "User Contributed Perl Documentation" | |
133 | .SH "NAME" | |
134 | ExtUtils::Manifest \- utilities to write and check a MANIFEST file | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 1 | |
138 | \& use ExtUtils::Manifest qw(...funcs to import...); | |
139 | .Ve | |
140 | .PP | |
141 | .Vb 1 | |
142 | \& mkmanifest(); | |
143 | .Ve | |
144 | .PP | |
145 | .Vb 4 | |
146 | \& my @missing_files = manicheck; | |
147 | \& my @skipped = skipcheck; | |
148 | \& my @extra_files = filecheck; | |
149 | \& my($missing, $extra) = fullcheck; | |
150 | .Ve | |
151 | .PP | |
152 | .Vb 1 | |
153 | \& my $found = manifind(); | |
154 | .Ve | |
155 | .PP | |
156 | .Vb 1 | |
157 | \& my $manifest = maniread(); | |
158 | .Ve | |
159 | .PP | |
160 | .Vb 1 | |
161 | \& manicopy($read,$target); | |
162 | .Ve | |
163 | .PP | |
164 | .Vb 1 | |
165 | \& maniadd({$file => $comment, ...}); | |
166 | .Ve | |
167 | .SH "DESCRIPTION" | |
168 | .IX Header "DESCRIPTION" | |
169 | .Sh "Functions" | |
170 | .IX Subsection "Functions" | |
171 | ExtUtils::Manifest exports no functions by default. The following are | |
172 | exported on request | |
173 | .IP "mkmanifest" 4 | |
174 | .IX Item "mkmanifest" | |
175 | .Vb 1 | |
176 | \& mkmanifest(); | |
177 | .Ve | |
178 | .Sp | |
179 | Writes all files in and below the current directory to your \fI\s-1MANIFEST\s0\fR. | |
180 | It works similar to | |
181 | .Sp | |
182 | .Vb 1 | |
183 | \& find . > MANIFEST | |
184 | .Ve | |
185 | .Sp | |
186 | All files that match any regular expression in a file \fI\s-1MANIFEST\s0.SKIP\fR | |
187 | (if it exists) are ignored. | |
188 | .Sp | |
189 | Any existing \fI\s-1MANIFEST\s0\fR file will be saved as \fI\s-1MANIFEST\s0.bak\fR. Lines | |
190 | from the old \fI\s-1MANIFEST\s0\fR file is preserved, including any comments | |
191 | that are found in the existing \fI\s-1MANIFEST\s0\fR file in the new one. | |
192 | .IP "manifind" 4 | |
193 | .IX Item "manifind" | |
194 | .Vb 1 | |
195 | \& my $found = manifind(); | |
196 | .Ve | |
197 | .Sp | |
198 | returns a hash reference. The keys of the hash are the files found | |
199 | below the current directory. | |
200 | .IP "manicheck" 4 | |
201 | .IX Item "manicheck" | |
202 | .Vb 1 | |
203 | \& my @missing_files = manicheck(); | |
204 | .Ve | |
205 | .Sp | |
206 | checks if all the files within a \f(CW\*(C`MANIFEST\*(C'\fR in the current directory | |
207 | really do exist. If \f(CW\*(C`MANIFEST\*(C'\fR and the tree below the current | |
208 | directory are in sync it silently returns an empty list. | |
209 | Otherwise it returns a list of files which are listed in the | |
210 | \&\f(CW\*(C`MANIFEST\*(C'\fR but missing from the directory, and by default also | |
211 | outputs these names to \s-1STDERR\s0. | |
212 | .IP "filecheck" 4 | |
213 | .IX Item "filecheck" | |
214 | .Vb 1 | |
215 | \& my @extra_files = filecheck(); | |
216 | .Ve | |
217 | .Sp | |
218 | finds files below the current directory that are not mentioned in the | |
219 | \&\f(CW\*(C`MANIFEST\*(C'\fR file. An optional file \f(CW\*(C`MANIFEST.SKIP\*(C'\fR will be | |
220 | consulted. Any file matching a regular expression in such a file will | |
221 | not be reported as missing in the \f(CW\*(C`MANIFEST\*(C'\fR file. The list of any | |
222 | extraneous files found is returned, and by default also reported to | |
223 | \&\s-1STDERR\s0. | |
224 | .IP "fullcheck" 4 | |
225 | .IX Item "fullcheck" | |
226 | .Vb 1 | |
227 | \& my($missing, $extra) = fullcheck(); | |
228 | .Ve | |
229 | .Sp | |
230 | does both a \fImanicheck()\fR and a \fIfilecheck()\fR, returning then as two array | |
231 | refs. | |
232 | .IP "skipcheck" 4 | |
233 | .IX Item "skipcheck" | |
234 | .Vb 1 | |
235 | \& my @skipped = skipcheck(); | |
236 | .Ve | |
237 | .Sp | |
238 | lists all the files that are skipped due to your \f(CW\*(C`MANIFEST.SKIP\*(C'\fR | |
239 | file. | |
240 | .IP "maniread" 4 | |
241 | .IX Item "maniread" | |
242 | .Vb 2 | |
243 | \& my $manifest = maniread(); | |
244 | \& my $manifest = maniread($manifest_file); | |
245 | .Ve | |
246 | .Sp | |
247 | reads a named \f(CW\*(C`MANIFEST\*(C'\fR file (defaults to \f(CW\*(C`MANIFEST\*(C'\fR in the current | |
248 | directory) and returns a \s-1HASH\s0 reference with files being the keys and | |
249 | comments being the values of the \s-1HASH\s0. Blank lines and lines which | |
250 | start with \f(CW\*(C`#\*(C'\fR in the \f(CW\*(C`MANIFEST\*(C'\fR file are discarded. | |
251 | .IP "manicopy" 4 | |
252 | .IX Item "manicopy" | |
253 | .Vb 2 | |
254 | \& manicopy(\e%src, $dest_dir); | |
255 | \& manicopy(\e%src, $dest_dir, $how); | |
256 | .Ve | |
257 | .Sp | |
258 | Copies the files that are the keys in \f(CW%src\fR to the \f(CW$dest_dir\fR. \f(CW%src\fR is | |
259 | typically returned by the \fImaniread()\fR function. | |
260 | .Sp | |
261 | .Vb 1 | |
262 | \& manicopy( maniread(), $dest_dir ); | |
263 | .Ve | |
264 | .Sp | |
265 | This function is useful for producing a directory tree identical to the | |
266 | intended distribution tree. | |
267 | .Sp | |
268 | $how can be used to specify a different methods of \*(L"copying\*(R". Valid | |
269 | values are \f(CW\*(C`cp\*(C'\fR, which actually copies the files, \f(CW\*(C`ln\*(C'\fR which creates | |
270 | hard links, and \f(CW\*(C`best\*(C'\fR which mostly links the files but copies any | |
271 | symbolic link to make a tree without any symbolic link. \f(CW\*(C`cp\*(C'\fR is the | |
272 | default. | |
273 | .IP "maniadd" 4 | |
274 | .IX Item "maniadd" | |
275 | .Vb 1 | |
276 | \& maniadd({ $file => $comment, ...}); | |
277 | .Ve | |
278 | .Sp | |
279 | Adds an entry to an existing \fI\s-1MANIFEST\s0\fR unless its already there. | |
280 | .Sp | |
281 | $file will be normalized (ie. Unixified). \fB\s-1UNIMPLEMENTED\s0\fR | |
282 | .Sh "\s-1MANIFEST\s0" | |
283 | .IX Subsection "MANIFEST" | |
284 | Anything between white space and an end of line within a \f(CW\*(C`MANIFEST\*(C'\fR | |
285 | file is considered to be a comment. Filenames and comments are | |
286 | separated by one or more \s-1TAB\s0 characters in the output. | |
287 | .Sh "\s-1MANIFEST\s0.SKIP" | |
288 | .IX Subsection "MANIFEST.SKIP" | |
289 | The file \s-1MANIFEST\s0.SKIP may contain regular expressions of files that | |
290 | should be ignored by \fImkmanifest()\fR and \fIfilecheck()\fR. The regular | |
291 | expressions should appear one on each line. Blank lines and lines | |
292 | which start with \f(CW\*(C`#\*(C'\fR are skipped. Use \f(CW\*(C`\e#\*(C'\fR if you need a regular | |
293 | expression to start with a sharp character. A typical example: | |
294 | .PP | |
295 | .Vb 5 | |
296 | \& # Version control files and dirs. | |
297 | \& \ebRCS\eb | |
298 | \& \ebCVS\eb | |
299 | \& ,v$ | |
300 | \& \eB\e.svn\eb | |
301 | .Ve | |
302 | .PP | |
303 | .Vb 5 | |
304 | \& # Makemaker generated files and dirs. | |
305 | \& ^MANIFEST\e. | |
306 | \& ^Makefile$ | |
307 | \& ^blib/ | |
308 | \& ^MakeMaker-\ed | |
309 | .Ve | |
310 | .PP | |
311 | .Vb 5 | |
312 | \& # Temp, old and emacs backup files. | |
313 | \& ~$ | |
314 | \& \e.old$ | |
315 | \& ^#.*#$ | |
316 | \& ^\e.# | |
317 | .Ve | |
318 | .PP | |
319 | If no \s-1MANIFEST\s0.SKIP file is found, a default set of skips will be | |
320 | used, similar to the example above. If you want nothing skipped, | |
321 | simply make an empty \s-1MANIFEST\s0.SKIP file. | |
322 | .Sh "\s-1EXPORT_OK\s0" | |
323 | .IX Subsection "EXPORT_OK" | |
324 | \&\f(CW&mkmanifest\fR, \f(CW&manicheck\fR, \f(CW&filecheck\fR, \f(CW&fullcheck\fR, | |
325 | \&\f(CW&maniread\fR, and \f(CW&manicopy\fR are exportable. | |
326 | .Sh "\s-1GLOBAL\s0 \s-1VARIABLES\s0" | |
327 | .IX Subsection "GLOBAL VARIABLES" | |
328 | \&\f(CW$ExtUtils::Manifest::MANIFEST\fR defaults to \f(CW\*(C`MANIFEST\*(C'\fR. Changing it | |
329 | results in both a different \f(CW\*(C`MANIFEST\*(C'\fR and a different | |
330 | \&\f(CW\*(C`MANIFEST.SKIP\*(C'\fR file. This is useful if you want to maintain | |
331 | different distributions for different audiences (say a user version | |
332 | and a developer version including \s-1RCS\s0). | |
333 | .PP | |
334 | \&\f(CW$ExtUtils::Manifest::Quiet\fR defaults to 0. If set to a true value, | |
335 | all functions act silently. | |
336 | .PP | |
337 | \&\f(CW$ExtUtils::Manifest::Debug\fR defaults to 0. If set to a true value, | |
338 | or if \s-1PERL_MM_MANIFEST_DEBUG\s0 is true, debugging output will be | |
339 | produced. | |
340 | .SH "DIAGNOSTICS" | |
341 | .IX Header "DIAGNOSTICS" | |
342 | All diagnostic output is sent to \f(CW\*(C`STDERR\*(C'\fR. | |
343 | .ie n .IP """Not in MANIFEST:""\fR \fIfile" 4 | |
344 | .el .IP "\f(CWNot in MANIFEST:\fR \fIfile\fR" 4 | |
345 | .IX Item "Not in MANIFEST: file" | |
346 | is reported if a file is found which is not in \f(CW\*(C`MANIFEST\*(C'\fR. | |
347 | .ie n .IP """Skipping""\fR \fIfile" 4 | |
348 | .el .IP "\f(CWSkipping\fR \fIfile\fR" 4 | |
349 | .IX Item "Skipping file" | |
350 | is reported if a file is skipped due to an entry in \f(CW\*(C`MANIFEST.SKIP\*(C'\fR. | |
351 | .ie n .IP """No such file:""\fR \fIfile" 4 | |
352 | .el .IP "\f(CWNo such file:\fR \fIfile\fR" 4 | |
353 | .IX Item "No such file: file" | |
354 | is reported if a file mentioned in a \f(CW\*(C`MANIFEST\*(C'\fR file does not | |
355 | exist. | |
356 | .ie n .IP """MANIFEST:""\fR \fI$!" 4 | |
357 | .el .IP "\f(CWMANIFEST:\fR \fI$!\fR" 4 | |
358 | .IX Item "MANIFEST: $!" | |
359 | is reported if \f(CW\*(C`MANIFEST\*(C'\fR could not be opened. | |
360 | .ie n .IP """Added to MANIFEST:""\fR \fIfile" 4 | |
361 | .el .IP "\f(CWAdded to MANIFEST:\fR \fIfile\fR" 4 | |
362 | .IX Item "Added to MANIFEST: file" | |
363 | is reported by \fImkmanifest()\fR if \f(CW$Verbose\fR is set and a file is added | |
364 | to \s-1MANIFEST\s0. \f(CW$Verbose\fR is set to 1 by default. | |
365 | .SH "ENVIRONMENT" | |
366 | .IX Header "ENVIRONMENT" | |
367 | .IP "\fB\s-1PERL_MM_MANIFEST_DEBUG\s0\fR" 4 | |
368 | .IX Item "PERL_MM_MANIFEST_DEBUG" | |
369 | Turns on debugging | |
370 | .SH "SEE ALSO" | |
371 | .IX Header "SEE ALSO" | |
372 | ExtUtils::MakeMaker which has handy targets for most of the functionality. | |
373 | .SH "AUTHOR" | |
374 | .IX Header "AUTHOR" | |
375 | Andreas Koenig \f(CW\*(C`andreas.koenig@anima.de\*(C'\fR | |
376 | .PP | |
377 | Currently maintained by Michael G Schwern \f(CW\*(C`schwern@pobox.com\*(C'\fR |