.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.IX Title "ExtUtils::MM_Any 3"
.TH ExtUtils::MM_Any 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
ExtUtils::MM_Any \- Platform\-agnostic MM methods
\& FOR INTERNAL USE ONLY!
\& package ExtUtils::MM_SomeOS;
\& # Temporarily, you have to subclass both. Put MM_Any first.
\& require ExtUtils::MM_Any;
\& require ExtUtils::MM_Unix;
\& @ISA = qw(ExtUtils::MM_Any ExtUtils::Unix);
\&\fB\s-1FOR\s0 \s-1INTERNAL\s0 \s-1USE\s0 \s-1ONLY\s0!\fR
ExtUtils::MM_Any is a superclass for the ExtUtils::MM_* set of
modules. It contains methods which are either inherently
cross-platform or are written in a cross-platform manner.
Subclass off of ExtUtils::MM_Any \fIand\fR ExtUtils::MM_Unix. This is a
\&\fB\s-1THIS\s0 \s-1MAY\s0 \s-1BE\s0 \s-1TEMPORARY\s0!\fR
Any methods marked \fIAbstract\fR must be implemented by subclasses.
.Sh "Cross-platform helper methods"
.IX Subsection "Cross-platform helper methods"
These are methods which help writing cross-platform code.
\fIos_flavor \fIAbstract\fI\fR
.IX Subsection "os_flavor Abstract"
\& my @os_flavor = $mm->os_flavor;
@os_flavor is the style of operating system this is, usually
corresponding to the MM_*.pm file we're using.
The first element of \f(CW@os_flavor\fR is the major family (ie. Unix,
Windows, \s-1VMS\s0, \s-1OS/2\s0, etc...) and the rest are sub families.
\& Cygwin98 ('Unix', 'Cygwin', 'Cygwin9x')
\& Windows NT ('Win32', 'WinNT')
\& Win98 ('Win32', 'Win9x')
\& Linux ('Unix', 'Linux')
\& MacOS X ('Unix', 'Darwin', 'MacOS', 'MacOS X')
This is used to write code for styles of operating system.
See \fIos_flavor_is()\fR for use.
.IX Subsection "os_flavor_is"
\& my $is_this_flavor = $mm->os_flavor_is($this_flavor);
\& my $is_this_flavor = $mm->os_flavor_is(@one_of_these_flavors);
Checks to see if the current operating system is one of the given flavors.
This is useful for code like:
\& if( $mm->os_flavor_is('Unix') ) {
.IX Subsection "split_command"
\& my @cmds = $MM->split_command($cmd, @args);
Most \s-1OS\s0 have a maximum command length they can execute at once. Large
modules can easily generate commands well past that limit. Its
necessary to split long commands up into a series of shorter commands.
\&\f(CW\*(C`split_command\*(C'\fR will return a series of \f(CW@cmds\fR each processing part of
the args. Collectively they will process all the arguments. Each
individual line in \f(CW@cmds\fR will not be longer than the
\&\f(CW$self\fR\->max_exec_len being careful to take into account macro expansion.
$cmd should include any switches and repeated initial arguments.
If no \f(CW@args\fR are given, no \f(CW@cmds\fR will be returned.
Pairs of arguments will always be preserved in a single command, this
is a heuristic for things like pm_to_blib and pod2man which work on
pairs of arguments. This makes things like this safe:
\& $self->split_command($cmd, %pod2man);
\& my @commands = $MM->echo($text);
\& my @commands = $MM->echo($text, $file);
\& my @commands = $MM->echo($text, $file, $appending);
Generates a set of \f(CW@commands\fR which print the \f(CW$text\fR to a \f(CW$file\fR.
If \f(CW$file\fR is not given, output goes to \s-1STDOUT\s0.
If \f(CW$appending\fR is true the \f(CW$file\fR will be appended to rather than
.IX Subsection "wraplist"
\& my $args = $mm->wraplist(@list);
Takes an array of items and turns them into a well-formatted list of
arguments. In most cases this is simply something like:
.IX Subsection "cd Abstract"
\& my $subdir_cmd = $MM->cd($subdir, @cmds);
This will generate a make fragment which runs the \f(CW@cmds\fR in the given
\&\f(CW$dir\fR. The rough equivalent to this, except cross platform.
Currently \f(CW$dir\fR can only go down one level. \*(L"foo\*(R" is fine. \*(L"foo/bar\*(R" is
not. \*(L"../foo\*(R" is right out.
The resulting \f(CW$subdir_cmd\fR has no leading tab nor trailing newline. This
makes it easier to embed in a make string. For example.
\& my $make = sprintf <<'CODE', $subdir_cmd;
\fIoneliner \fIAbstract\fI\fR
.IX Subsection "oneliner Abstract"
\& my $oneliner = $MM->oneliner($perl_code);
\& my $oneliner = $MM->oneliner($perl_code, \e@switches);
This will generate a perl one-liner safe for the particular platform
you're on based on the given \f(CW$perl_code\fR and \f(CW@switches\fR (a \-e is
assumed) suitable for using in a make target. It will use the proper
shell quoting and escapes.
$(\s-1PERLRUN\s0) will be used as perl.
Any newlines in \f(CW$perl_code\fR will be escaped. Leading and trailing
newlines will be stripped. Makes this idiom much easier:
\& my $code = $MM->oneliner(<<'CODE', [...switches...]);
Usage might be something like:
\& $oneliner = $MM->oneliner('print "Foo\en"');
\& $make = '$oneliner > somefile';
All dollar signs must be doubled in the \f(CW$perl_code\fR if you expect them
to be interpreted normally, otherwise it will be considered a make
macro. Also remember to quote make macros else it might be used as a
\& # Assign the value of the $(VERSION_FROM) make macro to $vf.
\& $oneliner = $MM->oneliner('$$vf = "$(VERSION_FROM)"');
Its currently very simple and may be expanded sometime in the figure
to include more flexible code and switches.
\fIquote_literal \fIAbstract\fI\fR
.IX Subsection "quote_literal Abstract"
\& my $safe_text = $MM->quote_literal($text);
This will quote \f(CW$text\fR so it is interpreted literally in the shell.
For example, on Unix this would escape any single-quotes in \f(CW$text\fR and
put single-quotes around the whole thing.
\fIescape_newlines \fIAbstract\fI\fR
.IX Subsection "escape_newlines Abstract"
\& my $escaped_text = $MM->escape_newlines($text);
Shell escapes newlines in \f(CW$text\fR.
\fImax_exec_len \fIAbstract\fI\fR
.IX Subsection "max_exec_len Abstract"
\& my $max_exec_len = $MM->max_exec_len;
Calculates the maximum command size the \s-1OS\s0 can exec. Effectively,
this is the max size of a shell command line.
These are methods which produce make targets.
.IX Subsection "all_target"
Generate the default target 'all'.
.IX Subsection "blibdirs_target"
\& my $make_frag = $mm->blibdirs_target;
Creates the blibdirs target which creates all the directories we use
The blibdirs.ts target is deprecated. Depend on blibdirs instead.
.IX Subsection "clean (o)"
Defines the clean target.
\fIclean_subdirs_target\fR
.IX Subsection "clean_subdirs_target"
\& my $make_frag = $MM->clean_subdirs_target;
Returns the clean_subdirs target. This is used by the clean target to
call clean on any subdirectories which contain Makefiles.
.IX Subsection "dir_target"
\& my $make_frag = $mm->dir_target(@directories);
Generates targets to create the specified directories and set its
Because depending on a directory to just ensure it exists doesn't work
too well (the modified time changes too often) \fIdir_target()\fR creates a
\&.exists file in the created directory. It is this you should depend on.
For portability purposes you should use the $(\s-1DIRFILESEP\s0) macro rather
than a '/' to seperate the directory from the file.
\& yourdirectory$(DIRFILESEP).exists
Defines the scratch directory target that will hold the distribution
before tar-ing (or shar\-ing).
.IX Subsection "dist_test"
Defines a target that produces the distribution in the
scratchdirectory, and runs 'perl Makefile.PL; make ;make test' in that
.IX Subsection "dynamic (o)"
Defines the dynamic target.
\fImakemakerdflt_target\fR
.IX Subsection "makemakerdflt_target"
\& my $make_frag = $mm->makemakerdflt_target
Returns a make fragment with the makemakerdeflt_target specified.
This target is the first target in the Makefile, is the default target
and simply points off to 'all' just in case any make variant gets
confused or something gets snuck in before the real 'all' target.
.IX Subsection "manifypods_target"
\& my $manifypods_target = $self->manifypods_target;
Generates the manifypods target. This target generates man pages from
all \s-1POD\s0 files in \s-1MAN1PODS\s0 and \s-1MAN3PODS\s0.
.IX Subsection "metafile_target"
\& my $target = $mm->metafile_target;
Generate the metafile target.
Writes the file \s-1META\s0.yml \s-1YAML\s0 encoded meta-data about the module in
the distdir. The format follows Module::Build's as closely as
possible. Additionally, we include:
.IX Subsection "distmeta_target"
\& my $make_frag = $mm->distmeta_target;
Generates the distmeta target to add \s-1META\s0.yml to the \s-1MANIFEST\s0 in the
.IX Subsection "realclean (o)"
Defines the realclean target.
\fIrealclean_subdirs_target\fR
.IX Subsection "realclean_subdirs_target"
\& my $make_frag = $MM->realclean_subdirs_target;
Returns the realclean_subdirs target. This is used by the realclean
target to call realclean on any subdirectories which contain Makefiles.
.IX Subsection "signature_target"
\& my $target = $mm->signature_target;
Generate the signature target.
Writes the file \s-1SIGNATURE\s0 with \*(L"cpansign \-s\*(R".
\fIdistsignature_target\fR
.IX Subsection "distsignature_target"
\& my $make_frag = $mm->distsignature_target;
Generates the distsignature target to add \s-1SIGNATURE\s0 to the \s-1MANIFEST\s0 in the
.IX Subsection "special_targets"
\& my $make_frag = $mm->special_targets
Returns a make fragment containing any targets which have special
meaning to make. For example, .SUFFIXES and .PHONY.
.IX Subsection "Init methods"
Methods which help initialize the MakeMaker object and macros.
.IX Subsection "init_INST"
Called by init_main. Sets up all INST_* variables except those related
to \s-1XS\s0 code. Those are handled in init_xs.
.IX Subsection "init_INSTALL"
Called by init_main. Sets up all INSTALL_* variables (except
\&\s-1INSTALLDIRS\s0) and *PREFIX.
\fIinit_INSTALL_from_PREFIX\fR
.IX Subsection "init_INSTALL_from_PREFIX"
\& $mm->init_INSTALL_from_PREFIX;
\fIinit_from_INSTALLBASE\fR
.IX Subsection "init_from_INSTALLBASE"
\& $mm->init_from_INSTALLBASE
\fIinit_VERSION \fIAbstract\fI\fR
.IX Subsection "init_VERSION Abstract"
Initialize macros representing versions of MakeMaker and other tools
\&\s-1MAKEMAKER:\s0 path to the MakeMaker module.
\&\s-1MM_VERSION:\s0 ExtUtils::MakeMaker Version
\&\s-1MM_REVISION:\s0 ExtUtils::MakeMaker version control revision (for backwards
\&\s-1VERSION:\s0 version of your module
\&\s-1VERSION_MACRO:\s0 which macro represents the version (usually '\s-1VERSION\s0')
\&\s-1VERSION_SYM:\s0 like version but safe for use as an \s-1RCS\s0 revision number
\&\s-1DEFINE_VERSION:\s0 \-D line to set the module version when compiling
\&\s-1XS_VERSION:\s0 version in your .xs file. Defaults to $(\s-1VERSION\s0)
\&\s-1XS_VERSION_MACRO:\s0 which macro represents the \s-1XS\s0 version.
\&\s-1XS_DEFINE_VERSION:\s0 \-D line to set the xs version when compiling.
\fIinit_others \fIAbstract\fI\fR
.IX Subsection "init_others Abstract"
Initializes the macro definitions used by \fItools_other()\fR and places them
in the \f(CW$MM\fR object.
If there is no description, its the same as the parameter to
\&\fIWriteMakefile()\fR documented in ExtUtils::MakeMaker.
Defines at least these macros.
\& NOECHO Tell make not to display the command itself
\& MAKE_APERL_FILE File used by MAKE_APERL
\& SHELL Program used to run
\& ECHO Print text adding a newline on the end
\& RM_RF Remove a directory
\& TOUCH Update a file's timestamp
\& TEST_F Test for a file's existence
\& CHMOD Change permissions on a
\& UMASK_NULL Nullify umask
\& DEV_NULL Supress all command output
\fIinit_DIRFILESEP \fIAbstract\fI\fR
.IX Subsection "init_DIRFILESEP Abstract"
\& my $dirfilesep = $MM->{DIRFILESEP};
Initializes the \s-1DIRFILESEP\s0 macro which is the seperator between the
directory and filename in a filepath. ie. / on Unix, \e on Win32 and
\& # instead of $(INST_ARCHAUTODIR)/extralibs.ld
\& $(INST_ARCHAUTODIR)$(DIRFILESEP)extralibs.ld
Something of a hack but it prevents a lot of code duplication between
Do not use this as a seperator between directories. Some operating
systems use different seperators between subdirectories as between
directories and filenames (for example: VOLUME:[dir1.dir2]file on \s-1VMS\s0).
\fIinit_linker \fIAbstract\fI\fR
.IX Subsection "init_linker Abstract"
Initialize macros which have to do with linking.
\&\s-1PERL_ARCHIVE:\s0 path to libperl.a equivalent to be linked to dynamic
\&\s-1PERL_ARCHIVE_AFTER:\s0 path to a library which should be put on the
linker command line \fIafter\fR the external libraries to be linked to
dynamic extensions. This may be needed if the linker is one\-pass, and
Perl includes some overrides for C \s-1RTL\s0 functions, such as \fImalloc()\fR.
\&\s-1EXPORT_LIST:\s0 name of a file that is passed to linker to define symbols
Some OSes do not need these in which case leave it blank.
.IX Subsection "init_platform"
Initialize any macros which are for platform specific use only.
A typical one is the version number of your \s-1OS\s0 specific mocule.
(ie. MM_Unix_VERSION or \s-1MM_VMS_VERSION\s0).
A grab bag of methods to generate specific macros and commands.
.IX Subsection "manifypods"
Defines targets and routines to translate the pods into manpages and
put them into the INST_* directories.
.IX Subsection "POD2MAN_macro"
\& my $pod2man_macro = $self->POD2MAN_macro
Returns a definition for the \s-1POD2MAN\s0 macro. This is a program
which emulates the pod2man utility. You can add more switches to the
command by simply appending them on the macro.
\& $(POD2MAN) --section=3 --perm_rw=$(PERM_RW) podfile1 man_page1 ...
.IX Subsection "test_via_harness"
\& my $command = $mm->test_via_harness($perl, $tests);
Returns a \f(CW$command\fR line which runs the given set of \f(CW$tests\fR with
Test::Harness and the given \f(CW$perl\fR.
.IX Subsection "test_via_script"
\& my $command = $mm->test_via_script($perl, $script);
Returns a \f(CW$command\fR line which just runs a single test without
Test::Harness. No checks are done on the results, they're just
Used for test.pl, since they don't always follow Test::Harness
.IX Subsection "tool_autosplit"
Defines a simple perl call that runs autosplit. May be deprecated by
.Sh "File::Spec wrappers"
.IX Subsection "File::Spec wrappers"
ExtUtils::MM_Any is a subclass of File::Spec. The methods noted here
File::Spec <= 0.83 has a bug where the file part of catfile is not
canonicalized. This override fixes that bug.
Methods I can't really figure out where they should go yet.
.IX Subsection "find_tests"
\& my $test = $mm->find_tests;
Returns a string suitable for feeding to the shell to return all
.IX Subsection "extra_clean_files"
\& my @files_to_clean = $MM->extra_clean_files;
Returns a list of \s-1OS\s0 specific files to be removed in the clean target in
addition to the usual set.
.IX Subsection "installvars"
\& my @installvars = $mm->installvars;
A list of all the INSTALL* variables without the \s-1INSTALL\s0 prefix. Useful
for iteration or building related variable sets.
\& my $wanted = $self->libscan($path);
Takes a path to a file or dir and returns an empty string if we don't
want to include this file in the library. Otherwise it returns the
the \f(CW$path\fR unchanged.
Mainly used to exclude version control administrative directories from
.IX Subsection "platform_constants"
\& my $make_frag = $mm->platform_constants
Returns a make fragment defining all the macros initialized in
\&\fIinit_platform()\fR rather than put them in \fIconstants()\fR.
Michael G Schwern <schwern@pobox.com> and the denizens of
makemaker@perl.org with code from ExtUtils::MM_Unix and
projects / OpenSPARC-T2-SAM / blob