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