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