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