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