doc: Add man page of gpgrt-config.

* doc/Makefile.am (myman_pages): Add gpgrt-config.1.
* doc/gpgrt.texi: Add gpgrt-config.1.

--

GnuPG-bug-id: 6288
Co-authored-by: Andreas Metzler <ametzler@debian.org>
Signed-off-by: NIIBE Yutaka <gniibe@fsij.org>

2 files changed, 69 insertions, 2 deletions

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..6612600 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 querying installed libraries
 @end menu
 
 @c The original version of this man page has been written for Debian and was
@@ -410,6 +411,72 @@ specified before any @option{--libs} or @option{--cflags} options.
 
 @manpause
 
+@manpage gpgrt-config.1
+@node gpgrt-config
+@section gpgrt-config - Helper tool for querying installed libraries.
+@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.
+
+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 pkg-config 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 linking statically instead of dynamically.
+
+@item --variable=@var{VARNAME}
+Output variable VARNAME from the module's pkg-config file.
+
+@end table
+
+@mansect bugs
+@noindent
+@command{gpgrt-config} is tried to be compatible to pkg-config, and to
+support cross build well, but it is not intended to be a replacement.
+
+@manpause
 
 
 @c **********************************************************