1Module::Install::CheckLUisbe(r3)Contributed Perl DocumenMtoadtuiloen::Install::CheckLib(3)
2
3
4

NAME

6       Module::Install::CheckLib - A Module::Install extension to check that a
7       library is available
8

SYNOPSIS

10         # In Makefile.PL
11
12         use inc::Module::Install;
13         checklibs lib => 'jpeg', header => 'jpeglib.h';
14
15       The Makefile.PL will exit unless library or header is found.
16

DESCRIPTION

18       Module::Install::CheckLib is a Module::Install extension that
19       integrates Devel::CheckLib so that CPAN authors may stipulate which
20       particular C library and its headers they want available and to exit
21       the "Makefile.PL" gracefully if they aren't.
22
23       The author specifies which C libraries, etc, they want available.
24       Devel::CheckLib is copied to the "inc/" directory along with the
25       Module::Install files.
26
27       On the module user side, the bundled "inc/" Devel::CheckLib determines
28       whether the current environment is supported or not and will exit
29       accordingly.
30

COMMANDS

32       This plugin adds the following Module::Install command:
33
34       "checklibs"
35           Requires a list of parameters. These are passed directly to
36           Devel::CheckLib "check_lib_or_exit" function.  Please consult the
37           documentation for Devel::CheckLib for more details on what these
38           parameters are.
39
40           This is generally the function one should use in Makefile.PL, as it
41           exits gracefully and plays nice with CPAN Testers.
42
43       "assertlibs"
44           The same as "checklibs" but uses Devel::CheckLib "assert_lib"
45           instead. "assert_lib" dies instead of exiting gracefully. It is
46           provided for completeness, please use "checklibs".
47
48       By default, the module skips calls to Devel::CheckLibs subroutines when
49       called from the author side. The extra option "run_checks_as_author"
50       can be given to both "checklibs" and "assertlibs" to enable those
51       checks even in author mode.
52
53       Example:
54
55         checklibs lib => libfoo, run_checks_as_author => 1;
56

AUTHOR

58       Chris "BinGOs" Williams
59
60       Based on use-devel-checklib by David Cantrell
61

LICENSE

63       Copyright © Chris Williams and David Cantrell
64
65       This module may be used, modified, and distributed under the same terms
66       as Perl itself. Please see the license that came with your Perl
67       distribution for details.
68

SEE ALSO

70       Module::Install
71
72       Devel::CheckLib
73
74
75
76perl v5.36.0                      2023-01-20      Module::Install::CheckLib(3)
Impressum