diff options
author | Dan Nicholson <dbn.lists@gmail.com> | 2013-04-18 07:23:06 -0700 |
---|---|---|
committer | Dan Nicholson <dbn.lists@gmail.com> | 2013-05-17 05:13:15 -0700 |
commit | 925119ce512a05f4c64049526aa19b1296b55e3e (patch) | |
tree | a487ef5776dccf6e6aed409b04b495f31da4b13e | |
parent | 43c1e0e4afa341ea7e4710de4dd81b0074948e68 (diff) | |
download | pkg-config-925119ce512a05f4c64049526aa19b1296b55e3e.tar.gz |
Document all pkg-config derived metadata variables
The derived variables pcfiledir, pc_top_builddir and pc_sysrootdir were
lacking in documentation. Rework the "QUERYING PKG-CONFIG'S DEFAULTS"
section to describe these and pc_path.
The example of using "pkg-config --modversion pkg-config" was removed
since it's superfluous to "pkg-config --version".
Freedesktop #62018 (https://bugs.freedesktop.org/show_bug.cgi?id=62018)
-rw-r--r-- | pkg-config.1 | 41 |
1 files changed, 36 insertions, 5 deletions
diff --git a/pkg-config.1 b/pkg-config.1 index 3616bcd..ccbfa5c 100644 --- a/pkg-config.1 +++ b/pkg-config.1 @@ -311,17 +311,48 @@ Replaces the default search directory, usually .IR /usr/lib/pkgconfig : /usr/share/pkgconfig . .\" -.SH QUERYING PKG-CONFIG'S DEFAULTS +.SH PKG-CONFIG DERIVED VARIABLES .I pkg-config -can be used to query itself for the default search path, version number -and other information, for instance using: +sets a few metadata variables that can be used in .pc files or queried +at runtime. +.TP +.I pc_path +The default search path used by +.I pkg-config +when searching for .pc files. This can be used in a query for the +.I pkg-config +module itself itself: .nf $ pkg-config --variable pc_path pkg-config .fi -or +.TP +.I pcfiledir +The installed location of the .pc file. This can be used to query the +location of the .pc file for a particular module, but it can also be +used to make .pc files relocatable. For instance: .nf - $ pkg-config --modversion pkg-config +prefix=${pcfiledir}/../.. +exec_prefix=${prefix} +libdir=${exec_prefix}/lib +includedir=${prefix}/include .fi +.TP +.I pc_sysrootdir +The sysroot directory set by the user. When the sysroot directory has +not been set, this value is +.IR / . +See the +.I PKG_CONFIG_SYSROOT_DIR +environment variable for more details. +.TP +.I pc_top_builddir +Location of the user's top build directory when calling +.IR pkg-config. +This is useful to dynamically set paths in uninstalled .pc files. See +the +.I PKG_CONFIG_TOP_BUILD_DIR +environment variable for more details. +.\" .SH WINDOWS SPECIALITIES The .I pkg-config |