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