lib/ExtUtils/MakeMaker.pm

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