From 2cc82bd2ca4e27763cd63baa81089d880c4ef408 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Wed, 14 Feb 2024 11:45:10 +0000 Subject: [PATCH] Add a man page for gi-inspect-typelib Signed-off-by: Simon McVittie --- .../girepository/gi-inspect-typelib.rst | 58 +++++++++++++++++++ docs/reference/girepository/meson.build | 1 + 2 files changed, 59 insertions(+) create mode 100644 docs/reference/girepository/gi-inspect-typelib.rst diff --git a/docs/reference/girepository/gi-inspect-typelib.rst b/docs/reference/girepository/gi-inspect-typelib.rst new file mode 100644 index 000000000..3c5b3382b --- /dev/null +++ b/docs/reference/girepository/gi-inspect-typelib.rst @@ -0,0 +1,58 @@ +.. _gio(1): +.. meta:: + :copyright: Copyright 2024 Collabora Ltd. + :license: LGPL-2.1-or-later +.. + This has to be duplicated from above to make it machine-readable by `reuse`: + SPDX-FileCopyrightText: 2024 Collabora Ltd. + SPDX-License-Identifier: LGPL-2.1-or-later + +================== +gi-inspect-typelib +================== + +----------------------- +Typelib inspection tool +----------------------- + +SYNOPSIS +-------- + +| **gi-inspect-typelib** [*OPTION*\ …] **--print-shlibs** *NAMESPACE* +| **gi-inspect-typelib** [*OPTION*\ …] **--print-typelibs** *NAMESPACE* + +DESCRIPTION +----------- + +**gi-inspect-typelib** displays information about GObject-Introspection +binary typelib files. + +OPTIONS +------- + +``--print-shlibs`` + Show the shared libraries that implement the *NAMESPACE*. + +``--print-typelibs`` + Show the other typelibs that the *NAMESPACE* depends on. + +``--typelib-version`` + The version of each *NAMESPACE* to inspect. + For example, the version of ``Gio-2.0.typelib`` is ``2.0``. + If not specified, use the newest available version if there is more + than one installed. + +EXAMPLE +------- + +On Linux, the ``Gio-2.0`` typelib is implemented by ``libgio-2.0.so.0``:: + + $ gi-inspect-typelib --typelib-version 2.0 --print-shlibs Gio + shlib: libgio-2.0.so.0 + +and it depends on GObject-2.0, GLib-2.0 and GModule-2.0:: + + $ gi-inspect-typelib --typelib-version 2.0 --print-typelibs Gio + typelib: GObject-2.0 + typelib: GLib-2.0 + typelib: GModule-2.0 diff --git a/docs/reference/girepository/meson.build b/docs/reference/girepository/meson.build index c0a2e53da..2d14ffd8a 100644 --- a/docs/reference/girepository/meson.build +++ b/docs/reference/girepository/meson.build @@ -2,6 +2,7 @@ if get_option('man-pages').enabled() manpages = [ 'gi-compile-repository', 'gi-decompile-typelib', + 'gi-inspect-typelib', ] foreach page : manpages custom_target(page + '-man',