lib/ExtUtils/MakeMaker.pm

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