NAME
Dist::Zilla::Plugin::CheckLib - Require that your distribution has a particular library available
VERSION
version 0.007
SYNOPSIS
In your dist.ini:
[CheckLib]
lib = jpeg
header = jpeglib.hDESCRIPTION
This is a Dist::Zilla plugin that modifies the Makefile.PL or Build.PL in your distribution to contain a Devel::CheckLib call, that asserts that a particular library and/or header is available. If it is not available, the program exits with a status of zero, which on a CPAN Testers machine will result in a NA result.
CONFIGURATION OPTIONS
All options are as documented in Devel::CheckLib:
lib
A string with the name of a single library name. Can be used more than once. Depending on the compiler found, library names will be fed to the compiler either as -l arguments or as .lib file names. (e.g. -ljpeg or jpeg.lib)
libpath
Additional path to search for libraries. Can be used more than once.
LIBS
A ExtUtils::MakeMaker-style space-separated list of libraries (each preceded by -l) and directories (preceded by -L).
debug
If true, emit information during processing that can be used for debugging. Note: as this is an arbitrary string that is inserted directly into Makefile.PL or Build.PL, this can be any arbitrary expression, for example:
[CheckLib]
debug = $ENV{AUTOMATED_TESTING} || $^O eq 'MSWin32'header
The name of a single header file name. Can be used more than once.
incpath
An additional path to search for headers. Can be used more than once.
INC
A ExtUtils::MakeMaker-style space-separated list of incpaths, each preceded by -I.
SEE ALSO
SUPPORT
Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-Plugin-CheckLib@rt.cpan.org).
There is also a mailing list available for users of this distribution, at http://dzil.org/#mailing-list.
There is also an irc channel available for users of this distribution, at #distzilla on irc.perl.org.
I am also usually active on irc, as 'ether' at irc.perl.org.
AUTHOR
Karen Etheridge <ether@cpan.org>
COPYRIGHT AND LICENCE
This software is copyright (c) 2014 by Karen Etheridge.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.