Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Alien::Build::MM (3)

Name

Alien::Build::MM - Alien::Build installer code for ExtUtils::MakeMaker

Synopsis

In your "Makefile.PL":

use ExtUtils::MakeMaker;
use Alien::Build::MM;

my $abmm = Alien::Build::MM->new;

WriteMakefile($abmm->mm_args(
ABSTRACT     => 'Discover or download and install libfoo',
DISTNAME     => 'Alien-Libfoo',
NAME         => 'Alien::Libfoo',
VERSION_FROM => 'lib/Alien/Libfoo.pm',
...
));

sub MY::postamble {
$abmm->mm_postamble(@_);
}

sub MY::install {
$abmm->mm_install(@_);
}

In your "lib/Alien/Libfoo.pm":

package Alien::Libfoo;
use base qw( Alien::Base );
1;

In your alienfile (needs to be named "alienfile" and should be in the
root of your dist):

use alienfile;

plugin 'PkgConfig' => 'libfoo';

share {
start_url 'http://libfoo.org';
...
};

Description

User Contributed Perl Documentation                        Alien::Build::MM(3)



NAME
       Alien::Build::MM - Alien::Build installer code for ExtUtils::MakeMaker

VERSION
       version 1.89

SYNOPSIS
       In your "Makefile.PL":

        use ExtUtils::MakeMaker;
        use Alien::Build::MM;

        my $abmm = Alien::Build::MM->new;

        WriteMakefile($abmm->mm_args(
          ABSTRACT     => 'Discover or download and install libfoo',
          DISTNAME     => 'Alien-Libfoo',
          NAME         => 'Alien::Libfoo',
          VERSION_FROM => 'lib/Alien/Libfoo.pm',
          ...
        ));

        sub MY::postamble {
          $abmm->mm_postamble(@_);
        }

        sub MY::install {
          $abmm->mm_install(@_);
        }

       In your "lib/Alien/Libfoo.pm":

        package Alien::Libfoo;
        use base qw( Alien::Base );
        1;

       In your alienfile (needs to be named "alienfile" and should be in the
       root of your dist):

        use alienfile;

        plugin 'PkgConfig' => 'libfoo';

        share {
          start_url 'http://libfoo.org';
          ...
        };

DESCRIPTION
       This class allows you to use Alien::Build and Alien::Base with
       ExtUtils::MakeMaker.  It load the alienfile recipe in the root of your
       Alien dist, updates the prereqs passed into "WriteMakefile" if any are
       specified by your alienfile or its plugins, and adds a postamble to the
       "Makefile" that will download/build/test the alienized package as
       appropriate.

       The alienfile must be named "alienfile".

       If you are using Dist::Zilla to author your Alien dist, you should
       consider using the Dist::Zilla::Plugin::AlienBuild plugin.

       I personally don't recommend it, but if you want to use Module::Build
       instead, you can use Alien::Build::MB.

CONSTRUCTOR
   new
        my $abmm = Alien::Build::MM->new;

       Create a new instance of Alien::Build::MM.

PROPERTIES
   build
        my $build = $abmm->build;

       The Alien::Build instance.

   alienfile_meta
        my $bool = $abmm->alienfile_meta

       Set to a false value, in order to turn off the x_alienfile meta

   clean_install
        my $bool = $abmm->clean_install;

       Set to a true value, in order to clean the share directory prior to
       installing.  If you use this you have to make sure that you install the
       install handler in your "Makefile.PL":

        $abmm = Alien::Build::MM->new(
          clean_install => 1,
        );

        ...

        sub MY::install {
          $abmm->mm_install(@_);
        }

METHODS
   mm_args
        my %args = $abmm->mm_args(%args);

       Adjust the arguments passed into "WriteMakefile" as needed by
       Alien::Build.

   mm_postamble
        my $postamble $abmm->mm_postamble;
        my $postamble $abmm->mm_postamble($mm);

       Returns the postamble for the "Makefile" needed for Alien::Build.  This
       adds the following "make" targets which are normally called when you
       run "make all", but can be run individually if needed for debugging.

       alien_prefix
           Determines the final install prefix ("%{.install.prefix}").

       alien_version
           Determine the perl_module_version
           ("%{.runtime.perl_module_version}")

       alien_download
           Downloads the source from the internet.  Does nothing for a system
           install.

       alien_build
           Build from source (if a share install).  Gather configuration (for
           either system or share install).

       alien_prop, alien_prop_meta, alien_prop_install, alien_prop_runtime
           Prints the meta, install and runtime properties for the Alien.

       alien_realclean, alien_clean
           Removes the alien specific files.  These targets are executed when
           you call the "realclean" and "clean" targets respectively.

       alien_clean_install
           Cleans out the Alien's share directory.  Caution should be used in
           invoking this target directly, as if you do not understand what you
           are doing you are likely to break your already installed Alien.

   mm_install
        sub MY::install {
          $abmm->mm_install(@_);
        }

       EXPERIMENTAL

       Adds an install rule to clean the final install dist directory prior to
       installing.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------------+
       |ATTRIBUTE TYPE |        ATTRIBUTE VALUE         |
       +---------------+--------------------------------+
       |Availability   | library/perl-5/alien-build-532 |
       +---------------+--------------------------------+
       |Stability      | Volatile                       |
       +---------------+--------------------------------+

SEE ALSO
       Alien::Build, Alien::Base, Alien, Dist::Zilla::Plugin::AlienBuild,
       Alien::Build::MB

AUTHOR
       Author: Graham Ollis <plicease@cpan.org>

       Contributors:

       Diab Jerius (DJERIUS)

       Roy Storey (KIWIROY)

       Ilya Pavlov

       David Mertens (run4flat)

       Mark Nunberg (mordy, mnunberg)

       Christian Walde (Mithaldu)

       Brian Wightman (MidLifeXis)

       Zaki Mughal (zmughal)

       mohawk (mohawk2, ETJ)

       Vikas N Kumar (vikasnkumar)

       Flavio Poletti (polettix)

       Salvador Fandio (salva)

       Gianni Ceccarelli (dakkar)

       Pavel Shaydo (zwon, trinitum)

       Kang-min Liu (, gugod)

       Nicholas Shipp (nshp)

       Juan Julin Merelo Guervs (JJ)

       Joel Berger (JBERGER)

       Petr Pisar (ppisar)

       Lance Wicks (LANCEW)

       Ahmad Fatoum (a3f, ATHREEF)

       Jos Joaqun Atria (JJATRIA)

       Duke Leto (LETO)

       Shoichi Kaji (SKAJI)

       Shawn Laffan (SLAFFAN)

       Paul Evans (leonerd, PEVANS)

COPYRIGHT AND LICENSE
       This software is copyright (c) 2011-2019 by Graham Ollis.

       This is free software; you can redistribute it and/or modify it under
       the same terms as the Perl 5 programming language system itself.



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/authors/id/P/PL/PLICEASE/Alien-Build-1.89.tar.gz.

       Further information about this software can be found on the open source
       community website at http://search.cpan.org/dist/Alien-Build/.



perl v5.32.0                      2019-09-25               Alien::Build::MM(3)