AnonymousFox

//usr/share/man/man3/ExtUtils::Command::MM.3pm

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" 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.  \*(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<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    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
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "ExtUtils::Command::MM 3"
.TH ExtUtils::Command::MM 3 "2018-03-19" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
ExtUtils::Command::MM \- Commands for the MM's to use in Makefiles
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  perl "\-MExtUtils::Command::MM" \-e "function" "\-\-" arguments...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fB\s-1FOR\s0 \s-1INTERNAL\s0 \s-1USE\s0 \s-1ONLY\s0!\fR  The interface is not stable.
.PP
ExtUtils::Command::MM encapsulates code which would otherwise have to
be done with large \*(L"one\*(R" liners.
.PP
Any $(\s-1FOO\s0) used in the examples are make variables, not Perl.
.IP "\fBtest_harness\fR" 4
.IX Item "test_harness"
.Vb 1
\&  test_harness($verbose, @test_libs);
.Ve
.Sp
Runs the tests on \f(CW@ARGV\fR via Test::Harness passing through the \f(CW$verbose\fR
flag.  Any \f(CW@test_libs\fR will be unshifted onto the test's \f(CW@INC\fR.
.Sp
\&\f(CW@test_libs\fR are run in alphabetical order.
.IP "\fBpod2man\fR" 4
.IX Item "pod2man"
.Vb 5
\&  pod2man( \*(Aq\-\-option=value\*(Aq,
\&           $podfile1 => $manpage1,
\&           $podfile2 => $manpage2,
\&           ...
\&         );
\&
\&  # or args on @ARGV
.Ve
.Sp
\&\fIpod2man()\fR is a function performing most of the duties of the pod2man
program.  Its arguments are exactly the same as pod2man as of 5.8.0
with the addition of:
.Sp
.Vb 1
\&    \-\-perm_rw   octal permission to set the resulting manpage to
.Ve
.Sp
And the removal of:
.Sp
.Vb 2
\&    \-\-verbose/\-v
\&    \-\-help/\-h
.Ve
.Sp
If no arguments are given to pod2man it will read from \f(CW@ARGV\fR.
.Sp
If Pod::Man is unavailable, this function will warn and return undef.
.IP "\fBwarn_if_old_packlist\fR" 4
.IX Item "warn_if_old_packlist"
.Vb 1
\&  perl "\-MExtUtils::Command::MM" \-e warn_if_old_packlist <somefile>
.Ve
.Sp
Displays a warning that an old packlist file was found.  Reads the
filename from \f(CW@ARGV\fR.
.IP "\fBperllocal_install\fR" 4
.IX Item "perllocal_install"
.Vb 2
\&    perl "\-MExtUtils::Command::MM" \-e perllocal_install
\&        <type> <module name> <key> <value> ...
\&
\&    # VMS only, key|value pairs come on STDIN
\&    perl "\-MExtUtils::Command::MM" \-e perllocal_install
\&        <type> <module name> < <key>|<value> ...
.Ve
.Sp
Prints a fragment of \s-1POD\s0 suitable for appending to perllocal.pod.
Arguments are read from \f(CW@ARGV\fR.
.Sp
\&'type' is the type of what you're installing.  Usually 'Module'.
.Sp
\&'module name' is simply the name of your module.  (Foo::Bar)
.Sp
Key/value pairs are extra information about the module.  Fields include:
.Sp
.Vb 5
\&    installed into      which directory your module was out into
\&    LINKTYPE            dynamic or static linking
\&    VERSION             module version number
\&    EXE_FILES           any executables installed in a space separated
\&                        list
.Ve
.IP "\fBuninstall\fR" 4
.IX Item "uninstall"
.Vb 1
\&    perl "\-MExtUtils::Command::MM" \-e uninstall <packlist>
.Ve
.Sp
A wrapper around \fIExtUtils::Install::uninstall()\fR.  Warns that
uninstallation is deprecated and doesn't actually perform the
uninstallation.
.IP "\fBtest_s\fR" 4
.IX Item "test_s"
.Vb 1
\&   perl "\-MExtUtils::Command::MM" \-e test_s <file>
.Ve
.Sp
Tests if a file exists and is not empty (size > 0).
\&\fIExits\fR with 0 if it does, 1 if it does not.
.IP "\fBcp_nonempty\fR" 4
.IX Item "cp_nonempty"
.Vb 1
\&  perl "\-MExtUtils::Command::MM" \-e cp_nonempty <srcfile> <dstfile> <perm>
.Ve
.Sp
Tests if the source file exists and is not empty (size > 0). If it is not empty
it copies it to the given destination with the given permissions.