Pkg-config
Original author(s) | James Henstridge; rewritten by Havoc Pennington |
---|---|
Developer(s) | Tollef Fog Heen / freedesktop.org |
Initial release | 2000; 24 years ago (2000) or earlier |
Stable release | 0.29.2 / March 20, 2017; 7 years ago (2017-03-20) |
Repository | gitlab |
Written in | C |
Operating system | Unix-like |
Type | Programming tool |
License | GNU GPL |
Website | www |
pkg-config is a computer program that defines and supports a unified interface for querying installed libraries for the purpose of compiling software that depends on them. It allows programmers and installation scripts to work without explicit knowledge of detailed library path information. pkg-config was originally designed for Linux, but it is now also available for BSD, Microsoft Windows, macOS, and Solaris.
It outputs various information about installed libraries. This information may include:
- Parameters (flags) for C or C++ compiler
- Parameters (flags) for linker
- Version of the package in question
The first implementation was written in shell.[1] Later, it was rewritten in C using the GLib library.[2]
Synopsis
When a library is installed (automatically through the use of an RPM, deb, or other binary packaging system or by compiling from the source), a .pc
file should be included and placed into a directory with other .pc
files (the exact directory is dependent upon the system and outlined in the pkg-config man page). This file has several entries.
These entries typically contain a list of dependent libraries that programs using the package also need to compile. Entries also typically include the location of header files, version information and a description.
Here is an example .pc
file for libpng:
prefix=/usr/local exec_prefix=${prefix} libdir=${exec_prefix}/lib includedir=${exec_prefix}/include Name: libpng Description: Loads and saves PNG files Version: 1.2.8 Libs: -L${libdir} -lpng12 -lz Cflags: -I${includedir}/libpng12
This file demonstrates how libpng
informs that its libraries can be found in /usr/local/lib
and its headers in /usr/local/include
, that the library name is libpng
, and that the version is 1.2.8. It also gives the additional linker flags that are needed to compile code that uses this library.
Here is an example of usage of pkg-config while compiling:
$ gcc -o test test.c $(pkg-config --libs --cflags libpng)
pkg-config can be used by build automation software such as CMake.
Alternative implementations
- pkgconf – Implementation of pkg-config without depending on GLib[5]
- u-config – Minimal implementation with first-class Windows support
- PkgConfig – Pure-Perl Core-Only replacement for pkg-config
- ruby-gnome/pkg-config – Implementation of pkg-config in Ruby
References
- ^ Havoc Pennington (4 June 2000). "Re: the *-config scripts". Retrieved 2020-01-22.
- ^ Havoc Pennington (23 July 2000). "pkg-config". Retrieved 2020-01-22.
- ^ a b c d Found on spread of pkgconf but not spread of pkg-config on repology
- ^ a b c d Replacing pkg-config with pkgconf on [email protected]
- ^ default, instead of pkg-config, on Alpine Linux,[3] Arch Linux,[4] CentOS 8+,[3] Fedora,[4] FreeBSD,[4] Mageia 7+,[3] Manjaro[3] and NetBSD[4]