lib/ExtUtils/MakeMaker.pm

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