PKGCONF(1)

📦 version 1.6.3, in opensuse-leap 16.0

✨ PKGCONF(1) ✨

okay so bestie, welcome to pkgconf(1) — it's a General Commands Manual page and honestly it's giving "the tool that makes your build system behave." Let's get into it 💅

🌸 NAME 🌸

pkgconf — a system for configuring build dependency information 🎀

🦋 SYNOPSIS 🦋

pkgconf [options] [list of modules]

literally that's it. options, then some modules, go off 👑

💖 DESCRIPTION 💖

pkgconf is a program which helps to configure compiler and linker flags for development libraries. no cap, that's the whole vibe. it lets build systems detect other dependencies and use them with the system toolchain. it's the matchmaker between your project and everything it needs 🫶

🌈 GENERAL OPTIONS 🌈

  • --version — Display the supported pkg-config version and exit. slay, you get a version number and then it dips ✨
  • --atleast-pkgconfig-version=VERSION — Exit with error if we do not support the requested pkg-config version. like a vibe check on the version, and if it flops you get an error 😭
  • --errors-to-stdout — Print all errors on the main output stream instead of the error output stream. errors but make them main-character 💅
  • --silence-errors — Do not display any errors at all. nothing to see here 🙈
  • --list-all — Walk all directories listed in the PKG_CONFIG_PATH environmental variable and display information on packages which have registered information there. a lil tour of everything registered 👑
  • --simulate — Simulates resolving a dependency graph based on the requested modules on the command line. Dumps a series of trees denoting pkgconf's resolver state. it's giving "let me show you my thought process" 🧚
  • --no-cache — Skip caching packages when they are loaded into the internal resolver. This may result in an alternate dependency graph being computed. different graph, no cap 🔥
  • --ignore-conflicts — Ignore ‘Conflicts’ rules in modules. drama? never heard of her 💀
  • --env-only — Learn about pkgconf's configuration strictly from environmental variables. environment variables only, periodt 🌱
  • --maximum-traverse-depth=DEPTH — Impose a limit on the allowed depth in the dependency graph. For example, a depth of 2 will restrict the resolver from acting on child dependencies of modules added to the resolver's solution. set a boundary, we love boundaries 🎀
  • --static — Compute a deeper dependency graph and use compiler/linker flags intended for static linking. deeper graph, static-link flags 🔥
  • --pure — Treats the computed dependency graph as if it were pure. This is mainly intended for use with the --static flag. pure vibes, mostly pairs with --static ✨
  • --no-provides — Ignore ‘Provides’ rules in modules when resolving dependencies. provides? not today 🌸
  • --with-path=PATH — Adds a new module search path to pkgconf's dependency resolver. Paths added in this way are given preference before other paths. your path goes to the front of the line 👑
  • --define-prefix — Attempts to determine the prefix variable to use for CFLAGS and LIBS entry relocations. This is mainly useful for platforms where framework SDKs are relocatable, such as Windows. relocatable SDKs say hi 🪟
  • --dont-define-prefix — Disables the ‘define-prefix’ feature. not today, prefix 🙅
  • --prefix-variable=VARIABLE — Sets the ‘prefix’ variable used by the ‘define-prefix’ feature. you pick the variable name 💜
  • --relocate=PATH — Relocates a path using the pkgconf_path_relocate API. This is mainly used by the testsuite to provide a guaranteed interface to the system's path relocation backend. test-suite core fr 🧪
  • --dont-relocate-paths — Disables the path relocation feature. relocation? cancelled 😌

🎀 MODULE-SPECIFIC OPTIONS 🎀

  • --atleast-version=VERSION — Exit with error if a module's version is less than the specified version. minimum version or it's a no 💅
  • --exact-version=VERSION — Exit with error if a module's version is not exactly the specified version. exact match only, we're picky ⭐
  • --max-version=VERSION — Exit with error if a module's version is greater than the specified version. ceiling version, don't exceed it 🚫
  • --exists — Exit with a non-zero result if the dependency resolver was unable to find all of the requested modules. basically "does this even exist bestie" 🔍
  • --uninstalled — Exit with a non-zero result if the dependency resolver uses an ‘uninstalled’ module as part of it's solution. spots the uninstalled ones 👀
  • --no-uninstalled — Forbids the dependency resolver from considering 'uninstalled' modules as part of a solution. uninstalled modules are BANNED from the solution 🙈

