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