lib/ExtUtils/MakeMaker.pm

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