NAME

Alien::LZ4 - Find or build LZ4

SYNOPSIS

From ExtUtils::MakeMaker:

 use ExtUtils::MakeMaker;
 use Alien::Base::Wrapper ();

 WriteMakefile(
   Alien::Base::Wrapper->new('Alien::LZ4')->mm_args2(
     NAME => 'FOO::XS',
     ...
   ),
 );

From Module::Build:

 use Module::Build;
 use Alien::Base::Wrapper qw( Alien::LZ4 !export );
 use Alien::LZ4;

 my $build = Module::Build->new(
   ...
   configure_requires => {
     'Alien::Base::Wrapper' => '0',
     'Alien::LZ4' => '0',
     ...
   },
   Alien::Base::Wrapper->mb_args,
   ...
 );

 $build->create_build_script;

From Inline::C / Inline::CPP script:

 use Inline 0.56 with => 'Alien::LZ4';

From Dist::Zilla

 [@Filter]
 -bundle = @Basic
 -remove = MakeMaker

 [Prereqs / ConfigureRequires]
 Alien::LZ4 = 0

 [MakeMaker::Awesome]
 header = use Alien::Base::Wrapper qw( Alien::LZ4 !export );
 WriteMakefile_arg = Alien::Base::Wrapper->mm_args

From FFI::Platypus:

 use FFI::Platypus;
 use Alien::LZ4;

 my $ffi = FFI::Platypus->new(
   lib => [ Alien::LZ4->dynamic_libs ],
 );

Command line tool:

 use Alien::LZ4;
 use Env qw( @PATH );

 unshift @PATH, Alien::LZ4->bin_dir;

DESCRIPTION

This distribution provides LZ4 so that it can be used by other Perl distributions that are on CPAN. It does this by first trying to detect an existing install of LZ4 on your system. If found it will use that. If it cannot be found, the source code will be downloaded from the internet and it will be installed in a private share location for the use of other modules.

SEE ALSO

LZ4

The LZ4 home page.

Alien

Documentation on the Alien concept itself.

Alien::Base

The base class for this Alien.

Alien::Build::Manual::AlienUser

Detailed manual for users of Alien classes.