lib/ExtUtils/MakeMaker.pm

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