4.1.4 Checking for a Library

The check_lib method can be used to check for the presence of a library.

This method takes the name of the library to check for as the first argument, and take an optional Hash of arguments as the second argument.

Example calls:

configure do
  check_lib "kpty", fail: false, set_define: "HAVE_LIBKPTY"
  check_lib "GL"
end

4.1.4.1 Options

4.1.4.1.1 :check_libpath

Optionally specifies an array of paths to look for the library in.

4.1.4.1.2 :fail

If the :fail option is set to false, then the absence of the library will not result in the configure option failing. The :fail option defaults to true if the :set_define option is not defined, and defaults to false if the :set_define option is defined.

4.1.4.1.3 :set_define

If set, a build define of the specified String will be added to the CPPDEFINES construction variable array if the requested library is found.

4.1.4.1.4 :use

If not set, the library will be used by default in all Environment objects. If set, the library will only be used in Environment objects that have a matching :use flag set.