docs: sort pkgconf(1) options

Andrea Pappacoda 2022-08-21 17:59:36 +02:00
parent 569f997fed
commit bea21d5f55
Signed by: tachi
GPG Key ID: 4A9208A2455077A7
2 changed files with 123 additions and 123 deletions

View File

@ -1,10 +1,10 @@
A. Wilcox <AWilcox@Wilcox-Tech.com>
Alexander Tsoy <alexander@tsoy.me>
Alexpux <alexey.pawlow@gmail.com>
Alon Bar-Lev <alon.barlev@gmail.com>
Alyx <alyx@malkier.net>
Andrea Pappacoda <andrea@pappacoda.it>
Ariadne Conill <ariadne@dereferenced.org>
A. Wilcox <AWilcox@Wilcox-Tech.com>
Baptiste Daroussin <bapt@FreeBSD.org>
Baptiste Daroussin <bapt@gandi.net>
Bryan Drewery <bryan@shatow.net>
@ -16,13 +16,14 @@ David Michael <fedora.dm0@gmail.com>
Emil Renner Berthing <esmil@mailme.dk>
Fabian Groffen <grobian@gentoo.org>
Graham Ollis <plicease@cpan.org>
✈ Graham ✈ <plicease@cpan.org>
Gregor Richards <Richards@codu.org>
Ignacio Casal Quinteiro <qignacio@amazon.com>
Igor Gnatenko <ignatenko@redhat.com>
Issam Maghni <concatime@users.noreply.github.com>
JD Horelick <jdhore1@gmail.com>
Jason Dusek <jason.dusek@gmail.com>
Javier Viguera <javier.viguera@digi.com>
JD Horelick <jdhore1@gmail.com>
Jean-Sébastien Pédron <dumbbell@FreeBSD.org>
John Hein <jhgit@users.github.com>
Jussi Pakkanen <jpakkane@gmail.com>
@ -32,11 +33,10 @@ Marcin Wojdyr <wojdyr@gmail.com>
Maxin B. John <maxinbjohn@users.noreply.github.com>
Michał Górny <mgorny@gentoo.org>
Mike Frysinger <vapier@gentoo.org>
orbea <orbea@fredslev.dk>
Seungha Yang <seungha.yang@navercorp.com>
TingPing <tingping@tingping.se>
Tobias Kortkamp <t6@users.noreply.github.com>
Tony Theodore <tonyt@logyst.com>
Volker Braun <vbraun.name@gmail.com>
Yu Kobayashi <yukoba@accelart.jp>
orbea <orbea@fredslev.dk>
✈ Graham ✈ <plicease@cpan.org>

View File