🦋 QUERY-SPECIFIC OPTIONS 🦋

  • --cflags, --cflags-only-I, --cflags-only-other — Display either all CFLAGS, only -I CFLAGS or only CFLAGS that are not -I. pick your cflags flavor 🌈
  • --libs, --libs-only-L, --libs-only-l, --libs-only-other — Display either all linker flags, only -L linker flags, only -l linker flags or only linker flags that are not -L or -l. all the linker flag combos you could ever want 🔥
  • --keep-system-cflags, --keep-system-libs — Keep CFLAGS or linker flag fragments that would be filtered due to being included by default in the compiler. normally they'd get filtered out, but you said keep 💖
  • --define-variable=VARNAME=VALUE — Define VARNAME as VALUE. Variables are used in query output, and some modules' results may change based on the presence of a variable definition. set it and watch the output shift 👑
  • --print-variables — Print all seen variables for a module to the output channel. every variable we've clocked 👁️
  • --print-provides — Print all relevant ‘Provides’ entries for a module to the output channel. the provides, served fresh ✨
  • --variable=VARNAME — Print the value of VARNAME. just the value pls 🎀
  • --print-requires, --print-requires-private — Print the modules included in either the Requires field or the Requires.private field. depends-on energy 🫶
  • --digraph — Dump the dependency resolver's solution as a graphviz ‘dot’ file. This can be used with graphviz to visualize module interdependencies. literally a whole aesthetic diagram of your deps 🧚
  • --path — Display the filenames of the ‘.pc’ files used by the dependency resolver for a given dependency set. show me the receipts (the .pc files) 📁
  • --env=VARNAME — Print the requested values as variable declarations in a similar format as the env(1) command. env(1)-core 💅
  • --fragment-filter=TYPES — Filter the fragment lists for the specified types. filtering, but make it fragments 🌸
  • --modversion — Print the version of the queried module. version reveal ⭐

💜 ENVIRONMENT 💜

  • PKG_CONFIG_PATH — List of secondary directories where ‘.pc’ files are looked up. the backup squad 🎀
  • PKG_CONFIG_LIBDIR — List of primary directories where ‘.pc’ files are looked up. the main characters 👑
  • PKG_CONFIG_SYSROOT_DIR — ‘sysroot’ directory, will be prepended to every path defined in PKG_CONFIG_PATH. Useful for cross compilation. cross-compilation bestie 🌉
  • PKG_CONFIG_TOP_BUILD_DIR — Provides an alternative setting for the ‘pc_top_builddir’ global variable. swaps out the global 🦋
  • PKG_CONFIG_PURE_DEPGRAPH — If set, enables the same behaviour as the --pure flag. same energy as --pure ✨
  • PKG_CONFIG_SYSTEM_INCLUDE_PATH — List of paths that are considered system include paths by the toolchain. This is a pkgconf-specific extension. pkgconf-only, iykyk 🔥
  • PKG_CONFIG_SYSTEM_LIBRARY_PATH — List of paths that are considered system library paths by the toolchain. This is a pkgconf-specific extension. also pkgconf-specific 💅
  • PKG_CONFIG_DISABLE_UNINSTALLED — If set, enables the same behaviour as the --no-uninstalled flag. same energy as --no-uninstalled 🙅
  • PKG_CONFIG_LOG — ‘logfile’ which is used for dumping audit information concerning installed module versions. the audit trail, the receipts 📓
  • PKG_CONFIG_DEBUG_SPEW — If set, enables additional debug logging. The format of the debug log messages is implementation-specific. debug spew, format varies 💀
  • PKG_CONFIG_DONT_RELOCATE_PATHS — If set, disables the path relocation feature. relocation off 😌

🌸 EXAMPLES 🌸

Displaying the CFLAGS of a package:

$ pkgconf --cflags foo
-fPIC -I/usr/include/foo

look at those flags go 💅✨

⭐ SEE ALSO ⭐

pc(5), pkg.m4(7)

go read those too bestie, they're part of the lore 📚

and that's the page! brought to you by the Debian crew, dated November 15, 2016 — mwah, ily, go configure those build deps 💖🎀🦋

📦 where this page comes from