glfs/general/genlib/gobject-introspection.xml
Bruce Dubbs c518884ee1 Update to smartmontools-7.0.
Update to mc-4.8.22. 
Update to gobject-introspection-1.58.3. 
Update to doxygen-1.8.15. 



git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@20918 af4574ff-66df-0310-9fd7-8a98e5e911e0
2019-01-03 23:27:28 +00:00

273 lines
9.0 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY gobject-introspection-download-http
"&gnome-download-http;/gobject-introspection/1.58/gobject-introspection-&gobject-introspection-version;.tar.xz">
<!ENTITY gobject-introspection-download-ftp
"&gnome-download-ftp;/gobject-introspection/1.58/gobject-introspection-&gobject-introspection-version;.tar.xz">
<!ENTITY gobject-introspection-md5sum "182432c1f33886be8f4da073218b597d">
<!ENTITY gobject-introspection-size "1.3 MB">
<!ENTITY gobject-introspection-buildsize "38 MB (add 7 MB for tests)">
<!ENTITY gobject-introspection-time "0.3 SBU (add 0.3 SBU for tests)">
]>
<sect1 id="gobject-introspection" xreflabel="gobject-introspection-&gobject-introspection-version;">
<?dbhtml filename="gobject-introspection.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>gobject-introspection-&gobject-introspection-version;</title>
<indexterm zone="gobject-introspection">
<primary sortas="a-gobject-introspection">gobject-introspection</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to GObject Introspection</title>
<para>
The <application>GObject Introspection</application> is used
to describe the program APIs and collect them in a uniform,
machine readable format.
</para>
&lfs83_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&gobject-introspection-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&gobject-introspection-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &gobject-introspection-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &gobject-introspection-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &gobject-introspection-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &gobject-introspection-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="glib2"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="which"/>
<!-- If - -with-python is used, configure runs "which $PYTHON", where PYTHON
is set to the argument of the switch. Somewhat silly because the presence
of which is not tested... -->
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="cairo"/> (required for the tests),
<xref linkend="gtk-doc"/>,
<xref linkend="Mako"/>,
<xref linkend="python2"/>, and
<ulink url="https://pypi.org/project/Markdown/">Markdown</ulink>
<!-- There was talk of this being required in the release notes. Can someone
who doesn't have this installed verify? -->
</para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/gobject-introspection"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of GObject Introspection</title>
<para>
Install <application>GObject Introspection</application> by running
the following commands:
</para>
<screen><userinput>./configure --prefix=/usr \
--disable-static \
--with-python=/usr/bin/python3 &amp;&amp;
make</userinput></screen>
<para>
To test the results, issue: <command>make check</command>.
<!--One test, Regress-1.0.gir, is known to fail with glibc-2.28.-->
<!-- This worked fine in 2.27, but is broken again in 2.28. -->
<!-- This works again with glibc 2.28 and gi 1.58.0 -->
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/static-libraries.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/gtk-doc-rebuild.xml"/>
<para><parameter>--with-python=/usr/bin/python3</parameter>: ensure the
Python-3.x interpreter is used instead of Python-2.x if installed.</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Program</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<!-- g-ir-doc-tool is installed if mako is presnet -->
<seglistitem>
<seg>
g-ir-annotation-tool, g-ir-compiler, g-ir-doc-tool,
g-ir-inspect, g-ir-generate, and g-ir-scanner
</seg>
<seg>
libgirepository-1.0.so and
/usr/lib/gobject-introspection/giscanner/_giscanner.so
</seg>
<seg>
/usr/include/gobject-introspection-1.0,
/usr/lib/girepository-1.0,
/usr/lib/gobject-introspection,
/usr/share/gir-1.0, and
/usr/share/gobject-introspection-1.0
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="g-ir-annotation-tool">
<term><command>g-ir-annotation-tool</command></term>
<listitem>
<para>
creates or extracts annotation data from GI typelibs.
</para>
<indexterm zone="gobject-introspection g-ir-annotation-tool">
<primary sortas="b-g-ir-annotation-tool">g-ir-annotation-tool</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="g-ir-compiler">
<term><command>g-ir-compiler</command></term>
<listitem>
<para>
converts one or more GIR files into one or more typelib.
</para>
<indexterm zone="gobject-introspection g-ir-compiler">
<primary sortas="b-g-ir-compiler">g-ir-compiler</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="g-ir-doc-tool">
<term><command>g-ir-doc-tool</command></term>
<listitem>
<para>
generates Mallard files that can be viewed with
<command>yelp</command> or rendered to HTML with
<command>yelp-build</command> from <ulink
url="http://ftp.acc.umu.se/pub/gnome/sources/yelp-tools">yelp-tools</ulink>.
</para>
<indexterm zone="gobject-introspection g-ir-doc-tool">
<primary sortas="b-g-ir-doc-tool">g-ir-doc-tool</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="g-ir-inspect">
<term><command>g-ir-inspect</command></term>
<listitem>
<para>
is a utility that gives information about a GI typelib.
</para>
<indexterm zone="gobject-introspection g-ir-inspect">
<primary sortas="b-g-ir-inspect">g-ir-inspect</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="g-ir-scanner">
<term><command>g-ir-scanner</command></term>
<listitem>
<para>
is a tool which generates GIR XML files by parsing headers and
introspecting GObject based libraries.
</para>
<indexterm zone="gobject-introspection g-ir-scanner">
<primary sortas="b-g-ir-scanner">g-ir-scanner</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="g-ir-generate">
<term><command>g-ir-generate</command></term>
<listitem>
<para>
is a GIR generator that uses the repository API.
</para>
<indexterm zone="gobject-introspection g-ir-generate">
<primary sortas="b-g-ir-generate">g-ir-generate</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libgirepository-1.0">
<term><filename class="libraryfile">libgirepository-1.0.so</filename></term>
<listitem>
<para>
provides an API to access the typelib metadata.
</para>
<indexterm zone="gobject-introspection libgirepository-1.0">
<primary sortas="c-libgirepository-1.0">libgirepository-1.0.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>