快速指南：pkg-config 的原理和使用方法

安装完 OpenCV-4.5.1，打算编译一个程序看看，你知道需要连接多少可静态库吗？用下面命令可以查看：

$ pkg-config --libs opencv4
-L/usr/local/lib -lopencv_highgui -lopencv_ml -lopencv_objdetect -lopencv_photo -lopencv_stitching -lopencv_video -lopencv_calib3d -lopencv_features2d -lopencv_dnn -lopencv_flann -lopencv_videoio -lopencv_imgcodecs -lopencv_imgproc -lopencv_core

1. pkg-config 用于简化 gcc/g++ 编译命令

利用这个特点，可以大大简化程序编译命令的输入。例如，我写了一个 OpenCV 的演示程序，输入下面的命令，即可完成编译：

$ g++ demo.cpp `pkg-config --cflags --libs opencv4` -o demo

上面的编译命令中，`pkg-config --cflags --libs gtk±2.0` 的作用就如前面所说的，把 opencv4 的头文件路径和库文件列出来，让编译去获取。–cflags 和 --libs 分别指定头文件和库文件。

注意：命令中的 ` 不是引号，而是数字 1 左边那个键位的那个符号。

其实，pkg-config同其他命令一样，有很多选项，不过我们一般只会用到–libs和–cflags选项。更多的选项可以在这里查看。

2. 配置 pkg-config 环境变量

2.1 *.pc 文件格式

像 OpenCV 这样庞大的代码包，它的路径信息写在 opencv4.pc 这个文件中。我搜了一下，这份文件保存在 /usr/local/lib/pkgconfig 路径下，内容如下：

# Package Information for pkg-config

prefix=/usr/local
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include/opencv4

Name: OpenCV
Description: Open Source Computer Vision Library
Version: 4.5.1
Libs: -L${exec_prefix}/lib -lopencv_highgui -lopencv_ml -lopencv_objdetect -lopencv_photo -lopencv_stitching -lopencv_video -lopencv_calib3d -lopencv_features2d -lopencv_dnn -lopencv_flann -lopencv_videoio -lopencv_imgcodecs -lopencv_imgproc -lopencv_core
Libs.private: -ldl -lm -lpthread -lrt
Cflags: -I${includedir}

仔细看一下发现这份文件实际上定义了：

Cflags：-I/usr/local/include/opencv4
Libs：-L/usr/local/lib -lopencv_highgui -lopencv_ml -lopencv_objdetect -lopencv_photo -lopencv_stitching -lopencv_video -lopencv_calib3d -lopencv_features2d -lopencv_dnn -lopencv_flann -lopencv_videoio -lopencv_imgcodecs -lopencv_imgproc -lopencv_core

pkg-config命令通过查询 *.pc 文件而知道这些的。我们所需要做的是，写一个属于自己的库的.pc文件。

2.2 pkg-config 的 *.pc 文件的搜索路径

2.2.1 pkg-config 默认搜索路径

那么 pkg-config 如何知道到 /usr/local/lib/pkgconfig 下去找 opencv4.pc 这份文件呢？我们用下面的命令查询一下 pkg-config 默认的搜索路径：

$ pkg-config --variable pc_path pkg-config
/usr/local/lib/x86_64-linux-gnu/pkgconfig:/usr/local/lib/pkgconfig:/usr/local/share/pkgconfig:/usr/lib/x86_64-linux-gnu/pkgconfig:/usr/lib/pkgconfig:/usr/share/pkgconfig

把搜索路径展开看看：

/usr/local/lib/x86_64-linux-gnu/pkgconfig
/usr/local/lib/pkgconfig
/usr/local/share/pkgconfig
/usr/lib/x86_64-linux-gnu/pkgconfig
/usr/lib/pkgconfig
/usr/share/pkgconfig

2.2.2 加入自己的搜索路径：环境变量PKG_CONFIG_PATH

如果想加入自己的搜索路径怎么办？可以设置环境变量 PKG_CONFIG_PATH。它是一个环境变量，指定pkg-config将在其中搜索其.pc文件的其他路径。

此变量用于扩展pkg-config的默认搜索路径。在典型的Unix系统上，它将在目录/usr/lib/pkgconfig和中搜索/usr/share/pkgconfig。这通常将涵盖系统安装的模块。但是，某些本地模块可能以不同的前缀安装，例如/usr/local。在这种情况下，必须在搜索路径前添加前缀，以便pkg-config可以找到.pc文件。

这个环境变量在那里定义呢？一共四个可能的位置：

配置文件	用途
~/.profile	当前用户登录进系统的时候执行的配置文件(有些系统中的名字可能是~/.bash_profile)
~/.bashrc	当前用户运行 bash 时候执行的配置文件
/etc/profile	全部用户登录进系统的时候执行的配置文件
/etc/bash.bashrc	全部用户运行 bash 时候执行的配置文件

我自己机器上保存在 /etc/profile 文件里面了，参见下面的代码：

... ...
PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib/pkgconfig
export PKG_CONFIG_PATH 

2.2.3 PKG_CONFIG_PATH和PKG_CONFIG_LIBDIR

如果想覆盖掉 PKG_CONFIG_PATH 的内容，据说可以设置另一个环境变量 PKG_CONFIG_LIBDIR，它的优先级较高，一旦设定便可以取代 PKG_CONFIG_PATH。这个我没作测试，估计这辈子都用不到它。

总起来我觉得 PKG_CONFIG_PATH 只能用来添加新的搜索路径，系统默认的路径保存在那里我没找到资料，如果那位朋友知晓请告知。

3. *.pc 文件编写格式

如何写自己的.pc文件？只需写 5 个内容即可：Name、Description、Version、Cflags、Libs。参见 opencv4.pc:

# Package Information for pkg-config

prefix=/usr/local
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include/opencv4

Name: OpenCV
Description: Open Source Computer Vision Library
Version: 4.5.1
Libs: -L${exec_prefix}/lib -lopencv_highgui -lopencv_ml -lopencv_objdetect -lopencv_photo -lopencv_stitching -lopencv_video -lopencv_calib3d -lopencv_features2d -lopencv_dnn -lopencv_flann -lopencv_videoio -lopencv_imgcodecs -lopencv_imgproc -lopencv_core
Libs.private: -ldl -lm -lpthread -lrt
Cflags: -I${includedir}

---

1. pkg-config的一些用法
2. 查看 pkg-config默认的搜索路径