[PATCH] pkg-config.1 formatting
Stepan Kasal
skasal at redhat.com
Sat Dec 8 07:55:46 PST 2007
Hello,
I noticed a few nits in pkg-config man page formatting.
1) The descriptions of the m4 macros are misaligned.
2) Two of these descriptions lacked the full stop at the end of the
last sentence.
3) There are many empty lines in the source, which increase some
vertical spacing. (On my system, this is not visible with "man
pkg-config", but it is revealed by "man pkg-config|less". I don't
know why.)
Atached please find a patch which fixes these glitches.
Stepan Kasal
-------------- next part --------------
2007-12-08 Stepan Kasal <skasal at redhat.com>
* pkg-config.1: Fix a few typos--add two omitted .TP tags and
two omitted full stops; and empty lines do influence the
formatting in nroff. :-(
--- pkg-config.1.typo 2007-06-18 23:35:05.000000000 +0200
+++ pkg-config.1 2007-12-08 16:26:48.000000000 +0100
@@ -48,8 +48,6 @@
cc program.c `pkg-config --cflags --libs gnomeui`
.fi
.PP
-
-.PP
\fIpkg-config\fP retrieves information about packages from
special metadata files. These files are named after the package,
with the extension \fI.pc\fP. By default, pkg-config looks in
@@ -57,14 +55,13 @@
look in the colon-separated (on Windows, semicolon-separated)
list of directories specified by the
PKG_CONFIG_PATH environment variable.
-
.PP
The package name specified on the \fIpkg-config\fP command line is
defined to be the name of the metadata file, minus the \fI.pc\fP
extension. If a library can install multiple versions simultaneously,
it must give each version its own name (for example, GTK 1.2 might
have the package name "gtk+" while GTK 2.0 has "gtk+-2.0").
-
+.\"
.SH OPTIONS
The following options are supported:
.TP
@@ -79,7 +76,6 @@
.TP
.I "--help"
Displays a help message and terminates.
-
.TP
.I "--print-errors"
If one or more of the modules on the command line, or their
@@ -91,7 +87,6 @@
alone (to just print errors encountered locating modules on the
command line) or with other options. The PKG_CONFIG_DEBUG_SPEW
environment variable overrides this option.
-
.TP
.I "--silence-errors"
If one or more of the modules on the command line, or their
@@ -103,11 +98,9 @@
option is only useful with options such as "--cflags" or
"--modversion" that print errors by default. The PKG_CONFIG_DEBUG_SPEW
environment variable overrides this option.
-
.TP
.I "--errors-to-stdout"
If printing errors, print them to stdout rather than the default stderr
-
.PP
The following options are used to compile and link programs:
.TP
@@ -134,7 +127,6 @@
the command line. Note that the union of "--libs-only-l" and
"--libs-only-L" may be smaller than "--libs", due to flags such as
-rdynamic.
-
.TP
.I "--variable=VARIABLENAME"
This returns the value of a variable defined in a package's \fI.pc\fP
@@ -154,7 +146,6 @@
--variable=prefix glib-2.0
/foo
.fi
-
.TP
.I "--uninstalled"
Normally if you request the package "foo" and the package
@@ -167,7 +158,6 @@
\fIpkg-config\fP from implicitly choosing "-uninstalled" packages, so
if that variable is set, they will only have been used if you pass
a name like "foo-uninstalled" on the command line explicitly.)
-
.TP
.I "--exists"
.TP
@@ -188,7 +178,6 @@
$ pkg-config --exists 'glib-2.0 >= 1.3.4 libxml = 1.8.3'
.fi
Remember to use \-\-print-errors if you want error messages.
-
.TP
.I "--msvc-syntax"
This option is available only on Windows. It causes \fIpkg-config\fP
@@ -198,27 +187,23 @@
of \fI-lfoo\fP it prints \fIfoo.lib\fP. Note that the --libs output
consists of flags for the linker, and should be placed on the cl
command line after a /link switch.
-
.TP
.I "--dont-define-prefix"
This option is available only on Windows. It prevents \fIpkg-config\fP
from automatically trying to override the value of the variable
"prefix" in each .pc file.
-
.TP
.I "--prefix-variable=PREFIX"
Also this option is available only on Windows. It sets the name of the
variable that \fIpkg-config\fP automatically sets as described above.
-
.TP
.I "--static"
Output libraries suitable for static linking. That means including
any private libraries in the output. This relies on proper tagging in
the .pc files, else a too large number of libraries will ordinarily be
output.
-
+.\"
.SH ENVIRONMENT VARIABLES
-
.TP
.I "PKG_CONFIG_PATH"
A colon-separated (on Windows, semicolon-separated) list of
@@ -227,12 +212,10 @@
\fIlibdir\fP/pkgconfig:\fIdatadir\fP/pkgconfig where \fIlibdir\fP is
the libdir where \fIpkg-config\fP and \fIdatadir\fP is the datadir
where \fIpkg-config\fP was installed.
-
.TP
.I "PKG_CONFIG_DEBUG_SPEW"
If set, causes \fIpkg-config\fP to print all kinds of
debugging information and report all errors.
-
.TP
.I "PKG_CONFIG_TOP_BUILD_DIR"
A value to set for the magic variable \fIpc_top_builddir\fP
@@ -242,7 +225,6 @@
compile/link flags reported by \fIpkg-config\fP will be used.
This only matters when compiling/linking against a package that hasn't
yet been installed.
-
.TP
.I "PKG_CONFIG_DISABLE_UNINSTALLED"
Normally if you request the package "foo" and the package
@@ -250,15 +232,12 @@
"-uninstalled" variant. This allows compilation/linking against
uninstalled packages. If this environment variable is set, it
disables said behavior.
-
.TP
.I "PKG_CONFIG_ALLOW_SYSTEM_CFLAGS"
Don't strip -I/usr/include out of cflags.
-
.TP
.I "PKG_CONFIG_ALLOW_SYSTEM_LIBS"
Don't strip -L/usr/lib out of libs
-
.TP
.I "PKG_CONFIG_LIBDIR"
Replaces the default \fIpkg-config\fP search directory.
@@ -279,9 +258,8 @@
used to specify directories to search for .pc files. Each (string)
value in these keys is treated as a directory where to look for .pc
files.
-
+.\"
.SH AUTOCONF MACROS
-
.TP
.I "PKG_CHECK_MODULES(VARIABLE-PREFIX,MODULES[,ACTION-IF-FOUND,[ACTION-IF-NOT-FOUND]])"
@@ -302,13 +280,15 @@
Note that if there is a possibility the first call to
PKG_CHECK_MODULES might not happen, you should be sure to include an
-explicit call to PKG_PROG_PKG_CONFIG in your configure.ac
-
+explicit call to PKG_PROG_PKG_CONFIG in your configure.ac.
+.\"
+.TP
.I "PKG_PROG_PKG_CONFIG([MIN-VERSION])"
Defines the PKG_CONFIG variable to the best pkg-config available,
useful if you need pkg-config but don't want to use PKG_CHECK_MODULES.
-
+.\"
+.TP
.I "PKG_CHECK_EXISTS(MODULES, [ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND])"
Check to see whether a particular set of modules exists. Similar
@@ -316,13 +296,12 @@
Similar to PKG_CHECK_MODULES, make sure that the first instance of
this or PKG_CHECK_MODULES is called, or make sure to call
-PKG_CHECK_EXISTS manually
-
+PKG_CHECK_EXISTS manually.
+.\"
.SH METADATA FILE SYNTAX
To add a library to the set of packages \fIpkg-config\fP knows about,
simply install a \fI.pc\fP file. You should install this file to
\fIlibdir\fP/pkgconfig.
-
.PP
Here is an example file:
.nf
@@ -342,11 +321,9 @@
Libs.private: -lm
Cflags: -I${includedir}/glib-2.0 -I${libdir}/glib/include
.fi
-
.PP
You would normally generate the file using configure, of course, so
that the prefix, etc. are set to the proper values.
-
.PP
Files have two kinds of line: keyword lines start with a keyword plus
a colon, and variable definitions start with an alphanumeric string
@@ -354,11 +331,9 @@
meaning to \fIpkg-config\fP; variables do not, you can have any
variables that you wish (however, users may expect to retrieve the
usual directory name variables).
-
.PP
Note that variable references are written "${foo}"; you can escape
literal "${" as "$${".
-
.TP
.I "Name:"
This field should be a human-readable name for the package. Note that
@@ -401,19 +376,17 @@
This line should give the link flags specific to your package.
Don't add any flags for required packages; \fIpkg-config\fP will
add those automatically.
-
.TP
.I "Libs.private:"
This line should list any private libraries in use. Private libraries
are libraries which are not exposed through your library, but are
needed in the case of static linking.
-
.TP
.I "Cflags:"
This line should list the compile flags specific to your package.
Don't add any flags for required packages; \fIpkg-config\fP will
add those automatically.
-
+.\"
.SH AUTHOR
\fIpkg-config\fP was written by James Henstridge, rewritten by Martijn
@@ -422,7 +395,7 @@
\fIgnome-config\fP was written by Miguel de Icaza, Raja Harinath and
various hackers in the GNOME team. It was inspired by Owen Taylor's
\fIgtk-config\fP program.
-
+.\"
.SH BUGS
\fIpkg-config\fP does not handle mixing of parameters with and without
More information about the pkg-config
mailing list