1 package ExtUtils::MakeMaker;
3 BEGIN {require 5.005_03;}
6 $Version_OK = "5.49"; # Makefiles older than $Version_OK will die
7 # (Will be checked from MakeMaker version 4.13 onwards)
8 ($Revision = substr(q$Revision: 1.59 $, 10)) =~ s/\s+$//;
15 @ISA @EXPORT @EXPORT_OK
16 $ISA_TTY $Revision $VERSION $Verbose $Version_OK %Config
17 %Keep_after_flush %MM_Sections @Prepend_parent
18 %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable
24 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
25 @EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists);
27 # These will go away once the last of the Win32 & VMS specific code is
29 my $Is_VMS = $^O eq 'VMS';
30 my $Is_Win32 = $^O eq 'MSWin32';
34 require ExtUtils::MM; # Things like CPAN assume loading ExtUtils::MakeMaker
37 require ExtUtils::MY; # XXX pre-5.8 versions of ExtUtils::Embed expect
38 # loading ExtUtils::MakeMaker will give them MY.
39 # This will go when Embed is it's own CPAN module.
43 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
50 my $mm = MM->new(\%att);
57 # Basic signatures of the attributes WriteMakefile takes. Each is
58 # the reference type. Any not noted simply take strings.
67 EXCLUDE_EXT=> 'array',
72 INCLUDE_EXT=> 'array',
73 LIBS => ['array','string'],
92 tool_autosplit => 'hash',
105 while( my($key, $val) = each %$att ) {
106 my $sig = $Att_Sigs{$key};
107 my @sigs = ref $sig ? @$sig : ($sig || 'string');
108 my $given = lc ref $val || 'string';
109 unless( grep $given eq $_, @sigs ) {
110 my $takes = join " or ", map { $_ ne 'string' ? "$_ reference"
113 my $has = $given ne 'string' ? "$given reference"
115 warn "WARNING: $key takes a $takes not a $has.\n".
116 " Please inform the author.\n";
117 $att->{$key} = $Default_Att{$sigs[0]};
124 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
125 Carp::confess("prompt function called without an argument")
126 unless defined $mess;
127 my $dispdef = defined $def ? "[$def] " : " ";
128 $def = defined $def ? $def : "";
132 print "$mess $dispdef";
133 if ($ISA_TTY && !$ENV{PERL_MM_USE_DEFAULT}) {
138 else { # user hit ctrl-D
145 return (!defined $ans || $ans eq '') ? $def : $ans;
148 sub eval_in_subdirs {
150 use Cwd qw(cwd abs_path);
151 my $pwd = cwd() || die "Can't figure out your cwd!";
153 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
154 push @INC, '.'; # '.' has to always be at the end of @INC
156 foreach my $dir (@{$self->{DIR}}){
157 my($abs) = $self->catdir($pwd,$dir);
158 $self->eval_in_x($abs);
165 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
172 # if ($@ =~ /prerequisites/) {
173 # die "MakeMaker WARNING: $@";
175 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
177 die "ERROR from evaluation of $dir/Makefile.PL: $@";
184 # package name for the classes into which the first object will be blessed
185 $PACKNAME = "PACK000";
187 my @attrib_help = qw/
189 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
190 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
191 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE
192 FULLPERL FULLPERLRUN FULLPERLRUNINST
194 INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR
196 PREFIX SITEPREFIX VENDORPREFIX
197 INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
198 INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
199 INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
200 INSTALLMAN1DIR INSTALLMAN3DIR
201 INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR
202 INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR
204 PERL_LIB PERL_ARCHLIB
205 SITELIBEXP SITEARCHEXP
206 INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS
207 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
209 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
210 PERLRUN PERLRUNINST PERL_CORE
211 PERL_SRC PERM_RW PERM_RWX
212 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
213 PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
214 SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
215 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
217 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
218 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
221 # IMPORTS is used under OS/2 and Win32
223 # @Overridable is close to @MM_Sections but not identical. The
224 # order is important. Many subroutines declare macros. These
225 # depend on each other. Let's try to collect the macros up front,
226 # then pasthru, then the rules.
228 # MM_Sections are the sections we have to call explicitly
229 # in Overridable we have subroutines that are used indirectly
235 post_initialize const_config constants tool_autosplit tool_xsubpp
236 tools_other dist macro depend cflags const_loadlibs const_cccmd
241 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
242 dynamic_lib static static_lib manifypods processPL
244 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
245 install force perldepend makefile staticmake test ppd
247 ); # loses section ordering
249 @Overridable = @MM_Sections;
250 push @Overridable, qw[
252 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
253 subdir_x test_via_harness test_via_script init_PERL
256 push @MM_Sections, qw[
258 pm_to_blib selfdocument
262 # Postamble needs to be the last that was always the case
263 push @MM_Sections, "postamble";
264 push @Overridable, "postamble";
266 # All sections are valid keys.
267 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
269 # we will use all these variables in the Makefile
272 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
273 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
277 foreach my $item (@attrib_help){
278 $Recognized_Att_Keys{$item} = 1;
280 foreach my $item (@Get_from_Config) {
281 $Recognized_Att_Keys{uc $item} = $Config{$item};
282 print "Attribute '\U$item\E' => '$Config{$item}'\n"
287 # When we eval a Makefile.PL in a subdirectory, that one will ask
288 # us (the parent) for the values and will prepend "..", so that
289 # all files to be installed end up below OUR ./blib
291 @Prepend_parent = qw(
292 INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT
293 MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC
298 NEEDS_LINKING HAS_LINK_CODE
300 @Keep_after_flush{@keep} = (1) x @keep;
306 The extension you are trying to build apparently is rather old and
307 most probably outdated. We detect that from the fact, that a
308 subroutine "writeMakefile" is called, and this subroutine is not
309 supported anymore since about October 1994.
311 Please contact the author or look into CPAN (details about CPAN can be
312 found in the FAQ and at http:/www.perl.com) for a more recent version
313 of the extension. If you're really desperate, you can try to change
314 the subroutine name from writeMakefile to WriteMakefile and rerun
315 'perl Makefile.PL', but you're most probably left alone, when you do
324 my($class,$self) = @_;
327 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
328 require Data::Dumper;
329 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
332 # PRINT_PREREQ is RedHatism.
333 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
334 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " } sort keys %{$self->{PREREQ_PM}}), "\n";
338 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
339 if (-f "MANIFEST" && ! -f "Makefile"){
343 $self = {} unless (defined $self);
347 my %configure_att; # record &{$self->{CONFIGURE}} attributes
348 my(%initial_att) = %$self; # record initial attributes
350 my(%unsatisfied) = ();
351 foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
352 eval "require $prereq";
354 my $pr_version = $prereq->VERSION || 0;
357 warn sprintf "Warning: prerequisite %s %s not found.\n",
358 $prereq, $self->{PREREQ_PM}{$prereq}
359 unless $self->{PREREQ_FATAL};
360 $unsatisfied{$prereq} = 'not installed';
361 } elsif ($pr_version < $self->{PREREQ_PM}->{$prereq} ){
362 warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n",
363 $prereq, $self->{PREREQ_PM}{$prereq},
364 ($pr_version || 'unknown version')
365 unless $self->{PREREQ_FATAL};
366 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ?
367 $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
370 if (%unsatisfied && $self->{PREREQ_FATAL}){
371 my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"}
373 die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)\n
374 Please install these modules first and rerun 'perl Makefile.PL'.\n};
377 if (defined $self->{CONFIGURE}) {
378 if (ref $self->{CONFIGURE} eq 'CODE') {
379 %configure_att = %{&{$self->{CONFIGURE}}};
380 $self = { %$self, %configure_att };
382 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
386 # This is for old Makefiles written pre 5.00, will go away
387 if ( Carp::longmess("") =~ /runsubdirpl/s ){
388 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
391 my $newclass = ++$PACKNAME;
392 local @Parent = @Parent; # Protect against non-local exits
395 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
396 mv_all_methods("MY",$newclass);
397 bless $self, $newclass;
399 require ExtUtils::MY;
400 @{"$newclass\:\:ISA"} = 'MM';
403 if (defined $Parent[-2]){
404 $self->{PARENT} = $Parent[-2];
406 for $key (@Prepend_parent) {
407 next unless defined $self->{PARENT}{$key};
408 $self->{$key} = $self->{PARENT}{$key};
409 unless ($^O eq 'VMS' && $key =~ /PERL$/) {
410 $self->{$key} = $self->catdir("..",$self->{$key})
411 unless $self->file_name_is_absolute($self->{$key});
413 # PERL or FULLPERL will be a command verb or even a
414 # command with an argument instead of a full file
415 # specification under VMS. So, don't turn the command
416 # into a filespec, but do add a level to the path of
417 # the argument if not already absolute.
418 my @cmd = split /\s+/, $self->{$key};
419 $cmd[1] = $self->catfile('[-]',$cmd[1])
420 unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]);
421 $self->{$key} = join(' ', @cmd);
424 if ($self->{PARENT}) {
425 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
426 foreach my $opt (qw(POLLUTE PERL_CORE)) {
427 if (exists $self->{PARENT}->{$opt}
428 and not exists $self->{$opt})
430 # inherit, but only if already unspecified
431 $self->{$opt} = $self->{PARENT}->{$opt};
435 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
436 parse_args($self,@fm) if @fm;
438 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
441 $self->{NAME} ||= $self->guess_name;
443 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
447 if (! $self->{PERL_SRC} ) {
448 require VMS::Filespec if $Is_VMS;
449 my($pthinks) = $self->canonpath($INC{'Config.pm'});
450 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
451 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
452 if ($pthinks ne $cthinks &&
453 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
454 print "Have $pthinks expected $cthinks\n";
456 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
459 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
461 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
462 Your perl and your Config.pm seem to have different ideas about the
463 architecture they are running on.
464 Perl thinks: [$pthinks]
465 Config says: [$Config{archname}]
466 This may or may not cause problems. Please check your installation of perl
467 if you have problems building this extension.
472 $self->init_dirscan();
473 $self->init_others();
475 my($argv) = neatvalue(\@ARGV);
479 push @{$self->{RESULT}}, <<END;
480 # This Makefile is for the $self->{NAME} extension to perl.
482 # It was generated automatically by MakeMaker version
483 # $VERSION (Revision: $Revision) from the contents of
484 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
486 # ANY CHANGES MADE HERE WILL BE LOST!
488 # MakeMaker ARGV: $argv
490 # MakeMaker Parameters:
493 foreach my $key (sort keys %initial_att){
494 my($v) = neatvalue($initial_att{$key});
495 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
497 push @{$self->{RESULT}}, "# $key => $v";
499 undef %initial_att; # free memory
501 if (defined $self->{CONFIGURE}) {
502 push @{$self->{RESULT}}, <<END;
504 # MakeMaker 'CONFIGURE' Parameters:
506 if (scalar(keys %configure_att) > 0) {
507 foreach my $key (sort keys %configure_att){
508 my($v) = neatvalue($configure_att{$key});
509 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
511 push @{$self->{RESULT}}, "# $key => $v";
516 push @{$self->{RESULT}}, "# no values returned";
518 undef %configure_att; # free memory
521 # turn the SKIP array into a SKIPHASH hash
523 for $skip (@{$self->{SKIP} || []}) {
524 $self->{SKIPHASH}{$skip} = 1;
526 delete $self->{SKIP}; # free memory
528 if ($self->{PARENT}) {
529 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
530 $self->{SKIPHASH}{$_} = 1;
534 # We run all the subdirectories now. They don't have much to query
535 # from the parent, but the parent has to query them: if they need linking!
536 unless ($self->{NORECURS}) {
537 $self->eval_in_subdirs if @{$self->{DIR}};
540 foreach my $section ( @MM_Sections ){
541 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
542 my($skipit) = $self->skipcheck($section);
544 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
546 my(%a) = %{$self->{$section} || {}};
547 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
548 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
549 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
553 push @{$self->{RESULT}}, "\n# End.";
558 sub WriteEmptyMakefile {
559 Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
562 my $self = MM->new(\%att);
563 if (-f "$self->{MAKEFILE}.old") {
564 chmod 0666, "$self->{MAKEFILE}.old";
565 unlink "$self->{MAKEFILE}.old" or warn "unlink $self->{MAKEFILE}.old: $!";
567 rename $self->{MAKEFILE}, "$self->{MAKEFILE}.old"
568 or warn "rename $self->{MAKEFILE} $self->{MAKEFILE}.old: $!"
569 if -f $self->{MAKEFILE};
570 open MF, '>'.$self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
583 close MF or die "close $self->{MAKEFILE} for write: $!";
587 print STDOUT "Checking if your kit is complete...\n";
588 require ExtUtils::Manifest;
590 $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
591 my(@missed) = ExtUtils::Manifest::manicheck();
593 print STDOUT "Warning: the following files are missing in your kit:\n";
594 print "\t", join "\n\t", @missed;
596 print STDOUT "Please inform the author.\n";
598 print STDOUT "Looks good\n";
603 my($self, @args) = @_;
605 unless (m/(.*?)=(.*)/) {
606 help(),exit 1 if m/^help$/;
607 ++$Verbose if m/^verb/;
610 my($name, $value) = ($1, $2);
611 if ($value =~ m/^~(\w+)?/) { # tilde with optional username
612 $value =~ s [^~(\w*)]
614 ((getpwnam($1))[7] || "~$1") :
618 $self->{uc($name)} = $value;
621 # catch old-style 'potential_libs' and inform user how to 'upgrade'
622 if (defined $self->{potential_libs}){
623 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
624 if ($self->{potential_libs}){
625 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
627 print STDOUT "$msg deleted.\n";
629 $self->{LIBS} = [$self->{potential_libs}];
630 delete $self->{potential_libs};
632 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
633 if (defined $self->{ARMAYBE}){
634 my($armaybe) = $self->{ARMAYBE};
635 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
636 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
637 my(%dl) = %{$self->{dynamic_lib} || {}};
638 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
639 delete $self->{ARMAYBE};
641 if (defined $self->{LDTARGET}){
642 print STDOUT "LDTARGET should be changed to LDFROM\n";
643 $self->{LDFROM} = $self->{LDTARGET};
644 delete $self->{LDTARGET};
646 # Turn a DIR argument on the command line into an array
647 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
648 # So they can choose from the command line, which extensions they want
649 # the grep enables them to have some colons too much in case they
650 # have to build a list with the shell
651 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
653 # Turn a INCLUDE_EXT argument on the command line into an array
654 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
655 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
657 # Turn a EXCLUDE_EXT argument on the command line into an array
658 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
659 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
662 foreach my $mmkey (sort keys %$self){
663 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
664 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
665 unless exists $Recognized_Att_Keys{$mmkey};
672 # We allow extension-specific hints files.
674 return unless -d "hints";
676 # First we look for the best hintsfile we have
677 my($hint)="${^O}_$Config{osvers}";
682 # Also try without trailing minor version numbers.
684 last if -f "hints/$hint.pl"; # found
686 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
688 my $hint_file = "hints/$hint.pl";
690 return unless -f $hint_file; # really there
692 _run_hintfile($self, $hint_file);
697 local($self) = shift; # make $self available to the hint file.
698 my($hint_file) = shift;
701 print STDERR "Processing hints file $hint_file\n";
702 my $ret = do "./$hint_file";
703 unless( defined $ret ) {
704 print STDERR $@ if $@;
711 my($symtab) = \%{"${from}::"};
713 # Here you see the *current* list of methods that are overridable
714 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
715 # still trying to reduce the list to some reasonable minimum --
716 # because I want to make it easier for the user. A.K.
718 local $SIG{__WARN__} = sub {
719 # can't use 'no warnings redefined', 5.6 only
720 warn @_ unless $_[0] =~ /^Subroutine .* redefined/
722 foreach my $method (@Overridable) {
724 # We cannot say "next" here. Nick might call MY->makeaperl
725 # which isn't defined right now
727 # Above statement was written at 4.23 time when Tk-b8 was
728 # around. As Tk-b9 only builds with 5.002something and MM 5 is
729 # standard, we try to enable the next line again. It was
730 # commented out until MM 5.23
732 next unless defined &{"${from}::$method"};
734 *{"${to}::$method"} = \&{"${from}::$method"};
736 # delete would do, if we were sure, nobody ever called
737 # MY->makeaperl directly
739 # delete $symtab->{$method};
741 # If we delete a method, then it will be undefined and cannot
742 # be called. But as long as we have Makefile.PLs that rely on
743 # %MY:: being intact, we have to fill the hole with an
746 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
749 # We have to clean out %INC also, because the current directory is
750 # changed frequently and Graham Barr prefers to get his version
751 # out of a History.pl file which is "required" so woudn't get
752 # loaded again in another extension requiring a History.pl
754 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
755 # to core dump in the middle of a require statement. The required
756 # file was Tk/MMutil.pm. The consequence is, we have to be
757 # extremely careful when we try to give perl a reason to reload a
758 # library with same name. The workaround prefers to drop nothing
759 # from %INC and teach the writers not to use such libraries.
762 # foreach $inc (keys %INC) {
763 # #warn "***$inc*** deleted";
771 if ($section eq 'dynamic') {
772 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
773 "in skipped section 'dynamic_bs'\n"
774 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
775 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
776 "in skipped section 'dynamic_lib'\n"
777 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
779 if ($section eq 'dynamic_lib') {
780 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
781 "targets in skipped section 'dynamic_bs'\n"
782 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
784 if ($section eq 'static') {
785 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
786 "in skipped section 'static_lib'\n"
787 if $self->{SKIPHASH}{static_lib} && $Verbose;
789 return 'skipped' if $self->{SKIPHASH}{$section};
797 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
799 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
800 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
802 for $chunk (@{$self->{RESULT}}) {
807 my($finalname) = $self->{MAKEFILE};
808 rename("MakeMaker.tmp", $finalname);
809 chmod 0644, $finalname unless $Is_VMS;
811 if ($self->{PARENT} && !$self->{_KEEP_AFTER_FLUSH}) {
812 foreach (keys %$self) { # safe memory
813 delete $self->{$_} unless $Keep_after_flush{$_};
817 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
820 # The following mkbootstrap() is only for installations that are calling
821 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
822 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
825 !!! Your Makefile has been built such a long time ago, !!!
826 !!! that is unlikely to work with current MakeMaker. !!!
827 !!! Please rebuild your Makefile !!!
831 # Ditto for mksymlists() as of MakeMaker 5.17
834 !!! Your Makefile has been built such a long time ago, !!!
835 !!! that is unlikely to work with current MakeMaker. !!!
836 !!! Please rebuild your Makefile !!!
842 return "undef" unless defined $v;
844 return "q[$v]" unless $t;
848 foreach my $elem (@$v) {
849 push @neat, "q[$elem]";
851 push @m, join ", ", @neat;
855 return "$v" unless $t eq 'HASH';
857 while (($key,$val) = each %$v){
858 last unless defined $key; # cautious programming in case (undef,undef) is true
859 push(@m,"$key=>".neatvalue($val)) ;
861 return "{ ".join(', ',@m)." }";
868 push @m, "\n# Full list of MakeMaker attribute values:";
869 foreach my $key (sort keys %$self){
870 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
871 my($v) = neatvalue($self->{$key});
872 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
874 push @m, "# $key => $v";
886 ExtUtils::MakeMaker - create an extension Makefile
890 use ExtUtils::MakeMaker;
892 WriteMakefile( ATTRIBUTE => VALUE [, ...] );
896 This utility is designed to write a Makefile for an extension module
897 from a Makefile.PL. It is based on the Makefile.SH model provided by
898 Andy Dougherty and the perl5-porters.
900 It splits the task of generating the Makefile into several subroutines
901 that can be individually overridden. Each subroutine returns the text
902 it wishes to have written to the Makefile.
904 MakeMaker is object oriented. Each directory below the current
905 directory that contains a Makefile.PL is treated as a separate
906 object. This makes it possible to write an unlimited number of
907 Makefiles with a single invocation of WriteMakefile().
909 =head2 How To Write A Makefile.PL
911 The short answer is: Don't.
913 Always begin with h2xs.
914 Always begin with h2xs!
915 ALWAYS BEGIN WITH H2XS!
917 even if you're not building around a header file, and even if you
918 don't have an XS component.
920 Run h2xs(1) before you start thinking about writing a module. For so
921 called pm-only modules that consist of C<*.pm> files only, h2xs has
922 the C<-X> switch. This will generate dummy files of all kinds that are
923 useful for the module developer.
925 The medium answer is:
927 use ExtUtils::MakeMaker;
928 WriteMakefile( NAME => "Foo::Bar" );
930 The long answer is the rest of the manpage :-)
932 =head2 Default Makefile Behaviour
934 The generated Makefile enables the user of the extension to invoke
936 perl Makefile.PL # optionally "perl Makefile.PL verbose"
938 make test # optionally set TEST_VERBOSE=1
939 make install # See below
941 The Makefile to be produced may be altered by adding arguments of the
942 form C<KEY=VALUE>. E.g.
944 perl Makefile.PL PREFIX=/tmp/myperl5
946 Other interesting targets in the generated Makefile are
948 make config # to check if the Makefile is up-to-date
949 make clean # delete local temp files (Makefile gets renamed)
950 make realclean # delete derived files (including ./blib)
951 make ci # check in all the files in the MANIFEST file
952 make dist # see below the Distribution Support section
956 MakeMaker checks for the existence of a file named F<test.pl> in the
957 current directory and if it exists it adds commands to the test target
958 of the generated Makefile that will execute the script with the proper
959 set of perl C<-I> options.
961 MakeMaker also checks for any files matching glob("t/*.t"). It will
962 add commands to the test target of the generated Makefile that execute
963 all matching files in alphabetical order via the L<Test::Harness>
964 module with the C<-I> switches set correctly.
968 A useful variation of the above is the target C<testdb>. It runs the
969 test under the Perl debugger (see L<perldebug>). If the file
970 F<test.pl> exists in the current directory, it is used for the test.
972 If you want to debug some other testfile, set C<TEST_FILE> variable
975 make testdb TEST_FILE=t/mytest.t
977 By default the debugger is called using C<-d> option to perl. If you
978 want to specify some other option, set C<TESTDB_SW> variable:
980 make testdb TESTDB_SW=-Dx
984 make alone puts all relevant files into directories that are named by
985 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
986 INST_MAN3DIR. All these default to something below ./blib if you are
987 I<not> building below the perl source directory. If you I<are>
988 building below the perl source, INST_LIB and INST_ARCHLIB default to
989 ../../lib, and INST_SCRIPT is not defined.
991 The I<install> target of the generated Makefile copies the files found
992 below each of the INST_* directories to their INSTALL*
993 counterparts. Which counterparts are chosen depends on the setting of
994 INSTALLDIRS according to the following table:
999 PREFIX SITEPREFIX VENDORPREFIX
1000 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
1001 INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
1002 INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
1003 INST_SCRIPT INSTALLSCRIPT INSTALLSCRIPT INSTALLSCRIPT
1004 INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR
1005 INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR
1007 The INSTALL... macros in turn default to their %Config
1008 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1010 You can check the values of these variables on your system with
1014 And to check the sequence in which the library directories are
1015 searched by perl, run
1017 perl -le 'print join $/, @INC'
1020 =head2 PREFIX and LIB attribute
1022 PREFIX and LIB can be used to set several INSTALL* attributes in one
1023 go. The quickest way to install a module in a non-standard place might
1026 perl Makefile.PL PREFIX=~
1028 This will install all files in the module under your home directory,
1029 with man pages and libraries going into an appropriate place (usually
1032 Another way to specify many INSTALL directories with a single
1035 perl Makefile.PL LIB=~/lib
1037 This will install the module's architecture-independent files into
1038 ~/lib, the architecture-dependent files into ~/lib/$archname.
1040 Note, that in both cases the tilde expansion is done by MakeMaker, not
1041 by perl by default, nor by make.
1043 Conflicts between parameters LIB, PREFIX and the various INSTALL*
1044 arguments are resolved so that:
1050 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1051 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1055 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1056 part of those INSTALL* arguments, even if the latter are explicitly
1057 set (but are set to still start with C<$Config{prefix}>).
1061 If the user has superuser privileges, and is not working on AFS or
1062 relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
1063 INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
1071 make install per default writes some documentation of what has been
1072 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1073 can be bypassed by calling make pure_install.
1077 will have to specify the installation directories as these most
1078 probably have changed since perl itself has been installed. They will
1079 have to do this by calling
1081 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1082 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1085 Be careful to repeat this procedure every time you recompile an
1086 extension, unless you are sure the AFS installation directories are
1089 =head2 Static Linking of a new Perl Binary
1091 An extension that is built with the above steps is ready to use on
1092 systems supporting dynamic loading. On systems that do not support
1093 dynamic loading, any newly created extension has to be linked together
1094 with the available resources. MakeMaker supports the linking process
1095 by creating appropriate targets in the Makefile whenever an extension
1096 is built. You can invoke the corresponding section of the makefile with
1100 That produces a new perl binary in the current directory with all
1101 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1102 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1103 UNIX, this is called Makefile.aperl (may be system dependent). If you
1104 want to force the creation of a new perl, it is recommended, that you
1105 delete this Makefile.aperl, so the directories are searched-through
1106 for linkable libraries again.
1108 The binary can be installed into the directory where perl normally
1109 resides on your machine with
1113 To produce a perl binary with a different name than C<perl>, either say
1115 perl Makefile.PL MAP_TARGET=myperl
1122 make myperl MAP_TARGET=myperl
1123 make inst_perl MAP_TARGET=myperl
1125 In any case you will be prompted with the correct invocation of the
1126 C<inst_perl> target that installs the new binary into INSTALLBIN.
1128 make inst_perl per default writes some documentation of what has been
1129 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1130 can be bypassed by calling make pure_inst_perl.
1132 Warning: the inst_perl: target will most probably overwrite your
1133 existing perl binary. Use with care!
1135 Sometimes you might want to build a statically linked perl although
1136 your system supports dynamic loading. In this case you may explicitly
1137 set the linktype with the invocation of the Makefile.PL or make:
1139 perl Makefile.PL LINKTYPE=static # recommended
1143 make LINKTYPE=static # works on most systems
1145 =head2 Determination of Perl Library and Installation Locations
1147 MakeMaker needs to know, or to guess, where certain things are
1148 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1149 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1150 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1152 Extensions may be built either using the contents of the perl source
1153 directory tree or from the installed perl library. The recommended way
1154 is to build extensions after you have run 'make install' on perl
1155 itself. You can do that in any directory on your hard disk that is not
1156 below the perl source tree. The support for extensions below the ext
1157 directory of the perl distribution is only good for the standard
1158 extensions that come with perl.
1160 If an extension is being built below the C<ext/> directory of the perl
1161 source then MakeMaker will set PERL_SRC automatically (e.g.,
1162 C<../..>). If PERL_SRC is defined and the extension is recognized as
1163 a standard extension, then other variables default to the following:
1166 PERL_LIB = PERL_SRC/lib
1167 PERL_ARCHLIB = PERL_SRC/lib
1169 INST_ARCHLIB = PERL_ARCHLIB
1171 If an extension is being built away from the perl source then MakeMaker
1172 will leave PERL_SRC undefined and default to using the installed copy
1173 of the perl library. The other variables default to the following:
1175 PERL_INC = $archlibexp/CORE
1176 PERL_LIB = $privlibexp
1177 PERL_ARCHLIB = $archlibexp
1178 INST_LIB = ./blib/lib
1179 INST_ARCHLIB = ./blib/arch
1181 If perl has not yet been installed then PERL_SRC can be defined on the
1182 command line as shown in the previous section.
1185 =head2 Which architecture dependent directory?
1187 If you don't want to keep the defaults for the INSTALL* macros,
1188 MakeMaker helps you to minimize the typing needed: the usual
1189 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1190 by Configure at perl compilation time. MakeMaker supports the user who
1191 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1192 then MakeMaker defaults the latter to be the same subdirectory of
1193 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1194 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1195 for INSTALLSITELIB and INSTALLSITEARCH.
1197 MakeMaker gives you much more freedom than needed to configure
1198 internal variables and get different results. It is worth to mention,
1199 that make(1) also lets you configure most of the variables that are
1200 used in the Makefile. But in the majority of situations this will not
1201 be necessary, and should only be done if the author of a package
1202 recommends it (or you know what you're doing).
1204 =head2 Using Attributes and Parameters
1206 The following attributes can be specified as arguments to WriteMakefile()
1207 or as NAME=VALUE pairs on the command line:
1213 One line description of the module. Will be included in PPD file.
1217 Name of the file that contains the package description. MakeMaker looks
1218 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1219 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1223 String containing name (and email address) of package author(s). Is used
1224 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1226 =item BINARY_LOCATION
1228 Used when creating PPD files for binary packages. It can be set to a
1229 full or relative path or URL to the binary archive for a particular
1230 architecture. For example:
1232 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1234 builds a PPD package that references a binary of the C<Agent> package,
1235 located in the C<x86> directory relative to the PPD itself.
1239 Ref to array of *.c file names. Initialised from a directory scan
1240 and the values portion of the XS attribute hash. This is not
1241 currently used by MakeMaker but may be handy in Makefile.PLs.
1245 String that will be included in the compiler call command line between
1246 the arguments INC and OPTIMIZE.
1250 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1251 config.sh. MakeMaker will add to CONFIG the following values anyway:
1271 CODE reference. The subroutine should return a hash reference. The
1272 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1273 be determined by some evaluation method.
1277 Something like C<"-DHAVE_UNISTD_H">
1281 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1286 Your name for distributing the package (by tar file). This defaults to
1291 Hashref of symbol names for routines to be made available as universal
1292 symbols. Each key/value pair consists of the package name and an
1293 array of routine names in that package. Used only under AIX, OS/2,
1294 VMS and Win32 at present. The routine names supplied will be expanded
1295 in the same way as XSUB names are expanded by the XS() macro.
1298 {"$(NAME)" => ["boot_$(NAME)" ] }
1302 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1303 "NetconfigPtr" => [ 'DESTROY'] }
1305 Please see the L<ExtUtils::Mksymlists> documentation for more information
1306 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1310 Array of symbol names for variables to be made available as universal symbols.
1311 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1312 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1316 Array of extension names to exclude when doing a static build. This
1317 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1318 details. (e.g. [ qw( Socket POSIX ) ] )
1320 This attribute may be most useful when specified as a string on the
1321 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1325 Ref to array of executable files. The files will be copied to the
1326 INST_SCRIPT directory. Make realclean will delete them from there
1329 =item FIRST_MAKEFILE
1331 The name of the Makefile to be produced. Defaults to the contents of
1332 MAKEFILE, but can be overridden. This is used for the second Makefile
1333 that will be produced for the MAP_TARGET.
1337 Perl binary able to run this extension, load XS modules, etc...
1341 Like PERLRUN, except it uses FULLPERL.
1343 =item FULLPERLRUNINST
1345 Like PERLRUNINST, except it uses FULLPERL.
1349 This provides an alternate means to specify function names to be
1350 exported from the extension. Its value is a reference to an
1351 array of function names to be exported by the extension. These
1352 names are passed through unaltered to the linker options file.
1356 Ref to array of *.h file names. Similar to C.
1360 This attribute is used to specify names to be imported into the
1361 extension. Takes a hash ref.
1363 It is only used on OS/2 and Win32.
1367 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1371 Array of extension names to be included when doing a static build.
1372 MakeMaker will normally build with all of the installed extensions when
1373 doing a static build, and that is usually the desired behavior. If
1374 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1375 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1377 It is not necessary to mention DynaLoader or the current extension when
1378 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1379 only DynaLoader and the current extension will be included in the build.
1381 This attribute may be most useful when specified as a string on the
1382 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1384 =item INSTALLARCHLIB
1386 Used by 'make install', which copies files from INST_ARCHLIB to this
1387 directory if INSTALLDIRS is set to perl.
1391 Directory to install binary files (e.g. tkperl) into if
1396 Determines which of the sets of installation directories to choose:
1397 perl, site or vendor. Defaults to site.
1399 =item INSTALLMAN1DIR
1401 =item INSTALLMAN3DIR
1403 These directories get the man pages at 'make install' time if
1404 INSTALLDIRS=perl. Defaults to $Config{installman*dir}.
1406 If set to 'none', no man pages will be installed.
1408 =item INSTALLPRIVLIB
1410 Used by 'make install', which copies files from INST_LIB to this
1411 directory if INSTALLDIRS is set to perl.
1413 Defaults to $Config{installprivlib}.
1417 Used by 'make install' which copies files from INST_SCRIPT to this
1420 =item INSTALLSITEARCH
1422 Used by 'make install', which copies files from INST_ARCHLIB to this
1423 directory if INSTALLDIRS is set to site (default).
1425 =item INSTALLSITEBIN
1427 Used by 'make install', which copies files from INST_BIN to this
1428 directory if INSTALLDIRS is set to site (default).
1430 =item INSTALLSITELIB
1432 Used by 'make install', which copies files from INST_LIB to this
1433 directory if INSTALLDIRS is set to site (default).
1435 =item INSTALLSITEMAN1DIR
1437 =item INSTALLSITEMAN3DIR
1439 These directories get the man pages at 'make install' time if
1440 INSTALLDIRS=site (default). Defaults to
1441 $(SITEPREFIX)/man/man$(MAN*EXT).
1443 If set to 'none', no man pages will be installed.
1445 =item INSTALLVENDORARCH
1447 Used by 'make install', which copies files from INST_ARCHLIB to this
1448 directory if INSTALLDIRS is set to vendor.
1450 =item INSTALLVENDORBIN
1452 Used by 'make install', which copies files from INST_BIN to this
1453 directory if INSTALLDIRS is set to vendor.
1455 =item INSTALLVENDORLIB
1457 Used by 'make install', which copies files from INST_LIB to this
1458 directory if INSTALLDIRS is set to vendor.
1460 =item INSTALLVENDORMAN1DIR
1462 =item INSTALLVENDORMAN3DIR
1464 These directories get the man pages at 'make install' time if
1465 INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT).
1467 If set to 'none', no man pages will be installed.
1471 Same as INST_LIB for architecture dependent files.
1475 Directory to put real binary files during 'make'. These will be copied
1476 to INSTALLBIN during 'make install'
1480 Directory where we put library files of this extension while building
1485 Directory to hold the man pages at 'make' time
1489 Directory to hold the man pages at 'make' time
1493 Directory, where executable files should be installed during
1494 'make'. Defaults to "./blib/script", just to have a dummy location during
1495 testing. make install will copy the files in INST_SCRIPT to
1500 Defaults to "$(OBJECT)" and is used in the ld command to specify
1501 what files to link/load from (also see dynamic_lib below for how to
1506 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1507 MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
1508 and INSTALLSITELIB to that value regardless any explicit setting of
1509 those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
1510 are set to the corresponding architecture subdirectory.
1514 The filename of the perllibrary that will be used together with this
1515 extension. Defaults to libperl.a.
1519 An anonymous array of alternative library
1520 specifications to be searched for (in order) until
1521 at least one library is found. E.g.
1523 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1525 Mind, that any element of the array
1526 contains a complete set of arguments for the ld
1527 command. So do not specify
1529 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1531 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1532 you specify a scalar as in
1534 'LIBS' => "-ltcl -ltk -lX11"
1536 MakeMaker will turn it into an array with one element.
1540 'static' or 'dynamic' (default unless usedl=undef in
1541 config.sh). Should only be used to force static linking (also see
1546 Boolean which tells MakeMaker, that it should include the rules to
1547 make a perl. This is handled automatically as a switch by
1548 MakeMaker. The user normally does not need it.
1552 The name of the Makefile to be produced.
1556 Hashref of pod-containing files. MakeMaker will default this to all
1557 EXE_FILES files that include POD directives. The files listed
1558 here will be converted to man pages and installed as was requested
1563 Hashref that assigns to *.pm and *.pod files the files into which the
1564 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1565 for POD directives. Files that contain POD will be the default keys of
1566 the MAN3PODS hashref. These will then be converted to man pages during
1567 C<make> and will be installed during C<make install>.
1571 If it is intended, that a new perl binary be produced, this variable
1572 may hold a name for that binary. Defaults to perl
1576 If the extension links to a library that it builds set this to the
1577 name of the library (see SDBM_File)
1581 Perl module name for this extension (DBD::Oracle). This will default
1582 to the directory name but should be explicitly defined in the
1587 MakeMaker will figure out if an extension contains linkable code
1588 anywhere down the directory tree, and will set this variable
1589 accordingly, but you can speed it up a very little bit if you define
1590 this boolean variable yourself.
1594 Defaults to C<@>. By setting it to an empty string you can generate a
1595 Makefile that echos all commands. Mainly used in debugging MakeMaker
1600 Boolean. Attribute to inhibit descending into subdirectories.
1604 In general, any generated Makefile checks for the current version of
1605 MakeMaker and the version the Makefile was built under. If NO_VC is
1606 set, the version check is neglected. Do not write this into your
1607 Makefile.PL, use it interactively instead.
1611 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1612 string containing all object files, e.g. "tkpBind.o
1613 tkpButton.o tkpCanvas.o"
1615 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1619 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1620 passed to subdirectory makes.
1624 Perl binary for tasks that can be done by miniperl
1628 Set only when MakeMaker is building the extensions of the Perl core
1633 The call to the program that is able to compile perlmain.c. Defaults
1638 Same as for PERL_LIB, but for architecture dependent files.
1640 Used only when MakeMaker is building the extensions of the Perl core
1641 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1642 and adding it would get in the way of PERL5LIB).
1646 Directory containing the Perl library to use.
1648 Used only when MakeMaker is building the extensions of the Perl core
1649 distribution (because normally $(PERL_LIB) is automatically in @INC,
1650 and adding it would get in the way of PERL5LIB).
1652 =item PERL_MALLOC_OK
1654 defaults to 0. Should be set to TRUE if the extension can work with
1655 the memory allocation routines substituted by the Perl malloc() subsystem.
1656 This should be applicable to most extensions with exceptions of those
1662 with bugs in memory allocations which are caught by Perl's malloc();
1666 which interact with the memory allocator in other ways than via
1667 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1671 which rely on special alignment which is not provided by Perl's malloc().
1675 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1676 nullifies many advantages of Perl's malloc(), such as better usage of
1677 system resources, error detection, memory usage reporting, catchable failure
1678 of memory allocations, etc.
1682 Use this instead of $(PERL) when you wish to run perl. It will set up
1683 extra necessary flags for you.
1687 Use this instead of $(PERL) when you wish to run perl to work with
1688 modules. It will add things like -I$(INST_ARCH) and other necessary
1689 flags so perl can see the modules you're about to install.
1693 Directory containing the Perl source code (use of this should be
1694 avoided, it may be undefined)
1698 Desired permission for read/writable files. Defaults to C<644>.
1699 See also L<MM_Unix/perm_rw>.
1703 Desired permission for executable files. Defaults to C<755>.
1704 See also L<MM_Unix/perm_rwx>.
1708 Ref to hash of files to be processed as perl programs. MakeMaker
1709 will default to any found *.PL file (except Makefile.PL) being keys
1710 and the basename of the file being the value. E.g.
1712 {'foobar.PL' => 'foobar'}
1714 The *.PL files are expected to produce output to the target files
1715 themselves. If multiple files can be generated from the same *.PL
1716 file then the value in the hash can be a reference to an array of
1717 target file names. E.g.
1719 {'foobar.PL' => ['foobar1','foobar2']}
1723 Hashref of .pm files and *.pl files to be installed. e.g.
1725 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1727 By default this will include *.pm and *.pl and the files found in
1728 the PMLIBDIRS directories. Defining PM in the
1729 Makefile.PL will override PMLIBDIRS.
1733 Ref to array of subdirectories containing library files. Defaults to
1734 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1735 they contain will be installed in the corresponding location in the
1736 library. A libscan() method can be used to alter the behaviour.
1737 Defining PM in the Makefile.PL will override PMLIBDIRS.
1739 (Where BASEEXT is the last component of NAME.)
1743 A filter program, in the traditional Unix sense (input from stdin, output
1744 to stdout) that is passed on each .pm file during the build (in the
1745 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1747 Great care is necessary when defining the command if quoting needs to be
1748 done. For instance, you would need to say:
1750 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1752 to remove all the leading coments on the fly during the build. The
1753 extra \\ are necessary, unfortunately, because this variable is interpolated
1754 within the context of a Perl program built on the command line, and double
1755 quotes are what is used with the -e switch to build that command line. The
1756 # is escaped for the Makefile, since what is going to be generated will then
1759 PM_FILTER = grep -v \"^\#\"
1761 Without the \\ before the #, we'd have the start of a Makefile comment,
1762 and the macro would be incorrectly defined.
1766 Release 5.005 grandfathered old global symbol names by providing preprocessor
1767 macros for extension source compatibility. As of release 5.6, these
1768 preprocessor definitions are not available by default. The POLLUTE flag
1769 specifies that the old names should still be defined:
1771 perl Makefile.PL POLLUTE=1
1773 Please inform the module author if this is necessary to successfully install
1774 a module under 5.6 or later.
1776 =item PPM_INSTALL_EXEC
1778 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1780 =item PPM_INSTALL_SCRIPT
1782 Name of the script that gets executed by the Perl Package Manager after
1783 the installation of a package.
1787 This overrides all the default install locations. Man pages,
1788 libraries, scripts, etc... MakeMaker will try to make an educated
1789 guess about where to place things under the new PREFIX based on your
1790 Config defaults. Failing that, it will fall back to a structure
1791 which should be sensible for your platform.
1793 If you specify LIB or any INSTALL* variables they will not be effected
1796 Defaults to $Config{installprefixexp}.
1800 Hashref: Names of modules that need to be available to run this
1801 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1802 desired version is the value. If the required version number is 0, we
1803 only check if any version is installed already.
1807 Bool. If this parameter is true, failing to have the required modules
1808 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1809 with the proper message.
1811 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1812 you are missing dependencies.
1814 Do I<not> use this parameter for simple requirements, which could be resolved
1815 at a later time, e.g. after an unsuccessful B<make test> of your module.
1817 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1821 Bool. If this parameter is true, the prerequisites will be printed to
1822 stdout and MakeMaker will exit. The output format is
1832 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
1834 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
1838 Like PREFIX, but only for the site install locations.
1840 Defaults to PREFIX (if set) or $Config{siteprefixexp}. Perls prior to
1841 5.6.0 didn't have an explicit siteprefix in the Config. In those
1842 cases $Config{installprefix} will be used.
1846 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
1847 Makefile. Caution! Do not use the SKIP attribute for the negligible
1848 speedup. It may seriously damage the resulting Makefile. Only use it
1849 if you really need it.
1853 Ref to array of typemap file names. Use this when the typemaps are
1854 in some directory other than the current directory or when they are
1855 not named B<typemap>. The last typemap in the list takes
1856 precedence. A typemap in the current directory has highest
1857 precedence, even if it isn't listed in TYPEMAPS. The default system
1858 typemap has lowest precedence.
1862 Like PREFIX, but only for the vendor install locations.
1864 Defaults to PREFIX (if set) or $Config{vendorprefixexp}
1868 If true, make install will be verbose
1872 Your version number for distributing the package. This defaults to
1877 Instead of specifying the VERSION in the Makefile.PL you can let
1878 MakeMaker parse a file to determine the version number. The parsing
1879 routine requires that the file named by VERSION_FROM contains one
1880 single line to compute the version number. The first line in the file
1881 that contains the regular expression
1883 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
1885 will be evaluated with eval() and the value of the named variable
1886 B<after> the eval() will be assigned to the VERSION attribute of the
1887 MakeMaker object. The following lines will be parsed o.k.:
1891 ( $VERSION ) = '$Revision: 1.59 $ ' =~ /\$Revision:\s+([^\s]+)/;
1892 $FOO::VERSION = '1.10';
1893 *FOO::VERSION = \'1.11';
1894 our $VERSION = 1.2.3; # new for perl5.6.0
1896 but these will fail:
1898 my $VERSION = '1.01';
1899 local $VERSION = '1.02';
1900 local $FOO::VERSION = '1.30';
1902 (Putting C<my> or C<local> on the preceding line will work o.k.)
1904 The file named in VERSION_FROM is not added as a dependency to
1905 Makefile. This is not really correct, but it would be a major pain
1906 during development to have to rewrite the Makefile for any smallish
1907 change in that file. If you want to make sure that the Makefile
1908 contains the correct VERSION macro after any change of the file, you
1909 would have to do something like
1911 depend => { Makefile => '$(VERSION_FROM)' }
1913 See attribute C<depend> below.
1917 Hashref of .xs files. MakeMaker will default this. e.g.
1919 {'name_of_file.xs' => 'name_of_file.c'}
1921 The .c files will automatically be included in the list of files
1922 deleted by a make clean.
1926 String of options to pass to xsubpp. This might include C<-C++> or
1927 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1932 May be set to an empty string, which is identical to C<-prototypes>, or
1933 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
1934 defaults to the empty string.
1938 Your version number for the .xs file of this package. This defaults
1939 to the value of the VERSION attribute.
1943 =head2 Additional lowercase attributes
1945 can be used to pass parameters to the methods which implement that
1946 part of the Makefile.
1952 {FILES => "*.xyz foo"}
1956 {ANY_TARGET => ANY_DEPENDECY, ...}
1958 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
1962 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
1963 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
1964 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
1966 If you specify COMPRESS, then SUFFIX should also be altered, as it is
1967 needed to tell make the target file of the compression. Setting
1968 DIST_CP to ln can be useful, if you need to preserve the timestamps on
1969 your files. DIST_CP can take the values 'cp', which copies the file,
1970 'ln', which links the file, and 'best' which copies symbolic links and
1971 links the rest. Default is 'best'.
1975 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
1979 {LINKTYPE => 'static', 'dynamic' or ''}
1981 NB: Extensions that have nothing but *.pm files had to say
1985 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1986 can be deleted safely. MakeMaker recognizes when there's nothing to
1991 {ANY_MACRO => ANY_VALUE, ...}
1995 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
2001 =item tool_autosplit
2007 =head2 Overriding MakeMaker Methods
2009 If you cannot achieve the desired Makefile behaviour by specifying
2010 attributes you may define private subroutines in the Makefile.PL.
2011 Each subroutine returns the text it wishes to have written to
2012 the Makefile. To override a section of the Makefile you can
2015 sub MY::c_o { "new literal text" }
2017 or you can edit the default by saying something like:
2019 package MY; # so that "SUPER" works right
2021 my $inherited = shift->SUPER::c_o(@_);
2022 $inherited =~ s/old text/new text/;
2026 If you are running experiments with embedding perl as a library into
2027 other applications, you might find MakeMaker is not sufficient. You'd
2028 better have a look at ExtUtils::Embed which is a collection of utilities
2031 If you still need a different solution, try to develop another
2032 subroutine that fits your needs and submit the diffs to
2033 F<makemaker@perl.org>
2035 For a complete description of all MakeMaker methods see
2036 L<ExtUtils::MM_Unix>.
2038 Here is a simple example of how to add a new target to the generated
2042 return <<'MAKE_FRAG';
2043 $(MYEXTLIB): sdbm/Makefile
2044 cd sdbm && $(MAKE) all
2050 =head2 Hintsfile support
2052 MakeMaker.pm uses the architecture specific information from
2053 Config.pm. In addition it evaluates architecture specific hints files
2054 in a C<hints/> directory. The hints files are expected to be named
2055 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2056 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2057 MakeMaker within the WriteMakefile() subroutine, and can be used to
2058 execute commands as well as to include special variables. The rules
2059 which hintsfile is chosen are the same as in Configure.
2061 The hintsfile is eval()ed immediately after the arguments given to
2062 WriteMakefile are stuffed into a hash reference $self but before this
2063 reference becomes blessed. So if you want to do the equivalent to
2064 override or create an attribute you would say something like
2066 $self->{LIBS} = ['-ldbm -lucb -lc'];
2068 =head2 Distribution Support
2070 For authors of extensions MakeMaker provides several Makefile
2071 targets. Most of the support comes from the ExtUtils::Manifest module,
2072 where additional documentation can be found.
2076 =item make distcheck
2078 reports which files are below the build directory but not in the
2079 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2082 =item make skipcheck
2084 reports which files are skipped due to the entries in the
2085 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2088 =item make distclean
2090 does a realclean first and then the distcheck. Note that this is not
2091 needed to build a new distribution as long as you are sure that the
2092 MANIFEST file is ok.
2096 rewrites the MANIFEST file, adding all remaining files found (See
2097 ExtUtils::Manifest::mkmanifest() for details)
2101 Copies all the files that are in the MANIFEST file to a newly created
2102 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2103 exists, it will be removed first.
2107 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2108 a make test in that directory.
2112 First does a distdir. Then a command $(PREOP) which defaults to a null
2113 command, followed by $(TOUNIX), which defaults to a null command under
2114 UNIX, and will convert files in distribution directory to UNIX format
2115 otherwise. Next it runs C<tar> on that directory into a tarfile and
2116 deletes the directory. Finishes with a command $(POSTOP) which
2117 defaults to a null command.
2121 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2123 =item make uutardist
2125 Runs a tardist first and uuencodes the tarfile.
2129 First does a distdir. Then a command $(PREOP) which defaults to a null
2130 command. Next it runs C<shar> on that directory into a sharfile and
2131 deletes the intermediate directory again. Finishes with a command
2132 $(POSTOP) which defaults to a null command. Note: For shdist to work
2133 properly a C<shar> program that can handle directories is mandatory.
2137 First does a distdir. Then a command $(PREOP) which defaults to a null
2138 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2139 zipfile. Then deletes that directory. Finishes with a command
2140 $(POSTOP) which defaults to a null command.
2144 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2148 Customization of the dist targets can be done by specifying a hash
2149 reference to the dist attribute of the WriteMakefile call. The
2150 following parameters are recognized:
2153 COMPRESS ('gzip --best')
2156 TO_UNIX (depends on the system)
2157 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2167 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2169 =head2 Disabling an extension
2171 If some events detected in F<Makefile.PL> imply that there is no way
2172 to create the Module, but this is a normal state of things, then you
2173 can create a F<Makefile> which does nothing, but succeeds on all the
2174 "usual" build targets. To do so, use
2176 ExtUtils::MakeMaker::WriteEmptyMakefile();
2178 instead of WriteMakefile().
2180 This may be useful if other modules expect this module to be I<built>
2181 OK, as opposed to I<work> OK (say, this system-dependent module builds
2182 in a subdirectory of some other distribution, or is listed as a
2183 dependency in a CPAN::Bundle, but the functionality is supported by
2184 different means on the current architecture).
2192 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2193 C<WriteMakefile()>. The string is split on whitespace, and the result
2194 is processed before any actual command line arguments are processed.
2196 =item PERL_MM_USE_DEFAULT
2198 If set to a true value then MakeMaker's prompt function will
2199 always return the default without waiting for user input.
2205 ExtUtils::MM_Unix, ExtUtils::Manifest ExtUtils::Install,
2210 Andy Dougherty <F<doughera@lafayette.edu>>, Andreas KE<ouml>nig
2211 <F<andreas.koenig@mind.de>>, Tim Bunce <F<timb@cpan.org>>. VMS
2212 support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2 support
2213 by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>.
2215 Currently maintained by Michael G Schwern <F<schwern@pobox.com>>
2217 Send patches and ideas to <F<makemaker@perl.org>>.
2219 Send bug reports via http://rt.cpan.org/. Please send your
2220 generated Makefile along with your report.
2222 For more up-to-date information, see http://www.makemaker.org.