Page MenuHome GnuPG
Files F4409631

moredocs.diff
ametzler1 (Andreas Metzler)
Actions

Authored By
ametzler1
Nov 27 2022, 4:30 PM
Size
3 KB
Subscribers
None

moredocs.diff
View Options

diff --git a/doc/Makefile.am b/doc/Makefile.am
index db34ba9..fb84652 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -34,9 +34,9 @@ YAT2M_OPTIONS = -I $(srcdir) \
myman_sources = gpgrt.texi
if INSTALL_GPG_ERROR_CONFIG
-myman_pages = gpg-error-config.1
+myman_pages = gpg-error-config.1 gpgrt-config.1
else
-myman_pages =
+myman_pages = gpgrt-config.1
endif
man_MANS = $(myman_pages)
diff --git a/doc/gpgrt.texi b/doc/gpgrt.texi
index 2478366..8807f76 100644
--- a/doc/gpgrt.texi
+++ b/doc/gpgrt.texi
@@ -342,6 +342,7 @@ TBD. (Description of the error function may be taken from Libgcrypt.)
@menu
* gpg-error-config:: Print required compiler flags
+* gpgrt-config:: Helper tool for autoconf macros.
@end menu
@c The original version of this man page has been written for Debian and was
@@ -410,6 +411,70 @@ specified before any @option{--libs} or @option{--cflags} options.
@manpause
+@manpage gpgrt-config.1
+@node gpgrt-config
+@section gpgrt-config - Helper tool for autoconf macros.
+@ifset manverb
+.B gpgrt-config
+\- Helper script to get information about the installed version of gpg libraries
+@end ifset
+
+@mansect synopsis
+@ifset manverb
+.B gpgrt-config
+.RI [ options ]
+.I [ module ]
+@end ifset
+
+@mansect description
+@command{gpgrt-config} is a script tool that is used by the autoconf macros
+shipped with gnupg software (e.g. AM_PATH_GPG_ERROR and AM_PATH_GPGME) to
+determine the compiler and linker flags that should be used to compile
+and link programs that use the specific library (e.g. libgpg-error or
+libgpgme). @command{gpgrt-config} uses pkg-config .pc files as data source.
+@command{gpgrt-config} should not be used directly since it
+requires additional hinting on where this info can be found by passing of
+@option{--libdir} or setting either @env{PKG_CONFIG_LIBDIR} or
+@env{PKG_CONFIG_PATH} environment variables correctly.
+
+Apart from options @command{gpgrt-config} accepts a single argument
+@option{module} specifying the basename (without the ".pc"-suffix) of the
+pkg-config file to be used as input. @option{module} will default to
+@option{gpg-error} if it is not specified.
+
+@mansect options
+@noindent
+@command{gpgrt-config} accepts the following options:
+
+@table @gnupgtabopt
+@item --libdir=@var{LIBDIR}
+Parent directory path of pkgconfig file search path.
+e.g. @samp{gpgrt-config --libdir=/usr/lib --exists gpgme}
+will parse @file{/usr/lib/pkgconfig/gpgme.pc}.
+
+@item --exists
+Test whether the pkgconfig file @file{module.pc} exist and exits with success or error accordingly.
+
+@item --modversion
+Print the currently installed version of @option{module} on the standard output.
+
+@item --libs
+Print the linker flags that are necessary to link a program using the
+@option{module}.
+
+@item --cflags
+Print the compiler flags that are necessary to compile a program using the
+@option{module}.
+
+@item --static
+Modifies output if lininging statically instead of dynamically.
+
+@item --variable=@var{VARNAME}
+Output variable VARNAME from the module's pkgconfig file.
+
+@end table
+
+@manpause
@c **********************************************************

File Metadata

Mime Type
text/x-diff
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
6c/5e/b665fbb803fc7892c56fb2da0e93

Event Timeline