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