lib/ExtUtils/MakeMaker.pm

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