@ -19,63 +19,9 @@ and use them with the system toolchain.
# GENERAL OPTIONS
*--version*
Display the supported pkg-config version and exit.
*--atleast-pkgconfig-version*=_VERSION_
Exit with error if we do not support the requested pkg-config version.
*--errors-to-stdout*
Print all errors on the main output stream instead of the error output
stream.
*--silence-errors*
Do not display any errors at all.
*--list-all*
Walk all directories listed in the _PKG_CONFIG_PATH_ environmental variable
and display information on packages which have registered information there.
*--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.
*--no-cache*
Skip caching packages when they are loaded into the internal resolver.
This may result in an alternate dependency graph being computed.
*--ignore-conflicts*
Ignore Conflicts rules in modules.
*--env-only*
Learn about pkgconf's configuration strictly from environmental variables.
*--validate* _package ..._
Validate specific .pc files for correctness.
*--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.
*--static*
Compute a deeper dependency graph and use compiler/linker flags intended
for static linking.
*--shared*
Compute a simple dependency graph that is only suitable for shared linking.
*--pure*
Treats the computed dependency graph as if it were pure. This is mainly
intended for use with the *--static* flag.
*--no-provides*
Ignore Provides rules in modules when resolving dependencies.
*--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.
*--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
@ -84,16 +30,70 @@ and use them with the system toolchain.
*--dont-define-prefix*
Disables the define-prefix feature.
*--dont-relocate-paths*
Disables the path relocation feature.
*--env-only*
Learn about pkgconf's configuration strictly from environmental variables.
*--errors-to-stdout*
Print all errors on the main output stream instead of the error output
stream.
*--ignore-conflicts*
Ignore Conflicts rules in modules.
*--list-all*
Walk all directories listed in the _PKG_CONFIG_PATH_ environmental variable
and display information on packages which have registered information there.
*--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.
*--no-cache*
Skip caching packages when they are loaded into the internal resolver.
This may result in an alternate dependency graph being computed.
*--no-provides*
Ignore Provides rules in modules when resolving dependencies.
*--prefix-variable*=_VARIABLE_
Sets the prefix variable used by the define-prefix feature.
*--pure*
Treats the computed dependency graph as if it were pure. This is mainly
intended for use with the *--static* flag.
*--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.
*--dont-relocate-paths*
Disables the path relocation feature.
*--shared*
Compute a simple dependency graph that is only suitable for shared linking.
*--silence-errors*
Do not display any errors at all.
*--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.
*--static*
Compute a deeper dependency graph and use compiler/linker flags intended
for static linking.
*--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.
*--validate* _package ..._
Validate specific .pc files for correctness.
*--version*
Display the supported pkg-config version and exit.
# MODULE-SPECIFIC OPTIONS
@ -103,61 +103,36 @@ and use them with the system toolchain.
*--exact-version*=_VERSION_
Exit with error if a module's version is not exactly the specified version.
*--max-version*=_VERSION_
Exit with error if a module's version is greater than the specified
version.
*--exists*
Exit with a non-zero result if the dependency resolver was unable to find
all of the requested modules.
*--uninstalled*
Exit with a non-zero result if the dependency resolver uses an
uninstalled module as part of its solution.
*--max-version*=_VERSION_
Exit with error if a module's version is greater than the specified
version.
*--no-uninstalled*
Forbids the dependency resolver from considering 'uninstalled' modules as
part of a solution.
*--uninstalled*
Exit with a non-zero result if the dependency resolver uses an
uninstalled module as part of its 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*.
*--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*.
*--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.
*--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.
*--print-variables*
Print all seen variables for a module to the output channel.
*--print-provides*
Print all relevant Provides entries for a module to the output channel.
*--variable*=_VARNAME_
Print the value of _VARNAME_.
*--print-requires*, *--print-requires-private*
Print the modules included in either the Requires field or the
Requires.private field.
*--digraph*
Dump the dependency resolver's solution as a graphviz dot file. This can
be used with graphviz to visualize module interdependencies.
*--path*
Display the filenames of the .pc files used by the dependency resolver for
a given dependency set.
*--env*=_VARNAME_
Print the requested values as variable declarations in a similar format as
the *env*(1) command.
@ -165,27 +140,74 @@ and use them with the system toolchain.
*--fragment-filter*=_TYPES_
Filter the fragment lists for the specified types.
*--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*.
*--modversion*
Print the version of the queried module.
*--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.
*--path*
Display the filenames of the .pc files used by the dependency resolver for
a given dependency set.
*--print-provides*
Print all relevant Provides entries for a module to the output channel.
*--print-requires*, *--print-requires-private*
Print the modules included in either the Requires field or the
Requires.private field.
*--print-variables*
Print all seen variables for a module to the output channel.
*--variable*=_VARNAME_
Print the value of _VARNAME_.
# ENVIRONMENT
_PKG_CONFIG_PATH_
List of secondary directories where .pc files are looked up.
_DESTDIR_
If set to _PKG_CONFIG_SYSROOT_DIR_, assume that
_PKG_CONFIG_FDO_SYSROOT_RULES_ is set.
_PKG_CONFIG_DEBUG_SPEW_
If set, enables additional debug logging. The format of the debug log
messages is implementation-specific.
_PKG_CONFIG_DISABLE_UNINSTALLED_
If set, enables the same behaviour as the *--no-uninstalled* flag.
_PKG_CONFIG_DONT_RELOCATE_PATHS_
If set, disables the path relocation feature.
_PKG_CONFIG_FDO_SYSROOT_RULES_
If set, follow the sysroot prefixing rules that freedesktop.org pkg-config
uses.
_PKG_CONFIG_LIBDIR_
List of primary directories where .pc files are looked up.
_PKG_CONFIG_SYSROOT_DIR_
sysroot directory, will be prepended to every path defined in
PKG_CONFIG_PATH. Useful for cross compilation.
_PKG_CONFIG_LOG_
logfile which is used for dumping audit information concerning installed
module versions.
_PKG_CONFIG_TOP_BUILD_DIR_
Provides an alternative setting for the pc_top_builddir global variable.
_PKG_CONFIG_MSVC_SYNTAX_
If set, uses MSVC syntax for fragments.
_PKG_CONFIG_PATH_
List of secondary directories where .pc files are looked up.
_PKG_CONFIG_PURE_DEPGRAPH_
If set, enables the same behaviour as the *--pure* flag.
_PKG_CONFIG_SYSROOT_DIR_
sysroot directory, will be prepended to every path defined in
PKG_CONFIG_PATH. Useful for cross compilation.
_PKG_CONFIG_SYSTEM_INCLUDE_PATH_
List of paths that are considered system include paths by the toolchain.
This is a pkgconf-specific extension.
@ -194,30 +216,8 @@ _PKG_CONFIG_SYSTEM_LIBRARY_PATH_
List of paths that are considered system library paths by the toolchain.
This is a pkgconf-specific extension.
_PKG_CONFIG_DISABLE_UNINSTALLED_
If set, enables the same behaviour as the *--no-uninstalled* flag.
_PKG_CONFIG_LOG_
logfile which is used for dumping audit information concerning installed
module versions.
_PKG_CONFIG_DEBUG_SPEW_
If set, enables additional debug logging. The format of the debug log
messages is implementation-specific.
_PKG_CONFIG_DONT_RELOCATE_PATHS_
If set, disables the path relocation feature.
_PKG_CONFIG_MSVC_SYNTAX_
If set, uses MSVC syntax for fragments.
_PKG_CONFIG_FDO_SYSROOT_RULES_
If set, follow the sysroot prefixing rules that freedesktop.org pkg-config
uses.
_DESTDIR_
If set to _PKG_CONFIG_SYSROOT_DIR_, assume that
_PKG_CONFIG_FDO_SYSROOT_RULES_ is set.
_PKG_CONFIG_TOP_BUILD_DIR_
Provides an alternative setting for the pc_top_builddir global variable.
# EXAMPLES