Better NetInfo behaviour.
[p5sagit/p5-mst-13.2.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 3package ExtUtils::MakeMaker;
4
875fa795 5$VERSION = "5.4302";
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 9
10
005c1a0e 11
8e07c86e 12require Exporter;
3b03c0f3 13use Config;
14use Carp ();
15#use FileHandle ();
e05e23b1 16
17use vars qw(
f1387719 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 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 32#
33# Set up the inheritance before we pull in the MM_* packages, because they
34# import variables and functions from here
35#
36@ISA = qw(Exporter);
37@EXPORT = qw(&WriteMakefile &writeMakefile $Verbose &prompt);
875fa795 38@EXPORT_OK = qw($VERSION &Version_check &neatvalue &mkbootstrap &mksymlists);
005c1a0e 39
e05e23b1 40#
41# Dummy package MM inherits actual methods from OS-specific
42# default packages. We use this intermediate package so
43# MY::XYZ->func() can call MM->func() and get the proper
44# default routine without having to know under what OS
45# it's running.
46#
47@MM::ISA = qw[ExtUtils::MM_Unix ExtUtils::Liblist ExtUtils::MakeMaker];
42793c05 48
e05e23b1 49#
50# Setup dummy package:
51# MY exists for overriding methods to be defined within
52#
53{
54 package MY;
f1387719 55 @MY::ISA = qw(MM);
56### sub AUTOLOAD { use Devel::Symdump; print Devel::Symdump->rnew->as_string; Carp::confess "hey why? $AUTOLOAD" }
e05e23b1 57 package MM;
e05e23b1 58 sub DESTROY {}
59}
42793c05 60
3b03c0f3 61# "predeclare the package: we only load it via AUTOLOAD
62# but we have already mentioned it in @ISA
63package ExtUtils::Liblist;
64
65package ExtUtils::MakeMaker;
e05e23b1 66#
7a2e2cd6 67# Now we can pull in the friends
e05e23b1 68#
68dc0745 69$Is_VMS = $^O eq 'VMS';
70$Is_OS2 = $^O eq 'os2';
71$Is_Mac = $^O eq 'MacOS';
72$Is_Win32 = $^O eq 'MSWin32';
a5f75d66 73
e05e23b1 74require ExtUtils::MM_Unix;
3b03c0f3 75
a5f75d66 76if ($Is_VMS) {
0d8023a2 77 require ExtUtils::MM_VMS;
f1387719 78 require VMS::Filespec; # is a noop as long as we require it within MM_VMS
0d8023a2 79}
a5f75d66 80if ($Is_OS2) {
e05e23b1 81 require ExtUtils::MM_OS2;
82}
f1387719 83if ($Is_Mac) {
84 require ExtUtils::MM_Mac;
85}
68dc0745 86if ($Is_Win32) {
87 require ExtUtils::MM_Win32;
88}
3b03c0f3 89
90# The SelfLoader would bring a lot of overhead for MakeMaker, because
91# we know for sure we will use most of the autoloaded functions once
92# we have to use one of them. So we write our own loader
93
94sub AUTOLOAD {
95 my $code;
96 if (defined fileno(DATA)) {
f1387719 97 my $fh = select DATA;
98 my $o = $/; # For future reads from the file.
99 $/ = "\n__END__\n";
100 $code = <DATA>;
101 $/ = $o;
102 select $fh;
3b03c0f3 103 close DATA;
104 eval $code;
105 if ($@) {
106 $@ =~ s/ at .*\n//;
107 Carp::croak $@;
108 }
109 } else {
110 warn "AUTOLOAD called unexpectedly for $AUTOLOAD";
111 }
112 defined(&$AUTOLOAD) or die "Myloader inconsistency error";
113 goto &$AUTOLOAD;
114}
864a5fa8 115
e05e23b1 116# The only subroutine we do not SelfLoad is Version_Check because it's
117# called so often. Loading this minimum still requires 1.2 secs on my
118# Indy :-(
e05e23b1 119
120sub Version_check {
121 my($checkversion) = @_;
122 die "Your Makefile was built with ExtUtils::MakeMaker v $checkversion.
123Current Version is $ExtUtils::MakeMaker::VERSION. There have been considerable
124changes in the meantime.
125Please rerun 'perl Makefile.PL' to regenerate the Makefile.\n"
126 if $checkversion < $Version_OK;
127 printf STDOUT "%s %s %s %s.\n", "Makefile built with ExtUtils::MakeMaker v",
128 $checkversion, "Current Version is", $VERSION
129 unless $checkversion == $VERSION;
8e07c86e 130}
e05e23b1 131
f1387719 132sub warnhandler {
133 $_[0] =~ /^Use of uninitialized value/ && return;
134 $_[0] =~ /used only once/ && return;
135 $_[0] =~ /^Subroutine\s+[\w:]+\s+redefined/ && return;
136 warn @_;
137}
138
3b03c0f3 139sub ExtUtils::MakeMaker::eval_in_subdirs ;
140sub ExtUtils::MakeMaker::eval_in_x ;
141sub ExtUtils::MakeMaker::full_setup ;
142sub ExtUtils::MakeMaker::writeMakefile ;
143sub ExtUtils::MakeMaker::new ;
144sub ExtUtils::MakeMaker::check_manifest ;
145sub ExtUtils::MakeMaker::parse_args ;
146sub ExtUtils::MakeMaker::check_hints ;
147sub ExtUtils::MakeMaker::mv_all_methods ;
148sub ExtUtils::MakeMaker::skipcheck ;
149sub ExtUtils::MakeMaker::flush ;
150sub ExtUtils::MakeMaker::mkbootstrap ;
151sub ExtUtils::MakeMaker::mksymlists ;
152sub ExtUtils::MakeMaker::neatvalue ;
153sub ExtUtils::MakeMaker::selfdocument ;
154sub ExtUtils::MakeMaker::WriteMakefile ;
68dc0745 155sub ExtUtils::MakeMaker::prompt ($;$) ;
f1387719 156
1571;
ccd13d1e 158
159__DATA__
160
3b03c0f3 161package ExtUtils::MakeMaker;
162
163sub WriteMakefile {
164 Carp::croak "WriteMakefile: Need even number of args" if @_ % 2;
f1387719 165 local $SIG{__WARN__} = \&warnhandler;
166
3b03c0f3 167 unless ($Setup_done++){
168 full_setup();
169 undef &ExtUtils::MakeMaker::full_setup; #safe memory
170 }
171 my %att = @_;
172 MM->new(\%att)->flush;
173}
174
f1387719 175sub prompt ($;$) {
3b03c0f3 176 my($mess,$def)=@_;
13bc20ff 177 $ISA_TTY = -t STDIN && (-t STDOUT || !(-f STDOUT || -c STDOUT)) ; # Pipe?
3b03c0f3 178 Carp::confess("prompt function called without an argument") unless defined $mess;
f1387719 179 my $dispdef = defined $def ? "[$def] " : " ";
180 $def = defined $def ? $def : "";
3b03c0f3 181 my $ans;
13bc20ff 182 local $|=1;
183 print "$mess $dispdef";
3b03c0f3 184 if ($ISA_TTY) {
f1387719 185 chomp($ans = <STDIN>);
13bc20ff 186 } else {
187 print "$def\n";
3b03c0f3 188 }
9ad0a0f6 189 return ($ans ne '') ? $ans : $def;
3b03c0f3 190}
191
e05e23b1 192sub eval_in_subdirs {
193 my($self) = @_;
194 my($dir);
3b03c0f3 195 use Cwd 'cwd';
e05e23b1 196 my $pwd = cwd();
197
e05e23b1 198 foreach $dir (@{$self->{DIR}}){
e05e23b1 199 my($abs) = $self->catdir($pwd,$dir);
200 $self->eval_in_x($abs);
201 }
e05e23b1 202 chdir $pwd;
864a5fa8 203}
42793c05 204
e05e23b1 205sub eval_in_x {
206 my($self,$dir) = @_;
207 package main;
3b03c0f3 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 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 227}
228
e05e23b1 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 234 $PACKNAME = "PACK000";
235
236 @Attrib_help = qw/
237
762efda7 238 AUTHOR ABSTRACT ABSTRACT_FROM BINARY_LOCATION
239 C CAPI CCFLAGS CONFIG CONFIGURE DEFINE DIR DISTNAME DL_FUNCS DL_VARS
875fa795 240 EXCLUDE_EXT EXE_FILES FIRST_MAKEFILE FULLPERL FUNCLIST H IMPORTS
762efda7 241 INC INCLUDE_EXT INSTALLARCHLIB INSTALLBIN INSTALLDIRS INSTALLMAN1DIR
f1387719 242 INSTALLMAN3DIR INSTALLPRIVLIB INSTALLSCRIPT INSTALLSITEARCH
243 INSTALLSITELIB INST_ARCHLIB INST_BIN INST_EXE INST_LIB
875fa795 244 INST_MAN1DIR INST_MAN3DIR INST_SCRIPT LDFROM LIB LIBPERL_A LIBS
f1387719 245 LINKTYPE MAKEAPERL MAKEFILE MAN1PODS MAN3PODS MAP_TARGET MYEXTLIB
762efda7 246 NAME NEEDS_LINKING NOECHO NORECURS NO_VC OBJECT OPTIMIZE PERL PERLMAINCC
2366100d 247 PERL_ARCHLIB PERL_LIB PERL_SRC PERM_RW PERM_RWX
875fa795 248 PL_FILES PM PMLIBDIRS PPM_INSTALL_EXEC PPM_INSTALL_SCRIPT PREFIX
f1387719 249 PREREQ_PM SKIP TYPEMAPS VERSION VERSION_FROM XS XSOPT XSPROTOARG
250 XS_VERSION clean depend dist dynamic_lib linkext macro realclean
762efda7 251 tool_autosplit
3b03c0f3 252 /;
253
875fa795 254 # IMPORTS is used under OS/2 and Win32
f1387719 255
256 # @Overridable is close to @MM_Sections but not identical. The
257 # order is important. Many subroutines declare macros. These
258 # depend on each other. Let's try to collect the macros up front,
259 # then pasthru, then the rules.
260
261 # MM_Sections are the sections we have to call explicitly
262 # in Overridable we have subroutines that are used indirectly
3b03c0f3 263
e05e23b1 264
265 @MM_Sections =
266 qw(
3b03c0f3 267
f1387719 268 post_initialize const_config constants tool_autosplit tool_xsubpp
269 tools_other dist macro depend cflags const_loadlibs const_cccmd
270 post_constants
271
272 pasthru
273
b86a2fa7 274 c_o xs_c xs_o top_targets linkext dlsyms dynamic dynamic_bs
f1387719 275 dynamic_lib static static_lib manifypods processPL installbin subdirs
276 clean realclean dist_basics dist_core dist_dir dist_test dist_ci
8f993c78 277 install force perldepend makefile staticmake test ppd
3b03c0f3 278
e05e23b1 279 ); # loses section ordering
280
3b03c0f3 281 @Overridable = @MM_Sections;
f1387719 282 push @Overridable, qw[
283
2366100d 284 dir_target libscan makeaperl needs_linking perm_rw perm_rwx
285 subdir_x test_via_harness test_via_script
f1387719 286
3b03c0f3 287 ];
288
f1387719 289 push @MM_Sections, qw[
3b03c0f3 290
f1387719 291 pm_to_blib selfdocument
292
293 ];
294
295 # Postamble needs to be the last that was always the case
296 push @MM_Sections, "postamble";
297 push @Overridable, "postamble";
e05e23b1 298
299 # All sections are valid keys.
3b03c0f3 300 @Recognized_Att_Keys{@MM_Sections} = (1) x @MM_Sections;
e05e23b1 301
302 # we will use all these variables in the Makefile
303 @Get_from_Config =
304 qw(
bbce6d69 305 ar cc cccdlflags ccdlflags dlext dlsrc ld lddlflags ldflags libc
8f993c78 306 lib_ext obj_ext osname osvers ranlib sitelibexp sitearchexp so exe_ext
e05e23b1 307 );
308
309 my $item;
3b03c0f3 310 foreach $item (@Attrib_help){
311 $Recognized_Att_Keys{$item} = 1;
e05e23b1 312 }
313 foreach $item (@Get_from_Config) {
314 $Recognized_Att_Keys{uc $item} = $Config{$item};
315 print "Attribute '\U$item\E' => '$Config{$item}'\n"
316 if ($Verbose >= 2);
317 }
318
319 #
3b03c0f3 320 # When we eval a Makefile.PL in a subdirectory, that one will ask
321 # us (the parent) for the values and will prepend "..", so that
322 # all files to be installed end up below OUR ./blib
e05e23b1 323 #
324 %Prepend_dot_dot =
325 qw(
f1387719 326
327 INST_BIN 1 INST_EXE 1 INST_LIB 1 INST_ARCHLIB 1 INST_SCRIPT
328 1 MAP_TARGET 1 INST_MAN1DIR 1 INST_MAN3DIR 1 PERL_SRC 1
329 PERL 1 FULLPERL 1
330
e05e23b1 331 );
332
3b03c0f3 333 my @keep = qw/
334 NEEDS_LINKING HAS_LINK_CODE
335 /;
336 @Keep_after_flush{@keep} = (1) x @keep;
e05e23b1 337}
42793c05 338
8e07c86e 339sub writeMakefile {
340 die <<END;
232e078e 341
8e07c86e 342The extension you are trying to build apparently is rather old and
343most probably outdated. We detect that from the fact, that a
344subroutine "writeMakefile" is called, and this subroutine is not
345supported anymore since about October 1994.
40000a8c 346
4633a7c4 347Please contact the author or look into CPAN (details about CPAN can be
348found in the FAQ and at http:/www.perl.com) for a more recent version
349of the extension. If you're really desperate, you can try to change
350the subroutine name from writeMakefile to WriteMakefile and rerun
351'perl Makefile.PL', but you're most probably left alone, when you do
352so.
42793c05 353
8e07c86e 354The MakeMaker team
1aef975c 355
42793c05 356END
8e07c86e 357}
42793c05 358
3b03c0f3 359sub ExtUtils::MakeMaker::new {
8e07c86e 360 my($class,$self) = @_;
361 my($key);
42793c05 362
e05e23b1 363 print STDOUT "MakeMaker (v$VERSION)\n" if $Verbose;
8e07c86e 364 if (-f "MANIFEST" && ! -f "Makefile"){
365 check_manifest();
1aef975c 366 }
42793c05 367
8e07c86e 368 $self = {} unless (defined $self);
005c1a0e 369
864a5fa8 370 check_hints($self);
4633a7c4 371
8e07c86e 372 my(%initial_att) = %$self; # record initial attributes
005c1a0e 373
f1387719 374 my($prereq);
375 foreach $prereq (sort keys %{$self->{PREREQ_PM}}) {
376 my $eval = "use $prereq $self->{PREREQ_PM}->{$prereq}";
377 eval $eval;
378 if ($@){
379 warn "Warning: prerequisite $prereq $self->{PREREQ_PM}->{$prereq} not found";
8f993c78 380# Why is/was this 'delete' here? We need PREREQ_PM later to make PPDs.
381# } else {
382# delete $self->{PREREQ_PM}{$prereq};
f1387719 383 }
384 }
385# if (@unsatisfied){
386# unless (defined $ExtUtils::MakeMaker::useCPAN) {
387# print qq{MakeMaker WARNING: prerequisites not found (@unsatisfied)
388# Please install these modules first and rerun 'perl Makefile.PL'.\n};
389# if ($ExtUtils::MakeMaker::hasCPAN) {
390# $ExtUtils::MakeMaker::useCPAN = prompt(qq{Should I try to use the CPAN module to fetch them for you?},"yes");
391# } else {
392# print qq{Hint: You may want to install the CPAN module to autofetch the needed modules\n};
393# $ExtUtils::MakeMaker::useCPAN=0;
394# }
395# }
396# if ($ExtUtils::MakeMaker::useCPAN) {
397# require CPAN;
398# CPAN->import(@unsatisfied);
399# } else {
400# die qq{prerequisites not found (@unsatisfied)};
401# }
402# warn qq{WARNING: prerequisites not found (@unsatisfied)};
403# }
404
8e07c86e 405 if (defined $self->{CONFIGURE}) {
406 if (ref $self->{CONFIGURE} eq 'CODE') {
407 $self = { %$self, %{&{$self->{CONFIGURE}}}};
005c1a0e 408 } else {
3b03c0f3 409 Carp::croak "Attribute 'CONFIGURE' to WriteMakefile() not a code reference\n";
005c1a0e 410 }
411 }
a0d0e21e 412
8e07c86e 413 # This is for old Makefiles written pre 5.00, will go away
414 if ( Carp::longmess("") =~ /runsubdirpl/s ){
3b03c0f3 415 Carp::carp("WARNING: Please rerun 'perl Makefile.PL' to regenerate your Makefiles\n");
8e07c86e 416 }
5d94fbed 417
ccd13d1e 418 my $newclass = ++$PACKNAME;
6071deed 419 local @Parent = @Parent; # Protect against non-local exits
8e07c86e 420 {
421# no strict;
ccd13d1e 422 print "Blessing Object into class [$newclass]\n" if $Verbose>=2;
423 mv_all_methods("MY",$newclass);
424 bless $self, $newclass;
e05e23b1 425 push @Parent, $self;
ccd13d1e 426 @{"$newclass\:\:ISA"} = 'MM';
8e07c86e 427 }
5d94fbed 428
e05e23b1 429 if (defined $Parent[-2]){
430 $self->{PARENT} = $Parent[-2];
8e07c86e 431 my $key;
e05e23b1 432 for $key (keys %Prepend_dot_dot) {
4633a7c4 433 next unless defined $self->{PARENT}{$key};
8e07c86e 434 $self->{$key} = $self->{PARENT}{$key};
bbce6d69 435 # PERL and FULLPERL may be command verbs instead of full
436 # file specifications under VMS. If so, don't turn them
437 # into a filespec.
8e07c86e 438 $self->{$key} = $self->catdir("..",$self->{$key})
bbce6d69 439 unless $self->file_name_is_absolute($self->{$key})
f86702cc 440 || ($^O eq 'VMS' and ($key =~ /PERL$/ && $self->{$key} =~ /^[\w\-\$]+$/));
8e07c86e 441 }
ccd13d1e 442 $self->{PARENT}->{CHILDREN}->{$newclass} = $self if $self->{PARENT};
8e07c86e 443 } else {
2443aee5 444 parse_args($self,split(' ', $ENV{PERL_MM_OPT} || ''),@ARGV);
8e07c86e 445 }
a0d0e21e 446
8e07c86e 447 $self->{NAME} ||= $self->guess_name;
a0d0e21e 448
8e07c86e 449 ($self->{NAME_SYM} = $self->{NAME}) =~ s/\W+/_/g;
a0d0e21e 450
8e07c86e 451 $self->init_main();
452
0d8023a2 453 if (! $self->{PERL_SRC} ) {
68dc0745 454 my($pthinks) = $self->canonpath($INC{'Config.pm'});
3e3baf6d 455 my($cthinks) = $self->catfile($Config{'archlibexp'},'Config.pm');
3b03c0f3 456 $pthinks = VMS::Filespec::vmsify($pthinks) if $Is_VMS;
3e3baf6d 457 if ($pthinks ne $cthinks &&
458 !($Is_Win32 and lc($pthinks) eq lc($cthinks))) {
459 print "Have $pthinks expected $cthinks\n";
460 if ($Is_Win32) {
461 $pthinks =~ s![/\\]Config\.pm$!!i; $pthinks =~ s!.*[/\\]!!;
462 }
463 else {
464 $pthinks =~ s!/Config\.pm$!!; $pthinks =~ s!.*/!!;
465 }
0d8023a2 466 print STDOUT <<END;
005c1a0e 467Your perl and your Config.pm seem to have different ideas about the architecture
468they are running on.
8e07c86e 469Perl thinks: [$pthinks]
e05e23b1 470Config says: [$Config{archname}]
005c1a0e 471This may or may not cause problems. Please check your installation of perl if you
472have problems building this extension.
473END
0d8023a2 474 }
005c1a0e 475 }
476
8e07c86e 477 $self->init_dirscan();
478 $self->init_others();
6071deed 479 my($argv) = neatvalue(\@ARGV);
480 $argv =~ s/^\[/(/;
481 $argv =~ s/\]$/)/;
75f92628 482
8e07c86e 483 push @{$self->{RESULT}}, <<END;
484# This Makefile is for the $self->{NAME} extension to perl.
485#
e05e23b1 486# It was generated automatically by MakeMaker version
487# $VERSION (Revision: $Revision) from the contents of
488# Makefile.PL. Don't edit this file, edit Makefile.PL instead.
8e07c86e 489#
490# ANY CHANGES MADE HERE WILL BE LOST!
491#
6071deed 492# MakeMaker ARGV: $argv
493#
8e07c86e 494# MakeMaker Parameters:
495END
a0d0e21e 496
42793c05 497 foreach $key (sort keys %initial_att){
498 my($v) = neatvalue($initial_att{$key});
8e07c86e 499 $v =~ s/(CODE|HASH|ARRAY|SCALAR)\([\dxa-f]+\)/$1\(...\)/;
42793c05 500 $v =~ tr/\n/ /s;
8e07c86e 501 push @{$self->{RESULT}}, "# $key => $v";
42793c05 502 }
a0d0e21e 503
8e07c86e 504 # turn the SKIP array into a SKIPHASH hash
505 my (%skip,$skip);
506 for $skip (@{$self->{SKIP} || []}) {
507 $self->{SKIPHASH}{$skip} = 1;
508 }
3b03c0f3 509 delete $self->{SKIP}; # free memory
510
511 if ($self->{PARENT}) {
512 for (qw/install dist dist_basics dist_core dist_dir dist_test dist_ci/) {
513 $self->{SKIPHASH}{$_} = 1;
514 }
515 }
42793c05 516
8e07c86e 517 # We run all the subdirectories now. They don't have much to query
518 # from the parent, but the parent has to query them: if they need linking!
8e07c86e 519 unless ($self->{NORECURS}) {
e05e23b1 520 $self->eval_in_subdirs if @{$self->{DIR}};
42793c05 521 }
a0d0e21e 522
8e07c86e 523 my $section;
e05e23b1 524 foreach $section ( @MM_Sections ){
525 print "Processing Makefile '$section' section\n" if ($Verbose >= 2);
8e07c86e 526 my($skipit) = $self->skipcheck($section);
527 if ($skipit){
528 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section $skipit.";
4e68a208 529 } else {
8e07c86e 530 my(%a) = %{$self->{$section} || {}};
531 push @{$self->{RESULT}}, "\n# --- MakeMaker $section section:";
e05e23b1 532 push @{$self->{RESULT}}, "# " . join ", ", %a if $Verbose && %a;
8e07c86e 533 push @{$self->{RESULT}}, $self->nicetext($self->$section( %a ));
e05e23b1 534 }
232e078e 535 }
8e07c86e 536
e05e23b1 537 push @{$self->{RESULT}}, "\n# End.";
8e07c86e 538
e05e23b1 539 $self;
232e078e 540}
541
1b171b8d 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 551all:
552
553clean:
554
555install:
556
557makemakerdflt:
558
559test:
560
561EOP
562 close MF or die "close Makefile for write: $!";
563}
564
e05e23b1 565sub check_manifest {
566 print STDOUT "Checking if your kit is complete...\n";
3b03c0f3 567 require ExtUtils::Manifest;
e05e23b1 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 578}
579
e05e23b1 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 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 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 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 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 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 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 648sub check_hints {
649 my($self) = @_;
650 # We allow extension-specific hints files.
864a5fa8 651
e05e23b1 652 return unless -d "hints";
8e07c86e 653
e05e23b1 654 # First we look for the best hintsfile we have
655 my(@goodhints);
f1387719 656 my($hint)="${^O}_$Config{osvers}";
e05e23b1 657 $hint =~ s/\./_/g;
658 $hint =~ s/_$//;
659 return unless $hint;
fed7345c 660
e05e23b1 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 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 679 print STDOUT "Processing hints file hints/$hint.pl\n";
680 eval join('',@goodhints);
681 print STDOUT $@ if $@;
682}
8e07c86e 683
e05e23b1 684sub mv_all_methods {
685 my($from,$to) = @_;
686 my($method);
687 my($symtab) = \%{"${from}::"};
688# no strict;
fed7345c 689
e05e23b1 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 697 # We cannot say "next" here. Nick might call MY->makeaperl
698 # which isn't defined right now
fed7345c 699
3b03c0f3 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 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 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 720 }
721
e05e23b1 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 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 739}
740
3b03c0f3 741sub skipcheck {
8e07c86e 742 my($self) = shift;
e05e23b1 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 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 762 return 'skipped' if $self->{SKIPHASH}{$section};
763 return '';
8e07c86e 764}
765
e05e23b1 766sub flush {
767 my $self = shift;
768 my($chunk);
3b03c0f3 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 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 779# print $fh "$chunk\n";
780 print FH "$chunk\n";
8e07c86e 781 }
e05e23b1 782
3b03c0f3 783# $fh->close;
784 close FH;
e05e23b1 785 my($finalname) = $self->{MAKEFILE};
786 rename("MakeMaker.tmp", $finalname);
787 chmod 0644, $finalname unless $Is_VMS;
3b03c0f3 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 796}
797
e05e23b1 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 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 816}
817
e05e23b1 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 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 840}
841
e05e23b1 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 858package ExtUtils::MakeMaker;
8591;
860
861__END__
005c1a0e 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 873which is really
874
875C<MM-E<gt>new(\%att)-E<gt>flush;>
876
005c1a0e 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 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 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 910 use ExtUtils::MakeMaker;
911 WriteMakefile( NAME => "Foo::Bar" );
8e07c86e 912
bab2b58e 913The long answer is the rest of the manpage :-)
005c1a0e 914
915=head2 Default Makefile Behaviour
916
f1387719 917The generated Makefile enables the user of the extension to invoke
005c1a0e 918
919 perl Makefile.PL # optionally "perl Makefile.PL verbose"
920 make
8e07c86e 921 make test # optionally set TEST_VERBOSE=1
922 make install # See below
005c1a0e 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 928
929Other interesting targets in the generated Makefile are
930
931 make config # to check if the Makefile is up-to-date
8e07c86e 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 935 make dist # see below the Distribution Support section
936
e05e23b1 937=head2 make test
938
bab2b58e 939MakeMaker checks for the existence of a file named F<test.pl> in the
e05e23b1 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 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 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 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 979 INSTALLDIRS set to
980 perl site
981
e05e23b1 982 INST_ARCHLIB INSTALLARCHLIB INSTALLSITEARCH
3b03c0f3 983 INST_LIB INSTALLPRIVLIB INSTALLSITELIB
f1387719 984 INST_BIN INSTALLBIN
985 INST_SCRIPT INSTALLSCRIPT
e05e23b1 986 INST_MAN1DIR INSTALLMAN1DIR
987 INST_MAN3DIR INSTALLMAN3DIR
005c1a0e 988
8e07c86e 989The INSTALL... macros in turn default to their %Config
990($Config{installprivlib}, $Config{installarchlib}, etc.) counterparts.
005c1a0e 991
3b03c0f3 992You can check the values of these variables on your system with
993
bab2b58e 994 perl '-V:install.*'
3b03c0f3 995
f1387719 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 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 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 1018This will replace the string specified by $Config{prefix} in all
1019$Config{install*} values.
005c1a0e 1020
bab2b58e 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 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 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 1035done into the file C<$(INSTALLARCHLIB)/perllocal.pod>. This feature
1036can be bypassed by calling make pure_install.
8e07c86e 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 1046 make
1047
e05e23b1 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 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 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 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 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 1095Warning: the inst_perl: target will most probably overwrite your
1096existing perl binary. Use with care!
005c1a0e 1097
8e07c86e 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 1108=head2 Determination of Perl Library and Installation Locations
1109
1110MakeMaker needs to know, or to guess, where certain things are
e05e23b1 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 1114
1115Extensions may be built either using the contents of the perl source
e05e23b1 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 1122
1123If an extension is being built below the C<ext/> directory of the perl
e05e23b1 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 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 1138 PERL_INC = $archlibexp/CORE
1139 PERL_LIB = $privlibexp
1140 PERL_ARCHLIB = $archlibexp
1141 INST_LIB = ./blib/lib
1142 INST_ARCHLIB = ./blib/arch
005c1a0e 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 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 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 1168
1169The following attributes can be specified as arguments to WriteMakefile()
1170or as NAME=VALUE pairs on the command line:
1171
875fa795 1172=over 2
005c1a0e 1173
875fa795 1174=item AUTHOR
8e07c86e 1175
875fa795 1176String containing name (and email address) of package author(s). Is used
1177in PPD (Perl Package Description) files for PPM (Perl Package Manager).
1178
1179=item ABSTRACT
1180
1181One line description of the module. Will be included in PPD file.
1182
1183=item ABSTRACT_FROM
1184
1185Name of the file that contains the package description. MakeMaker looks
1186for a line in the POD matching /^($package\s-\s)(.*)/. This is typically
1187the first line in the "=head1 NAME" section. $2 becomes the abstract.
1188
1189=item BINARY_LOCATION
1190
1191Used when creating PPD files for binary packages. It can be set to a
1192full or relative path or URL to the binary archive for a particular
1193architecture. For example:
1194
1195 perl Makefile.PL BINARY_LOCATION=x86/Agent.tar.gz
1196
1197builds a PPD package that references a binary of the C<Agent> package,
20e08411 1198located in the C<x86> directory relative to the PPD itself.
8e07c86e 1199
864a5fa8 1200=item C
8e07c86e 1201
864a5fa8 1202Ref to array of *.c file names. Initialised from a directory scan
1203and the values portion of the XS attribute hash. This is not
1204currently used by MakeMaker but may be handy in Makefile.PLs.
8e07c86e 1205
875fa795 1206=item CAPI
1207
1208Switch to force usage of the Perl C API even when compiling for PERL_OBJECT.
1209
84902520 1210=item CCFLAGS
1211
1212String that will be included in the compiler call command line between
1213the arguments INC and OPTIMIZE.
1214
864a5fa8 1215=item CONFIG
8e07c86e 1216
864a5fa8 1217Arrayref. E.g. [qw(archname manext)] defines ARCHNAME & MANEXT from
1218config.sh. MakeMaker will add to CONFIG the following values anyway:
1219ar
1220cc
1221cccdlflags
1222ccdlflags
1223dlext
1224dlsrc
1225ld
1226lddlflags
1227ldflags
1228libc
1229lib_ext
1230obj_ext
1231ranlib
e05e23b1 1232sitelibexp
1233sitearchexp
864a5fa8 1234so
8e07c86e 1235
1236=item CONFIGURE
1237
e05e23b1 1238CODE reference. The subroutine should return a hash reference. The
1fef88e7 1239hash may contain further attributes, e.g. {LIBS =E<gt> ...}, that have to
8e07c86e 1240be determined by some evaluation method.
1241
864a5fa8 1242=item DEFINE
8e07c86e 1243
864a5fa8 1244Something like C<"-DHAVE_UNISTD_H">
8e07c86e 1245
864a5fa8 1246=item DIR
8e07c86e 1247
864a5fa8 1248Ref to array of subdirectories containing Makefile.PLs e.g. [ 'sdbm'
1249] in ext/SDBM_File
8e07c86e 1250
864a5fa8 1251=item DISTNAME
8e07c86e 1252
e05e23b1 1253Your name for distributing the package (by tar file). This defaults to
864a5fa8 1254NAME above.
8e07c86e 1255
864a5fa8 1256=item DL_FUNCS
8e07c86e 1257
875fa795 1258Hashref of symbol names for routines to be made available as universal
1259symbols. Each key/value pair consists of the package name and an
1260array of routine names in that package. Used only under AIX, OS/2,
1261VMS and Win32 at present. The routine names supplied will be expanded
1262in the same way as XSUB names are expanded by the XS() macro.
1263Defaults to
8e07c86e 1264
864a5fa8 1265 {"$(NAME)" => ["boot_$(NAME)" ] }
8e07c86e 1266
864a5fa8 1267e.g.
8e07c86e 1268
864a5fa8 1269 {"RPC" => [qw( boot_rpcb rpcb_gettime getnetconfigent )],
1270 "NetconfigPtr" => [ 'DESTROY'] }
8e07c86e 1271
875fa795 1272Please see the L<ExtUtils::Mksymlists> documentation for more information
1273about the DL_FUNCS, DL_VARS and FUNCLIST attributes.
1274
864a5fa8 1275=item DL_VARS
8e07c86e 1276
875fa795 1277Array of symbol names for variables to be made available as universal symbols.
1278Used only under AIX, OS/2, VMS and Win32 at present. Defaults to [].
1279(e.g. [ qw(Foo_version Foo_numstreams Foo_tree ) ])
8e07c86e 1280
f1387719 1281=item EXCLUDE_EXT
1282
1283Array of extension names to exclude when doing a static build. This
1284is ignored if INCLUDE_EXT is present. Consult INCLUDE_EXT for more
1285details. (e.g. [ qw( Socket POSIX ) ] )
1286
1287This attribute may be most useful when specified as a string on the
1288commandline: perl Makefile.PL EXCLUDE_EXT='Socket Safe'
1289
864a5fa8 1290=item EXE_FILES
8e07c86e 1291
864a5fa8 1292Ref to array of executable files. The files will be copied to the
f1387719 1293INST_SCRIPT directory. Make realclean will delete them from there
864a5fa8 1294again.
8e07c86e 1295
864a5fa8 1296=item FIRST_MAKEFILE
1297
1298The name of the Makefile to be produced. Defaults to the contents of
1299MAKEFILE, but can be overridden. This is used for the second Makefile
1300that will be produced for the MAP_TARGET.
1301
1302=item FULLPERL
8e07c86e 1303
864a5fa8 1304Perl binary able to run this extension.
1305
762efda7 1306=item FUNCLIST
1307
1308This provides an alternate means to specify function names to be
1309exported from the extension. Its value is a reference to an
1310array of function names to be exported by the extension. These
1311names are passed through unaltered to the linker options file.
1312
864a5fa8 1313=item H
1314
1315Ref to array of *.h file names. Similar to C.
1316
84902520 1317=item IMPORTS
1318
875fa795 1319This attribute is used to specify names to be imported into the
1320extension. It is only used on OS/2 and Win32.
84902520 1321
864a5fa8 1322=item INC
1323
1324Include file dirs eg: C<"-I/usr/5include -I/path/to/inc">
1325
f1387719 1326=item INCLUDE_EXT
1327
1328Array of extension names to be included when doing a static build.
1329MakeMaker will normally build with all of the installed extensions when
1330doing a static build, and that is usually the desired behavior. If
1331INCLUDE_EXT is present then MakeMaker will build only with those extensions
1332which are explicitly mentioned. (e.g. [ qw( Socket POSIX ) ])
1333
1334It is not necessary to mention DynaLoader or the current extension when
1335filling in INCLUDE_EXT. If the INCLUDE_EXT is mentioned but is empty then
1336only DynaLoader and the current extension will be included in the build.
1337
1338This attribute may be most useful when specified as a string on the
1339commandline: perl Makefile.PL INCLUDE_EXT='POSIX Socket Devel::Peek'
1340
864a5fa8 1341=item INSTALLARCHLIB
1342
e05e23b1 1343Used by 'make install', which copies files from INST_ARCHLIB to this
1344directory if INSTALLDIRS is set to perl.
864a5fa8 1345
1346=item INSTALLBIN
1347
f1387719 1348Directory to install binary files (e.g. tkperl) into.
e05e23b1 1349
1350=item INSTALLDIRS
1351
1352Determines which of the two sets of installation directories to
1353choose: installprivlib and installarchlib versus installsitelib and
1354installsitearch. The first pair is chosen with INSTALLDIRS=perl, the
1355second with INSTALLDIRS=site. Default is site.
8e07c86e 1356
1357=item INSTALLMAN1DIR
1358
864a5fa8 1359This directory gets the man pages at 'make install' time. Defaults to
1360$Config{installman1dir}.
1361
8e07c86e 1362=item INSTALLMAN3DIR
1363
864a5fa8 1364This directory gets the man pages at 'make install' time. Defaults to
1365$Config{installman3dir}.
8e07c86e 1366
864a5fa8 1367=item INSTALLPRIVLIB
8e07c86e 1368
e05e23b1 1369Used by 'make install', which copies files from INST_LIB to this
1370directory if INSTALLDIRS is set to perl.
1371
f1387719 1372=item INSTALLSCRIPT
1373
1374Used by 'make install' which copies files from INST_SCRIPT to this
1375directory.
1376
875fa795 1377=item INSTALLSITEARCH
e05e23b1 1378
875fa795 1379Used by 'make install', which copies files from INST_ARCHLIB to this
e05e23b1 1380directory if INSTALLDIRS is set to site (default).
1381
875fa795 1382=item INSTALLSITELIB
e05e23b1 1383
875fa795 1384Used by 'make install', which copies files from INST_LIB to this
e05e23b1 1385directory if INSTALLDIRS is set to site (default).
8e07c86e 1386
864a5fa8 1387=item INST_ARCHLIB
8e07c86e 1388
864a5fa8 1389Same as INST_LIB for architecture dependent files.
8e07c86e 1390
f1387719 1391=item INST_BIN
1392
1393Directory to put real binary files during 'make'. These will be copied
1394to INSTALLBIN during 'make install'
1395
864a5fa8 1396=item INST_EXE
8e07c86e 1397
f1387719 1398Old name for INST_SCRIPT. Deprecated. Please use INST_SCRIPT if you
1399need to use it.
8e07c86e 1400
864a5fa8 1401=item INST_LIB
8e07c86e 1402
864a5fa8 1403Directory where we put library files of this extension while building
1404it.
8e07c86e 1405
864a5fa8 1406=item INST_MAN1DIR
8e07c86e 1407
864a5fa8 1408Directory to hold the man pages at 'make' time
8e07c86e 1409
864a5fa8 1410=item INST_MAN3DIR
8e07c86e 1411
864a5fa8 1412Directory to hold the man pages at 'make' time
8e07c86e 1413
f1387719 1414=item INST_SCRIPT
1415
1416Directory, where executable files should be installed during
1417'make'. Defaults to "./blib/bin", just to have a dummy location during
1418testing. make install will copy the files in INST_SCRIPT to
1419INSTALLSCRIPT.
1420
864a5fa8 1421=item LDFROM
8e07c86e 1422
864a5fa8 1423defaults to "$(OBJECT)" and is used in the ld command to specify
1424what files to link/load from (also see dynamic_lib below for how to
1425specify ld flags)
8e07c86e 1426
bab2b58e 1427=item LIB
1428
1429LIB can only be set at C<perl Makefile.PL> time. It has the effect of
1430setting both INSTALLPRIVLIB and INSTALLSITELIB to that value regardless any
1431
762efda7 1432=item LIBPERL_A
1433
1434The filename of the perllibrary that will be used together with this
1435extension. Defaults to libperl.a.
1436
8e07c86e 1437=item LIBS
1438
1439An anonymous array of alternative library
1440specifications to be searched for (in order) until
864a5fa8 1441at least one library is found. E.g.
8e07c86e 1442
1443 'LIBS' => ["-lgdbm", "-ldbm -lfoo", "-L/path -ldbm.nfs"]
1444
1445Mind, that any element of the array
1446contains a complete set of arguments for the ld
1447command. So do not specify
1448
1449 'LIBS' => ["-ltcl", "-ltk", "-lX11"]
1450
1451See ODBM_File/Makefile.PL for an example, where an array is needed. If
1452you specify a scalar as in
1453
1454 'LIBS' => "-ltcl -ltk -lX11"
1455
1456MakeMaker will turn it into an array with one element.
1457
864a5fa8 1458=item LINKTYPE
8e07c86e 1459
e05e23b1 1460'static' or 'dynamic' (default unless usedl=undef in
1461config.sh). Should only be used to force static linking (also see
864a5fa8 1462linkext below).
8e07c86e 1463
864a5fa8 1464=item MAKEAPERL
8e07c86e 1465
864a5fa8 1466Boolean which tells MakeMaker, that it should include the rules to
1467make a perl. This is handled automatically as a switch by
1468MakeMaker. The user normally does not need it.
8e07c86e 1469
864a5fa8 1470=item MAKEFILE
8e07c86e 1471
864a5fa8 1472The name of the Makefile to be produced.
8e07c86e 1473
864a5fa8 1474=item MAN1PODS
8e07c86e 1475
864a5fa8 1476Hashref of pod-containing files. MakeMaker will default this to all
1477EXE_FILES files that include POD directives. The files listed
1478here will be converted to man pages and installed as was requested
1479at Configure time.
8e07c86e 1480
864a5fa8 1481=item MAN3PODS
8e07c86e 1482
864a5fa8 1483Hashref of .pm and .pod files. MakeMaker will default this to all
1484 .pod and any .pm files that include POD directives. The files listed
1485here will be converted to man pages and installed as was requested
1486at Configure time.
8e07c86e 1487
864a5fa8 1488=item MAP_TARGET
8e07c86e 1489
864a5fa8 1490If it is intended, that a new perl binary be produced, this variable
1491may hold a name for that binary. Defaults to perl
8e07c86e 1492
864a5fa8 1493=item MYEXTLIB
4633a7c4 1494
864a5fa8 1495If the extension links to a library that it builds set this to the
1496name of the library (see SDBM_File)
4633a7c4 1497
864a5fa8 1498=item NAME
8e07c86e 1499
864a5fa8 1500Perl module name for this extension (DBD::Oracle). This will default
1501to the directory name but should be explicitly defined in the
1502Makefile.PL.
8e07c86e 1503
864a5fa8 1504=item NEEDS_LINKING
8e07c86e 1505
864a5fa8 1506MakeMaker will figure out, if an extension contains linkable code
1507anywhere down the directory tree, and will set this variable
1508accordingly, but you can speed it up a very little bit, if you define
1509this boolean variable yourself.
8e07c86e 1510
e05e23b1 1511=item NOECHO
1512
f1387719 1513Defaults to C<@>. By setting it to an empty string you can generate a
e05e23b1 1514Makefile that echos all commands. Mainly used in debugging MakeMaker
1515itself.
1516
864a5fa8 1517=item NORECURS
8e07c86e 1518
e05e23b1 1519Boolean. Attribute to inhibit descending into subdirectories.
8e07c86e 1520
762efda7 1521=item NO_VC
1522
1523In general any generated Makefile checks for the current version of
1524MakeMaker and the version the Makefile was built under. If NO_VC is
1525set, the version check is neglected. Do not write this into your
1526Makefile.PL, use it interactively instead.
1527
864a5fa8 1528=item OBJECT
8e07c86e 1529
864a5fa8 1530List of object files, defaults to '$(BASEEXT)$(OBJ_EXT)', but can be a long
1531string containing all object files, e.g. "tkpBind.o
1532tkpButton.o tkpCanvas.o"
8e07c86e 1533
3b03c0f3 1534=item OPTIMIZE
1535
1536Defaults to C<-O>. Set it to C<-g> to turn debugging on. The flag is
1537passed to subdirectory makes.
1538
864a5fa8 1539=item PERL
8e07c86e 1540
864a5fa8 1541Perl binary for tasks that can be done by miniperl
8e07c86e 1542
864a5fa8 1543=item PERLMAINCC
005c1a0e 1544
864a5fa8 1545The call to the program that is able to compile perlmain.c. Defaults
1546to $(CC).
005c1a0e 1547
864a5fa8 1548=item PERL_ARCHLIB
005c1a0e 1549
864a5fa8 1550Same as above for architecture dependent files
8e07c86e 1551
864a5fa8 1552=item PERL_LIB
8e07c86e 1553
864a5fa8 1554Directory containing the Perl library to use.
8e07c86e 1555
864a5fa8 1556=item PERL_SRC
8e07c86e 1557
864a5fa8 1558Directory containing the Perl source code (use of this should be
1559avoided, it may be undefined)
8e07c86e 1560
2366100d 1561=item PERM_RW
1562
1563Desired Permission for read/writable files. Defaults to C<644>.
1564See also L<MM_Unix/perm_rw>.
1565
1566=item PERM_RWX
1567
1568Desired permission for executable files. Defaults to C<755>.
1569See also L<MM_Unix/perm_rwx>.
1570
864a5fa8 1571=item PL_FILES
8e07c86e 1572
864a5fa8 1573Ref to hash of files to be processed as perl programs. MakeMaker
1574will default to any found *.PL file (except Makefile.PL) being keys
1575and the basename of the file being the value. E.g.
8e07c86e 1576
864a5fa8 1577 {'foobar.PL' => 'foobar'}
8e07c86e 1578
864a5fa8 1579The *.PL files are expected to produce output to the target files
3aa35033 1580themselves. If multiple files can be generated from the same *.PL
1581file then the value in the hash can be a reference to an array of
1582target file names. E.g.
1583
1584 {'foobar.PL' => ['foobar1','foobar2']}
8e07c86e 1585
864a5fa8 1586=item PM
8e07c86e 1587
864a5fa8 1588Hashref of .pm files and *.pl files to be installed. e.g.
8e07c86e 1589
864a5fa8 1590 {'name_of_file.pm' => '$(INST_LIBDIR)/install_as.pm'}
8e07c86e 1591
a3cb178b 1592By default this will include *.pm and *.pl and the files found in
1593the PMLIBDIRS directories. Defining PM in the
864a5fa8 1594Makefile.PL will override PMLIBDIRS.
8e07c86e 1595
864a5fa8 1596=item PMLIBDIRS
8e07c86e 1597
864a5fa8 1598Ref to array of subdirectories containing library files. Defaults to
a3cb178b 1599[ 'lib', $(BASEEXT) ]. The directories will be scanned and I<any> files
864a5fa8 1600they contain will be installed in the corresponding location in the
1601library. A libscan() method can be used to alter the behaviour.
1602Defining PM in the Makefile.PL will override PMLIBDIRS.
8e07c86e 1603
875fa795 1604=item PPM_INSTALL_EXEC
1605
20e08411 1606Name of the executable used to run C<PPM_INSTALL_SCRIPT> below. (e.g. perl)
875fa795 1607
1608=item PPM_INSTALL_SCRIPT
1609
1610Name of the script that gets executed by the Perl Package Manager after
1611the installation of a package.
1612
864a5fa8 1613=item PREFIX
8e07c86e 1614
864a5fa8 1615Can be used to set the three INSTALL* attributes in one go (except for
e05e23b1 1616probably INSTALLMAN1DIR, if it is not below PREFIX according to
1617%Config). They will have PREFIX as a common directory node and will
1618branch from that node into lib/, lib/ARCHNAME or whatever Configure
1619decided at the build time of your perl (unless you override one of
1620them, of course).
8e07c86e 1621
f1387719 1622=item PREREQ_PM
8e07c86e 1623
f1387719 1624Hashref: Names of modules that need to be available to run this
1625extension (e.g. Fcntl for SDBM_File) are the keys of the hash and the
1626desired version is the value. If the required version number is 0, we
1627only check if any version is installed already.
8e07c86e 1628
864a5fa8 1629=item SKIP
8e07c86e 1630
864a5fa8 1631Arryref. E.g. [qw(name1 name2)] skip (do not write) sections of the
f1387719 1632Makefile. Caution! Do not use the SKIP attribute for the neglectible
1633speedup. It may seriously damage the resulting Makefile. Only use it,
1634if you really need it.
8e07c86e 1635
864a5fa8 1636=item TYPEMAPS
8e07c86e 1637
864a5fa8 1638Ref to array of typemap file names. Use this when the typemaps are
1639in some directory other than the current directory or when they are
1640not named B<typemap>. The last typemap in the list takes
1641precedence. A typemap in the current directory has highest
1642precedence, even if it isn't listed in TYPEMAPS. The default system
1643typemap has lowest precedence.
8e07c86e 1644
864a5fa8 1645=item VERSION
8e07c86e 1646
864a5fa8 1647Your version number for distributing the package. This defaults to
16480.1.
8e07c86e 1649
0d8023a2 1650=item VERSION_FROM
1651
1652Instead of specifying the VERSION in the Makefile.PL you can let
1653MakeMaker parse a file to determine the version number. The parsing
1654routine requires that the file named by VERSION_FROM contains one
1655single line to compute the version number. The first line in the file
1656that contains the regular expression
1657
84902520 1658 /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
0d8023a2 1659
1660will be evaluated with eval() and the value of the named variable
1661B<after> the eval() will be assigned to the VERSION attribute of the
1662MakeMaker object. The following lines will be parsed o.k.:
1663
1664 $VERSION = '1.00';
84902520 1665 *VERSION = \'1.01';
2366100d 1666 ( $VERSION ) = '$Revision: 1.222 $ ' =~ /\$Revision:\s+([^\s]+)/;
0d8023a2 1667 $FOO::VERSION = '1.10';
84902520 1668 *FOO::VERSION = \'1.11';
0d8023a2 1669
1670but these will fail:
1671
1672 my $VERSION = '1.01';
1673 local $VERSION = '1.02';
1674 local $FOO::VERSION = '1.30';
1675
84902520 1676The file named in VERSION_FROM is not added as a dependency to
1677Makefile. This is not really correct, but it would be a major pain
1678during development to have to rewrite the Makefile for any smallish
1679change in that file. If you want to make sure that the Makefile
1680contains the correct VERSION macro after any change of the file, you
1681would have to do something like
1682
1683 depend => { Makefile => '$(VERSION_FROM)' }
1684
1685See attribute C<depend> below.
0d8023a2 1686
864a5fa8 1687=item XS
8e07c86e 1688
864a5fa8 1689Hashref of .xs files. MakeMaker will default this. e.g.
8e07c86e 1690
864a5fa8 1691 {'name_of_file.xs' => 'name_of_file.c'}
8e07c86e 1692
864a5fa8 1693The .c files will automatically be included in the list of files
1694deleted by a make clean.
4633a7c4 1695
864a5fa8 1696=item XSOPT
8e07c86e 1697
864a5fa8 1698String of options to pass to xsubpp. This might include C<-C++> or
1699C<-extern>. Do not include typemaps here; the TYPEMAP parameter exists for
1700that purpose.
8e07c86e 1701
864a5fa8 1702=item XSPROTOARG
4633a7c4 1703
4e68a208 1704May be set to an empty string, which is identical to C<-prototypes>, or
864a5fa8 1705C<-noprototypes>. See the xsubpp documentation for details. MakeMaker
4e68a208 1706defaults to the empty string.
1707
0d8023a2 1708=item XS_VERSION
1709
1710Your version number for the .xs file of this package. This defaults
1711to the value of the VERSION attribute.
1712
8e07c86e 1713=back
1714
1715=head2 Additional lowercase attributes
1716
1717can be used to pass parameters to the methods which implement that
f1387719 1718part of the Makefile.
8e07c86e 1719
1720=over 2
1721
864a5fa8 1722=item clean
8e07c86e 1723
864a5fa8 1724 {FILES => "*.xyz foo"}
1725
c07a80fd 1726=item depend
1727
1728 {ANY_TARGET => ANY_DEPENDECY, ...}
1729
864a5fa8 1730=item dist
1731
5f8e730b 1732 {TARFLAGS => 'cvfF', COMPRESS => 'gzip', SUFFIX => '.gz',
3b03c0f3 1733 SHAR => 'shar -m', DIST_CP => 'ln', ZIP => '/bin/zip',
f1387719 1734 ZIPFLAGS => '-rl', DIST_DEFAULT => 'private tardist' }
864a5fa8 1735
1736If you specify COMPRESS, then SUFFIX should also be altered, as it is
1737needed to tell make the target file of the compression. Setting
1738DIST_CP to ln can be useful, if you need to preserve the timestamps on
1739your files. DIST_CP can take the values 'cp', which copies the file,
1740'ln', which links the file, and 'best' which copies symbolic links and
1741links the rest. Default is 'best'.
1742
1743=item dynamic_lib
1744
0d8023a2 1745 {ARMAYBE => 'ar', OTHERLDFLAGS => '...', INST_DYNAMIC_DEP => '...'}
8e07c86e 1746
8e07c86e 1747=item linkext
1748
1749 {LINKTYPE => 'static', 'dynamic' or ''}
1750
864a5fa8 1751NB: Extensions that have nothing but *.pm files had to say
8e07c86e 1752
1753 {LINKTYPE => ''}
1754
864a5fa8 1755with Pre-5.0 MakeMakers. Since version 5.00 of MakeMaker such a line
1756can be deleted safely. MakeMaker recognizes, when there's nothing to
1757be linked.
8e07c86e 1758
864a5fa8 1759=item macro
8e07c86e 1760
864a5fa8 1761 {ANY_MACRO => ANY_VALUE, ...}
8e07c86e 1762
1763=item realclean
1764
1765 {FILES => '$(INST_ARCHAUTODIR)/*.xyz'}
1766
8e07c86e 1767=item tool_autosplit
1768
1769 {MAXLEN =E<gt> 8}
005c1a0e 1770
1771=back
1772
1773=head2 Overriding MakeMaker Methods
1774
1775If you cannot achieve the desired Makefile behaviour by specifying
1776attributes you may define private subroutines in the Makefile.PL.
1777Each subroutines returns the text it wishes to have written to
1778the Makefile. To override a section of the Makefile you can
1779either say:
1780
1781 sub MY::c_o { "new literal text" }
1782
1783or you can edit the default by saying something like:
1784
8e07c86e 1785 sub MY::c_o {
14870ecd 1786 package MY; # so that "SUPER" works right
1787 my $inherited = shift->SUPER::c_o(@_);
f1387719 1788 $inherited =~ s/old text/new text/;
1789 $inherited;
8e07c86e 1790 }
1791
bdda3fbd 1792If you are running experiments with embedding perl as a library into
1793other applications, you might find MakeMaker is not sufficient. You'd
1794better have a look at ExtUtils::Embed which is a collection of utilities
1795for embedding.
005c1a0e 1796
1797If you still need a different solution, try to develop another
bdda3fbd 1798subroutine that fits your needs and submit the diffs to
1799F<perl5-porters@perl.org> or F<comp.lang.perl.moderated> as appropriate.
005c1a0e 1800
3b03c0f3 1801For a complete description of all MakeMaker methods see L<ExtUtils::MM_Unix>.
1802
1803Here is a simple example of how to add a new target to the generated
1804Makefile:
1805
1806 sub MY::postamble {
1807 '
1808 $(MYEXTLIB): sdbm/Makefile
1809 cd sdbm && $(MAKE) all
1810 ';
1811 }
1812
1813
f1387719 1814=head2 Hintsfile support
1815
1816MakeMaker.pm uses the architecture specific information from
1817Config.pm. In addition it evaluates architecture specific hints files
1818in a C<hints/> directory. The hints files are expected to be named
1819like their counterparts in C<PERL_SRC/hints>, but with an C<.pl> file
1820name extension (eg. C<next_3_2.pl>). They are simply C<eval>ed by
1821MakeMaker within the WriteMakefile() subroutine, and can be used to
1822execute commands as well as to include special variables. The rules
1823which hintsfile is chosen are the same as in Configure.
1824
1825The hintsfile is eval()ed immediately after the arguments given to
1826WriteMakefile are stuffed into a hash reference $self but before this
1827reference becomes blessed. So if you want to do the equivalent to
1828override or create an attribute you would say something like
1829
1830 $self->{LIBS} = ['-ldbm -lucb -lc'];
1831
005c1a0e 1832=head2 Distribution Support
1833
1834For authors of extensions MakeMaker provides several Makefile
1835targets. Most of the support comes from the ExtUtils::Manifest module,
1836where additional documentation can be found.
1837
1838=over 4
1839
1840=item make distcheck
8e07c86e 1841
005c1a0e 1842reports which files are below the build directory but not in the
1843MANIFEST file and vice versa. (See ExtUtils::Manifest::fullcheck() for
1844details)
1845
4633a7c4 1846=item make skipcheck
1847
1848reports which files are skipped due to the entries in the
1849C<MANIFEST.SKIP> file (See ExtUtils::Manifest::skipcheck() for
1850details)
1851
005c1a0e 1852=item make distclean
8e07c86e 1853
005c1a0e 1854does a realclean first and then the distcheck. Note that this is not
1855needed to build a new distribution as long as you are sure, that the
1856MANIFEST file is ok.
1857
1858=item make manifest
8e07c86e 1859
005c1a0e 1860rewrites the MANIFEST file, adding all remaining files found (See
1861ExtUtils::Manifest::mkmanifest() for details)
1862
1863=item make distdir
8e07c86e 1864
005c1a0e 1865Copies all the files that are in the MANIFEST file to a newly created
1866directory with the name C<$(DISTNAME)-$(VERSION)>. If that directory
1867exists, it will be removed first.
1868
8e07c86e 1869=item make disttest
1870
1871Makes a distdir first, and runs a C<perl Makefile.PL>, a make, and
4633a7c4 1872a make test in that directory.
8e07c86e 1873
005c1a0e 1874=item make tardist
8e07c86e 1875
3b03c0f3 1876First does a distdir. Then a command $(PREOP) which defaults to a null
f1387719 1877command, followed by $(TOUNIX), which defaults to a null command under
1878UNIX, and will convert files in distribution directory to UNIX format
1879otherwise. Next it runs C<tar> on that directory into a tarfile and
3b03c0f3 1880deletes the directory. Finishes with a command $(POSTOP) which
1881defaults to a null command.
005c1a0e 1882
1883=item make dist
8e07c86e 1884
005c1a0e 1885Defaults to $(DIST_DEFAULT) which in turn defaults to tardist.
1886
1887=item make uutardist
8e07c86e 1888
005c1a0e 1889Runs a tardist first and uuencodes the tarfile.
1890
1891=item make shdist
8e07c86e 1892
3b03c0f3 1893First does a distdir. Then a command $(PREOP) which defaults to a null
1894command. Next it runs C<shar> on that directory into a sharfile and
1895deletes the intermediate directory again. Finishes with a command
1896$(POSTOP) which defaults to a null command. Note: For shdist to work
1897properly a C<shar> program that can handle directories is mandatory.
1898
1899=item make zipdist
1900
1901First does a distdir. Then a command $(PREOP) which defaults to a null
1902command. Runs C<$(ZIP) $(ZIPFLAGS)> on that directory into a
1903zipfile. Then deletes that directory. Finishes with a command
1904$(POSTOP) which defaults to a null command.
005c1a0e 1905
1906=item make ci
8e07c86e 1907
1908Does a $(CI) and a $(RCS_LABEL) on all files in the MANIFEST file.
1909
1910=back
005c1a0e 1911
1912Customization of the dist targets can be done by specifying a hash
1913reference to the dist attribute of the WriteMakefile call. The
1914following parameters are recognized:
1915
8e07c86e 1916 CI ('ci -u')
5f8e730b 1917 COMPRESS ('gzip --best')
005c1a0e 1918 POSTOP ('@ :')
8e07c86e 1919 PREOP ('@ :')
f1387719 1920 TO_UNIX (depends on the system)
8e07c86e 1921 RCS_LABEL ('rcs -q -Nv$(VERSION_SYM):')
1922 SHAR ('shar')
5f8e730b 1923 SUFFIX ('.gz')
8e07c86e 1924 TAR ('tar')
1925 TARFLAGS ('cvf')
3b03c0f3 1926 ZIP ('zip')
1927 ZIPFLAGS ('-r')
005c1a0e 1928
1929An example:
1930
5f8e730b 1931 WriteMakefile( 'dist' => { COMPRESS=>"bzip2", SUFFIX=>".bz2" })
005c1a0e 1932
1b171b8d 1933=head2 Disabling an extension
1934
1935If some events detected in F<Makefile.PL> imply that there is no way
1936to create the Module, but this is a normal state of things, then you
1937can create a F<Makefile> which does nothing, but succeeds on all the
1938"usual" build targets. To do so, use
1939
1940 ExtUtils::MakeMaker::WriteEmptyMakefile();
1941
1942instead of WriteMakefile().
1943
1944This may be useful if other modules expect this module to be I<built>
1945OK, as opposed to I<work> OK (say, this system-dependent module builds
1946in a subdirectory of some other distribution, or is listed as a
1947dependency in a CPAN::Bundle, but the functionality is supported by
1948different means on the current architecture).
1949
6ce21ffa 1950=head1 ENVIRONMENT
1951
1952=over 8
1953
2443aee5 1954=item PERL_MM_OPT
6ce21ffa 1955
1956Command line options used by C<MakeMaker-E<gt>new()>, and thus by
1957C<WriteMakefile()>. The string is split on whitespace, and the result
1958is processed before any actual command line arguments are processed.
1959
1960=back
1961
f1387719 1962=head1 SEE ALSO
1963
1964ExtUtils::MM_Unix, ExtUtils::Manifest, ExtUtils::testlib,
bdda3fbd 1965ExtUtils::Install, ExtUtils::Embed
005c1a0e 1966
e05e23b1 1967=head1 AUTHORS
fed7345c 1968
352854fa 1969Andy Dougherty <F<doughera@lafcol.lafayette.edu>>, Andreas KE<ouml>nig
1970<F<A.Koenig@franz.ww.TU-Berlin.DE>>, Tim Bunce <F<Tim.Bunce@ig.co.uk>>.
bd3fa61c 1971VMS support by Charles Bailey <F<bailey@newman.upenn.edu>>. OS/2
352854fa 1972support by Ilya Zakharevich <F<ilya@math.ohio-state.edu>>. Contact the
e05e23b1 1973makemaker mailing list C<mailto:makemaker@franz.ww.tu-berlin.de>, if
1974you have any questions.
fed7345c 1975
005c1a0e 1976=cut