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