glfs/general/genlib/gobject-introspection.xml
Krejzi 0568701f04 typo correction
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@9724 af4574ff-66df-0310-9fd7-8a98e5e911e0
2012-03-18 11:38:00 +00:00

193 lines
6.9 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;
<!-- Note gobject-introspection-1.30+ is incompatible with other BLFS packages-->
<!ENTITY gobject-introspection-download-http "&gnome-download-http;/gobject-introspection/1.30/gobject-introspection-&gobject-introspection-version;.tar.xz">
<!ENTITY gobject-introspection-download-ftp "&gnome-download-ftp;/gobject-introspection/1.30/gobject-introspection-&gobject-introspection-version;.tar.xz">
<!ENTITY gobject-introspection-md5sum "4e5f8d02890aa1f2459b9890e0a45486">
<!ENTITY gobject-introspection-size "1 MB">
<!ENTITY gobject-introspection-buildsize "34 MB">
<!ENTITY gobject-introspection-time "0.6 SBU">
]>
<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> package is used
to describe the APIs and collect them in a uniform, machine readable
format.</para>
&lfs70_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="pkgconfig"/>,
<xref linkend="libffi"/> or <xref linkend="gcc"/> (build Java so that
<filename class='libraryfile'>libffi</filename> is built), and
<xref linkend="python2"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="cairo"/> (Required for the tests) and
<xref linkend="gtk-doc"/>
</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-tests &amp;&amp;
make</userinput></screen>
<para>To test the results, issue: <command>make check</command>.</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>
<para><parameter>--disable-tests</parameter>: This parameter disable test
libraries. Remove the parameter if you have <application>cairo</application>
installed and would like the tests to be performed.</para>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/gtk-doc-rebuild.xml"/>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>g-ir-annotation-tool, g-ir-compiler, g-ir-doc-tool, g-ir-generate,
and g-ir-scanner</seg>
<seg>_giscanner.{so,a} and libgirepository-1.0.{so,a}</seg>
<seg>/usr/include/gobject-introspection-1.0,
/usr/lib/{girepository-1.0,gobject-introspection},
/usr/lib/share/{gir-1.0,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-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-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, using 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,a}</filename></term>
<listitem>
<para>provides an API to access to the typelib metadata.</para>
<indexterm zone="gobject-introspection libgirepository-1.0">
<primary sortas="c-libgirepository-1.0">libgirepository-1.0.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libgirepository-everything-1.0">
<term><filename class='libraryfile'>libgirepository-everything-1.0.{so,a}</filename></term>
<listitem>
<para>provides an API to access to the typelib metadata.</para>
<indexterm zone="gobject-introspection libgirepository-everything-1.0">
<primary sortas="c-libgirepository-everything-1.0">libgirepository-everything-1.0.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>