1 package ExtUtils::MakeMaker;
3 BEGIN {require 5.005_03;}
6 ($Revision) = q$Revision: 1.141 $ =~ /Revision:\s+(\S+)/;
14 @ISA @EXPORT @EXPORT_OK
15 $Revision $VERSION $Verbose %Config
16 @Prepend_parent @Parent
17 %Recognized_Att_Keys @Get_from_Config @MM_Sections @Overridable
23 @EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
24 @EXPORT_OK = qw($VERSION &neatvalue &mkbootstrap &mksymlists);
26 # These will go away once the last of the Win32 & VMS specific code is
28 my $Is_VMS = $^O eq 'VMS';
29 my $Is_Win32 = $^O eq 'MSWin32';
31 # Our filename for diagnostic and debugging purposes. More reliable
32 # than %INC (think caseless filesystems)
37 require ExtUtils::MM; # Things like CPAN assume loading ExtUtils::MakeMaker
40 require ExtUtils::MY; # XXX pre-5.8 versions of ExtUtils::Embed expect
41 # loading ExtUtils::MakeMaker will give them MY.
42 # This will go when Embed is it's own CPAN module.
46 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
53 my $mm = MM->new(\%att);
60 # Basic signatures of the attributes WriteMakefile takes. Each is the
61 # reference type. Empty value indicate it takes a non-reference
71 EXCLUDE_EXT => 'array',
76 INCLUDE_EXT => 'array',
87 _KEEP_AFTER_FLUSH => '',
98 tool_autosplit => 'hash',
101 @Att_Sigs{keys %Recognized_Att_Keys} = ('') x keys %Recognized_Att_Keys;
102 @Att_Sigs{keys %Special_Sigs} = values %Special_Sigs;
108 while( my($key, $val) = each %$att ) {
109 my $sig = $Att_Sigs{$key};
110 unless( defined $sig ) {
111 warn "WARNING: $key is not a known parameter.\n";
115 my @sigs = ref $sig ? @$sig : $sig;
116 my $given = lc ref $val;
117 unless( grep $given eq $_, @sigs ) {
118 my $takes = join " or ", map { $_ ne '' ? "$_ reference"
121 my $has = $given ne '' ? "$given reference"
123 warn "WARNING: $key takes a $takes not a $has.\n".
124 " Please inform the author.\n";
130 my($mess, $def) = @_;
131 Carp::confess("prompt function called without an argument")
132 unless defined $mess;
134 my $isa_tty = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ;
136 my $dispdef = defined $def ? "[$def] " : " ";
137 $def = defined $def ? $def : "";
141 print "$mess $dispdef";
144 if ($ENV{PERL_MM_USE_DEFAULT} || (!$isa_tty && eof STDIN)) {
152 else { # user hit ctrl-D
157 return (!defined $ans || $ans eq '') ? $def : $ans;
160 sub eval_in_subdirs {
162 use Cwd qw(cwd abs_path);
163 my $pwd = cwd() || die "Can't figure out your cwd!";
165 local @INC = map eval {abs_path($_) if -e} || $_, @INC;
166 push @INC, '.'; # '.' has to always be at the end of @INC
168 foreach my $dir (@{$self->{DIR}}){
169 my($abs) = $self->catdir($pwd,$dir);
170 eval { $self->eval_in_x($abs); };
179 chdir $dir or Carp::carp("Couldn't change to directory $dir: $!");
186 # if ($@ =~ /prerequisites/) {
187 # die "MakeMaker WARNING: $@";
189 # warn "WARNING from evaluation of $dir/Makefile.PL: $@";
191 die "ERROR from evaluation of $dir/Makefile.PL: $@";
196 # package name for the classes into which the first object will be blessed
197 my $PACKNAME = 'PACK000';
202 my @attrib_help = qw/
204 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
205 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
206 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE
207 FULLPERL FULLPERLRUN FULLPERLRUNINST
210 INST_ARCHLIB INST_SCRIPT INST_BIN INST_LIB INST_MAN1DIR INST_MAN3DIR
213 PERLPREFIX SITEPREFIX VENDORPREFIX
214 INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
215 INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
216 INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
217 INSTALLMAN1DIR INSTALLMAN3DIR
218 INSTALLSITEMAN1DIR INSTALLSITEMAN3DIR
219 INSTALLVENDORMAN1DIR INSTALLVENDORMAN3DIR
221 PERL_LIB PERL_ARCHLIB
222 SITELIBEXP SITEARCHEXP
224 INC INCLUDE_EXT LDFROM LIB LIBPERL_A LIBS
225 LINKTYPE MAKEAPERL MAKEFILE MAKEFILE_OLD MAN1PODS MAN3PODS MAP_TARGET
226 MYEXTLIB NAME NEEDS_LINKING NOECHO NO_META NORECURS NO_VC OBJECT OPTIMIZE
227 PERL_MALLOC_OK PERL PERLMAINCC PERLRUN PERLRUNINST PERL_CORE
228 PERL_SRC PERM_RW PERM_RWX
229 PL_FILES PM PM_FILTER PMLIBDIRS POLLUTE PPM_INSTALL_EXEC
230 PPM_INSTALL_SCRIPT PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
231 SIGN SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
232 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
235 MACPERL_SRC MACPERL_LIB MACLIBS_68K MACLIBS_PPC MACLIBS_SC MACLIBS_MRC
236 MACLIBS_ALL_68K MACLIBS_ALL_PPC MACLIBS_SHARED
239 # IMPORTS is used under OS/2 and Win32
241 # @Overridable is close to @MM_Sections but not identical. The
242 # order is important. Many subroutines declare macros. These
243 # depend on each other. Let's try to collect the macros up front,
244 # then pasthru, then the rules.
246 # MM_Sections are the sections we have to call explicitly
247 # in Overridable we have subroutines that are used indirectly
253 post_initialize const_config constants platform_constants
254 tool_autosplit tool_xsubpp tools_other
258 dist macro depend cflags const_loadlibs const_cccmd
265 top_targets linkext dlsyms dynamic dynamic_bs
266 dynamic_lib static static_lib manifypods processPL
268 clean_subdirs clean realclean_subdirs realclean
269 metafile metafile_addtomanifest
270 signature signature_addtomanifest
271 dist_basics dist_core distdir dist_test dist_ci
272 install force perldepend makefile staticmake test ppd
274 ); # loses section ordering
276 @Overridable = @MM_Sections;
277 push @Overridable, qw[
279 blibdirs_target libscan makeaperl needs_linking perm_rw perm_rwx
280 subdir_x test_via_harness test_via_script init_PERL
283 push @MM_Sections, qw[
285 pm_to_blib selfdocument
289 # Postamble needs to be the last that was always the case
290 push @MM_Sections, "postamble";
291 push @Overridable, "postamble";
293 # All sections are valid keys.
294 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
296 # we will use all these variables in the Makefile
299 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
300 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so
304 # 5.5.3 doesn't have any concept of vendor libs
305 push @Get_from_Config, qw( vendorarchexp vendorlibexp ) if $] >= 5.006;
307 foreach my $item (@attrib_help){
308 $Recognized_Att_Keys{$item} = 1;
310 foreach my $item (@Get_from_Config) {
311 $Recognized_Att_Keys{uc $item} = $Config{$item};
312 print "Attribute '\U$item\E' => '$Config{$item}'\n"
317 # When we eval a Makefile.PL in a subdirectory, that one will ask
318 # us (the parent) for the values and will prepend "..", so that
319 # all files to be installed end up below OUR ./blib
321 @Prepend_parent = qw(
322 INST_BIN INST_LIB INST_ARCHLIB INST_SCRIPT
323 MAP_TARGET INST_MAN1DIR INST_MAN3DIR PERL_SRC
331 The extension you are trying to build apparently is rather old and
332 most probably outdated. We detect that from the fact, that a
333 subroutine "writeMakefile" is called, and this subroutine is not
334 supported anymore since about October 1994.
336 Please contact the author or look into CPAN (details about CPAN can be
337 found in the FAQ and at http:/www.perl.com) for a more recent version
338 of the extension. If you're really desperate, you can try to change
339 the subroutine name from writeMakefile to WriteMakefile and rerun
340 'perl Makefile.PL', but you're most probably left alone, when you do
349 my($class,$self) = @_;
352 # Store the original args passed to WriteMakefile()
353 foreach my $k (keys %$self) {
354 $self->{ARGS}{$k} = $self->{$k};
357 if ("@ARGV" =~ /\bPREREQ_PRINT\b/) {
358 require Data::Dumper;
359 print Data::Dumper->Dump([$self->{PREREQ_PM}], [qw(PREREQ_PM)]);
363 # PRINT_PREREQ is RedHatism.
364 if ("@ARGV" =~ /\bPRINT_PREREQ\b/) {
365 print join(" ", map { "perl($_)>=$self->{PREREQ_PM}->{$_} " }
366 sort keys %{$self->{PREREQ_PM}}), "\n";
370 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
371 if (-f "MANIFEST" && ! -f "Makefile"){
375 $self = {} unless (defined $self);
379 my %configure_att; # record &{$self->{CONFIGURE}} attributes
380 my(%initial_att) = %$self; # record initial attributes
382 my(%unsatisfied) = ();
383 foreach my $prereq (sort keys %{$self->{PREREQ_PM}}) {
384 # 5.8.0 has a bug with require Foo::Bar alone in an eval, so an
385 # extra statement is a workaround.
386 my $file = "$prereq.pm";
388 eval { require $file };
390 my $pr_version = $prereq->VERSION || 0;
392 # convert X.Y_Z alpha version #s to X.YZ for easier comparisons
393 $pr_version =~ s/(\d+)\.(\d+)_(\d+)/$1.$2$3/;
396 warn sprintf "Warning: prerequisite %s %s not found.\n",
397 $prereq, $self->{PREREQ_PM}{$prereq}
398 unless $self->{PREREQ_FATAL};
399 $unsatisfied{$prereq} = 'not installed';
400 } elsif ($pr_version < $self->{PREREQ_PM}->{$prereq} ){
401 warn sprintf "Warning: prerequisite %s %s not found. We have %s.\n",
402 $prereq, $self->{PREREQ_PM}{$prereq},
403 ($pr_version || 'unknown version')
404 unless $self->{PREREQ_FATAL};
405 $unsatisfied{$prereq} = $self->{PREREQ_PM}->{$prereq} ?
406 $self->{PREREQ_PM}->{$prereq} : 'unknown version' ;
409 if (%unsatisfied && $self->{PREREQ_FATAL}){
410 my $failedprereqs = join ', ', map {"$_ $unsatisfied{$_}"}
412 die qq{MakeMaker FATAL: prerequisites not found ($failedprereqs)\n
413 Please install these modules first and rerun 'perl Makefile.PL'.\n};
416 if (defined $self->{CONFIGURE}) {
417 if (ref $self->{CONFIGURE} eq 'CODE') {
418 %configure_att = %{&{$self->{CONFIGURE}}};
419 $self = { %$self, %configure_att };
421 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
425 # This is for old Makefiles written pre 5.00, will go away
426 if ( Carp::longmess("") =~ /runsubdirpl/s ){
427 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
430 my $newclass = ++$PACKNAME;
431 local @Parent = @Parent; # Protect against non-local exits
434 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
435 mv_all_methods("MY",$newclass);
436 bless $self, $newclass;
438 require ExtUtils::MY;
439 @{"$newclass\:\:ISA"} = 'MM';
442 if (defined $Parent[-2]){
443 $self->{PARENT} = $Parent[-2];
445 for $key (@Prepend_parent) {
446 next unless defined $self->{PARENT}{$key};
448 # Don't stomp on WriteMakefile() args.
449 next if defined $self->{ARGS}{$key} and
450 $self->{ARGS}{$key} eq $self->{$key};
452 $self->{$key} = $self->{PARENT}{$key};
454 unless ($Is_VMS && $key =~ /PERL$/) {
455 $self->{$key} = $self->catdir("..",$self->{$key})
456 unless $self->file_name_is_absolute($self->{$key});
458 # PERL or FULLPERL will be a command verb or even a
459 # command with an argument instead of a full file
460 # specification under VMS. So, don't turn the command
461 # into a filespec, but do add a level to the path of
462 # the argument if not already absolute.
463 my @cmd = split /\s+/, $self->{$key};
464 $cmd[1] = $self->catfile('[-]',$cmd[1])
465 unless (@cmd < 2) || $self->file_name_is_absolute($cmd[1]);
466 $self->{$key} = join(' ', @cmd);
469 if ($self->{PARENT}) {
470 $self->{PARENT}->{CHILDREN}->{$newclass} = $self;
471 foreach my $opt (qw(POLLUTE PERL_CORE)) {
472 if (exists $self->{PARENT}->{$opt}
473 and not exists $self->{$opt})
475 # inherit, but only if already unspecified
476 $self->{$opt} = $self->{PARENT}->{$opt};
480 my @fm = grep /^FIRST_MAKEFILE=/, @ARGV;
481 parse_args($self,@fm) if @fm;
483 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
486 $self->{NAME} ||= $self->guess_name;
488 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
499 $self->init_DIRFILESEP;
502 if (! $self->{PERL_SRC} ) {
503 require VMS::Filespec if $Is_VMS;
504 my($pthinks) = $self->canonpath($INC{'Config.pm'});
505 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
506 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
507 if ($pthinks ne $cthinks &&
508 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
509 print "Have $pthinks expected $cthinks\n";
511 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
514 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
516 print STDOUT <<END unless $self->{UNINSTALLED_PERL};
517 Your perl and your Config.pm seem to have different ideas about the
518 architecture they are running on.
519 Perl thinks: [$pthinks]
520 Config says: [$Config{archname}]
521 This may or may not cause problems. Please check your installation of perl
522 if you have problems building this extension.
527 $self->init_others();
528 $self->init_platform();
530 my($argv) = neatvalue(\@ARGV);
534 push @{$self->{RESULT}}, <<END;
535 # This Makefile is for the $self->{NAME} extension to perl.
537 # It was generated automatically by MakeMaker version
538 # $VERSION (Revision: $Revision) from the contents of
539 # Makefile.PL. Don't edit this file, edit Makefile.PL instead.
541 # ANY CHANGES MADE HERE WILL BE LOST!
543 # MakeMaker ARGV: $argv
545 # MakeMaker Parameters:
548 foreach my $key (sort keys %initial_att){
549 next if $key eq 'ARGS';
551 my($v) = neatvalue($initial_att{$key});
552 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
554 push @{$self->{RESULT}}, "# $key => $v";
556 undef %initial_att; # free memory
558 if (defined $self->{CONFIGURE}) {
559 push @{$self->{RESULT}}, <<END;
561 # MakeMaker 'CONFIGURE' Parameters:
563 if (scalar(keys %configure_att) > 0) {
564 foreach my $key (sort keys %configure_att){
565 next if $key eq 'ARGS';
566 my($v) = neatvalue($configure_att{$key});
567 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
569 push @{$self->{RESULT}}, "# $key => $v";
574 push @{$self->{RESULT}}, "# no values returned";
576 undef %configure_att; # free memory
579 # turn the SKIP array into a SKIPHASH hash
581 for $skip (@{$self->{SKIP} || []}) {
582 $self->{SKIPHASH}{$skip} = 1;
584 delete $self->{SKIP}; # free memory
586 if ($self->{PARENT}) {
587 for (qw/install dist dist_basics dist_core distdir dist_test dist_ci/) {
588 $self->{SKIPHASH}{$_} = 1;
592 # We run all the subdirectories now. They don't have much to query
593 # from the parent, but the parent has to query them: if they need linking!
594 unless ($self->{NORECURS}) {
595 $self->eval_in_subdirs if @{$self->{DIR}};
598 foreach my $section ( @MM_Sections ){
599 # Support for new foo_target() methods.
600 my $method = $section;
601 $method .= '_target' unless $self->can($method);
603 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
604 my($skipit) = $self->skipcheck($section);
606 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
608 my(%a) = %{$self->{$section} || {}};
609 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
610 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
611 push @{$self->{RESULT}}, $self->nicetext($self->$method( %a ));
615 push @{$self->{RESULT}}, "\n# End.";
620 sub WriteEmptyMakefile {
621 Carp::croak "WriteEmptyMakefile: Need even number of args" if @_ % 2;
624 my $self = MM->new(\%att);
625 if (-f $self->{MAKEFILE_OLD}) {
626 _unlink($self->{MAKEFILE_OLD}) or
627 warn "unlink $self->{MAKEFILE_OLD}: $!";
629 if ( -f $self->{MAKEFILE} ) {
630 _rename($self->{MAKEFILE}, $self->{MAKEFILE_OLD}) or
631 warn "rename $self->{MAKEFILE} => $self->{MAKEFILE_OLD}: $!"
633 open MF, '>'.$self->{MAKEFILE} or die "open $self->{MAKEFILE} for write: $!";
646 close MF or die "close $self->{MAKEFILE} for write: $!";
650 print STDOUT "Checking if your kit is complete...\n";
651 require ExtUtils::Manifest;
653 $ExtUtils::Manifest::Quiet = $ExtUtils::Manifest::Quiet = 1;
654 my(@missed) = ExtUtils::Manifest::manicheck();
656 print STDOUT "Warning: the following files are missing in your kit:\n";
657 print "\t", join "\n\t", @missed;
659 print STDOUT "Please inform the author.\n";
661 print STDOUT "Looks good\n";
666 my($self, @args) = @_;
668 unless (m/(.*?)=(.*)/) {
669 ++$Verbose if m/^verb/;
672 my($name, $value) = ($1, $2);
673 if ($value =~ m/^~(\w+)?/) { # tilde with optional username
674 $value =~ s [^~(\w*)]
676 ((getpwnam($1))[7] || "~$1") :
681 # Remember the original args passed it. It will be useful later.
682 $self->{ARGS}{uc $name} = $self->{uc $name} = $value;
685 # catch old-style 'potential_libs' and inform user how to 'upgrade'
686 if (defined $self->{potential_libs}){
687 my($msg)="'potential_libs' => '$self->{potential_libs}' should be";
688 if ($self->{potential_libs}){
689 print STDOUT "$msg changed to:\n\t'LIBS' => ['$self->{potential_libs}']\n";
691 print STDOUT "$msg deleted.\n";
693 $self->{LIBS} = [$self->{potential_libs}];
694 delete $self->{potential_libs};
696 # catch old-style 'ARMAYBE' and inform user how to 'upgrade'
697 if (defined $self->{ARMAYBE}){
698 my($armaybe) = $self->{ARMAYBE};
699 print STDOUT "ARMAYBE => '$armaybe' should be changed to:\n",
700 "\t'dynamic_lib' => {ARMAYBE => '$armaybe'}\n";
701 my(%dl) = %{$self->{dynamic_lib} || {}};
702 $self->{dynamic_lib} = { %dl, ARMAYBE => $armaybe};
703 delete $self->{ARMAYBE};
705 if (defined $self->{LDTARGET}){
706 print STDOUT "LDTARGET should be changed to LDFROM\n";
707 $self->{LDFROM} = $self->{LDTARGET};
708 delete $self->{LDTARGET};
710 # Turn a DIR argument on the command line into an array
711 if (defined $self->{DIR} && ref \$self->{DIR} eq 'SCALAR') {
712 # So they can choose from the command line, which extensions they want
713 # the grep enables them to have some colons too much in case they
714 # have to build a list with the shell
715 $self->{DIR} = [grep $_, split ":", $self->{DIR}];
717 # Turn a INCLUDE_EXT argument on the command line into an array
718 if (defined $self->{INCLUDE_EXT} && ref \$self->{INCLUDE_EXT} eq 'SCALAR') {
719 $self->{INCLUDE_EXT} = [grep $_, split '\s+', $self->{INCLUDE_EXT}];
721 # Turn a EXCLUDE_EXT argument on the command line into an array
722 if (defined $self->{EXCLUDE_EXT} && ref \$self->{EXCLUDE_EXT} eq 'SCALAR') {
723 $self->{EXCLUDE_EXT} = [grep $_, split '\s+', $self->{EXCLUDE_EXT}];
726 foreach my $mmkey (sort keys %$self){
727 next if $mmkey eq 'ARGS';
728 print STDOUT " $mmkey => ", neatvalue($self->{$mmkey}), "\n" if $Verbose;
729 print STDOUT "'$mmkey' is not a known MakeMaker parameter name.\n"
730 unless exists $Recognized_Att_Keys{$mmkey};
737 # We allow extension-specific hints files.
740 my $curdir = File::Spec->curdir;
742 my $hint_dir = File::Spec->catdir($curdir, "hints");
743 return unless -d $hint_dir;
745 # First we look for the best hintsfile we have
746 my($hint)="${^O}_$Config{osvers}";
751 # Also try without trailing minor version numbers.
753 last if -f File::Spec->catfile($hint_dir, "$hint.pl"); # found
755 last unless $hint =~ s/_[^_]*$//; # nothing to cut off
757 my $hint_file = File::Spec->catfile($hint_dir, "$hint.pl");
759 return unless -f $hint_file; # really there
761 _run_hintfile($self, $hint_file);
766 local($self) = shift; # make $self available to the hint file.
767 my($hint_file) = shift;
770 print STDERR "Processing hints file $hint_file\n";
772 # Just in case the ./ isn't on the hint file, which File::Spec can
773 # often strip off, we bung the curdir into @INC
774 local @INC = (File::Spec->curdir, @INC);
775 my $ret = do $hint_file;
776 if( !defined $ret ) {
777 my $error = $@ || $!;
785 my($symtab) = \%{"${from}::"};
787 # Here you see the *current* list of methods that are overridable
788 # from Makefile.PL via MY:: subroutines. As of VERSION 5.07 I'm
789 # still trying to reduce the list to some reasonable minimum --
790 # because I want to make it easier for the user. A.K.
792 local $SIG{__WARN__} = sub {
793 # can't use 'no warnings redefined', 5.6 only
794 warn @_ unless $_[0] =~ /^Subroutine .* redefined/
796 foreach my $method (@Overridable) {
798 # We cannot say "next" here. Nick might call MY->makeaperl
799 # which isn't defined right now
801 # Above statement was written at 4.23 time when Tk-b8 was
802 # around. As Tk-b9 only builds with 5.002something and MM 5 is
803 # standard, we try to enable the next line again. It was
804 # commented out until MM 5.23
806 next unless defined &{"${from}::$method"};
808 *{"${to}::$method"} = \&{"${from}::$method"};
810 # delete would do, if we were sure, nobody ever called
811 # MY->makeaperl directly
813 # delete $symtab->{$method};
815 # If we delete a method, then it will be undefined and cannot
816 # be called. But as long as we have Makefile.PLs that rely on
817 # %MY:: being intact, we have to fill the hole with an
820 eval "package MY; sub $method { shift->SUPER::$method(\@_); }";
823 # We have to clean out %INC also, because the current directory is
824 # changed frequently and Graham Barr prefers to get his version
825 # out of a History.pl file which is "required" so woudn't get
826 # loaded again in another extension requiring a History.pl
828 # With perl5.002_01 the deletion of entries in %INC caused Tk-b11
829 # to core dump in the middle of a require statement. The required
830 # file was Tk/MMutil.pm. The consequence is, we have to be
831 # extremely careful when we try to give perl a reason to reload a
832 # library with same name. The workaround prefers to drop nothing
833 # from %INC and teach the writers not to use such libraries.
836 # foreach $inc (keys %INC) {
837 # #warn "***$inc*** deleted";
845 if ($section eq 'dynamic') {
846 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
847 "in skipped section 'dynamic_bs'\n"
848 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
849 print STDOUT "Warning (non-fatal): Target 'dynamic' depends on targets ",
850 "in skipped section 'dynamic_lib'\n"
851 if $self->{SKIPHASH}{dynamic_lib} && $Verbose;
853 if ($section eq 'dynamic_lib') {
854 print STDOUT "Warning (non-fatal): Target '\$(INST_DYNAMIC)' depends on ",
855 "targets in skipped section 'dynamic_bs'\n"
856 if $self->{SKIPHASH}{dynamic_bs} && $Verbose;
858 if ($section eq 'static') {
859 print STDOUT "Warning (non-fatal): Target 'static' depends on targets ",
860 "in skipped section 'static_lib'\n"
861 if $self->{SKIPHASH}{static_lib} && $Verbose;
863 return 'skipped' if $self->{SKIPHASH}{$section};
871 print STDOUT "Writing $self->{MAKEFILE} for $self->{NAME}\n";
873 unlink($self->{MAKEFILE}, "MakeMaker.tmp", $Is_VMS ? 'Descrip.MMS' : '');
874 open(FH,">MakeMaker.tmp") or die "Unable to open MakeMaker.tmp: $!";
876 for $chunk (@{$self->{RESULT}}) {
881 my($finalname) = $self->{MAKEFILE};
882 _rename("MakeMaker.tmp", $finalname) or
883 warn "rename MakeMaker.tmp => $finalname: $!";
884 chmod 0644, $finalname unless $Is_VMS;
886 my %keep = map { ($_ => 1) } qw(NEEDS_LINKING HAS_LINK_CODE);
888 if ($self->{PARENT} && !$self->{_KEEP_AFTER_FLUSH}) {
889 foreach (keys %$self) { # safe memory
890 delete $self->{$_} unless $keep{$_};
894 system("$Config::Config{eunicefix} $finalname") unless $Config::Config{eunicefix} eq ":";
898 # This is a rename for OS's where the target must be unlinked first.
900 my($src, $dest) = @_;
903 return rename $src, $dest;
906 # This is an unlink for OS's where the target must be writable first.
910 return unlink @files;
914 # The following mkbootstrap() is only for installations that are calling
915 # the pre-4.1 mkbootstrap() from their old Makefiles. This MakeMaker
916 # writes Makefiles, that use ExtUtils::Mkbootstrap directly.
919 !!! Your Makefile has been built such a long time ago, !!!
920 !!! that is unlikely to work with current MakeMaker. !!!
921 !!! Please rebuild your Makefile !!!
925 # Ditto for mksymlists() as of MakeMaker 5.17
928 !!! Your Makefile has been built such a long time ago, !!!
929 !!! that is unlikely to work with current MakeMaker. !!!
930 !!! Please rebuild your Makefile !!!
936 return "undef" unless defined $v;
938 return "q[$v]" unless $t;
942 foreach my $elem (@$v) {
943 push @neat, "q[$elem]";
945 push @m, join ", ", @neat;
949 return "$v" unless $t eq 'HASH';
951 while (($key,$val) = each %$v){
952 last unless defined $key; # cautious programming in case (undef,undef) is true
953 push(@m,"$key=>".neatvalue($val)) ;
955 return "{ ".join(', ',@m)." }";
962 push @m, "\n# Full list of MakeMaker attribute values:";
963 foreach my $key (sort keys %$self){
964 next if $key eq 'RESULT' || $key =~ /^[A-Z][a-z]/;
965 my($v) = neatvalue($self->{$key});
966 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
968 push @m, "# $key => $v";
980 ExtUtils::MakeMaker - Create a module Makefile
984 use ExtUtils::MakeMaker;
986 WriteMakefile( ATTRIBUTE => VALUE [, ...] );
990 This utility is designed to write a Makefile for an extension module
991 from a Makefile.PL. It is based on the Makefile.SH model provided by
992 Andy Dougherty and the perl5-porters.
994 It splits the task of generating the Makefile into several subroutines
995 that can be individually overridden. Each subroutine returns the text
996 it wishes to have written to the Makefile.
998 MakeMaker is object oriented. Each directory below the current
999 directory that contains a Makefile.PL is treated as a separate
1000 object. This makes it possible to write an unlimited number of
1001 Makefiles with a single invocation of WriteMakefile().
1003 =head2 How To Write A Makefile.PL
1005 See ExtUtils::MakeMaker::Tutorial.
1007 The long answer is the rest of the manpage :-)
1009 =head2 Default Makefile Behaviour
1011 The generated Makefile enables the user of the extension to invoke
1013 perl Makefile.PL # optionally "perl Makefile.PL verbose"
1015 make test # optionally set TEST_VERBOSE=1
1016 make install # See below
1018 The Makefile to be produced may be altered by adding arguments of the
1019 form C<KEY=VALUE>. E.g.
1021 perl Makefile.PL PREFIX=/tmp/myperl5
1023 Other interesting targets in the generated Makefile are
1025 make config # to check if the Makefile is up-to-date
1026 make clean # delete local temp files (Makefile gets renamed)
1027 make realclean # delete derived files (including ./blib)
1028 make ci # check in all the files in the MANIFEST file
1029 make dist # see below the Distribution Support section
1033 MakeMaker checks for the existence of a file named F<test.pl> in the
1034 current directory and if it exists it execute the script with the
1035 proper set of perl C<-I> options.
1037 MakeMaker also checks for any files matching glob("t/*.t"). It will
1038 execute all matching files in alphabetical order via the
1039 L<Test::Harness> module with the C<-I> switches set correctly.
1041 If you'd like to see the raw output of your tests, set the
1042 C<TEST_VERBOSE> variable to true.
1044 make test TEST_VERBOSE=1
1048 A useful variation of the above is the target C<testdb>. It runs the
1049 test under the Perl debugger (see L<perldebug>). If the file
1050 F<test.pl> exists in the current directory, it is used for the test.
1052 If you want to debug some other testfile, set the C<TEST_FILE> variable
1055 make testdb TEST_FILE=t/mytest.t
1057 By default the debugger is called using C<-d> option to perl. If you
1058 want to specify some other option, set the C<TESTDB_SW> variable:
1060 make testdb TESTDB_SW=-Dx
1064 make alone puts all relevant files into directories that are named by
1065 the macros INST_LIB, INST_ARCHLIB, INST_SCRIPT, INST_MAN1DIR and
1066 INST_MAN3DIR. All these default to something below ./blib if you are
1067 I<not> building below the perl source directory. If you I<are>
1068 building below the perl source, INST_LIB and INST_ARCHLIB default to
1069 ../../lib, and INST_SCRIPT is not defined.
1071 The I<install> target of the generated Makefile copies the files found
1072 below each of the INST_* directories to their INSTALL*
1073 counterparts. Which counterparts are chosen depends on the setting of
1074 INSTALLDIRS according to the following table:
1079 PERLPREFIX SITEPREFIX VENDORPREFIX
1080 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH INSTALLVENDORARCH
1081 INST_LIB INSTALLPRIVLIB INSTALLSITELIB INSTALLVENDORLIB
1082 INST_BIN INSTALLBIN INSTALLSITEBIN INSTALLVENDORBIN
1083 INST_SCRIPT INSTALLSCRIPT INSTALLSCRIPT INSTALLSCRIPT
1084 INST_MAN1DIR INSTALLMAN1DIR INSTALLSITEMAN1DIR INSTALLVENDORMAN1DIR
1085 INST_MAN3DIR INSTALLMAN3DIR INSTALLSITEMAN3DIR INSTALLVENDORMAN3DIR
1087 The INSTALL... macros in turn default to their %Config
1088 ($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
1090 You can check the values of these variables on your system with
1094 And to check the sequence in which the library directories are
1095 searched by perl, run
1097 perl -le 'print join $/, @INC'
1099 Sometimes older versions of the module you're installing live in other
1100 directories in @INC. Because Perl loads the first version of a module it
1101 finds, not the newest, you might accidentally get one of these older
1102 versions even after installing a brand new version. To delete I<all other
1103 versions of the module you're installing> (not simply older ones) set the
1106 make install UNINST=1
1109 =head2 PREFIX and LIB attribute
1111 PREFIX and LIB can be used to set several INSTALL* attributes in one
1112 go. The quickest way to install a module in a non-standard place might
1115 perl Makefile.PL PREFIX=~
1117 This will install all files in the module under your home directory,
1118 with man pages and libraries going into an appropriate place (usually
1121 Another way to specify many INSTALL directories with a single
1124 perl Makefile.PL LIB=~/lib
1126 This will install the module's architecture-independent files into
1127 ~/lib, the architecture-dependent files into ~/lib/$archname.
1129 Note, that in both cases the tilde expansion is done by MakeMaker, not
1130 by perl by default, nor by make.
1132 Conflicts between parameters LIB, PREFIX and the various INSTALL*
1133 arguments are resolved so that:
1139 setting LIB overrides any setting of INSTALLPRIVLIB, INSTALLARCHLIB,
1140 INSTALLSITELIB, INSTALLSITEARCH (and they are not affected by PREFIX);
1144 without LIB, setting PREFIX replaces the initial C<$Config{prefix}>
1145 part of those INSTALL* arguments, even if the latter are explicitly
1146 set (but are set to still start with C<$Config{prefix}>).
1150 If the user has superuser privileges, and is not working on AFS or
1151 relatives, then the defaults for INSTALLPRIVLIB, INSTALLARCHLIB,
1152 INSTALLSCRIPT, etc. will be appropriate, and this incantation will be
1160 make install per default writes some documentation of what has been
1161 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1162 can be bypassed by calling make pure_install.
1166 will have to specify the installation directories as these most
1167 probably have changed since perl itself has been installed. They will
1168 have to do this by calling
1170 perl Makefile.PL INSTALLSITELIB=/afs/here/today \
1171 INSTALLSCRIPT=/afs/there/now INSTALLMAN3DIR=/afs/for/manpages
1174 Be careful to repeat this procedure every time you recompile an
1175 extension, unless you are sure the AFS installation directories are
1178 =head2 Static Linking of a new Perl Binary
1180 An extension that is built with the above steps is ready to use on
1181 systems supporting dynamic loading. On systems that do not support
1182 dynamic loading, any newly created extension has to be linked together
1183 with the available resources. MakeMaker supports the linking process
1184 by creating appropriate targets in the Makefile whenever an extension
1185 is built. You can invoke the corresponding section of the makefile with
1189 That produces a new perl binary in the current directory with all
1190 extensions linked in that can be found in INST_ARCHLIB, SITELIBEXP,
1191 and PERL_ARCHLIB. To do that, MakeMaker writes a new Makefile, on
1192 UNIX, this is called Makefile.aperl (may be system dependent). If you
1193 want to force the creation of a new perl, it is recommended, that you
1194 delete this Makefile.aperl, so the directories are searched-through
1195 for linkable libraries again.
1197 The binary can be installed into the directory where perl normally
1198 resides on your machine with
1202 To produce a perl binary with a different name than C<perl>, either say
1204 perl Makefile.PL MAP_TARGET=myperl
1211 make myperl MAP_TARGET=myperl
1212 make inst_perl MAP_TARGET=myperl
1214 In any case you will be prompted with the correct invocation of the
1215 C<inst_perl> target that installs the new binary into INSTALLBIN.
1217 make inst_perl per default writes some documentation of what has been
1218 done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This
1219 can be bypassed by calling make pure_inst_perl.
1221 Warning: the inst_perl: target will most probably overwrite your
1222 existing perl binary. Use with care!
1224 Sometimes you might want to build a statically linked perl although
1225 your system supports dynamic loading. In this case you may explicitly
1226 set the linktype with the invocation of the Makefile.PL or make:
1228 perl Makefile.PL LINKTYPE=static # recommended
1232 make LINKTYPE=static # works on most systems
1234 =head2 Determination of Perl Library and Installation Locations
1236 MakeMaker needs to know, or to guess, where certain things are
1237 located. Especially INST_LIB and INST_ARCHLIB (where to put the files
1238 during the make(1) run), PERL_LIB and PERL_ARCHLIB (where to read
1239 existing modules from), and PERL_INC (header files and C<libperl*.*>).
1241 Extensions may be built either using the contents of the perl source
1242 directory tree or from the installed perl library. The recommended way
1243 is to build extensions after you have run 'make install' on perl
1244 itself. You can do that in any directory on your hard disk that is not
1245 below the perl source tree. The support for extensions below the ext
1246 directory of the perl distribution is only good for the standard
1247 extensions that come with perl.
1249 If an extension is being built below the C<ext/> directory of the perl
1250 source then MakeMaker will set PERL_SRC automatically (e.g.,
1251 C<../..>). If PERL_SRC is defined and the extension is recognized as
1252 a standard extension, then other variables default to the following:
1255 PERL_LIB = PERL_SRC/lib
1256 PERL_ARCHLIB = PERL_SRC/lib
1258 INST_ARCHLIB = PERL_ARCHLIB
1260 If an extension is being built away from the perl source then MakeMaker
1261 will leave PERL_SRC undefined and default to using the installed copy
1262 of the perl library. The other variables default to the following:
1264 PERL_INC = $archlibexp/CORE
1265 PERL_LIB = $privlibexp
1266 PERL_ARCHLIB = $archlibexp
1267 INST_LIB = ./blib/lib
1268 INST_ARCHLIB = ./blib/arch
1270 If perl has not yet been installed then PERL_SRC can be defined on the
1271 command line as shown in the previous section.
1274 =head2 Which architecture dependent directory?
1276 If you don't want to keep the defaults for the INSTALL* macros,
1277 MakeMaker helps you to minimize the typing needed: the usual
1278 relationship between INSTALLPRIVLIB and INSTALLARCHLIB is determined
1279 by Configure at perl compilation time. MakeMaker supports the user who
1280 sets INSTALLPRIVLIB. If INSTALLPRIVLIB is set, but INSTALLARCHLIB not,
1281 then MakeMaker defaults the latter to be the same subdirectory of
1282 INSTALLPRIVLIB as Configure decided for the counterparts in %Config ,
1283 otherwise it defaults to INSTALLPRIVLIB. The same relationship holds
1284 for INSTALLSITELIB and INSTALLSITEARCH.
1286 MakeMaker gives you much more freedom than needed to configure
1287 internal variables and get different results. It is worth to mention,
1288 that make(1) also lets you configure most of the variables that are
1289 used in the Makefile. But in the majority of situations this will not
1290 be necessary, and should only be done if the author of a package
1291 recommends it (or you know what you're doing).
1293 =head2 Using Attributes and Parameters
1295 The following attributes may be specified as arguments to WriteMakefile()
1296 or as NAME=VALUE pairs on the command line.
1302 One line description of the module. Will be included in PPD file.
1306 Name of the file that contains the package description. MakeMaker looks
1307 for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1308 the first line in the "=head1 NAME" section. $2 becomes the abstract.
1312 String containing name (and email address) of package author(s). Is used
1313 in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1315 =item BINARY_LOCATION
1317 Used when creating PPD files for binary packages. It can be set to a
1318 full or relative path or URL to the binary archive for a particular
1319 architecture. For example:
1321 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1323 builds a PPD package that references a binary of the C<Agent> package,
1324 located in the C<x86> directory relative to the PPD itself.
1328 Ref to array of *.c file names. Initialised from a directory scan
1329 and the values portion of the XS attribute hash. This is not
1330 currently used by MakeMaker but may be handy in Makefile.PLs.
1334 String that will be included in the compiler call command line between
1335 the arguments INC and OPTIMIZE.
1339 Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1340 config.sh. MakeMaker will add to CONFIG the following values anyway:
1360 CODE reference. The subroutine should return a hash reference. The
1361 hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
1362 be determined by some evaluation method.
1366 Something like C<"-DHAVE_UNISTD_H">
1370 This is the root directory into which the code will be installed. It
1371 I<prepends itself to the normal prefix>. For example, if your code
1372 would normally go into /usr/local/lib/perl you could set DESTDIR=/tmp/
1373 and installation would go into /tmp/usr/local/lib/perl.
1375 This is primarily of use for people who repackage Perl modules.
1377 NOTE: Due to the nature of make, it is important that you put the trailing
1378 slash on your DESTDIR. "/tmp/" not "/tmp".
1382 Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1387 A safe filename for the package.
1389 Defaults to NAME above but with :: replaced with -.
1391 For example, Foo::Bar becomes Foo-Bar.
1395 Your name for distributing the package with the version number
1396 included. This is used by 'make dist' to name the resulting archive
1399 Defaults to DISTNAME-VERSION.
1401 For example, version 1.04 of Foo::Bar becomes Foo-Bar-1.04.
1403 On some OS's where . has special meaning VERSION_SYM may be used in
1408 Hashref of symbol names for routines to be made available as universal
1409 symbols. Each key/value pair consists of the package name and an
1410 array of routine names in that package. Used only under AIX, OS/2,
1411 VMS and Win32 at present. The routine names supplied will be expanded
1412 in the same way as XSUB names are expanded by the XS() macro.
1415 {"$(NAME)" => ["boot_$(NAME)" ] }
1419 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1420 "NetconfigPtr" => [ 'DESTROY'] }
1422 Please see the L<ExtUtils::Mksymlists> documentation for more information
1423 about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1427 Array of symbol names for variables to be made available as universal symbols.
1428 Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1429 (e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
1433 Array of extension names to exclude when doing a static build. This
1434 is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1435 details. (e.g. [ qw( Socket POSIX ) ] )
1437 This attribute may be most useful when specified as a string on the
1438 command line: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1442 Ref to array of executable files. The files will be copied to the
1443 INST_SCRIPT directory. Make realclean will delete them from there
1446 If your executables start with something like #!perl or
1447 #!/usr/bin/perl MakeMaker will change this to the path of the perl
1448 'Makefile.PL' was invoked with so the programs will be sure to run
1449 properly even if perl is not in /usr/bin/perl.
1451 =item FIRST_MAKEFILE
1453 The name of the Makefile to be produced. This is used for the second
1454 Makefile that will be produced for the MAP_TARGET.
1456 Defaults to 'Makefile' or 'Descrip.MMS' on VMS.
1458 (Note: we couldn't use MAKEFILE because dmake uses this for something
1463 Perl binary able to run this extension, load XS modules, etc...
1467 Like PERLRUN, except it uses FULLPERL.
1469 =item FULLPERLRUNINST
1471 Like PERLRUNINST, except it uses FULLPERL.
1475 This provides an alternate means to specify function names to be
1476 exported from the extension. Its value is a reference to an
1477 array of function names to be exported by the extension. These
1478 names are passed through unaltered to the linker options file.
1482 Ref to array of *.h file names. Similar to C.
1486 This attribute is used to specify names to be imported into the
1487 extension. Takes a hash ref.
1489 It is only used on OS/2 and Win32.
1493 Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1497 Array of extension names to be included when doing a static build.
1498 MakeMaker will normally build with all of the installed extensions when
1499 doing a static build, and that is usually the desired behavior. If
1500 INCLUDE_EXT is present then MakeMaker will build only with those extensions
1501 which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1503 It is not necessary to mention DynaLoader or the current extension when
1504 filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1505 only DynaLoader and the current extension will be included in the build.
1507 This attribute may be most useful when specified as a string on the
1508 command line: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1510 =item INSTALLARCHLIB
1512 Used by 'make install', which copies files from INST_ARCHLIB to this
1513 directory if INSTALLDIRS is set to perl.
1517 Directory to install binary files (e.g. tkperl) into if
1522 Determines which of the sets of installation directories to choose:
1523 perl, site or vendor. Defaults to site.
1525 =item INSTALLMAN1DIR
1527 =item INSTALLMAN3DIR
1529 These directories get the man pages at 'make install' time if
1530 INSTALLDIRS=perl. Defaults to $Config{installman*dir}.
1532 If set to 'none', no man pages will be installed.
1534 =item INSTALLPRIVLIB
1536 Used by 'make install', which copies files from INST_LIB to this
1537 directory if INSTALLDIRS is set to perl.
1539 Defaults to $Config{installprivlib}.
1543 Used by 'make install' which copies files from INST_SCRIPT to this
1546 =item INSTALLSITEARCH
1548 Used by 'make install', which copies files from INST_ARCHLIB to this
1549 directory if INSTALLDIRS is set to site (default).
1551 =item INSTALLSITEBIN
1553 Used by 'make install', which copies files from INST_BIN to this
1554 directory if INSTALLDIRS is set to site (default).
1556 =item INSTALLSITELIB
1558 Used by 'make install', which copies files from INST_LIB to this
1559 directory if INSTALLDIRS is set to site (default).
1561 =item INSTALLSITEMAN1DIR
1563 =item INSTALLSITEMAN3DIR
1565 These directories get the man pages at 'make install' time if
1566 INSTALLDIRS=site (default). Defaults to
1567 $(SITEPREFIX)/man/man$(MAN*EXT).
1569 If set to 'none', no man pages will be installed.
1571 =item INSTALLVENDORARCH
1573 Used by 'make install', which copies files from INST_ARCHLIB to this
1574 directory if INSTALLDIRS is set to vendor.
1576 =item INSTALLVENDORBIN
1578 Used by 'make install', which copies files from INST_BIN to this
1579 directory if INSTALLDIRS is set to vendor.
1581 =item INSTALLVENDORLIB
1583 Used by 'make install', which copies files from INST_LIB to this
1584 directory if INSTALLDIRS is set to vendor.
1586 =item INSTALLVENDORMAN1DIR
1588 =item INSTALLVENDORMAN3DIR
1590 These directories get the man pages at 'make install' time if
1591 INSTALLDIRS=vendor. Defaults to $(VENDORPREFIX)/man/man$(MAN*EXT).
1593 If set to 'none', no man pages will be installed.
1597 Same as INST_LIB for architecture dependent files.
1601 Directory to put real binary files during 'make'. These will be copied
1602 to INSTALLBIN during 'make install'
1606 Directory where we put library files of this extension while building
1611 Directory to hold the man pages at 'make' time
1615 Directory to hold the man pages at 'make' time
1619 Directory, where executable files should be installed during
1620 'make'. Defaults to "./blib/script", just to have a dummy location during
1621 testing. make install will copy the files in INST_SCRIPT to
1626 Program to be used to link libraries for dynamic loading.
1628 Defaults to $Config{ld}.
1632 Any special flags that might need to be passed to ld to create a
1633 shared library suitable for dynamic loading. It is up to the makefile
1634 to use it. (See L<Config/lddlflags>)
1636 Defaults to $Config{lddlflags}.
1640 Defaults to "$(OBJECT)" and is used in the ld command to specify
1641 what files to link/load from (also see dynamic_lib below for how to
1646 LIB should only be set at C<perl Makefile.PL> time but is allowed as a
1647 MakeMaker argument. It has the effect of setting both INSTALLPRIVLIB
1648 and INSTALLSITELIB to that value regardless any explicit setting of
1649 those arguments (or of PREFIX). INSTALLARCHLIB and INSTALLSITEARCH
1650 are set to the corresponding architecture subdirectory.
1654 The filename of the perllibrary that will be used together with this
1655 extension. Defaults to libperl.a.
1659 An anonymous array of alternative library
1660 specifications to be searched for (in order) until
1661 at least one library is found. E.g.
1663 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1665 Mind, that any element of the array
1666 contains a complete set of arguments for the ld
1667 command. So do not specify
1669 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1671 See ODBM_File/Makefile.PL for an example, where an array is needed. If
1672 you specify a scalar as in
1674 'LIBS' => "-ltcl -ltk -lX11"
1676 MakeMaker will turn it into an array with one element.
1680 'static' or 'dynamic' (default unless usedl=undef in
1681 config.sh). Should only be used to force static linking (also see
1686 Boolean which tells MakeMaker, that it should include the rules to
1687 make a perl. This is handled automatically as a switch by
1688 MakeMaker. The user normally does not need it.
1692 When 'make clean' or similar is run, the $(FIRST_MAKEFILE) will be
1693 backed up at this location.
1695 Defaults to $(FIRST_MAKEFILE).old or $(FIRST_MAKEFILE)_old on VMS.
1699 Hashref of pod-containing files. MakeMaker will default this to all
1700 EXE_FILES files that include POD directives. The files listed
1701 here will be converted to man pages and installed as was requested
1706 Hashref that assigns to *.pm and *.pod files the files into which the
1707 manpages are to be written. MakeMaker parses all *.pod and *.pm files
1708 for POD directives. Files that contain POD will be the default keys of
1709 the MAN3PODS hashref. These will then be converted to man pages during
1710 C<make> and will be installed during C<make install>.
1714 If it is intended, that a new perl binary be produced, this variable
1715 may hold a name for that binary. Defaults to perl
1719 If the extension links to a library that it builds set this to the
1720 name of the library (see SDBM_File)
1724 Perl module name for this extension (DBD::Oracle). This will default
1725 to the directory name but should be explicitly defined in the
1730 MakeMaker will figure out if an extension contains linkable code
1731 anywhere down the directory tree, and will set this variable
1732 accordingly, but you can speed it up a very little bit if you define
1733 this boolean variable yourself.
1737 Command so make does not print the literal commands its running.
1739 By setting it to an empty string you can generate a Makefile that
1740 prints all commands. Mainly used in debugging MakeMaker itself.
1746 Boolean. Attribute to inhibit descending into subdirectories.
1750 When true, suppresses the generation and addition to the MANIFEST of
1751 the META.yml module meta-data file during 'make distdir'.
1757 In general, any generated Makefile checks for the current version of
1758 MakeMaker and the version the Makefile was built under. If NO_VC is
1759 set, the version check is neglected. Do not write this into your
1760 Makefile.PL, use it interactively instead.
1764 List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1765 string containing all object files, e.g. "tkpBind.o
1766 tkpButton.o tkpCanvas.o"
1768 (Where BASEEXT is the last component of NAME, and OBJ_EXT is $Config{obj_ext}.)
1772 Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1773 passed to subdirectory makes.
1777 Perl binary for tasks that can be done by miniperl
1781 Set only when MakeMaker is building the extensions of the Perl core
1786 The call to the program that is able to compile perlmain.c. Defaults
1791 Same as for PERL_LIB, but for architecture dependent files.
1793 Used only when MakeMaker is building the extensions of the Perl core
1794 distribution (because normally $(PERL_ARCHLIB) is automatically in @INC,
1795 and adding it would get in the way of PERL5LIB).
1799 Directory containing the Perl library to use.
1801 Used only when MakeMaker is building the extensions of the Perl core
1802 distribution (because normally $(PERL_LIB) is automatically in @INC,
1803 and adding it would get in the way of PERL5LIB).
1805 =item PERL_MALLOC_OK
1807 defaults to 0. Should be set to TRUE if the extension can work with
1808 the memory allocation routines substituted by the Perl malloc() subsystem.
1809 This should be applicable to most extensions with exceptions of those
1815 with bugs in memory allocations which are caught by Perl's malloc();
1819 which interact with the memory allocator in other ways than via
1820 malloc(), realloc(), free(), calloc(), sbrk() and brk();
1824 which rely on special alignment which is not provided by Perl's malloc().
1828 B<NOTE.> Negligence to set this flag in I<any one> of loaded extension
1829 nullifies many advantages of Perl's malloc(), such as better usage of
1830 system resources, error detection, memory usage reporting, catchable failure
1831 of memory allocations, etc.
1835 Directory under which core modules are to be installed.
1837 Defaults to $Config{installprefixexp} falling back to
1838 $Config{installprefix}, $Config{prefixexp} or $Config{prefix} should
1839 $Config{installprefixexp} not exist.
1841 Overridden by PREFIX.
1845 Use this instead of $(PERL) when you wish to run perl. It will set up
1846 extra necessary flags for you.
1850 Use this instead of $(PERL) when you wish to run perl to work with
1851 modules. It will add things like -I$(INST_ARCH) and other necessary
1852 flags so perl can see the modules you're about to install.
1856 Directory containing the Perl source code (use of this should be
1857 avoided, it may be undefined)
1861 Desired permission for read/writable files. Defaults to C<644>.
1862 See also L<MM_Unix/perm_rw>.
1866 Desired permission for executable files. Defaults to C<755>.
1867 See also L<MM_Unix/perm_rwx>.
1871 Ref to hash of files to be processed as perl programs. MakeMaker
1872 will default to any found *.PL file (except Makefile.PL) being keys
1873 and the basename of the file being the value. E.g.
1875 {'foobar.PL' => 'foobar'}
1877 The *.PL files are expected to produce output to the target files
1878 themselves. If multiple files can be generated from the same *.PL
1879 file then the value in the hash can be a reference to an array of
1880 target file names. E.g.
1882 {'foobar.PL' => ['foobar1','foobar2']}
1886 Hashref of .pm files and *.pl files to be installed. e.g.
1888 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
1890 By default this will include *.pm and *.pl and the files found in
1891 the PMLIBDIRS directories. Defining PM in the
1892 Makefile.PL will override PMLIBDIRS.
1896 Ref to array of subdirectories containing library files. Defaults to
1897 [ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
1898 they contain will be installed in the corresponding location in the
1899 library. A libscan() method can be used to alter the behaviour.
1900 Defining PM in the Makefile.PL will override PMLIBDIRS.
1902 (Where BASEEXT is the last component of NAME.)
1906 A filter program, in the traditional Unix sense (input from stdin, output
1907 to stdout) that is passed on each .pm file during the build (in the
1908 pm_to_blib() phase). It is empty by default, meaning no filtering is done.
1910 Great care is necessary when defining the command if quoting needs to be
1911 done. For instance, you would need to say:
1913 {'PM_FILTER' => 'grep -v \\"^\\#\\"'}
1915 to remove all the leading coments on the fly during the build. The
1916 extra \\ are necessary, unfortunately, because this variable is interpolated
1917 within the context of a Perl program built on the command line, and double
1918 quotes are what is used with the -e switch to build that command line. The
1919 # is escaped for the Makefile, since what is going to be generated will then
1922 PM_FILTER = grep -v \"^\#\"
1924 Without the \\ before the #, we'd have the start of a Makefile comment,
1925 and the macro would be incorrectly defined.
1929 Release 5.005 grandfathered old global symbol names by providing preprocessor
1930 macros for extension source compatibility. As of release 5.6, these
1931 preprocessor definitions are not available by default. The POLLUTE flag
1932 specifies that the old names should still be defined:
1934 perl Makefile.PL POLLUTE=1
1936 Please inform the module author if this is necessary to successfully install
1937 a module under 5.6 or later.
1939 =item PPM_INSTALL_EXEC
1941 Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
1943 =item PPM_INSTALL_SCRIPT
1945 Name of the script that gets executed by the Perl Package Manager after
1946 the installation of a package.
1950 This overrides all the default install locations. Man pages,
1951 libraries, scripts, etc... MakeMaker will try to make an educated
1952 guess about where to place things under the new PREFIX based on your
1953 Config defaults. Failing that, it will fall back to a structure
1954 which should be sensible for your platform.
1956 If you specify LIB or any INSTALL* variables they will not be effected
1961 Bool. If this parameter is true, failing to have the required modules
1962 (or the right versions thereof) will be fatal. perl Makefile.PL will die
1963 with the proper message.
1965 Note: see L<Test::Harness> for a shortcut for stopping tests early if
1966 you are missing dependencies.
1968 Do I<not> use this parameter for simple requirements, which could be resolved
1969 at a later time, e.g. after an unsuccessful B<make test> of your module.
1971 It is I<extremely> rare to have to use C<PREREQ_FATAL> at all!
1975 Hashref: Names of modules that need to be available to run this
1976 extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1977 desired version is the value. If the required version number is 0, we
1978 only check if any version is installed already.
1982 Bool. If this parameter is true, the prerequisites will be printed to
1983 stdout and MakeMaker will exit. The output format is an evalable hash
1994 RedHatism for C<PREREQ_PRINT>. The output format is different, though:
1996 perl(A::B)>=Vers1 perl(C::D)>=Vers2 ...
2000 Like PERLPREFIX, but only for the site install locations.
2002 Defaults to $Config{siteprefixexp}. Perls prior to 5.6.0 didn't have
2003 an explicit siteprefix in the Config. In those cases
2004 $Config{installprefix} will be used.
2006 Overridable by PREFIX
2010 When true, perform the generation and addition to the MANIFEST of
2011 the SIGNATURE file during 'make distdir', via 'cpansign -s'.
2013 Note that you need to install the Module::Signature module to
2014 perform this operation.
2020 Arrayref. E.g. [qw(name1 name2)] skip (do not write) sections of the
2021 Makefile. Caution! Do not use the SKIP attribute for the negligible
2022 speedup. It may seriously damage the resulting Makefile. Only use it
2023 if you really need it.
2027 Ref to array of typemap file names. Use this when the typemaps are
2028 in some directory other than the current directory or when they are
2029 not named B<typemap>. The last typemap in the list takes
2030 precedence. A typemap in the current directory has highest
2031 precedence, even if it isn't listed in TYPEMAPS. The default system
2032 typemap has lowest precedence.
2036 Like PERLPREFIX, but only for the vendor install locations.
2038 Defaults to $Config{vendorprefixexp}.
2040 Overridable by PREFIX
2044 If true, make install will be verbose
2048 Your version number for distributing the package. This defaults to
2053 Instead of specifying the VERSION in the Makefile.PL you can let
2054 MakeMaker parse a file to determine the version number. The parsing
2055 routine requires that the file named by VERSION_FROM contains one
2056 single line to compute the version number. The first line in the file
2057 that contains the regular expression
2059 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
2061 will be evaluated with eval() and the value of the named variable
2062 B<after> the eval() will be assigned to the VERSION attribute of the
2063 MakeMaker object. The following lines will be parsed o.k.:
2067 $VERSION = sprintf "%d.%03d", q$Revision: 1.141 $ =~ /(\d+)/g;
2068 $FOO::VERSION = '1.10';
2069 *FOO::VERSION = \'1.11';
2070 our $VERSION = 1.2.3; # new for perl5.6.0
2072 but these will fail:
2074 my $VERSION = '1.01';
2075 local $VERSION = '1.02';
2076 local $FOO::VERSION = '1.30';
2078 (Putting C<my> or C<local> on the preceding line will work o.k.)
2080 The file named in VERSION_FROM is not added as a dependency to
2081 Makefile. This is not really correct, but it would be a major pain
2082 during development to have to rewrite the Makefile for any smallish
2083 change in that file. If you want to make sure that the Makefile
2084 contains the correct VERSION macro after any change of the file, you
2085 would have to do something like
2087 depend => { Makefile => '$(VERSION_FROM)' }
2089 See attribute C<depend> below.
2093 A sanitized VERSION with . replaced by _. For places where . has
2094 special meaning (some filesystems, RCS labels, etc...)
2098 Hashref of .xs files. MakeMaker will default this. e.g.
2100 {'name_of_file.xs' => 'name_of_file.c'}
2102 The .c files will automatically be included in the list of files
2103 deleted by a make clean.
2107 String of options to pass to xsubpp. This might include C<-C++> or
2108 C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
2113 May be set to an empty string, which is identical to C<-prototypes>, or
2114 C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
2115 defaults to the empty string.
2119 Your version number for the .xs file of this package. This defaults
2120 to the value of the VERSION attribute.
2124 =head2 Additional lowercase attributes
2126 can be used to pass parameters to the methods which implement that
2127 part of the Makefile. Parameters are specified as a hash ref but are
2128 passed to the method as a hash.
2134 {FILES => "*.xyz foo"}
2138 {ANY_TARGET => ANY_DEPENDECY, ...}
2140 (ANY_TARGET must not be given a double-colon rule by MakeMaker.)
2144 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
2145 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
2146 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
2148 If you specify COMPRESS, then SUFFIX should also be altered, as it is
2149 needed to tell make the target file of the compression. Setting
2150 DIST_CP to ln can be useful, if you need to preserve the timestamps on
2151 your files. DIST_CP can take the values 'cp', which copies the file,
2152 'ln', which links the file, and 'best' which copies symbolic links and
2153 links the rest. Default is 'best'.
2157 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
2161 {LINKTYPE => 'static', 'dynamic' or ''}
2163 NB: Extensions that have nothing but *.pm files had to say
2167 with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
2168 can be deleted safely. MakeMaker recognizes when there's nothing to
2173 {ANY_MACRO => ANY_VALUE, ...}
2177 Anything put here will be passed to MY::postamble() if you have one.
2181 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
2187 =item tool_autosplit
2193 =head2 Overriding MakeMaker Methods
2195 If you cannot achieve the desired Makefile behaviour by specifying
2196 attributes you may define private subroutines in the Makefile.PL.
2197 Each subroutine returns the text it wishes to have written to
2198 the Makefile. To override a section of the Makefile you can
2201 sub MY::c_o { "new literal text" }
2203 or you can edit the default by saying something like:
2205 package MY; # so that "SUPER" works right
2207 my $inherited = shift->SUPER::c_o(@_);
2208 $inherited =~ s/old text/new text/;
2212 If you are running experiments with embedding perl as a library into
2213 other applications, you might find MakeMaker is not sufficient. You'd
2214 better have a look at ExtUtils::Embed which is a collection of utilities
2217 If you still need a different solution, try to develop another
2218 subroutine that fits your needs and submit the diffs to
2219 C<makemaker@perl.org>
2221 For a complete description of all MakeMaker methods see
2222 L<ExtUtils::MM_Unix>.
2224 Here is a simple example of how to add a new target to the generated
2228 return <<'MAKE_FRAG';
2229 $(MYEXTLIB): sdbm/Makefile
2230 cd sdbm && $(MAKE) all
2235 =head2 The End Of Cargo Cult Programming
2237 WriteMakefile() now does some basic sanity checks on its parameters to
2238 protect against typos and malformatted values. This means some things
2239 which happened to work in the past will now throw warnings and
2240 possibly produce internal errors.
2242 Some of the most common mistakes:
2246 =item C<<MAN3PODS => ' '>>
2248 This is commonly used to supress the creation of man pages. MAN3PODS
2249 takes a hash ref not a string, but the above worked by accident in old
2250 versions of MakeMaker.
2252 The correct code is C<<MAN3PODS => { }>>.
2257 =head2 Hintsfile support
2259 MakeMaker.pm uses the architecture specific information from
2260 Config.pm. In addition it evaluates architecture specific hints files
2261 in a C<hints/> directory. The hints files are expected to be named
2262 like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
2263 name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
2264 MakeMaker within the WriteMakefile() subroutine, and can be used to
2265 execute commands as well as to include special variables. The rules
2266 which hintsfile is chosen are the same as in Configure.
2268 The hintsfile is eval()ed immediately after the arguments given to
2269 WriteMakefile are stuffed into a hash reference $self but before this
2270 reference becomes blessed. So if you want to do the equivalent to
2271 override or create an attribute you would say something like
2273 $self->{LIBS} = ['-ldbm -lucb -lc'];
2275 =head2 Distribution Support
2277 For authors of extensions MakeMaker provides several Makefile
2278 targets. Most of the support comes from the ExtUtils::Manifest module,
2279 where additional documentation can be found.
2283 =item make distcheck
2285 reports which files are below the build directory but not in the
2286 MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
2289 =item make skipcheck
2291 reports which files are skipped due to the entries in the
2292 C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
2295 =item make distclean
2297 does a realclean first and then the distcheck. Note that this is not
2298 needed to build a new distribution as long as you are sure that the
2299 MANIFEST file is ok.
2303 rewrites the MANIFEST file, adding all remaining files found (See
2304 ExtUtils::Manifest::mkmanifest() for details)
2308 Copies all the files that are in the MANIFEST file to a newly created
2309 directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
2310 exists, it will be removed first.
2312 Additionally, it will create a META.yml module meta-data file and add
2313 this to your MANFIEST. You can shut this behavior off with the NO_META
2318 Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
2319 a make test in that directory.
2323 First does a distdir. Then a command $(PREOP) which defaults to a null
2324 command, followed by $(TOUNIX), which defaults to a null command under
2325 UNIX, and will convert files in distribution directory to UNIX format
2326 otherwise. Next it runs C<tar> on that directory into a tarfile and
2327 deletes the directory. Finishes with a command $(POSTOP) which
2328 defaults to a null command.
2332 Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
2334 =item make uutardist
2336 Runs a tardist first and uuencodes the tarfile.
2340 First does a distdir. Then a command $(PREOP) which defaults to a null
2341 command. Next it runs C<shar> on that directory into a sharfile and
2342 deletes the intermediate directory again. Finishes with a command
2343 $(POSTOP) which defaults to a null command. Note: For shdist to work
2344 properly a C<shar> program that can handle directories is mandatory.
2348 First does a distdir. Then a command $(PREOP) which defaults to a null
2349 command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
2350 zipfile. Then deletes that directory. Finishes with a command
2351 $(POSTOP) which defaults to a null command.
2355 Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
2359 Customization of the dist targets can be done by specifying a hash
2360 reference to the dist attribute of the WriteMakefile call. The
2361 following parameters are recognized:
2364 COMPRESS ('gzip --best')
2367 TO_UNIX (depends on the system)
2368 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
2378 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
2381 =head2 Module Meta-Data
2383 Long plaguing users of MakeMaker based modules has been the problem of
2384 getting basic information about the module out of the sources
2385 I<without> running the F<Makefile.PL> and doing a bunch of messy
2386 heuristics on the resulting F<Makefile>. To this end a simple module
2387 meta-data file has been introduced, F<META.yml>.
2389 F<META.yml> is a YAML document (see http://www.yaml.org) containing
2390 basic information about the module (name, version, prerequisites...)
2391 in an easy to read format. The format is developed and defined by the
2392 Module::Build developers (see
2393 http://module-build.sourceforge.net/META-spec.html)
2395 MakeMaker will automatically generate a F<META.yml> file for you and
2396 add it to your F<MANIFEST> as part of the 'distdir' target (and thus
2397 the 'dist' target). This is intended to seamlessly and rapidly
2398 populate CPAN with module meta-data. If you wish to shut this feature
2399 off, set the C<NO_META> C<WriteMakefile()> flag to true.
2402 =head2 Disabling an extension
2404 If some events detected in F<Makefile.PL> imply that there is no way
2405 to create the Module, but this is a normal state of things, then you
2406 can create a F<Makefile> which does nothing, but succeeds on all the
2407 "usual" build targets. To do so, use
2409 ExtUtils::MakeMaker::WriteEmptyMakefile();
2411 instead of WriteMakefile().
2413 This may be useful if other modules expect this module to be I<built>
2414 OK, as opposed to I<work> OK (say, this system-dependent module builds
2415 in a subdirectory of some other distribution, or is listed as a
2416 dependency in a CPAN::Bundle, but the functionality is supported by
2417 different means on the current architecture).
2419 =head2 Other Handy Functions
2425 my $value = prompt($message);
2426 my $value = prompt($message, $default);
2428 The C<prompt()> function provides an easy way to request user input
2429 used to write a makefile. It displays the $message as a prompt for
2430 input. If a $default is provided it will be used as a default. The
2431 function returns the $value selected by the user.
2433 If C<prompt()> detects that it is not running interactively and there
2434 is nothing on STDIN or if the PERL_MM_USE_DEFAULT environment variable
2435 is set to true, the $default will be used without prompting. This
2436 prevents automated processes from blocking on user input.
2438 If no $default is provided an empty string will be used instead.
2449 Command line options used by C<MakeMaker-E<gt>new()>, and thus by
2450 C<WriteMakefile()>. The string is split on whitespace, and the result
2451 is processed before any actual command line arguments are processed.
2453 =item PERL_MM_USE_DEFAULT
2455 If set to a true value then MakeMaker's prompt function will
2456 always return the default without waiting for user input.
2462 ExtUtils::MM_Unix, ExtUtils::Manifest ExtUtils::Install,
2467 Andy Dougherty C<doughera@lafayette.edu>, Andreas KE<ouml>nig
2468 C<andreas.koenig@mind.de>, Tim Bunce C<timb@cpan.org>. VMS
2469 support by Charles Bailey C<bailey@newman.upenn.edu>. OS/2 support
2470 by Ilya Zakharevich C<ilya@math.ohio-state.edu>.
2472 Currently maintained by Michael G Schwern C<schwern@pobox.com>
2474 Send patches and ideas to C<makemaker@perl.org>.
2476 Send bug reports via http://rt.cpan.org/. Please send your
2477 generated Makefile along with your report.
2479 For more up-to-date information, see L<http://www.makemaker.org>.
2483 This program is free software; you can redistribute it and/or
2484 modify it under the same terms as Perl itself.
2486 See L<http://www.perl.com/perl/misc/Artistic.html>