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