Commit | Line | Data |
e05e23b1 |
1 | package ExtUtils::MakeMaker; |
2 | |
57b1a898 |
3 | BEGIN {require 5.005_03;} |
4 | |
af7522e5 |
5 | $VERSION = '6.21'; |
6 | ($Revision) = q$Revision: 1.144 $ =~ /Revision:\s+(\S+)/; |
005c1a0e |
7 | |
8e07c86e |
8 | require Exporter; |
3b03c0f3 |
9 | use Config; |
10 | use Carp (); |
dedf98bc |
11 | use File::Path; |
e05e23b1 |
12 | |
13 | use vars qw( |
f6d6199c |
14 | @ISA @EXPORT @EXPORT_OK |
dedf98bc |
15 | $Revision $VERSION $Verbose %Config |
16 | @Prepend_parent @Parent |
5e9e174b |
17 | %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable |
dedf98bc |
18 | $Filename |
f6d6199c |
19 | ); |
5e9e174b |
20 | use strict; |
005c1a0e |
21 | |
e05e23b1 |
22 | @ISA = qw(Exporter); |
23 | @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt); |
f6d6199c |
24 | @EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists); |
42793c05 |
25 | |
f6d6199c |
26 | # These will go away once the last of the Win32 & VMS specific code is |
27 | # purged. |
5e9e174b |
28 | my $Is_VMS = $^O eq 'VMS'; |
5e9e174b |
29 | my $Is_Win32 = $^O eq 'MSWin32'; |
3b03c0f3 |
30 | |
dedf98bc |
31 | # Our filename for diagnostic and debugging purposes. More reliable |
32 | # than %INC (think caseless filesystems) |
33 | $Filename = __FILE__; |
34 | |
9ab29e2b |
35 | full_setup(); |
864a5fa8 |
36 | |
f6d6199c |
37 | require ExtUtils::MM; # Things like CPAN assume loading ExtUtils::MakeMaker |
38 | # will give them MM. |
e05e23b1 |
39 | |
45bc4d3a |
40 | require ExtUtils::MY; # XXX pre-5.8 versions of ExtUtils::Embed expect |
41 | # loading ExtUtils::MakeMaker will give them MY. |
42 | # This will go when Embed is it's own CPAN module. |
43 | |
f1387719 |
44 | |
3b03c0f3 |
45 | sub WriteMakefile { |
46 | Carp::croak "WriteMakefile: Need even number of args" if @_ % 2; |
f1387719 |
47 | |
f6d6199c |
48 | require ExtUtils::MY; |
3b03c0f3 |
49 | my %att = @_; |
69ff8adf |
50 | |
51 | _verify_att(\%att); |
52 | |
e0678a30 |
53 | my $mm = MM->new(\%att); |
54 | $mm->flush; |
55 | |
56 | return $mm; |
3b03c0f3 |
57 | } |
58 | |
69ff8adf |
59 | |
d5d4ec93 |
60 | # Basic signatures of the attributes WriteMakefile takes. Each is the |
61 | # reference type. Empty value indicate it takes a non-reference |
62 | # scalar. |
479d2113 |
63 | my %Att_Sigs; |
64 | my %Special_Sigs = ( |
d5d4ec93 |
65 | C => 'array', |
d5d4ec93 |
66 | CONFIG => 'array', |
67 | CONFIGURE => 'code', |
d5d4ec93 |
68 | DIR => 'array', |
d5d4ec93 |
69 | DL_FUNCS => 'hash', |
70 | DL_VARS => 'array', |
71 | EXCLUDE_EXT => 'array', |
72 | EXE_FILES => 'array', |
d5d4ec93 |
73 | FUNCLIST => 'array', |
74 | H => 'array', |
75 | IMPORTS => 'hash', |
d5d4ec93 |
76 | INCLUDE_EXT => 'array', |
d5d4ec93 |
77 | LIBS => ['array',''], |
d5d4ec93 |
78 | MAN1PODS => 'hash', |
79 | MAN3PODS => 'hash', |
d5d4ec93 |
80 | PL_FILES => 'hash', |
81 | PM => 'hash', |
82 | PMLIBDIRS => 'array', |
d5d4ec93 |
83 | PREREQ_PM => 'hash', |
d5d4ec93 |
84 | SKIP => 'array', |
85 | TYPEMAPS => 'array', |
d5d4ec93 |
86 | XS => 'hash', |
479d2113 |
87 | _KEEP_AFTER_FLUSH => '', |
69ff8adf |
88 | |
89 | clean => 'hash', |
90 | depend => 'hash', |
91 | dist => 'hash', |
92 | dynamic_lib=> 'hash', |
93 | linkext => 'hash', |
94 | macro => 'hash', |
531e2ba1 |
95 | postamble => 'hash', |
69ff8adf |
96 | realclean => 'hash', |
97 | test => 'hash', |
98 | tool_autosplit => 'hash', |
99 | ); |
100 | |
479d2113 |
101 | @Att_Sigs{keys %Recognized_Att_Keys} = ('') x keys %Recognized_Att_Keys; |
102 | @Att_Sigs{keys %Special_Sigs} = values %Special_Sigs; |
103 | |
69ff8adf |
104 | |
105 | sub _verify_att { |
106 | my($att) = @_; |
107 | |
108 | while( my($key, $val) = each %$att ) { |
109 | my $sig = $Att_Sigs{$key}; |
d5d4ec93 |
110 | unless( defined $sig ) { |
111 | warn "WARNING: $key is not a known parameter.\n"; |
112 | next; |
113 | } |
114 | |
115 | my @sigs = ref $sig ? @$sig : $sig; |
116 | my $given = lc ref $val; |
69ff8adf |
117 | unless( grep $given eq $_, @sigs ) { |
d5d4ec93 |
118 | my $takes = join " or ", map { $_ ne '' ? "$_ reference" |
119 | : "string/number" |
69ff8adf |
120 | } @sigs; |
d5d4ec93 |
121 | my $has = $given ne '' ? "$given reference" |
122 | : "string/number"; |
69ff8adf |
123 | warn "WARNING: $key takes a $takes not a $has.\n". |
124 | " Please inform the author.\n"; |
69ff8adf |
125 | } |
126 | } |
127 | } |
128 | |
f1387719 |
129 | sub prompt ($;$) { |
479d2113 |
130 | my($mess, $def) = @_; |
e0678a30 |
131 | Carp::confess("prompt function called without an argument") |
132 | unless defined $mess; |
479d2113 |
133 | |
134 | my $isa_tty = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; |
135 | |
f1387719 |
136 | my $dispdef = defined $def ? "[$def] " : " "; |
137 | $def = defined $def ? $def : ""; |
479d2113 |
138 | |
13bc20ff |
139 | local $|=1; |
f6d6199c |
140 | local $\; |
13bc20ff |
141 | print "$mess $dispdef"; |
479d2113 |
142 | |
143 | my $ans; |
144 | if ($ENV{PERL_MM_USE_DEFAULT} || (!$isa_tty && eof STDIN)) { |
145 | print "$def\n"; |
146 | } |
147 | else { |
f6d6199c |
148 | $ans = <STDIN>; |
149 | if( defined $ans ) { |
150 | chomp $ans; |
151 | } |
152 | else { # user hit ctrl-D |
153 | print "\n"; |
154 | } |
155 | } |
479d2113 |
156 | |
f6d6199c |
157 | return (!defined $ans || $ans eq '') ? $def : $ans; |
3b03c0f3 |
158 | } |
159 | |
e05e23b1 |
160 | sub eval_in_subdirs { |
161 | my($self) = @_; |
a8112c7f |
162 | use Cwd qw(cwd abs_path); |
f582e489 |
163 | my $pwd = cwd() || die "Can't figure out your cwd!"; |
164 | |
3593a55e |
165 | local @INC = map eval {abs_path($_) if -e} || $_, @INC; |
f6d6199c |
166 | push @INC, '.'; # '.' has to always be at the end of @INC |
e05e23b1 |
167 | |
5e9e174b |
168 | foreach my $dir (@{$self->{DIR}}){ |
f6d6199c |
169 | my($abs) = $self->catdir($pwd,$dir); |
a7d1454b |
170 | eval { $self->eval_in_x($abs); }; |
171 | last if $@; |
e05e23b1 |
172 | } |
e05e23b1 |
173 | chdir $pwd; |
a7d1454b |
174 | die $@ if $@; |
864a5fa8 |
175 | } |
42793c05 |
176 | |
e05e23b1 |
177 | sub eval_in_x { |
178 | my($self,$dir) = @_; |
6626a13a |
179 | chdir $dir or Carp::carp("Couldn't change to directory $dir: $!"); |
5e9e174b |
180 | |
f6d6199c |
181 | { |
182 | package main; |
183 | do './Makefile.PL'; |
184 | }; |
f1387719 |
185 | if ($@) { |
f6d6199c |
186 | # if ($@ =~ /prerequisites/) { |
187 | # die "MakeMaker WARNING: $@"; |
188 | # } else { |
189 | # warn "WARNING from evaluation of $dir/Makefile.PL: $@"; |
190 | # } |
45bc4d3a |
191 | die "ERROR from evaluation of $dir/Makefile.PL: $@"; |
f1387719 |
192 | } |
e05e23b1 |
193 | } |
194 | |
479d2113 |
195 | |
196 | # package name for the classes into which the first object will be blessed |
197 | my $PACKNAME = 'PACK000'; |
198 | |
e05e23b1 |
199 | sub full_setup { |
200 | $Verbose ||= 0; |
3b03c0f3 |
201 | |
5e9e174b |
202 | my @attrib_help = qw/ |
3b03c0f3 |
203 | |
762efda7 |
204 | AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION |
205 | C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS |
479d2113 |
206 | EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE |
75e2e551 |
207 | FULLPERL FULLPERLRUN FULLPERLRUNINST |
208 | FUNCLIST H IMPORTS |
431b0fc4 |
209 | |
45bc4d3a |
210 | INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR |
5c161494 |
211 | INSTALLDIRS |
479d2113 |
212 | DESTDIR PREFIX |
213 | PERLPREFIX SITEPREFIX VENDORPREFIX |
5c161494 |
214 | INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB |
215 | INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH |
45bc4d3a |
216 | INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN |
217 | INSTALLMAN1DIR INSTALLMAN3DIR |
218 | INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR |
219 | INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR |
220 | INSTALLSCRIPT |
5c161494 |
221 | PERL_LIB PERL_ARCHLIB |
222 | SITELIBEXP SITEARCHEXP |
431b0fc4 |
223 | |
5c161494 |
224 | INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS |
2530b651 |
225 | LINKTYPE MAKEAPERL MAKEFILE MAKEFILE_OLD MAN1PODS MAN3PODS MAP_TARGET |
226 | MYEXTLIB NAME NEEDS_LINKING NOECHO NO_META NORECURS NO_VC OBJECT OPTIMIZE |
431b0fc4 |
227 | PERL_MALLOC_OK PERL PERLMAINCC PERLRUN PERLRUNINST PERL_CORE |
5c161494 |
228 | PERL_SRC PERM_RW PERM_RWX |
131aa089 |
229 | PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC |
5c161494 |
230 | PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ |
bb68fe9e |
231 | SIGN SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG |
f1387719 |
232 | XS_VERSION clean depend dist dynamic_lib linkext macro realclean |
762efda7 |
233 | tool_autosplit |
431b0fc4 |
234 | |
084592ab |
235 | MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC |
236 | MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED |
f6d6199c |
237 | /; |
3b03c0f3 |
238 | |
875fa795 |
239 | # IMPORTS is used under OS/2 and Win32 |
f1387719 |
240 | |
241 | # @Overridable is close to @MM_Sections but not identical. The |
242 | # order is important. Many subroutines declare macros. These |
243 | # depend on each other. Let's try to collect the macros up front, |
244 | # then pasthru, then the rules. |
245 | |
246 | # MM_Sections are the sections we have to call explicitly |
247 | # in Overridable we have subroutines that are used indirectly |
3b03c0f3 |
248 | |
e05e23b1 |
249 | |
250 | @MM_Sections = |
f6d6199c |
251 | qw( |
3b03c0f3 |
252 | |
479d2113 |
253 | post_initialize const_config constants platform_constants |
254 | tool_autosplit tool_xsubpp tools_other |
255 | |
256 | makemakerdflt |
257 | |
258 | dist macro depend cflags const_loadlibs const_cccmd |
f1387719 |
259 | post_constants |
260 | |
261 | pasthru |
262 | |
479d2113 |
263 | special_targets |
264 | c_o xs_c xs_o |
af7522e5 |
265 | top_targets blibdirs linkext dlsyms dynamic dynamic_bs |
f6d6199c |
266 | dynamic_lib static static_lib manifypods processPL |
cae6c631 |
267 | installbin subdirs |
479d2113 |
268 | clean_subdirs clean realclean_subdirs realclean |
269 | metafile metafile_addtomanifest |
bb68fe9e |
270 | signature signature_addtomanifest |
479d2113 |
271 | dist_basics dist_core distdir dist_test dist_ci |
8f993c78 |
272 | install force perldepend makefile staticmake test ppd |
3b03c0f3 |
273 | |
f6d6199c |
274 | ); # loses section ordering |
e05e23b1 |
275 | |
3b03c0f3 |
276 | @Overridable = @MM_Sections; |
f1387719 |
277 | push @Overridable, qw[ |
278 | |
af7522e5 |
279 | libscan makeaperl needs_linking perm_rw perm_rwx |
75e2e551 |
280 | subdir_x test_via_harness test_via_script init_PERL |
f6d6199c |
281 | ]; |
3b03c0f3 |
282 | |
f1387719 |
283 | push @MM_Sections, qw[ |
3b03c0f3 |
284 | |
f1387719 |
285 | pm_to_blib selfdocument |
286 | |
f6d6199c |
287 | ]; |
f1387719 |
288 | |
289 | # Postamble needs to be the last that was always the case |
290 | push @MM_Sections, "postamble"; |
291 | push @Overridable, "postamble"; |
e05e23b1 |
292 | |
293 | # All sections are valid keys. |
3b03c0f3 |
294 | @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections; |
e05e23b1 |
295 | |
296 | # we will use all these variables in the Makefile |
297 | @Get_from_Config = |
f6d6199c |
298 | qw( |
299 | ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc |
300 | lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so |
301 | exe_ext full_ar |
302 | ); |
e05e23b1 |
303 | |
479d2113 |
304 | # 5.5.3 doesn't have any concept of vendor libs |
305 | push @Get_from_Config, qw( vendorarchexp vendorlibexp ) if $] >= 5.006; |
306 | |
5e9e174b |
307 | foreach my $item (@attrib_help){ |
f6d6199c |
308 | $Recognized_Att_Keys{$item} = 1; |
e05e23b1 |
309 | } |
5e9e174b |
310 | foreach my $item (@Get_from_Config) { |
f6d6199c |
311 | $Recognized_Att_Keys{uc $item} = $Config{$item}; |
312 | print "Attribute '\U$item\E' => '$Config{$item}'\n" |
313 | if ($Verbose >= 2); |
e05e23b1 |
314 | } |
315 | |
316 | # |
3b03c0f3 |
317 | # When we eval a Makefile.PL in a subdirectory, that one will ask |
318 | # us (the parent) for the values and will prepend "..", so that |
319 | # all files to be installed end up below OUR ./blib |
e05e23b1 |
320 | # |
e0678a30 |
321 | @Prepend_parent = qw( |
322 | INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT |
f6d6199c |
323 | MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC |
324 | PERL FULLPERL |
325 | ); |
e05e23b1 |
326 | } |
42793c05 |
327 | |
8e07c86e |
328 | sub writeMakefile { |
329 | die <<END; |
232e078e |
330 | |
8e07c86e |
331 | The extension you are trying to build apparently is rather old and |
332 | most probably outdated. We detect that from the fact, that a |
333 | subroutine "writeMakefile" is called, and this subroutine is not |
334 | supported anymore since about October 1994. |
40000a8c |
335 | |
4633a7c4 |
336 | Please contact the author or look into CPAN (details about CPAN can be |
337 | found in the FAQ and at http:/www.perl.com) for a more recent version |
338 | of the extension. If you're really desperate, you can try to change |
339 | the subroutine name from writeMakefile to WriteMakefile and rerun |
340 | 'perl Makefile.PL', but you're most probably left alone, when you do |
341 | so. |
42793c05 |
342 | |
8e07c86e |
343 | The MakeMaker team |
1aef975c |
344 | |
42793c05 |
345 | END |
8e07c86e |
346 | } |
42793c05 |
347 | |
f6d6199c |
348 | sub new { |
8e07c86e |
349 | my($class,$self) = @_; |
350 | my($key); |
42793c05 |
351 | |
479d2113 |
352 | # Store the original args passed to WriteMakefile() |
353 | foreach my $k (keys %$self) { |
354 | $self->{ARGS}{$k} = $self->{$k}; |
355 | } |
356 | |
88d69b28 |
357 | if ("@ARGV" =~ /\bPREREQ_PRINT\b/) { |
f6d6199c |
358 | require Data::Dumper; |
88d69b28 |
359 | print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]); |
919b8535 |
360 | exit 0; |
f6d6199c |
361 | } |
88d69b28 |
362 | |
363 | # PRINT_PREREQ is RedHatism. |
364 | if ("@ARGV" =~ /\bPRINT_PREREQ\b/) { |
2c91f887 |
365 | print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } |
366 | sort keys %{$self->{PREREQ_PM}}), "\n"; |
f6d6199c |
367 | exit 0; |
88d69b28 |
368 | } |
369 | |
e05e23b1 |
370 | print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose; |
8e07c86e |
371 | if (-f "MANIFEST" && ! -f "Makefile"){ |
f6d6199c |
372 | check_manifest(); |
1aef975c |
373 | } |
42793c05 |
374 | |
8e07c86e |
375 | $self = {} unless (defined $self); |
005c1a0e |
376 | |
864a5fa8 |
377 | check_hints($self); |
4633a7c4 |
378 | |
c3be8c6e |
379 | my %configure_att; # record &{$self->{CONFIGURE}} attributes |
8e07c86e |
380 | my(%initial_att) = %$self; # record initial attributes |
005c1a0e |
381 | |
a4260cbc |
382 | my(%unsatisfied) = (); |
5e9e174b |
383 | foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) { |
479d2113 |
384 | # 5.8.0 has a bug with require Foo::Bar alone in an eval, so an |
385 | # extra statement is a workaround. |
a7d1454b |
386 | my $file = "$prereq.pm"; |
387 | $file =~ s{::}{/}g; |
388 | eval { require $file }; |
f6d6199c |
389 | |
e0678a30 |
390 | my $pr_version = $prereq->VERSION || 0; |
391 | |
479d2113 |
392 | # convert X.Y_Z alpha version #s to X.YZ for easier comparisons |
393 | $pr_version =~ s/(\d+)\.(\d+)_(\d+)/$1.$2$3/; |
394 | |
f6d6199c |
395 | if ($@) { |
396 | warn sprintf "Warning: prerequisite %s %s not found.\n", |
397 | $prereq, $self->{PREREQ_PM}{$prereq} |
398 | unless $self->{PREREQ_FATAL}; |
399 | $unsatisfied{$prereq} = 'not installed'; |
e0678a30 |
400 | } elsif ($pr_version < $self->{PREREQ_PM}->{$prereq} ){ |
45bc4d3a |
401 | warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n", |
f6d6199c |
402 | $prereq, $self->{PREREQ_PM}{$prereq}, |
e0678a30 |
403 | ($pr_version || 'unknown version') |
f6d6199c |
404 | unless $self->{PREREQ_FATAL}; |
405 | $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ? |
406 | $self->{PREREQ_PM}->{$prereq} : 'unknown version' ; |
407 | } |
f1387719 |
408 | } |
a4260cbc |
409 | if (%unsatisfied && $self->{PREREQ_FATAL}){ |
f6d6199c |
410 | my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"} |
411 | keys %unsatisfied; |
412 | die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)\n |
413 | Please install these modules first and rerun 'perl Makefile.PL'.\n}; |
a4260cbc |
414 | } |
f1387719 |
415 | |
8e07c86e |
416 | if (defined $self->{CONFIGURE}) { |
f6d6199c |
417 | if (ref $self->{CONFIGURE} eq 'CODE') { |
418 | %configure_att = %{&{$self->{CONFIGURE}}}; |
419 | $self = { %$self, %configure_att }; |
420 | } else { |
421 | Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n"; |
422 | } |
005c1a0e |
423 | } |
a0d0e21e |
424 | |
8e07c86e |
425 | # This is for old Makefiles written pre 5.00, will go away |
426 | if ( Carp::longmess("") =~ /runsubdirpl/s ){ |
f6d6199c |
427 | Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n"); |
8e07c86e |
428 | } |
5d94fbed |
429 | |
ccd13d1e |
430 | my $newclass = ++$PACKNAME; |
f6d6199c |
431 | local @Parent = @Parent; # Protect against non-local exits |
8e07c86e |
432 | { |
f6d6199c |
433 | no strict 'refs'; |
434 | print "Blessing Object into class [$newclass]\n" if $Verbose>=2; |
435 | mv_all_methods("MY",$newclass); |
436 | bless $self, $newclass; |
437 | push @Parent, $self; |
438 | require ExtUtils::MY; |
439 | @{"$newclass\:\:ISA"} = 'MM'; |
8e07c86e |
440 | } |
5d94fbed |
441 | |
e05e23b1 |
442 | if (defined $Parent[-2]){ |
f6d6199c |
443 | $self->{PARENT} = $Parent[-2]; |
444 | my $key; |
e0678a30 |
445 | for $key (@Prepend_parent) { |
f6d6199c |
446 | next unless defined $self->{PARENT}{$key}; |
531e2ba1 |
447 | |
448 | # Don't stomp on WriteMakefile() args. |
46442182 |
449 | next if defined $self->{ARGS}{$key} and |
450 | $self->{ARGS}{$key} eq $self->{$key}; |
451 | |
452 | $self->{$key} = $self->{PARENT}{$key}; |
531e2ba1 |
453 | |
479d2113 |
454 | unless ($Is_VMS && $key =~ /PERL$/) { |
f6d6199c |
455 | $self->{$key} = $self->catdir("..",$self->{$key}) |
456 | unless $self->file_name_is_absolute($self->{$key}); |
457 | } else { |
458 | # PERL or FULLPERL will be a command verb or even a |
459 | # command with an argument instead of a full file |
460 | # specification under VMS. So, don't turn the command |
461 | # into a filespec, but do add a level to the path of |
462 | # the argument if not already absolute. |
463 | my @cmd = split /\s+/, $self->{$key}; |
464 | $cmd[1] = $self->catfile('[-]',$cmd[1]) |
465 | unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]); |
466 | $self->{$key} = join(' ', @cmd); |
467 | } |
468 | } |
469 | if ($self->{PARENT}) { |
470 | $self->{PARENT}->{CHILDREN}->{$newclass} = $self; |
471 | foreach my $opt (qw(POLLUTE PERL_CORE)) { |
472 | if (exists $self->{PARENT}->{$opt} |
473 | and not exists $self->{$opt}) |
474 | { |
475 | # inherit, but only if already unspecified |
476 | $self->{$opt} = $self->{PARENT}->{$opt}; |
477 | } |
478 | } |
479 | } |
480 | my @fm = grep /^FIRST_MAKEFILE=/, @ARGV; |
481 | parse_args($self,@fm) if @fm; |
8e07c86e |
482 | } else { |
f6d6199c |
483 | parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV); |
8e07c86e |
484 | } |
a0d0e21e |
485 | |
8e07c86e |
486 | $self->{NAME} ||= $self->guess_name; |
a0d0e21e |
487 | |
8e07c86e |
488 | ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g; |
a0d0e21e |
489 | |
479d2113 |
490 | $self->init_main; |
491 | $self->init_VERSION; |
492 | $self->init_dist; |
493 | $self->init_INST; |
494 | $self->init_INSTALL; |
531e2ba1 |
495 | $self->init_DEST; |
479d2113 |
496 | $self->init_dirscan; |
497 | $self->init_xs; |
498 | $self->init_PERL; |
499 | $self->init_DIRFILESEP; |
500 | $self->init_linker; |
8e07c86e |
501 | |
0d8023a2 |
502 | if (! $self->{PERL_SRC} ) { |
f6d6199c |
503 | require VMS::Filespec if $Is_VMS; |
504 | my($pthinks) = $self->canonpath($INC{'Config.pm'}); |
505 | my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm'); |
506 | $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS; |
507 | if ($pthinks ne $cthinks && |
508 | !($Is_Win32 and lc($pthinks) eq lc($cthinks))) { |
3e3baf6d |
509 | print "Have $pthinks expected $cthinks\n"; |
f6d6199c |
510 | if ($Is_Win32) { |
511 | $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!; |
512 | } |
513 | else { |
514 | $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!; |
515 | } |
516 | print STDOUT <<END unless $self->{UNINSTALLED_PERL}; |
517 | Your perl and your Config.pm seem to have different ideas about the |
518 | architecture they are running on. |
8e07c86e |
519 | Perl thinks: [$pthinks] |
e05e23b1 |
520 | Config says: [$Config{archname}] |
f6d6199c |
521 | This may or may not cause problems. Please check your installation of perl |
522 | if you have problems building this extension. |
005c1a0e |
523 | END |
f6d6199c |
524 | } |
005c1a0e |
525 | } |
526 | |
8e07c86e |
527 | $self->init_others(); |
479d2113 |
528 | $self->init_platform(); |
e0678a30 |
529 | $self->init_PERM(); |
6071deed |
530 | my($argv) = neatvalue(\@ARGV); |
531 | $argv =~ s/^\[/(/; |
532 | $argv =~ s/\]$/)/; |
75f92628 |
533 | |
8e07c86e |
534 | push @{$self->{RESULT}}, <<END; |
535 | # This Makefile is for the $self->{NAME} extension to perl. |
536 | # |
e05e23b1 |
537 | # It was generated automatically by MakeMaker version |
538 | # $VERSION (Revision: $Revision) from the contents of |
539 | # Makefile.PL. Don't edit this file, edit Makefile.PL instead. |
8e07c86e |
540 | # |
f6d6199c |
541 | # ANY CHANGES MADE HERE WILL BE LOST! |
8e07c86e |
542 | # |
6071deed |
543 | # MakeMaker ARGV: $argv |
544 | # |
8e07c86e |
545 | # MakeMaker Parameters: |
546 | END |
a0d0e21e |
547 | |
5e9e174b |
548 | foreach my $key (sort keys %initial_att){ |
479d2113 |
549 | next if $key eq 'ARGS'; |
550 | |
f6d6199c |
551 | my($v) = neatvalue($initial_att{$key}); |
552 | $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/; |
553 | $v =~ tr/\n/ /s; |
554 | push @{$self->{RESULT}}, "# $key => $v"; |
42793c05 |
555 | } |
c3be8c6e |
556 | undef %initial_att; # free memory |
557 | |
558 | if (defined $self->{CONFIGURE}) { |
559 | push @{$self->{RESULT}}, <<END; |
560 | |
561 | # MakeMaker 'CONFIGURE' Parameters: |
562 | END |
563 | if (scalar(keys %configure_att) > 0) { |
5e9e174b |
564 | foreach my $key (sort keys %configure_att){ |
479d2113 |
565 | next if $key eq 'ARGS'; |
c3be8c6e |
566 | my($v) = neatvalue($configure_att{$key}); |
567 | $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/; |
568 | $v =~ tr/\n/ /s; |
569 | push @{$self->{RESULT}}, "# $key => $v"; |
570 | } |
571 | } |
572 | else |
573 | { |
574 | push @{$self->{RESULT}}, "# no values returned"; |
575 | } |
576 | undef %configure_att; # free memory |
577 | } |
a0d0e21e |
578 | |
8e07c86e |
579 | # turn the SKIP array into a SKIPHASH hash |
580 | my (%skip,$skip); |
581 | for $skip (@{$self->{SKIP} || []}) { |
f6d6199c |
582 | $self->{SKIPHASH}{$skip} = 1; |
8e07c86e |
583 | } |
3b03c0f3 |
584 | delete $self->{SKIP}; # free memory |
585 | |
586 | if ($self->{PARENT}) { |
479d2113 |
587 | for (qw/install dist dist_basics dist_core distdir dist_test dist_ci/) { |
f6d6199c |
588 | $self->{SKIPHASH}{$_} = 1; |
589 | } |
3b03c0f3 |
590 | } |
42793c05 |
591 | |
8e07c86e |
592 | # We run all the subdirectories now. They don't have much to query |
593 | # from the parent, but the parent has to query them: if they need linking! |
8e07c86e |
594 | unless ($self->{NORECURS}) { |
f6d6199c |
595 | $self->eval_in_subdirs if @{$self->{DIR}}; |
42793c05 |
596 | } |
a0d0e21e |
597 | |
5e9e174b |
598 | foreach my $section ( @MM_Sections ){ |
479d2113 |
599 | # Support for new foo_target() methods. |
600 | my $method = $section; |
601 | $method .= '_target' unless $self->can($method); |
602 | |
f6d6199c |
603 | print "Processing Makefile '$section' section\n" if ($Verbose >= 2); |
604 | my($skipit) = $self->skipcheck($section); |
605 | if ($skipit){ |
606 | push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit."; |
607 | } else { |
608 | my(%a) = %{$self->{$section} || {}}; |
609 | push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:"; |
610 | push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a; |
479d2113 |
611 | push @{$self->{RESULT}}, $self->nicetext($self->$method( %a )); |
f6d6199c |
612 | } |
232e078e |
613 | } |
8e07c86e |
614 | |
e05e23b1 |
615 | push @{$self->{RESULT}}, "\n# End."; |
8e07c86e |
616 | |
e05e23b1 |
617 | $self; |
232e078e |
618 | } |
619 | |
1b171b8d |
620 | sub WriteEmptyMakefile { |
a8112c7f |
621 | Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2; |
a8112c7f |
622 | |
623 | my %att = @_; |
624 | my $self = MM->new(\%att); |
479d2113 |
625 | if (-f $self->{MAKEFILE_OLD}) { |
dedf98bc |
626 | _unlink($self->{MAKEFILE_OLD}) or |
627 | warn "unlink $self->{MAKEFILE_OLD}: $!"; |
479d2113 |
628 | } |
629 | if ( -f $self->{MAKEFILE} ) { |
dedf98bc |
630 | _rename($self->{MAKEFILE}, $self->{MAKEFILE_OLD}) or |
631 | warn "rename $self->{MAKEFILE} => $self->{MAKEFILE_OLD}: $!" |
a8112c7f |
632 | } |
57b1a898 |
633 | open MF, '>'.$self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!"; |
a8112c7f |
634 | print MF <<'EOP'; |
1b171b8d |
635 | all: |
636 | |
637 | clean: |
638 | |
639 | install: |
640 | |
641 | makemakerdflt: |
642 | |
643 | test: |
644 | |
645 | EOP |
a8112c7f |
646 | close MF or die "close $self->{MAKEFILE} for write: $!"; |
1b171b8d |
647 | } |
648 | |
e05e23b1 |
649 | sub check_manifest { |
650 | print STDOUT "Checking if your kit is complete...\n"; |
3b03c0f3 |
651 | require ExtUtils::Manifest; |
5e9e174b |
652 | # avoid warning |
653 | $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1; |
654 | my(@missed) = ExtUtils::Manifest::manicheck(); |
655 | if (@missed) { |
f6d6199c |
656 | print STDOUT "Warning: the following files are missing in your kit:\n"; |
657 | print "\t", join "\n\t", @missed; |
658 | print STDOUT "\n"; |
659 | print STDOUT "Please inform the author.\n"; |
8e07c86e |
660 | } else { |
f6d6199c |
661 | print STDOUT "Looks good\n"; |
8e07c86e |
662 | } |
8e07c86e |
663 | } |
664 | |
e05e23b1 |
665 | sub parse_args{ |
666 | my($self, @args) = @_; |
5e9e174b |
667 | foreach (@args) { |
f6d6199c |
668 | unless (m/(.*?)=(.*)/) { |
f6d6199c |
669 | ++$Verbose if m/^verb/; |
670 | next; |
671 | } |
672 | my($name, $value) = ($1, $2); |
673 | if ($value =~ m/^~(\w+)?/) { # tilde with optional username |
674 | $value =~ s [^~(\w*)] |
675 | [$1 ? |
676 | ((getpwnam($1))[7] || "~$1") : |
677 | (getpwuid($>))[7] |
678 | ]ex; |
679 | } |
479d2113 |
680 | |
681 | # Remember the original args passed it. It will be useful later. |
682 | $self->{ARGS}{uc $name} = $self->{uc $name} = $value; |
8e07c86e |
683 | } |
8e07c86e |
684 | |
e05e23b1 |
685 | # catch old-style 'potential_libs' and inform user how to 'upgrade' |
686 | if (defined $self->{potential_libs}){ |
f6d6199c |
687 | my($msg)="'potential_libs' => '$self->{potential_libs}' should be"; |
688 | if ($self->{potential_libs}){ |
689 | print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n"; |
690 | } else { |
691 | print STDOUT "$msg deleted.\n"; |
692 | } |
693 | $self->{LIBS} = [$self->{potential_libs}]; |
694 | delete $self->{potential_libs}; |
8e07c86e |
695 | } |
e05e23b1 |
696 | # catch old-style 'ARMAYBE' and inform user how to 'upgrade' |
697 | if (defined $self->{ARMAYBE}){ |
f6d6199c |
698 | my($armaybe) = $self->{ARMAYBE}; |
699 | print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n", |
700 | "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n"; |
701 | my(%dl) = %{$self->{dynamic_lib} || {}}; |
702 | $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe}; |
703 | delete $self->{ARMAYBE}; |
8e07c86e |
704 | } |
e05e23b1 |
705 | if (defined $self->{LDTARGET}){ |
f6d6199c |
706 | print STDOUT "LDTARGET should be changed to LDFROM\n"; |
707 | $self->{LDFROM} = $self->{LDTARGET}; |
708 | delete $self->{LDTARGET}; |
8e07c86e |
709 | } |
e05e23b1 |
710 | # Turn a DIR argument on the command line into an array |
711 | if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') { |
f6d6199c |
712 | # So they can choose from the command line, which extensions they want |
713 | # the grep enables them to have some colons too much in case they |
714 | # have to build a list with the shell |
715 | $self->{DIR} = [grep $_, split ":", $self->{DIR}]; |
8e07c86e |
716 | } |
f1387719 |
717 | # Turn a INCLUDE_EXT argument on the command line into an array |
718 | if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') { |
f6d6199c |
719 | $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}]; |
f1387719 |
720 | } |
721 | # Turn a EXCLUDE_EXT argument on the command line into an array |
722 | if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') { |
f6d6199c |
723 | $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}]; |
f1387719 |
724 | } |
5e9e174b |
725 | |
726 | foreach my $mmkey (sort keys %$self){ |
479d2113 |
727 | next if $mmkey eq 'ARGS'; |
f6d6199c |
728 | print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose; |
729 | print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n" |
730 | unless exists $Recognized_Att_Keys{$mmkey}; |
e05e23b1 |
731 | } |
f1387719 |
732 | $| = 1 if $Verbose; |
e05e23b1 |
733 | } |
8e07c86e |
734 | |
e05e23b1 |
735 | sub check_hints { |
736 | my($self) = @_; |
737 | # We allow extension-specific hints files. |
864a5fa8 |
738 | |
479d2113 |
739 | require File::Spec; |
740 | my $curdir = File::Spec->curdir; |
741 | |
742 | my $hint_dir = File::Spec->catdir($curdir, "hints"); |
743 | return unless -d $hint_dir; |
8e07c86e |
744 | |
e05e23b1 |
745 | # First we look for the best hintsfile we have |
f1387719 |
746 | my($hint)="${^O}_$Config{osvers}"; |
e05e23b1 |
747 | $hint =~ s/\./_/g; |
748 | $hint =~ s/_$//; |
749 | return unless $hint; |
fed7345c |
750 | |
e05e23b1 |
751 | # Also try without trailing minor version numbers. |
752 | while (1) { |
479d2113 |
753 | last if -f File::Spec->catfile($hint_dir, "$hint.pl"); # found |
e05e23b1 |
754 | } continue { |
f6d6199c |
755 | last unless $hint =~ s/_[^_]*$//; # nothing to cut off |
e05e23b1 |
756 | } |
479d2113 |
757 | my $hint_file = File::Spec->catfile($hint_dir, "$hint.pl"); |
6626a13a |
758 | |
759 | return unless -f $hint_file; # really there |
fed7345c |
760 | |
f6d6199c |
761 | _run_hintfile($self, $hint_file); |
762 | } |
763 | |
764 | sub _run_hintfile { |
57b1a898 |
765 | no strict 'vars'; |
f6d6199c |
766 | local($self) = shift; # make $self available to the hint file. |
767 | my($hint_file) = shift; |
768 | |
479d2113 |
769 | local($@, $!); |
39234879 |
770 | print STDERR "Processing hints file $hint_file\n"; |
479d2113 |
771 | |
772 | # Just in case the ./ isn't on the hint file, which File::Spec can |
773 | # often strip off, we bung the curdir into @INC |
774 | local @INC = (File::Spec->curdir, @INC); |
775 | my $ret = do $hint_file; |
776 | if( !defined $ret ) { |
777 | my $error = $@ || $!; |
778 | print STDERR $error; |
75e2e551 |
779 | } |
e05e23b1 |
780 | } |
8e07c86e |
781 | |
e05e23b1 |
782 | sub mv_all_methods { |
783 | my($from,$to) = @_; |
5e9e174b |
784 | no strict 'refs'; |
e05e23b1 |
785 | my($symtab) = \%{"${from}::"}; |
fed7345c |
786 | |
e05e23b1 |
787 | # Here you see the *current* list of methods that are overridable |
788 | # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm |
789 | # still trying to reduce the list to some reasonable minimum -- |
790 | # because I want to make it easier for the user. A.K. |
40000a8c |
791 | |
57b1a898 |
792 | local $SIG{__WARN__} = sub { |
793 | # can't use 'no warnings redefined', 5.6 only |
794 | warn @_ unless $_[0] =~ /^Subroutine .* redefined/ |
795 | }; |
5e9e174b |
796 | foreach my $method (@Overridable) { |
fed7345c |
797 | |
f6d6199c |
798 | # We cannot say "next" here. Nick might call MY->makeaperl |
799 | # which isn't defined right now |
800 | |
801 | # Above statement was written at 4.23 time when Tk-b8 was |
802 | # around. As Tk-b9 only builds with 5.002something and MM 5 is |
803 | # standard, we try to enable the next line again. It was |
804 | # commented out until MM 5.23 |
805 | |
806 | next unless defined &{"${from}::$method"}; |
fed7345c |
807 | |
f6d6199c |
808 | *{"${to}::$method"} = \&{"${from}::$method"}; |
3b03c0f3 |
809 | |
f6d6199c |
810 | # delete would do, if we were sure, nobody ever called |
811 | # MY->makeaperl directly |
fed7345c |
812 | |
f6d6199c |
813 | # delete $symtab->{$method}; |
8e07c86e |
814 | |
f6d6199c |
815 | # If we delete a method, then it will be undefined and cannot |
816 | # be called. But as long as we have Makefile.PLs that rely on |
817 | # %MY:: being intact, we have to fill the hole with an |
818 | # inheriting method: |
fed7345c |
819 | |
f6d6199c |
820 | eval "package MY; sub $method { shift->SUPER::$method(\@_); }"; |
5d94fbed |
821 | } |
822 | |
e05e23b1 |
823 | # We have to clean out %INC also, because the current directory is |
824 | # changed frequently and Graham Barr prefers to get his version |
825 | # out of a History.pl file which is "required" so woudn't get |
826 | # loaded again in another extension requiring a History.pl |
a0d0e21e |
827 | |
f1387719 |
828 | # With perl5.002_01 the deletion of entries in %INC caused Tk-b11 |
829 | # to core dump in the middle of a require statement. The required |
830 | # file was Tk/MMutil.pm. The consequence is, we have to be |
831 | # extremely careful when we try to give perl a reason to reload a |
832 | # library with same name. The workaround prefers to drop nothing |
833 | # from %INC and teach the writers not to use such libraries. |
834 | |
835 | # my $inc; |
836 | # foreach $inc (keys %INC) { |
f6d6199c |
837 | # #warn "***$inc*** deleted"; |
838 | # delete $INC{$inc}; |
f1387719 |
839 | # } |
8e07c86e |
840 | } |
841 | |
3b03c0f3 |
842 | sub skipcheck { |
8e07c86e |
843 | my($self) = shift; |
e05e23b1 |
844 | my($section) = @_; |
845 | if ($section eq 'dynamic') { |
f6d6199c |
846 | print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ", |
847 | "in skipped section 'dynamic_bs'\n" |
e05e23b1 |
848 | if $self->{SKIPHASH}{dynamic_bs} && $Verbose; |
849 | print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ", |
f6d6199c |
850 | "in skipped section 'dynamic_lib'\n" |
e05e23b1 |
851 | if $self->{SKIPHASH}{dynamic_lib} && $Verbose; |
8e07c86e |
852 | } |
e05e23b1 |
853 | if ($section eq 'dynamic_lib') { |
854 | print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ", |
f6d6199c |
855 | "targets in skipped section 'dynamic_bs'\n" |
e05e23b1 |
856 | if $self->{SKIPHASH}{dynamic_bs} && $Verbose; |
857 | } |
858 | if ($section eq 'static') { |
859 | print STDOUT "Warning (non-fatal): Target 'static' depends on targets ", |
f6d6199c |
860 | "in skipped section 'static_lib'\n" |
e05e23b1 |
861 | if $self->{SKIPHASH}{static_lib} && $Verbose; |
8e07c86e |
862 | } |
e05e23b1 |
863 | return 'skipped' if $self->{SKIPHASH}{$section}; |
864 | return ''; |
8e07c86e |
865 | } |
866 | |
e05e23b1 |
867 | sub flush { |
868 | my $self = shift; |
869 | my($chunk); |
3b03c0f3 |
870 | local *FH; |
e05e23b1 |
871 | print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n"; |
8e07c86e |
872 | |
e05e23b1 |
873 | unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : ''); |
3b03c0f3 |
874 | open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!"; |
8e07c86e |
875 | |
e05e23b1 |
876 | for $chunk (@{$self->{RESULT}}) { |
f6d6199c |
877 | print FH "$chunk\n"; |
8e07c86e |
878 | } |
e05e23b1 |
879 | |
3b03c0f3 |
880 | close FH; |
e05e23b1 |
881 | my($finalname) = $self->{MAKEFILE}; |
479d2113 |
882 | _rename("MakeMaker.tmp", $finalname) or |
883 | warn "rename MakeMaker.tmp => $finalname: $!"; |
e05e23b1 |
884 | chmod 0644, $finalname unless $Is_VMS; |
3b03c0f3 |
885 | |
479d2113 |
886 | my %keep = map { ($_ => 1) } qw(NEEDS_LINKING HAS_LINK_CODE); |
887 | |
e0678a30 |
888 | if ($self->{PARENT} && !$self->{_KEEP_AFTER_FLUSH}) { |
f6d6199c |
889 | foreach (keys %$self) { # safe memory |
479d2113 |
890 | delete $self->{$_} unless $keep{$_}; |
f6d6199c |
891 | } |
3b03c0f3 |
892 | } |
893 | |
e05e23b1 |
894 | system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":"; |
40000a8c |
895 | } |
896 | |
479d2113 |
897 | |
898 | # This is a rename for OS's where the target must be unlinked first. |
899 | sub _rename { |
900 | my($src, $dest) = @_; |
901 | chmod 0666, $dest; |
902 | unlink $dest; |
903 | return rename $src, $dest; |
904 | } |
905 | |
dedf98bc |
906 | # This is an unlink for OS's where the target must be writable first. |
907 | sub _unlink { |
908 | my @files = @_; |
909 | chmod 0666, @files; |
910 | return unlink @files; |
911 | } |
912 | |
479d2113 |
913 | |
e05e23b1 |
914 | # The following mkbootstrap() is only for installations that are calling |
915 | # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker |
916 | # writes Makefiles, that use ExtUtils::Mkbootstrap directly. |
917 | sub mkbootstrap { |
918 | die <<END; |
919 | !!! Your Makefile has been built such a long time ago, !!! |
920 | !!! that is unlikely to work with current MakeMaker. !!! |
921 | !!! Please rebuild your Makefile !!! |
922 | END |
8e07c86e |
923 | } |
005c1a0e |
924 | |
e05e23b1 |
925 | # Ditto for mksymlists() as of MakeMaker 5.17 |
926 | sub mksymlists { |
927 | die <<END; |
928 | !!! Your Makefile has been built such a long time ago, !!! |
929 | !!! that is unlikely to work with current MakeMaker. !!! |
930 | !!! Please rebuild your Makefile !!! |
931 | END |
4633a7c4 |
932 | } |
933 | |
e05e23b1 |
934 | sub neatvalue { |
935 | my($v) = @_; |
936 | return "undef" unless defined $v; |
937 | my($t) = ref $v; |
938 | return "q[$v]" unless $t; |
939 | if ($t eq 'ARRAY') { |
f6d6199c |
940 | my(@m, @neat); |
941 | push @m, "["; |
942 | foreach my $elem (@$v) { |
943 | push @neat, "q[$elem]"; |
944 | } |
945 | push @m, join ", ", @neat; |
946 | push @m, "]"; |
947 | return join "", @m; |
e05e23b1 |
948 | } |
949 | return "$v" unless $t eq 'HASH'; |
950 | my(@m, $key, $val); |
3b03c0f3 |
951 | while (($key,$val) = each %$v){ |
f6d6199c |
952 | last unless defined $key; # cautious programming in case (undef,undef) is true |
953 | push(@m,"$key=>".neatvalue($val)) ; |
3b03c0f3 |
954 | } |
e05e23b1 |
955 | return "{ ".join(', ',@m)." }"; |
4e68a208 |
956 | } |
957 | |
e05e23b1 |
958 | sub selfdocument { |
959 | my($self) = @_; |
960 | my(@m); |
961 | if ($Verbose){ |
f6d6199c |
962 | push @m, "\n# Full list of MakeMaker attribute values:"; |
963 | foreach my $key (sort keys %$self){ |
964 | next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/; |
965 | my($v) = neatvalue($self->{$key}); |
966 | $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/; |
967 | $v =~ tr/\n/ /s; |
968 | push @m, "# $key => $v"; |
969 | } |
e05e23b1 |
970 | } |
971 | join "\n", @m; |
972 | } |
4e68a208 |
973 | |
3b03c0f3 |
974 | 1; |
975 | |
976 | __END__ |
005c1a0e |
977 | |
978 | =head1 NAME |
979 | |
479d2113 |
980 | ExtUtils::MakeMaker - Create a module Makefile |
005c1a0e |
981 | |
982 | =head1 SYNOPSIS |
983 | |
e0678a30 |
984 | use ExtUtils::MakeMaker; |
005c1a0e |
985 | |
e0678a30 |
986 | WriteMakefile( ATTRIBUTE => VALUE [, ...] ); |
8e07c86e |
987 | |
005c1a0e |
988 | =head1 DESCRIPTION |
989 | |
990 | This utility is designed to write a Makefile for an extension module |
991 | from a Makefile.PL. It is based on the Makefile.SH model provided by |
992 | Andy Dougherty and the perl5-porters. |
993 | |
994 | It splits the task of generating the Makefile into several subroutines |
995 | that can be individually overridden. Each subroutine returns the text |
996 | it wishes to have written to the Makefile. |
997 | |
f1387719 |
998 | MakeMaker is object oriented. Each directory below the current |
e0678a30 |
999 | directory that contains a Makefile.PL is treated as a separate |
f1387719 |
1000 | object. This makes it possible to write an unlimited number of |
1001 | Makefiles with a single invocation of WriteMakefile(). |
8e07c86e |
1002 | |
f1387719 |
1003 | =head2 How To Write A Makefile.PL |
8e07c86e |
1004 | |
479d2113 |
1005 | See ExtUtils::MakeMaker::Tutorial. |
8e07c86e |
1006 | |
bab2b58e |
1007 | The long answer is the rest of the manpage :-) |
005c1a0e |
1008 | |
1009 | =head2 Default Makefile Behaviour |
1010 | |
f1387719 |
1011 | The generated Makefile enables the user of the extension to invoke |
005c1a0e |
1012 | |
1013 | perl Makefile.PL # optionally "perl Makefile.PL verbose" |
1014 | make |
8e07c86e |
1015 | make test # optionally set TEST_VERBOSE=1 |
1016 | make install # See below |
005c1a0e |
1017 | |
1018 | The Makefile to be produced may be altered by adding arguments of the |
e05e23b1 |
1019 | form C<KEY=VALUE>. E.g. |
005c1a0e |
1020 | |
e05e23b1 |
1021 | perl Makefile.PL PREFIX=/tmp/myperl5 |
005c1a0e |
1022 | |
1023 | Other interesting targets in the generated Makefile are |
1024 | |
1025 | make config # to check if the Makefile is up-to-date |
8e07c86e |
1026 | make clean # delete local temp files (Makefile gets renamed) |
1027 | make realclean # delete derived files (including ./blib) |
e05e23b1 |
1028 | make ci # check in all the files in the MANIFEST file |
005c1a0e |
1029 | make dist # see below the Distribution Support section |
1030 | |
e05e23b1 |
1031 | =head2 make test |
1032 | |
bab2b58e |
1033 | MakeMaker checks for the existence of a file named F<test.pl> in the |
d5d4ec93 |
1034 | current directory and if it exists it execute the script with the |
1035 | proper set of perl C<-I> options. |
e05e23b1 |
1036 | |
1037 | MakeMaker also checks for any files matching glob("t/*.t"). It will |
d5d4ec93 |
1038 | execute all matching files in alphabetical order via the |
1039 | L<Test::Harness> module with the C<-I> switches set correctly. |
1040 | |
1041 | If you'd like to see the raw output of your tests, set the |
1042 | C<TEST_VERBOSE> variable to true. |
1043 | |
1044 | make test TEST_VERBOSE=1 |
e05e23b1 |
1045 | |
bab2b58e |
1046 | =head2 make testdb |
1047 | |
1048 | A useful variation of the above is the target C<testdb>. It runs the |
1049 | test under the Perl debugger (see L<perldebug>). If the file |
1050 | F<test.pl> exists in the current directory, it is used for the test. |
1051 | |
d5d4ec93 |
1052 | If you want to debug some other testfile, set the C<TEST_FILE> variable |
bab2b58e |
1053 | thusly: |
1054 | |
1055 | make testdb TEST_FILE=t/mytest.t |
1056 | |
1057 | By default the debugger is called using C<-d> option to perl. If you |
d5d4ec93 |
1058 | want to specify some other option, set the C<TESTDB_SW> variable: |
bab2b58e |
1059 | |
1060 | make testdb TESTDB_SW=-Dx |
1061 | |
e05e23b1 |
1062 | =head2 make install |
005c1a0e |
1063 | |
8e07c86e |
1064 | make alone puts all relevant files into directories that are named by |
f6d6199c |
1065 | the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and |
1066 | INST_MAN3DIR. All these default to something below ./blib if you are |
1067 | I<not> building below the perl source directory. If you I<are> |
1068 | building below the perl source, INST_LIB and INST_ARCHLIB default to |
1069 | ../../lib, and INST_SCRIPT is not defined. |
005c1a0e |
1070 | |
e05e23b1 |
1071 | The I<install> target of the generated Makefile copies the files found |
1072 | below each of the INST_* directories to their INSTALL* |
1073 | counterparts. Which counterparts are chosen depends on the setting of |
1074 | INSTALLDIRS according to the following table: |
005c1a0e |
1075 | |
f6d6199c |
1076 | INSTALLDIRS set to |
5c161494 |
1077 | perl site vendor |
e05e23b1 |
1078 | |
479d2113 |
1079 | PERLPREFIX SITEPREFIX VENDORPREFIX |
5c161494 |
1080 | INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH |
1081 | INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB |
1082 | INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN |
1083 | INST_SCRIPT INSTALLSCRIPT INSTALLSCRIPT INSTALLSCRIPT |
1084 | INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR |
1085 | INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR |
005c1a0e |
1086 | |
8e07c86e |
1087 | The INSTALL... macros in turn default to their %Config |
1088 | ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts. |
005c1a0e |
1089 | |
3b03c0f3 |
1090 | You can check the values of these variables on your system with |
1091 | |
bab2b58e |
1092 | perl '-V:install.*' |
3b03c0f3 |
1093 | |
f1387719 |
1094 | And to check the sequence in which the library directories are |
1095 | searched by perl, run |
005c1a0e |
1096 | |
f1387719 |
1097 | perl -le 'print join $/, @INC' |
005c1a0e |
1098 | |
a7d1454b |
1099 | Sometimes older versions of the module you're installing live in other |
1100 | directories in @INC. Because Perl loads the first version of a module it |
1101 | finds, not the newest, you might accidentally get one of these older |
1102 | versions even after installing a brand new version. To delete I<all other |
1103 | versions of the module you're installing> (not simply older ones) set the |
1104 | C<UNINST> variable. |
1105 | |
1106 | make install UNINST=1 |
1107 | |
005c1a0e |
1108 | |
bab2b58e |
1109 | =head2 PREFIX and LIB attribute |
1110 | |
1111 | PREFIX and LIB can be used to set several INSTALL* attributes in one |
1112 | go. The quickest way to install a module in a non-standard place might |
1113 | be |
1114 | |
f6d6199c |
1115 | perl Makefile.PL PREFIX=~ |
005c1a0e |
1116 | |
f6d6199c |
1117 | This will install all files in the module under your home directory, |
1118 | with man pages and libraries going into an appropriate place (usually |
1119 | ~/man and ~/lib). |
bab2b58e |
1120 | |
1121 | Another way to specify many INSTALL directories with a single |
f6d6199c |
1122 | parameter is LIB. |
005c1a0e |
1123 | |
f6d6199c |
1124 | perl Makefile.PL LIB=~/lib |
005c1a0e |
1125 | |
f6d6199c |
1126 | This will install the module's architecture-independent files into |
1127 | ~/lib, the architecture-dependent files into ~/lib/$archname. |
005c1a0e |
1128 | |
bab2b58e |
1129 | Note, that in both cases the tilde expansion is done by MakeMaker, not |
e35b8f9e |
1130 | by perl by default, nor by make. |
1131 | |
f6d6199c |
1132 | Conflicts between parameters LIB, PREFIX and the various INSTALL* |
1133 | arguments are resolved so that: |
e35b8f9e |
1134 | |
1135 | =over 4 |
1136 | |
1137 | =item * |
1138 | |
1139 | setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB, |
1140 | INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX); |
1141 | |
1142 | =item * |
1143 | |
1144 | without LIB, setting PREFIX replaces the initial C<$Config{prefix}> |
1145 | part of those INSTALL* arguments, even if the latter are explicitly |
1146 | set (but are set to still start with C<$Config{prefix}>). |
1147 | |
1148 | =back |
005c1a0e |
1149 | |
f6d6199c |
1150 | If the user has superuser privileges, and is not working on AFS or |
1151 | relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB, |
1152 | INSTALLSCRIPT, etc. will be appropriate, and this incantation will be |
1153 | the best: |
005c1a0e |
1154 | |
e0678a30 |
1155 | perl Makefile.PL; |
1156 | make; |
1157 | make test |
005c1a0e |
1158 | make install |
1159 | |
8e07c86e |
1160 | make install per default writes some documentation of what has been |
e05e23b1 |
1161 | done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature |
1162 | can be bypassed by calling make pure_install. |
8e07c86e |
1163 | |
1164 | =head2 AFS users |
1165 | |
1166 | will have to specify the installation directories as these most |
1167 | probably have changed since perl itself has been installed. They will |
1168 | have to do this by calling |
1169 | |
e05e23b1 |
1170 | perl Makefile.PL INSTALLSITELIB=/afs/here/today \ |
f6d6199c |
1171 | INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages |
8e07c86e |
1172 | make |
1173 | |
e05e23b1 |
1174 | Be careful to repeat this procedure every time you recompile an |
1175 | extension, unless you are sure the AFS installation directories are |
1176 | still valid. |
005c1a0e |
1177 | |
8e07c86e |
1178 | =head2 Static Linking of a new Perl Binary |
005c1a0e |
1179 | |
1180 | An extension that is built with the above steps is ready to use on |
1181 | systems supporting dynamic loading. On systems that do not support |
1182 | dynamic loading, any newly created extension has to be linked together |
1183 | with the available resources. MakeMaker supports the linking process |
1184 | by creating appropriate targets in the Makefile whenever an extension |
1185 | is built. You can invoke the corresponding section of the makefile with |
1186 | |
1187 | make perl |
1188 | |
1189 | That produces a new perl binary in the current directory with all |
da7f727a |
1190 | extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP, |
e05e23b1 |
1191 | and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on |
1192 | UNIX, this is called Makefile.aperl (may be system dependent). If you |
1193 | want to force the creation of a new perl, it is recommended, that you |
1194 | delete this Makefile.aperl, so the directories are searched-through |
1195 | for linkable libraries again. |
005c1a0e |
1196 | |
1197 | The binary can be installed into the directory where perl normally |
1198 | resides on your machine with |
1199 | |
1200 | make inst_perl |
1201 | |
1202 | To produce a perl binary with a different name than C<perl>, either say |
1203 | |
1204 | perl Makefile.PL MAP_TARGET=myperl |
1205 | make myperl |
1206 | make inst_perl |
1207 | |
1208 | or say |
1209 | |
1210 | perl Makefile.PL |
1211 | make myperl MAP_TARGET=myperl |
1212 | make inst_perl MAP_TARGET=myperl |
1213 | |
1214 | In any case you will be prompted with the correct invocation of the |
1215 | C<inst_perl> target that installs the new binary into INSTALLBIN. |
1216 | |
8e07c86e |
1217 | make inst_perl per default writes some documentation of what has been |
1218 | done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This |
1219 | can be bypassed by calling make pure_inst_perl. |
005c1a0e |
1220 | |
e05e23b1 |
1221 | Warning: the inst_perl: target will most probably overwrite your |
1222 | existing perl binary. Use with care! |
005c1a0e |
1223 | |
8e07c86e |
1224 | Sometimes you might want to build a statically linked perl although |
1225 | your system supports dynamic loading. In this case you may explicitly |
1226 | set the linktype with the invocation of the Makefile.PL or make: |
1227 | |
1228 | perl Makefile.PL LINKTYPE=static # recommended |
1229 | |
1230 | or |
1231 | |
1232 | make LINKTYPE=static # works on most systems |
1233 | |
005c1a0e |
1234 | =head2 Determination of Perl Library and Installation Locations |
1235 | |
1236 | MakeMaker needs to know, or to guess, where certain things are |
e05e23b1 |
1237 | located. Especially INST_LIB and INST_ARCHLIB (where to put the files |
1238 | during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read |
1239 | existing modules from), and PERL_INC (header files and C<libperl*.*>). |
005c1a0e |
1240 | |
1241 | Extensions may be built either using the contents of the perl source |
e05e23b1 |
1242 | directory tree or from the installed perl library. The recommended way |
1243 | is to build extensions after you have run 'make install' on perl |
1244 | itself. You can do that in any directory on your hard disk that is not |
1245 | below the perl source tree. The support for extensions below the ext |
1246 | directory of the perl distribution is only good for the standard |
1247 | extensions that come with perl. |
005c1a0e |
1248 | |
1249 | If an extension is being built below the C<ext/> directory of the perl |
e05e23b1 |
1250 | source then MakeMaker will set PERL_SRC automatically (e.g., |
1251 | C<../..>). If PERL_SRC is defined and the extension is recognized as |
1252 | a standard extension, then other variables default to the following: |
005c1a0e |
1253 | |
1254 | PERL_INC = PERL_SRC |
1255 | PERL_LIB = PERL_SRC/lib |
1256 | PERL_ARCHLIB = PERL_SRC/lib |
1257 | INST_LIB = PERL_LIB |
1258 | INST_ARCHLIB = PERL_ARCHLIB |
1259 | |
1260 | If an extension is being built away from the perl source then MakeMaker |
1261 | will leave PERL_SRC undefined and default to using the installed copy |
1262 | of the perl library. The other variables default to the following: |
1263 | |
e05e23b1 |
1264 | PERL_INC = $archlibexp/CORE |
1265 | PERL_LIB = $privlibexp |
1266 | PERL_ARCHLIB = $archlibexp |
1267 | INST_LIB = ./blib/lib |
1268 | INST_ARCHLIB = ./blib/arch |
005c1a0e |
1269 | |
1270 | If perl has not yet been installed then PERL_SRC can be defined on the |
1271 | command line as shown in the previous section. |
1272 | |
005c1a0e |
1273 | |
f1387719 |
1274 | =head2 Which architecture dependent directory? |
005c1a0e |
1275 | |
f1387719 |
1276 | If you don't want to keep the defaults for the INSTALL* macros, |
1277 | MakeMaker helps you to minimize the typing needed: the usual |
1278 | relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined |
1279 | by Configure at perl compilation time. MakeMaker supports the user who |
1280 | sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not, |
1281 | then MakeMaker defaults the latter to be the same subdirectory of |
1282 | INSTALLPRIVLIB as Configure decided for the counterparts in %Config , |
1283 | otherwise it defaults to INSTALLPRIVLIB. The same relationship holds |
1284 | for INSTALLSITELIB and INSTALLSITEARCH. |
005c1a0e |
1285 | |
f1387719 |
1286 | MakeMaker gives you much more freedom than needed to configure |
1287 | internal variables and get different results. It is worth to mention, |
1288 | that make(1) also lets you configure most of the variables that are |
1289 | used in the Makefile. But in the majority of situations this will not |
a7665c5e |
1290 | be necessary, and should only be done if the author of a package |
f1387719 |
1291 | recommends it (or you know what you're doing). |
005c1a0e |
1292 | |
e05e23b1 |
1293 | =head2 Using Attributes and Parameters |
005c1a0e |
1294 | |
a884ca7c |
1295 | The following attributes may be specified as arguments to WriteMakefile() |
1296 | or as NAME=VALUE pairs on the command line. |
005c1a0e |
1297 | |
875fa795 |
1298 | =over 2 |
005c1a0e |
1299 | |
875fa795 |
1300 | =item ABSTRACT |
1301 | |
1302 | One line description of the module. Will be included in PPD file. |
1303 | |
1304 | =item ABSTRACT_FROM |
1305 | |
1306 | Name of the file that contains the package description. MakeMaker looks |
1307 | for a line in the POD matching /^($package\s-\s)(.*)/. This is typically |
1308 | the first line in the "=head1 NAME" section. $2 becomes the abstract. |
1309 | |
e35b8f9e |
1310 | =item AUTHOR |
1311 | |
1312 | String containing name (and email address) of package author(s). Is used |
1313 | in PPD (Perl Package Description) files for PPM (Perl Package Manager). |
1314 | |
875fa795 |
1315 | =item BINARY_LOCATION |
1316 | |
1317 | Used when creating PPD files for binary packages. It can be set to a |
1318 | full or relative path or URL to the binary archive for a particular |
1319 | architecture. For example: |
1320 | |
f6d6199c |
1321 | perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz |
875fa795 |
1322 | |
1323 | builds a PPD package that references a binary of the C<Agent> package, |
20e08411 |
1324 | located in the C<x86> directory relative to the PPD itself. |
8e07c86e |
1325 | |
864a5fa8 |
1326 | =item C |
8e07c86e |
1327 | |
864a5fa8 |
1328 | Ref to array of *.c file names. Initialised from a directory scan |
1329 | and the values portion of the XS attribute hash. This is not |
1330 | currently used by MakeMaker but may be handy in Makefile.PLs. |
8e07c86e |
1331 | |
84902520 |
1332 | =item CCFLAGS |
1333 | |
1334 | String that will be included in the compiler call command line between |
1335 | the arguments INC and OPTIMIZE. |
1336 | |
864a5fa8 |
1337 | =item CONFIG |
8e07c86e |
1338 | |
864a5fa8 |
1339 | Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from |
1340 | config.sh. MakeMaker will add to CONFIG the following values anyway: |
1341 | ar |
1342 | cc |
1343 | cccdlflags |
1344 | ccdlflags |
1345 | dlext |
1346 | dlsrc |
1347 | ld |
1348 | lddlflags |
1349 | ldflags |
1350 | libc |
1351 | lib_ext |
1352 | obj_ext |
1353 | ranlib |
e05e23b1 |
1354 | sitelibexp |
1355 | sitearchexp |
864a5fa8 |
1356 | so |
8e07c86e |
1357 | |
1358 | =item CONFIGURE |
1359 | |
e05e23b1 |
1360 | CODE reference. The subroutine should return a hash reference. The |
1fef88e7 |
1361 | hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to |
8e07c86e |
1362 | be determined by some evaluation method. |
1363 | |
864a5fa8 |
1364 | =item DEFINE |
8e07c86e |
1365 | |
864a5fa8 |
1366 | Something like C<"-DHAVE_UNISTD_H"> |
8e07c86e |
1367 | |
479d2113 |
1368 | =item DESTDIR |
1369 | |
1370 | This is the root directory into which the code will be installed. It |
1371 | I<prepends itself to the normal prefix>. For example, if your code |
531e2ba1 |
1372 | would normally go into /usr/local/lib/perl you could set DESTDIR=/tmp/ |
479d2113 |
1373 | and installation would go into /tmp/usr/local/lib/perl. |
1374 | |
1375 | This is primarily of use for people who repackage Perl modules. |
1376 | |
531e2ba1 |
1377 | NOTE: Due to the nature of make, it is important that you put the trailing |
1378 | slash on your DESTDIR. "/tmp/" not "/tmp". |
479d2113 |
1379 | |
864a5fa8 |
1380 | =item DIR |
8e07c86e |
1381 | |
864a5fa8 |
1382 | Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm' |
1383 | ] in ext/SDBM_File |
8e07c86e |
1384 | |
864a5fa8 |
1385 | =item DISTNAME |
8e07c86e |
1386 | |
479d2113 |
1387 | A safe filename for the package. |
1388 | |
1389 | Defaults to NAME above but with :: replaced with -. |
1390 | |
1391 | For example, Foo::Bar becomes Foo-Bar. |
1392 | |
1393 | =item DISTVNAME |
1394 | |
1395 | Your name for distributing the package with the version number |
1396 | included. This is used by 'make dist' to name the resulting archive |
1397 | file. |
1398 | |
1399 | Defaults to DISTNAME-VERSION. |
1400 | |
1401 | For example, version 1.04 of Foo::Bar becomes Foo-Bar-1.04. |
1402 | |
1403 | On some OS's where . has special meaning VERSION_SYM may be used in |
1404 | place of VERSION. |
8e07c86e |
1405 | |
864a5fa8 |
1406 | =item DL_FUNCS |
8e07c86e |
1407 | |
875fa795 |
1408 | Hashref of symbol names for routines to be made available as universal |
1409 | symbols. Each key/value pair consists of the package name and an |
1410 | array of routine names in that package. Used only under AIX, OS/2, |
1411 | VMS and Win32 at present. The routine names supplied will be expanded |
1412 | in the same way as XSUB names are expanded by the XS() macro. |
1413 | Defaults to |
8e07c86e |
1414 | |
864a5fa8 |
1415 | {"$(NAME)" => ["boot_$(NAME)" ] } |
8e07c86e |
1416 | |
864a5fa8 |
1417 | e.g. |
8e07c86e |
1418 | |
864a5fa8 |
1419 | {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )], |
1420 | "NetconfigPtr" => [ 'DESTROY'] } |
8e07c86e |
1421 | |
875fa795 |
1422 | Please see the L<ExtUtils::Mksymlists> documentation for more information |
1423 | about the DL_FUNCS, DL_VARS and FUNCLIST attributes. |
1424 | |
864a5fa8 |
1425 | =item DL_VARS |
8e07c86e |
1426 | |
875fa795 |
1427 | Array of symbol names for variables to be made available as universal symbols. |
1428 | Used only under AIX, OS/2, VMS and Win32 at present. Defaults to []. |
1429 | (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ]) |
8e07c86e |
1430 | |
f1387719 |
1431 | =item EXCLUDE_EXT |
1432 | |
1433 | Array of extension names to exclude when doing a static build. This |
1434 | is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more |
1435 | details. (e.g. [ qw( Socket POSIX ) ] ) |
1436 | |
1437 | This attribute may be most useful when specified as a string on the |
de592821 |
1438 | command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe' |
f1387719 |
1439 | |
864a5fa8 |
1440 | =item EXE_FILES |
8e07c86e |
1441 | |
864a5fa8 |
1442 | Ref to array of executable files. The files will be copied to the |
f1387719 |
1443 | INST_SCRIPT directory. Make realclean will delete them from there |
864a5fa8 |
1444 | again. |
8e07c86e |
1445 | |
2530b651 |
1446 | If your executables start with something like #!perl or |
1447 | #!/usr/bin/perl MakeMaker will change this to the path of the perl |
1448 | 'Makefile.PL' was invoked with so the programs will be sure to run |
1449 | properly even if perl is not in /usr/bin/perl. |
1450 | |
864a5fa8 |
1451 | =item FIRST_MAKEFILE |
1452 | |
479d2113 |
1453 | The name of the Makefile to be produced. This is used for the second |
1454 | Makefile that will be produced for the MAP_TARGET. |
1455 | |
1456 | Defaults to 'Makefile' or 'Descrip.MMS' on VMS. |
1457 | |
1458 | (Note: we couldn't use MAKEFILE because dmake uses this for something |
1459 | else). |
864a5fa8 |
1460 | |
1461 | =item FULLPERL |
8e07c86e |
1462 | |
75e2e551 |
1463 | Perl binary able to run this extension, load XS modules, etc... |
1464 | |
1465 | =item FULLPERLRUN |
1466 | |
1467 | Like PERLRUN, except it uses FULLPERL. |
1468 | |
1469 | =item FULLPERLRUNINST |
1470 | |
1471 | Like PERLRUNINST, except it uses FULLPERL. |
864a5fa8 |
1472 | |
762efda7 |
1473 | =item FUNCLIST |
1474 | |
1475 | This provides an alternate means to specify function names to be |
1476 | exported from the extension. Its value is a reference to an |
1477 | array of function names to be exported by the extension. These |
1478 | names are passed through unaltered to the linker options file. |
1479 | |
864a5fa8 |
1480 | =item H |
1481 | |
1482 | Ref to array of *.h file names. Similar to C. |
1483 | |
84902520 |
1484 | =item IMPORTS |
1485 | |
875fa795 |
1486 | This attribute is used to specify names to be imported into the |
69ff8adf |
1487 | extension. Takes a hash ref. |
1488 | |
1489 | It is only used on OS/2 and Win32. |
84902520 |
1490 | |
864a5fa8 |
1491 | =item INC |
1492 | |
1493 | Include file dirs eg: C<"-I/usr/5include -I/path/to/inc"> |
1494 | |
f1387719 |
1495 | =item INCLUDE_EXT |
1496 | |
1497 | Array of extension names to be included when doing a static build. |
1498 | MakeMaker will normally build with all of the installed extensions when |
1499 | doing a static build, and that is usually the desired behavior. If |
1500 | INCLUDE_EXT is present then MakeMaker will build only with those extensions |
1501 | which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ]) |
1502 | |
1503 | It is not necessary to mention DynaLoader or the current extension when |
1504 | filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then |
1505 | only DynaLoader and the current extension will be included in the build. |
1506 | |
1507 | This attribute may be most useful when specified as a string on the |
de592821 |
1508 | command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek' |
f1387719 |
1509 | |
864a5fa8 |
1510 | =item INSTALLARCHLIB |
1511 | |
e05e23b1 |
1512 | Used by 'make install', which copies files from INST_ARCHLIB to this |
1513 | directory if INSTALLDIRS is set to perl. |
864a5fa8 |
1514 | |
1515 | =item INSTALLBIN |
1516 | |
5c161494 |
1517 | Directory to install binary files (e.g. tkperl) into if |
1518 | INSTALLDIRS=perl. |
e05e23b1 |
1519 | |
1520 | =item INSTALLDIRS |
1521 | |
5c161494 |
1522 | Determines which of the sets of installation directories to choose: |
1523 | perl, site or vendor. Defaults to site. |
8e07c86e |
1524 | |
1525 | =item INSTALLMAN1DIR |
1526 | |
1527 | =item INSTALLMAN3DIR |
1528 | |
5c161494 |
1529 | These directories get the man pages at 'make install' time if |
1530 | INSTALLDIRS=perl. Defaults to $Config{installman*dir}. |
8e07c86e |
1531 | |
5c161494 |
1532 | If set to 'none', no man pages will be installed. |
e0678a30 |
1533 | |
864a5fa8 |
1534 | =item INSTALLPRIVLIB |
8e07c86e |
1535 | |
e05e23b1 |
1536 | Used by 'make install', which copies files from INST_LIB to this |
1537 | directory if INSTALLDIRS is set to perl. |
1538 | |
5c161494 |
1539 | Defaults to $Config{installprivlib}. |
1540 | |
f1387719 |
1541 | =item INSTALLSCRIPT |
1542 | |
1543 | Used by 'make install' which copies files from INST_SCRIPT to this |
1544 | directory. |
1545 | |
875fa795 |
1546 | =item INSTALLSITEARCH |
e05e23b1 |
1547 | |
875fa795 |
1548 | Used by 'make install', which copies files from INST_ARCHLIB to this |
e05e23b1 |
1549 | directory if INSTALLDIRS is set to site (default). |
1550 | |
5c161494 |
1551 | =item INSTALLSITEBIN |
1552 | |
1553 | Used by 'make install', which copies files from INST_BIN to this |
1554 | directory if INSTALLDIRS is set to site (default). |
1555 | |
875fa795 |
1556 | =item INSTALLSITELIB |
e05e23b1 |
1557 | |
875fa795 |
1558 | Used by 'make install', which copies files from INST_LIB to this |
e05e23b1 |
1559 | directory if INSTALLDIRS is set to site (default). |
8e07c86e |
1560 | |
5c161494 |
1561 | =item INSTALLSITEMAN1DIR |
1562 | |
1563 | =item INSTALLSITEMAN3DIR |
1564 | |
1565 | These directories get the man pages at 'make install' time if |
1566 | INSTALLDIRS=site (default). Defaults to |
1567 | $(SITEPREFIX)/man/man$(MAN*EXT). |
1568 | |
1569 | If set to 'none', no man pages will be installed. |
1570 | |
1571 | =item INSTALLVENDORARCH |
1572 | |
1573 | Used by 'make install', which copies files from INST_ARCHLIB to this |
1574 | directory if INSTALLDIRS is set to vendor. |
1575 | |
1576 | =item INSTALLVENDORBIN |
1577 | |
1578 | Used by 'make install', which copies files from INST_BIN to this |
1579 | directory if INSTALLDIRS is set to vendor. |
1580 | |
1581 | =item INSTALLVENDORLIB |
1582 | |
1583 | Used by 'make install', which copies files from INST_LIB to this |
1584 | directory if INSTALLDIRS is set to vendor. |
1585 | |
1586 | =item INSTALLVENDORMAN1DIR |
1587 | |
1588 | =item INSTALLVENDORMAN3DIR |
1589 | |
1590 | These directories get the man pages at 'make install' time if |
1591 | INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT). |
1592 | |
1593 | If set to 'none', no man pages will be installed. |
1594 | |
864a5fa8 |
1595 | =item INST_ARCHLIB |
8e07c86e |
1596 | |
864a5fa8 |
1597 | Same as INST_LIB for architecture dependent files. |
8e07c86e |
1598 | |
f1387719 |
1599 | =item INST_BIN |
1600 | |
1601 | Directory to put real binary files during 'make'. These will be copied |
1602 | to INSTALLBIN during 'make install' |
1603 | |
e35b8f9e |
1604 | =item INST_LIB |
1605 | |
1606 | Directory where we put library files of this extension while building |
1607 | it. |
1608 | |
864a5fa8 |
1609 | =item INST_MAN1DIR |
8e07c86e |
1610 | |
864a5fa8 |
1611 | Directory to hold the man pages at 'make' time |
8e07c86e |
1612 | |
864a5fa8 |
1613 | =item INST_MAN3DIR |
8e07c86e |
1614 | |
864a5fa8 |
1615 | Directory to hold the man pages at 'make' time |
8e07c86e |
1616 | |
f1387719 |
1617 | =item INST_SCRIPT |
1618 | |
1619 | Directory, where executable files should be installed during |
c3fed81c |
1620 | 'make'. Defaults to "./blib/script", just to have a dummy location during |
f1387719 |
1621 | testing. make install will copy the files in INST_SCRIPT to |
1622 | INSTALLSCRIPT. |
1623 | |
479d2113 |
1624 | =item LD |
1625 | |
1626 | Program to be used to link libraries for dynamic loading. |
1627 | |
1628 | Defaults to $Config{ld}. |
1629 | |
a884ca7c |
1630 | =item LDDLFLAGS |
1631 | |
1632 | Any special flags that might need to be passed to ld to create a |
1633 | shared library suitable for dynamic loading. It is up to the makefile |
1634 | to use it. (See L<Config/lddlflags>) |
1635 | |
1636 | Defaults to $Config{lddlflags}. |
1637 | |
864a5fa8 |
1638 | =item LDFROM |
8e07c86e |
1639 | |
69ff8adf |
1640 | Defaults to "$(OBJECT)" and is used in the ld command to specify |
864a5fa8 |
1641 | what files to link/load from (also see dynamic_lib below for how to |
1642 | specify ld flags) |
8e07c86e |
1643 | |
bab2b58e |
1644 | =item LIB |
1645 | |
e35b8f9e |
1646 | LIB should only be set at C<perl Makefile.PL> time but is allowed as a |
f6d6199c |
1647 | MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB |
1648 | and INSTALLSITELIB to that value regardless any explicit setting of |
1649 | those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH |
1650 | are set to the corresponding architecture subdirectory. |
bab2b58e |
1651 | |
762efda7 |
1652 | =item LIBPERL_A |
1653 | |
1654 | The filename of the perllibrary that will be used together with this |
1655 | extension. Defaults to libperl.a. |
1656 | |
8e07c86e |
1657 | =item LIBS |
1658 | |
1659 | An anonymous array of alternative library |
1660 | specifications to be searched for (in order) until |
864a5fa8 |
1661 | at least one library is found. E.g. |
8e07c86e |
1662 | |
1663 | 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"] |
1664 | |
1665 | Mind, that any element of the array |
1666 | contains a complete set of arguments for the ld |
1667 | command. So do not specify |
1668 | |
1669 | 'LIBS' => ["-ltcl", "-ltk", "-lX11"] |
1670 | |
1671 | See ODBM_File/Makefile.PL for an example, where an array is needed. If |
1672 | you specify a scalar as in |
1673 | |
1674 | 'LIBS' => "-ltcl -ltk -lX11" |
1675 | |
1676 | MakeMaker will turn it into an array with one element. |
1677 | |
864a5fa8 |
1678 | =item LINKTYPE |
8e07c86e |
1679 | |
e05e23b1 |
1680 | 'static' or 'dynamic' (default unless usedl=undef in |
1681 | config.sh). Should only be used to force static linking (also see |
864a5fa8 |
1682 | linkext below). |
8e07c86e |
1683 | |
864a5fa8 |
1684 | =item MAKEAPERL |
8e07c86e |
1685 | |
864a5fa8 |
1686 | Boolean which tells MakeMaker, that it should include the rules to |
1687 | make a perl. This is handled automatically as a switch by |
1688 | MakeMaker. The user normally does not need it. |
8e07c86e |
1689 | |
479d2113 |
1690 | =item MAKEFILE_OLD |
1691 | |
1692 | When 'make clean' or similar is run, the $(FIRST_MAKEFILE) will be |
1693 | backed up at this location. |
8e07c86e |
1694 | |
479d2113 |
1695 | Defaults to $(FIRST_MAKEFILE).old or $(FIRST_MAKEFILE)_old on VMS. |
8e07c86e |
1696 | |
864a5fa8 |
1697 | =item MAN1PODS |
8e07c86e |
1698 | |
864a5fa8 |
1699 | Hashref of pod-containing files. MakeMaker will default this to all |
1700 | EXE_FILES files that include POD directives. The files listed |
1701 | here will be converted to man pages and installed as was requested |
1702 | at Configure time. |
8e07c86e |
1703 | |
864a5fa8 |
1704 | =item MAN3PODS |
8e07c86e |
1705 | |
bfa2a9ad |
1706 | Hashref that assigns to *.pm and *.pod files the files into which the |
1707 | manpages are to be written. MakeMaker parses all *.pod and *.pm files |
1708 | for POD directives. Files that contain POD will be the default keys of |
1709 | the MAN3PODS hashref. These will then be converted to man pages during |
1710 | C<make> and will be installed during C<make install>. |
8e07c86e |
1711 | |
864a5fa8 |
1712 | =item MAP_TARGET |
8e07c86e |
1713 | |
864a5fa8 |
1714 | If it is intended, that a new perl binary be produced, this variable |
1715 | may hold a name for that binary. Defaults to perl |
8e07c86e |
1716 | |
864a5fa8 |
1717 | =item MYEXTLIB |
4633a7c4 |
1718 | |
864a5fa8 |
1719 | If the extension links to a library that it builds set this to the |
1720 | name of the library (see SDBM_File) |
4633a7c4 |
1721 | |
864a5fa8 |
1722 | =item NAME |
8e07c86e |
1723 | |
864a5fa8 |
1724 | Perl module name for this extension (DBD::Oracle). This will default |
1725 | to the directory name but should be explicitly defined in the |
1726 | Makefile.PL. |
8e07c86e |
1727 | |
864a5fa8 |
1728 | =item NEEDS_LINKING |
8e07c86e |
1729 | |
a7665c5e |
1730 | MakeMaker will figure out if an extension contains linkable code |
864a5fa8 |
1731 | anywhere down the directory tree, and will set this variable |
a7665c5e |
1732 | accordingly, but you can speed it up a very little bit if you define |
864a5fa8 |
1733 | this boolean variable yourself. |
8e07c86e |
1734 | |
e05e23b1 |
1735 | =item NOECHO |
1736 | |
479d2113 |
1737 | Command so make does not print the literal commands its running. |
1738 | |
1739 | By setting it to an empty string you can generate a Makefile that |
1740 | prints all commands. Mainly used in debugging MakeMaker itself. |
1741 | |
1742 | Defaults to C<@>. |
e05e23b1 |
1743 | |
864a5fa8 |
1744 | =item NORECURS |
8e07c86e |
1745 | |
e05e23b1 |
1746 | Boolean. Attribute to inhibit descending into subdirectories. |
8e07c86e |
1747 | |
1df8d179 |
1748 | =item NO_META |
1749 | |
1750 | When true, suppresses the generation and addition to the MANIFEST of |
1751 | the META.yml module meta-data file during 'make distdir'. |
1752 | |
1753 | Defaults to false. |
1754 | |
762efda7 |
1755 | =item NO_VC |
1756 | |
a7665c5e |
1757 | In general, any generated Makefile checks for the current version of |
762efda7 |
1758 | MakeMaker and the version the Makefile was built under. If NO_VC is |
1759 | set, the version check is neglected. Do not write this into your |
1760 | Makefile.PL, use it interactively instead. |
1761 | |
864a5fa8 |
1762 | =item OBJECT |
8e07c86e |
1763 | |
864a5fa8 |
1764 | List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long |
1765 | string containing all object files, e.g. "tkpBind.o |
1766 | tkpButton.o tkpCanvas.o" |
8e07c86e |
1767 | |
e35b8f9e |
1768 | (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.) |
1769 | |
3b03c0f3 |
1770 | =item OPTIMIZE |
1771 | |
1772 | Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is |
1773 | passed to subdirectory makes. |
1774 | |
864a5fa8 |
1775 | =item PERL |
8e07c86e |
1776 | |
864a5fa8 |
1777 | Perl binary for tasks that can be done by miniperl |
8e07c86e |
1778 | |
da7f727a |
1779 | =item PERL_CORE |
1780 | |
1781 | Set only when MakeMaker is building the extensions of the Perl core |
1782 | distribution. |
1783 | |
864a5fa8 |
1784 | =item PERLMAINCC |
005c1a0e |
1785 | |
864a5fa8 |
1786 | The call to the program that is able to compile perlmain.c. Defaults |
1787 | to $(CC). |
005c1a0e |
1788 | |
864a5fa8 |
1789 | =item PERL_ARCHLIB |
005c1a0e |
1790 | |
da7f727a |
1791 | Same as for PERL_LIB, but for architecture dependent files. |
1792 | |
1793 | Used only when MakeMaker is building the extensions of the Perl core |
1794 | distribution (because normally $(PERL_ARCHLIB) is automatically in @INC, |
1795 | and adding it would get in the way of PERL5LIB). |
8e07c86e |
1796 | |
864a5fa8 |
1797 | =item PERL_LIB |
8e07c86e |
1798 | |
864a5fa8 |
1799 | Directory containing the Perl library to use. |
8e07c86e |
1800 | |
da7f727a |
1801 | Used only when MakeMaker is building the extensions of the Perl core |
1802 | distribution (because normally $(PERL_LIB) is automatically in @INC, |
1803 | and adding it would get in the way of PERL5LIB). |
1804 | |
e35b8f9e |
1805 | =item PERL_MALLOC_OK |
1806 | |
1807 | defaults to 0. Should be set to TRUE if the extension can work with |
1808 | the memory allocation routines substituted by the Perl malloc() subsystem. |
1809 | This should be applicable to most extensions with exceptions of those |
1810 | |
1811 | =over 4 |
1812 | |
1813 | =item * |
1814 | |
1815 | with bugs in memory allocations which are caught by Perl's malloc(); |
1816 | |
1817 | =item * |
1818 | |
1819 | which interact with the memory allocator in other ways than via |
1820 | malloc(), realloc(), free(), calloc(), sbrk() and brk(); |
1821 | |
1822 | =item * |
1823 | |
1824 | which rely on special alignment which is not provided by Perl's malloc(). |
1825 | |
1826 | =back |
1827 | |
1828 | B<NOTE.> Negligence to set this flag in I<any one> of loaded extension |
1829 | nullifies many advantages of Perl's malloc(), such as better usage of |
1830 | system resources, error detection, memory usage reporting, catchable failure |
1831 | of memory allocations, etc. |
1832 | |
479d2113 |
1833 | =item PERLPREFIX |
1834 | |
1835 | Directory under which core modules are to be installed. |
1836 | |
1837 | Defaults to $Config{installprefixexp} falling back to |
1838 | $Config{installprefix}, $Config{prefixexp} or $Config{prefix} should |
1839 | $Config{installprefixexp} not exist. |
1840 | |
1841 | Overridden by PREFIX. |
1842 | |
da7f727a |
1843 | =item PERLRUN |
1844 | |
75e2e551 |
1845 | Use this instead of $(PERL) when you wish to run perl. It will set up |
1846 | extra necessary flags for you. |
f6d6199c |
1847 | |
ffbaec2a |
1848 | =item PERLRUNINST |
f6d6199c |
1849 | |
75e2e551 |
1850 | Use this instead of $(PERL) when you wish to run perl to work with |
1851 | modules. It will add things like -I$(INST_ARCH) and other necessary |
1852 | flags so perl can see the modules you're about to install. |
f6d6199c |
1853 | |
864a5fa8 |
1854 | =item PERL_SRC |
8e07c86e |
1855 | |
864a5fa8 |
1856 | Directory containing the Perl source code (use of this should be |
1857 | avoided, it may be undefined) |
8e07c86e |
1858 | |
2366100d |
1859 | =item PERM_RW |
1860 | |
de592821 |
1861 | Desired permission for read/writable files. Defaults to C<644>. |
2366100d |
1862 | See also L<MM_Unix/perm_rw>. |
1863 | |
1864 | =item PERM_RWX |
1865 | |
1866 | Desired permission for executable files. Defaults to C<755>. |
1867 | See also L<MM_Unix/perm_rwx>. |
1868 | |
864a5fa8 |
1869 | =item PL_FILES |
8e07c86e |
1870 | |
864a5fa8 |
1871 | Ref to hash of files to be processed as perl programs. MakeMaker |
1872 | will default to any found *.PL file (except Makefile.PL) being keys |
1873 | and the basename of the file being the value. E.g. |
8e07c86e |
1874 | |
864a5fa8 |
1875 | {'foobar.PL' => 'foobar'} |
8e07c86e |
1876 | |
864a5fa8 |
1877 | The *.PL files are expected to produce output to the target files |
3aa35033 |
1878 | themselves. If multiple files can be generated from the same *.PL |
1879 | file then the value in the hash can be a reference to an array of |
1880 | target file names. E.g. |
1881 | |
1882 | {'foobar.PL' => ['foobar1','foobar2']} |
8e07c86e |
1883 | |
864a5fa8 |
1884 | =item PM |
8e07c86e |
1885 | |
864a5fa8 |
1886 | Hashref of .pm files and *.pl files to be installed. e.g. |
8e07c86e |
1887 | |
864a5fa8 |
1888 | {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'} |
8e07c86e |
1889 | |
a3cb178b |
1890 | By default this will include *.pm and *.pl and the files found in |
1891 | the PMLIBDIRS directories. Defining PM in the |
864a5fa8 |
1892 | Makefile.PL will override PMLIBDIRS. |
8e07c86e |
1893 | |
864a5fa8 |
1894 | =item PMLIBDIRS |
8e07c86e |
1895 | |
864a5fa8 |
1896 | Ref to array of subdirectories containing library files. Defaults to |
a3cb178b |
1897 | [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files |
864a5fa8 |
1898 | they contain will be installed in the corresponding location in the |
1899 | library. A libscan() method can be used to alter the behaviour. |
1900 | Defining PM in the Makefile.PL will override PMLIBDIRS. |
8e07c86e |
1901 | |
e35b8f9e |
1902 | (Where BASEEXT is the last component of NAME.) |
1903 | |
131aa089 |
1904 | =item PM_FILTER |
1905 | |
1906 | A filter program, in the traditional Unix sense (input from stdin, output |
1907 | to stdout) that is passed on each .pm file during the build (in the |
1908 | pm_to_blib() phase). It is empty by default, meaning no filtering is done. |
1909 | |
1910 | Great care is necessary when defining the command if quoting needs to be |
1911 | done. For instance, you would need to say: |
1912 | |
1913 | {'PM_FILTER' => 'grep -v \\"^\\#\\"'} |
1914 | |
1915 | to remove all the leading coments on the fly during the build. The |
1916 | extra \\ are necessary, unfortunately, because this variable is interpolated |
1917 | within the context of a Perl program built on the command line, and double |
1918 | quotes are what is used with the -e switch to build that command line. The |
1919 | # is escaped for the Makefile, since what is going to be generated will then |
1920 | be: |
1921 | |
1922 | PM_FILTER = grep -v \"^\#\" |
1923 | |
1924 | Without the \\ before the #, we'd have the start of a Makefile comment, |
1925 | and the macro would be incorrectly defined. |
1926 | |
2aea4d40 |
1927 | =item POLLUTE |
1928 | |
1929 | Release 5.005 grandfathered old global symbol names by providing preprocessor |
a7665c5e |
1930 | macros for extension source compatibility. As of release 5.6, these |
2aea4d40 |
1931 | preprocessor definitions are not available by default. The POLLUTE flag |
1932 | specifies that the old names should still be defined: |
1933 | |
1934 | perl Makefile.PL POLLUTE=1 |
1935 | |
1936 | Please inform the module author if this is necessary to successfully install |
a7665c5e |
1937 | a module under 5.6 or later. |
2aea4d40 |
1938 | |
875fa795 |
1939 | =item PPM_INSTALL_EXEC |
1940 | |
20e08411 |
1941 | Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl) |
875fa795 |
1942 | |
1943 | =item PPM_INSTALL_SCRIPT |
1944 | |
1945 | Name of the script that gets executed by the Perl Package Manager after |
1946 | the installation of a package. |
1947 | |
864a5fa8 |
1948 | =item PREFIX |
8e07c86e |
1949 | |
f6d6199c |
1950 | This overrides all the default install locations. Man pages, |
1951 | libraries, scripts, etc... MakeMaker will try to make an educated |
1952 | guess about where to place things under the new PREFIX based on your |
1953 | Config defaults. Failing that, it will fall back to a structure |
1954 | which should be sensible for your platform. |
1955 | |
1956 | If you specify LIB or any INSTALL* variables they will not be effected |
1957 | by the PREFIX. |
a4260cbc |
1958 | |
b2340c53 |
1959 | =item PREREQ_FATAL |
1960 | |
1961 | Bool. If this parameter is true, failing to have the required modules |
1962 | (or the right versions thereof) will be fatal. perl Makefile.PL will die |
1963 | with the proper message. |
1964 | |
1965 | Note: see L<Test::Harness> for a shortcut for stopping tests early if |
1966 | you are missing dependencies. |
1967 | |
1968 | Do I<not> use this parameter for simple requirements, which could be resolved |
1969 | at a later time, e.g. after an unsuccessful B<make test> of your module. |
1970 | |
1971 | It is I<extremely> rare to have to use C<PREREQ_FATAL> at all! |
1972 | |
d5d4ec93 |
1973 | =item PREREQ_PM |
1974 | |
1975 | Hashref: Names of modules that need to be available to run this |
1976 | extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the |
1977 | desired version is the value. If the required version number is 0, we |
1978 | only check if any version is installed already. |
1979 | |
88d69b28 |
1980 | =item PREREQ_PRINT |
1981 | |
1982 | Bool. If this parameter is true, the prerequisites will be printed to |
2c91f887 |
1983 | stdout and MakeMaker will exit. The output format is an evalable hash |
1984 | ref. |
88d69b28 |
1985 | |
1986 | $PREREQ_PM = { |
1987 | 'A::B' => Vers1, |
1988 | 'C::D' => Vers2, |
1989 | ... |
1990 | }; |
1991 | |
1992 | =item PRINT_PREREQ |
1993 | |
1994 | RedHatism for C<PREREQ_PRINT>. The output format is different, though: |
1995 | |
1996 | perl(A::B)>=Vers1 perl(C::D)>=Vers2 ... |
1997 | |
5c161494 |
1998 | =item SITEPREFIX |
1999 | |
479d2113 |
2000 | Like PERLPREFIX, but only for the site install locations. |
2001 | |
2002 | Defaults to $Config{siteprefixexp}. Perls prior to 5.6.0 didn't have |
2003 | an explicit siteprefix in the Config. In those cases |
2004 | $Config{installprefix} will be used. |
5c161494 |
2005 | |
479d2113 |
2006 | Overridable by PREFIX |
5c161494 |
2007 | |
bb68fe9e |
2008 | =item SIGN |
2009 | |
2010 | When true, perform the generation and addition to the MANIFEST of |
2011 | the SIGNATURE file during 'make distdir', via 'cpansign -s'. |
2012 | |
2013 | Note that you need to install the Module::Signature module to |
2014 | perform this operation. |
2015 | |
2016 | Defaults to false. |
2017 | |
864a5fa8 |
2018 | =item SKIP |
8e07c86e |
2019 | |
da7f727a |
2020 | Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the |
a7665c5e |
2021 | Makefile. Caution! Do not use the SKIP attribute for the negligible |
2022 | speedup. It may seriously damage the resulting Makefile. Only use it |
f1387719 |
2023 | if you really need it. |
8e07c86e |
2024 | |
864a5fa8 |
2025 | =item TYPEMAPS |
8e07c86e |
2026 | |
864a5fa8 |
2027 | Ref to array of typemap file names. Use this when the typemaps are |
2028 | in some directory other than the current directory or when they are |
2029 | not named B<typemap>. The last typemap in the list takes |
2030 | precedence. A typemap in the current directory has highest |
2031 | precedence, even if it isn't listed in TYPEMAPS. The default system |
2032 | typemap has lowest precedence. |
8e07c86e |
2033 | |
5c161494 |
2034 | =item VENDORPREFIX |
2035 | |
479d2113 |
2036 | Like PERLPREFIX, but only for the vendor install locations. |
2037 | |
2038 | Defaults to $Config{vendorprefixexp}. |
5c161494 |
2039 | |
479d2113 |
2040 | Overridable by PREFIX |
5c161494 |
2041 | |
45bc4d3a |
2042 | =item VERBINST |
2043 | |
2044 | If true, make install will be verbose |
2045 | |
864a5fa8 |
2046 | =item VERSION |
8e07c86e |
2047 | |
864a5fa8 |
2048 | Your version number for distributing the package. This defaults to |
2049 | 0.1. |
8e07c86e |
2050 | |
0d8023a2 |
2051 | =item VERSION_FROM |
2052 | |
2053 | Instead of specifying the VERSION in the Makefile.PL you can let |
2054 | MakeMaker parse a file to determine the version number. The parsing |
2055 | routine requires that the file named by VERSION_FROM contains one |
2056 | single line to compute the version number. The first line in the file |
2057 | that contains the regular expression |
2058 | |
84902520 |
2059 | /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/ |
0d8023a2 |
2060 | |
2061 | will be evaluated with eval() and the value of the named variable |
2062 | B<after> the eval() will be assigned to the VERSION attribute of the |
2063 | MakeMaker object. The following lines will be parsed o.k.: |
2064 | |
2065 | $VERSION = '1.00'; |
84902520 |
2066 | *VERSION = \'1.01'; |
af7522e5 |
2067 | $VERSION = sprintf "%d.%03d", q$Revision: 1.144 $ =~ /(\d+)/g; |
0d8023a2 |
2068 | $FOO::VERSION = '1.10'; |
84902520 |
2069 | *FOO::VERSION = \'1.11'; |
f6d6199c |
2070 | our $VERSION = 1.2.3; # new for perl5.6.0 |
0d8023a2 |
2071 | |
2072 | but these will fail: |
2073 | |
2074 | my $VERSION = '1.01'; |
2075 | local $VERSION = '1.02'; |
2076 | local $FOO::VERSION = '1.30'; |
2077 | |
e35b8f9e |
2078 | (Putting C<my> or C<local> on the preceding line will work o.k.) |
2079 | |
84902520 |
2080 | The file named in VERSION_FROM is not added as a dependency to |
2081 | Makefile. This is not really correct, but it would be a major pain |
2082 | during development to have to rewrite the Makefile for any smallish |
2083 | change in that file. If you want to make sure that the Makefile |
2084 | contains the correct VERSION macro after any change of the file, you |
2085 | would have to do something like |
2086 | |
2087 | depend => { Makefile => '$(VERSION_FROM)' } |
2088 | |
2089 | See attribute C<depend> below. |
0d8023a2 |
2090 | |
479d2113 |
2091 | =item VERSION_SYM |
2092 | |
2093 | A sanitized VERSION with . replaced by _. For places where . has |
2094 | special meaning (some filesystems, RCS labels, etc...) |
2095 | |
864a5fa8 |
2096 | =item XS |
8e07c86e |
2097 | |
864a5fa8 |
2098 | Hashref of .xs files. MakeMaker will default this. e.g. |
8e07c86e |
2099 | |
864a5fa8 |
2100 | {'name_of_file.xs' => 'name_of_file.c'} |
8e07c86e |
2101 | |
864a5fa8 |
2102 | The .c files will automatically be included in the list of files |
2103 | deleted by a make clean. |
4633a7c4 |
2104 | |
864a5fa8 |
2105 | =item XSOPT |
8e07c86e |
2106 | |
864a5fa8 |
2107 | String of options to pass to xsubpp. This might include C<-C++> or |
2108 | C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for |
2109 | that purpose. |
8e07c86e |
2110 | |
864a5fa8 |
2111 | =item XSPROTOARG |
4633a7c4 |
2112 | |
4e68a208 |
2113 | May be set to an empty string, which is identical to C<-prototypes>, or |
864a5fa8 |
2114 | C<-noprototypes>. See the xsubpp documentation for details. MakeMaker |
4e68a208 |
2115 | defaults to the empty string. |
2116 | |
0d8023a2 |
2117 | =item XS_VERSION |
2118 | |
2119 | Your version number for the .xs file of this package. This defaults |
2120 | to the value of the VERSION attribute. |
2121 | |
8e07c86e |
2122 | =back |
2123 | |
2124 | =head2 Additional lowercase attributes |
2125 | |
2126 | can be used to pass parameters to the methods which implement that |
531e2ba1 |
2127 | part of the Makefile. Parameters are specified as a hash ref but are |
2128 | passed to the method as a hash. |
8e07c86e |
2129 | |
2130 | =over 2 |
2131 | |
864a5fa8 |
2132 | =item clean |
8e07c86e |
2133 | |
864a5fa8 |
2134 | {FILES => "*.xyz foo"} |
2135 | |
c07a80fd |
2136 | =item depend |
2137 | |
2138 | {ANY_TARGET => ANY_DEPENDECY, ...} |
2139 | |
e35b8f9e |
2140 | (ANY_TARGET must not be given a double-colon rule by MakeMaker.) |
2141 | |
864a5fa8 |
2142 | =item dist |
2143 | |
5f8e730b |
2144 | {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz', |
3b03c0f3 |
2145 | SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip', |
f1387719 |
2146 | ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' } |
864a5fa8 |
2147 | |
2148 | If you specify COMPRESS, then SUFFIX should also be altered, as it is |
2149 | needed to tell make the target file of the compression. Setting |
2150 | DIST_CP to ln can be useful, if you need to preserve the timestamps on |
2151 | your files. DIST_CP can take the values 'cp', which copies the file, |
2152 | 'ln', which links the file, and 'best' which copies symbolic links and |
2153 | links the rest. Default is 'best'. |
2154 | |
2155 | =item dynamic_lib |
2156 | |
0d8023a2 |
2157 | {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'} |
8e07c86e |
2158 | |
8e07c86e |
2159 | =item linkext |
2160 | |
2161 | {LINKTYPE => 'static', 'dynamic' or ''} |
2162 | |
864a5fa8 |
2163 | NB: Extensions that have nothing but *.pm files had to say |
8e07c86e |
2164 | |
2165 | {LINKTYPE => ''} |
2166 | |
864a5fa8 |
2167 | with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line |
a7665c5e |
2168 | can be deleted safely. MakeMaker recognizes when there's nothing to |
864a5fa8 |
2169 | be linked. |
8e07c86e |
2170 | |
864a5fa8 |
2171 | =item macro |
8e07c86e |
2172 | |
864a5fa8 |
2173 | {ANY_MACRO => ANY_VALUE, ...} |
8e07c86e |
2174 | |
531e2ba1 |
2175 | =item postamble |
2176 | |
2177 | Anything put here will be passed to MY::postamble() if you have one. |
2178 | |
8e07c86e |
2179 | =item realclean |
2180 | |
2181 | {FILES => '$(INST_ARCHAUTODIR)/*.xyz'} |
2182 | |
f2f614a6 |
2183 | =item test |
2184 | |
2185 | {TESTS => 't/*.t'} |
2186 | |
8e07c86e |
2187 | =item tool_autosplit |
2188 | |
f2f614a6 |
2189 | {MAXLEN => 8} |
005c1a0e |
2190 | |
2191 | =back |
2192 | |
2193 | =head2 Overriding MakeMaker Methods |
2194 | |
2195 | If you cannot achieve the desired Makefile behaviour by specifying |
2196 | attributes you may define private subroutines in the Makefile.PL. |
e0678a30 |
2197 | Each subroutine returns the text it wishes to have written to |
005c1a0e |
2198 | the Makefile. To override a section of the Makefile you can |
2199 | either say: |
2200 | |
f6d6199c |
2201 | sub MY::c_o { "new literal text" } |
005c1a0e |
2202 | |
2203 | or you can edit the default by saying something like: |
2204 | |
e0678a30 |
2205 | package MY; # so that "SUPER" works right |
2206 | sub c_o { |
f6d6199c |
2207 | my $inherited = shift->SUPER::c_o(@_); |
2208 | $inherited =~ s/old text/new text/; |
2209 | $inherited; |
2210 | } |
8e07c86e |
2211 | |
bdda3fbd |
2212 | If you are running experiments with embedding perl as a library into |
2213 | other applications, you might find MakeMaker is not sufficient. You'd |
2214 | better have a look at ExtUtils::Embed which is a collection of utilities |
2215 | for embedding. |
005c1a0e |
2216 | |
2217 | If you still need a different solution, try to develop another |
bdda3fbd |
2218 | subroutine that fits your needs and submit the diffs to |
a7d1454b |
2219 | C<makemaker@perl.org> |
005c1a0e |
2220 | |
e0678a30 |
2221 | For a complete description of all MakeMaker methods see |
2222 | L<ExtUtils::MM_Unix>. |
3b03c0f3 |
2223 | |
2224 | Here is a simple example of how to add a new target to the generated |
2225 | Makefile: |
2226 | |
2227 | sub MY::postamble { |
e0678a30 |
2228 | return <<'MAKE_FRAG'; |
3b03c0f3 |
2229 | $(MYEXTLIB): sdbm/Makefile |
f6d6199c |
2230 | cd sdbm && $(MAKE) all |
e0678a30 |
2231 | |
2232 | MAKE_FRAG |
3b03c0f3 |
2233 | } |
2234 | |
a884ca7c |
2235 | =head2 The End Of Cargo Cult Programming |
2236 | |
2237 | WriteMakefile() now does some basic sanity checks on its parameters to |
2238 | protect against typos and malformatted values. This means some things |
2239 | which happened to work in the past will now throw warnings and |
2240 | possibly produce internal errors. |
2241 | |
2242 | Some of the most common mistakes: |
2243 | |
2244 | =over 2 |
2245 | |
2246 | =item C<<MAN3PODS => ' '>> |
2247 | |
2248 | This is commonly used to supress the creation of man pages. MAN3PODS |
2249 | takes a hash ref not a string, but the above worked by accident in old |
2250 | versions of MakeMaker. |
2251 | |
2252 | The correct code is C<<MAN3PODS => { }>>. |
2253 | |
2254 | =back |
2255 | |
3b03c0f3 |
2256 | |
f1387719 |
2257 | =head2 Hintsfile support |
2258 | |
2259 | MakeMaker.pm uses the architecture specific information from |
2260 | Config.pm. In addition it evaluates architecture specific hints files |
2261 | in a C<hints/> directory. The hints files are expected to be named |
2262 | like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file |
2263 | name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by |
2264 | MakeMaker within the WriteMakefile() subroutine, and can be used to |
2265 | execute commands as well as to include special variables. The rules |
2266 | which hintsfile is chosen are the same as in Configure. |
2267 | |
2268 | The hintsfile is eval()ed immediately after the arguments given to |
2269 | WriteMakefile are stuffed into a hash reference $self but before this |
2270 | reference becomes blessed. So if you want to do the equivalent to |
2271 | override or create an attribute you would say something like |
2272 | |
2273 | $self->{LIBS} = ['-ldbm -lucb -lc']; |
2274 | |
005c1a0e |
2275 | =head2 Distribution Support |
2276 | |
2277 | For authors of extensions MakeMaker provides several Makefile |
2278 | targets. Most of the support comes from the ExtUtils::Manifest module, |
2279 | where additional documentation can be found. |
2280 | |
2281 | =over 4 |
2282 | |
2283 | =item make distcheck |
8e07c86e |
2284 | |
005c1a0e |
2285 | reports which files are below the build directory but not in the |
2286 | MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for |
2287 | details) |
2288 | |
4633a7c4 |
2289 | =item make skipcheck |
2290 | |
2291 | reports which files are skipped due to the entries in the |
2292 | C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for |
2293 | details) |
2294 | |
005c1a0e |
2295 | =item make distclean |
8e07c86e |
2296 | |
005c1a0e |
2297 | does a realclean first and then the distcheck. Note that this is not |
a7665c5e |
2298 | needed to build a new distribution as long as you are sure that the |
005c1a0e |
2299 | MANIFEST file is ok. |
2300 | |
2301 | =item make manifest |
8e07c86e |
2302 | |
005c1a0e |
2303 | rewrites the MANIFEST file, adding all remaining files found (See |
2304 | ExtUtils::Manifest::mkmanifest() for details) |
2305 | |
2306 | =item make distdir |
8e07c86e |
2307 | |
005c1a0e |
2308 | Copies all the files that are in the MANIFEST file to a newly created |
2309 | directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory |
2310 | exists, it will be removed first. |
2311 | |
1df8d179 |
2312 | Additionally, it will create a META.yml module meta-data file and add |
2313 | this to your MANFIEST. You can shut this behavior off with the NO_META |
2314 | flag. |
2315 | |
f6d6199c |
2316 | =item make disttest |
8e07c86e |
2317 | |
2318 | Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and |
4633a7c4 |
2319 | a make test in that directory. |
8e07c86e |
2320 | |
005c1a0e |
2321 | =item make tardist |
8e07c86e |
2322 | |
3b03c0f3 |
2323 | First does a distdir. Then a command $(PREOP) which defaults to a null |
f1387719 |
2324 | command, followed by $(TOUNIX), which defaults to a null command under |
2325 | UNIX, and will convert files in distribution directory to UNIX format |
2326 | otherwise. Next it runs C<tar> on that directory into a tarfile and |
3b03c0f3 |
2327 | deletes the directory. Finishes with a command $(POSTOP) which |
2328 | defaults to a null command. |
005c1a0e |
2329 | |
2330 | =item make dist |
8e07c86e |
2331 | |
005c1a0e |
2332 | Defaults to $(DIST_DEFAULT) which in turn defaults to tardist. |
2333 | |
2334 | =item make uutardist |
8e07c86e |
2335 | |
005c1a0e |
2336 | Runs a tardist first and uuencodes the tarfile. |
2337 | |
2338 | =item make shdist |
8e07c86e |
2339 | |
3b03c0f3 |
2340 | First does a distdir. Then a command $(PREOP) which defaults to a null |
2341 | command. Next it runs C<shar> on that directory into a sharfile and |
2342 | deletes the intermediate directory again. Finishes with a command |
2343 | $(POSTOP) which defaults to a null command. Note: For shdist to work |
2344 | properly a C<shar> program that can handle directories is mandatory. |
2345 | |
2346 | =item make zipdist |
2347 | |
2348 | First does a distdir. Then a command $(PREOP) which defaults to a null |
2349 | command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a |
2350 | zipfile. Then deletes that directory. Finishes with a command |
2351 | $(POSTOP) which defaults to a null command. |
005c1a0e |
2352 | |
2353 | =item make ci |
8e07c86e |
2354 | |
2355 | Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file. |
2356 | |
2357 | =back |
005c1a0e |
2358 | |
2359 | Customization of the dist targets can be done by specifying a hash |
2360 | reference to the dist attribute of the WriteMakefile call. The |
2361 | following parameters are recognized: |
2362 | |
8e07c86e |
2363 | CI ('ci -u') |
5f8e730b |
2364 | COMPRESS ('gzip --best') |
005c1a0e |
2365 | POSTOP ('@ :') |
8e07c86e |
2366 | PREOP ('@ :') |
f1387719 |
2367 | TO_UNIX (depends on the system) |
8e07c86e |
2368 | RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):') |
2369 | SHAR ('shar') |
5f8e730b |
2370 | SUFFIX ('.gz') |
8e07c86e |
2371 | TAR ('tar') |
2372 | TARFLAGS ('cvf') |
3b03c0f3 |
2373 | ZIP ('zip') |
2374 | ZIPFLAGS ('-r') |
005c1a0e |
2375 | |
2376 | An example: |
2377 | |
5f8e730b |
2378 | WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" }) |
005c1a0e |
2379 | |
1df8d179 |
2380 | |
2381 | =head2 Module Meta-Data |
2382 | |
2383 | Long plaguing users of MakeMaker based modules has been the problem of |
2384 | getting basic information about the module out of the sources |
2385 | I<without> running the F<Makefile.PL> and doing a bunch of messy |
2386 | heuristics on the resulting F<Makefile>. To this end a simple module |
2387 | meta-data file has been introduced, F<META.yml>. |
2388 | |
2389 | F<META.yml> is a YAML document (see http://www.yaml.org) containing |
2390 | basic information about the module (name, version, prerequisites...) |
2391 | in an easy to read format. The format is developed and defined by the |
64964e6d |
2392 | Module::Build developers (see |
2393 | http://module-build.sourceforge.net/META-spec.html) |
1df8d179 |
2394 | |
2395 | MakeMaker will automatically generate a F<META.yml> file for you and |
2396 | add it to your F<MANIFEST> as part of the 'distdir' target (and thus |
2397 | the 'dist' target). This is intended to seamlessly and rapidly |
2398 | populate CPAN with module meta-data. If you wish to shut this feature |
2399 | off, set the C<NO_META> C<WriteMakefile()> flag to true. |
2400 | |
2401 | |
1b171b8d |
2402 | =head2 Disabling an extension |
2403 | |
2404 | If some events detected in F<Makefile.PL> imply that there is no way |
2405 | to create the Module, but this is a normal state of things, then you |
2406 | can create a F<Makefile> which does nothing, but succeeds on all the |
2407 | "usual" build targets. To do so, use |
2408 | |
2409 | ExtUtils::MakeMaker::WriteEmptyMakefile(); |
2410 | |
2411 | instead of WriteMakefile(). |
2412 | |
2413 | This may be useful if other modules expect this module to be I<built> |
2414 | OK, as opposed to I<work> OK (say, this system-dependent module builds |
2415 | in a subdirectory of some other distribution, or is listed as a |
2416 | dependency in a CPAN::Bundle, but the functionality is supported by |
2417 | different means on the current architecture). |
2418 | |
479d2113 |
2419 | =head2 Other Handy Functions |
2420 | |
2421 | =over 4 |
2422 | |
2423 | =item prompt |
2424 | |
2425 | my $value = prompt($message); |
2426 | my $value = prompt($message, $default); |
2427 | |
2428 | The C<prompt()> function provides an easy way to request user input |
2429 | used to write a makefile. It displays the $message as a prompt for |
2430 | input. If a $default is provided it will be used as a default. The |
2431 | function returns the $value selected by the user. |
2432 | |
2433 | If C<prompt()> detects that it is not running interactively and there |
2434 | is nothing on STDIN or if the PERL_MM_USE_DEFAULT environment variable |
2435 | is set to true, the $default will be used without prompting. This |
2436 | prevents automated processes from blocking on user input. |
2437 | |
2438 | If no $default is provided an empty string will be used instead. |
2439 | |
2440 | =back |
2441 | |
2442 | |
6ce21ffa |
2443 | =head1 ENVIRONMENT |
2444 | |
479d2113 |
2445 | =over 4 |
6ce21ffa |
2446 | |
2443aee5 |
2447 | =item PERL_MM_OPT |
6ce21ffa |
2448 | |
2449 | Command line options used by C<MakeMaker-E<gt>new()>, and thus by |
2450 | C<WriteMakefile()>. The string is split on whitespace, and the result |
2451 | is processed before any actual command line arguments are processed. |
2452 | |
9d05ba64 |
2453 | =item PERL_MM_USE_DEFAULT |
2454 | |
2455 | If set to a true value then MakeMaker's prompt function will |
2456 | always return the default without waiting for user input. |
2457 | |
6ce21ffa |
2458 | =back |
2459 | |
f1387719 |
2460 | =head1 SEE ALSO |
2461 | |
f6d6199c |
2462 | ExtUtils::MM_Unix, ExtUtils::Manifest ExtUtils::Install, |
2463 | ExtUtils::Embed |
005c1a0e |
2464 | |
e05e23b1 |
2465 | =head1 AUTHORS |
fed7345c |
2466 | |
a7d1454b |
2467 | Andy Dougherty C<doughera@lafayette.edu>, Andreas KE<ouml>nig |
2468 | C<andreas.koenig@mind.de>, Tim Bunce C<timb@cpan.org>. VMS |
2469 | support by Charles Bailey C<bailey@newman.upenn.edu>. OS/2 support |
2470 | by Ilya Zakharevich C<ilya@math.ohio-state.edu>. |
de90321e |
2471 | |
a7d1454b |
2472 | Currently maintained by Michael G Schwern C<schwern@pobox.com> |
f6d6199c |
2473 | |
a7d1454b |
2474 | Send patches and ideas to C<makemaker@perl.org>. |
e8012c20 |
2475 | |
e0678a30 |
2476 | Send bug reports via http://rt.cpan.org/. Please send your |
2477 | generated Makefile along with your report. |
2478 | |
a7d1454b |
2479 | For more up-to-date information, see L<http://www.makemaker.org>. |
fed7345c |
2480 | |
479d2113 |
2481 | =head1 LICENSE |
2482 | |
2483 | This program is free software; you can redistribute it and/or |
2484 | modify it under the same terms as Perl itself. |
2485 | |
a7d1454b |
2486 | See L<http://www.perl.com/perl/misc/Artistic.html> |
479d2113 |
2487 | |
2488 | |
005c1a0e |
2489 | =cut |