source: general/genlib/gobject-introspection.xml@ 4b1b99e8

elogind
Last change on this file since 4b1b99e8 was 4b1b99e8, checked in by DJ Lucas <dj@…>, 5 years ago

Merge to HEAD 21160.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/BOOK-elogind@21161 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 9.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY gobject-introspection-download-http
8 "&gnome-download-http;/gobject-introspection/1.58/gobject-introspection-&gobject-introspection-version;.tar.xz">
9 <!ENTITY gobject-introspection-download-ftp
10 "&gnome-download-ftp;/gobject-introspection/1.58/gobject-introspection-&gobject-introspection-version;.tar.xz">
11 <!ENTITY gobject-introspection-md5sum "182432c1f33886be8f4da073218b597d">
12 <!ENTITY gobject-introspection-size "1.3 MB">
13 <!ENTITY gobject-introspection-buildsize "38 MB (add 7 MB for tests)">
14 <!ENTITY gobject-introspection-time "0.3 SBU (add 0.3 SBU for tests)">
15]>
16
17<sect1 id="gobject-introspection" xreflabel="gobject-introspection-&gobject-introspection-version;">
18 <?dbhtml filename="gobject-introspection.html"?>
19
20 <sect1info>
21 <othername>$LastChangedBy$</othername>
22 <date>$Date$</date>
23 </sect1info>
24
25 <title>gobject-introspection-&gobject-introspection-version;</title>
26
27 <indexterm zone="gobject-introspection">
28 <primary sortas="a-gobject-introspection">gobject-introspection</primary>
29 </indexterm>
30
31 <sect2 role="package">
32 <title>Introduction to GObject Introspection</title>
33
34 <para>
35 The <application>GObject Introspection</application> is used
36 to describe the program APIs and collect them in a uniform,
37 machine readable format.
38 </para>
39
40 &lfs84_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&gobject-introspection-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&gobject-introspection-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &gobject-introspection-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &gobject-introspection-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &gobject-introspection-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &gobject-introspection-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="glib2"/>
79 </para>
80
81 <bridgehead renderas="sect4">Recommended</bridgehead>
82 <para role="recommended">
83 <xref linkend="which"/>
84<!-- If - -with-python is used, configure runs "which $PYTHON", where PYTHON
85 is set to the argument of the switch. Somewhat silly because the presence
86 of which is not tested... -->
87 </para>
88
89 <bridgehead renderas="sect4">Optional</bridgehead>
90 <para role="optional">
91 <xref linkend="cairo"/> (required for the tests),
92 <xref linkend="gjs"/> (to satisfy one of the tests),
93 <xref linkend="gtk-doc"/>,
94 <xref linkend="Mako"/>,
95 <xref linkend="python2"/>, and
96 <ulink url="https://pypi.org/project/Markdown/">Markdown</ulink>
97 <!-- There was talk of this being required in the release notes. Can someone
98 who doesn't have this installed verify? -->
99 </para>
100
101 <para condition="html" role="usernotes">User Notes:
102 <ulink url="&blfs-wiki;/gobject-introspection"/>
103 </para>
104 </sect2>
105
106 <sect2 role="installation">
107 <title>Installation of GObject Introspection</title>
108
109 <para>
110 Install <application>GObject Introspection</application> by running
111 the following commands:
112 </para>
113
114<screen><userinput>./configure --prefix=/usr \
115 --disable-static \
116 --with-python=/usr/bin/python3 &amp;&amp;
117make</userinput></screen>
118
119 <para>
120 To test the results, issue: <command>make check</command>.
121 <!--One test, Regress-1.0.gir, is known to fail with glibc-2.28.-->
122 <!-- This worked fine in 2.27, but is broken again in 2.28. -->
123 <!-- This works again with glibc 2.28 and gi 1.58.0 -->
124 </para>
125
126 <para>
127 Now, as the <systemitem class="username">root</systemitem> user:
128 </para>
129
130<screen role="root"><userinput>make install</userinput></screen>
131
132 </sect2>
133
134 <sect2 role="commands">
135 <title>Command Explanations</title>
136
137 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
138 href="../../xincludes/static-libraries.xml"/>
139
140 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
141 href="../../xincludes/gtk-doc-rebuild.xml"/>
142
143 <para><parameter>--with-python=/usr/bin/python3</parameter>: ensure the
144 Python-3.x interpreter is used instead of Python-2.x if installed.</para>
145
146 </sect2>
147
148 <sect2 role="content">
149 <title>Contents</title>
150
151 <segmentedlist>
152 <segtitle>Installed Program</segtitle>
153 <segtitle>Installed Libraries</segtitle>
154 <segtitle>Installed Directories</segtitle>
155
156 <!-- g-ir-doc-tool is installed if mako is presnet -->
157 <seglistitem>
158 <seg>
159 g-ir-annotation-tool, g-ir-compiler, g-ir-doc-tool,
160 g-ir-inspect, g-ir-generate, and g-ir-scanner
161 </seg>
162 <seg>
163 libgirepository-1.0.so and
164 /usr/lib/gobject-introspection/giscanner/_giscanner.so
165 </seg>
166 <seg>
167 /usr/include/gobject-introspection-1.0,
168 /usr/lib/girepository-1.0,
169 /usr/lib/gobject-introspection,
170 /usr/share/gir-1.0, and
171 /usr/share/gobject-introspection-1.0
172 </seg>
173 </seglistitem>
174 </segmentedlist>
175
176 <variablelist>
177 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
178 <?dbfo list-presentation="list"?>
179 <?dbhtml list-presentation="table"?>
180
181 <varlistentry id="g-ir-annotation-tool">
182 <term><command>g-ir-annotation-tool</command></term>
183 <listitem>
184 <para>
185 creates or extracts annotation data from GI typelibs.
186 </para>
187 <indexterm zone="gobject-introspection g-ir-annotation-tool">
188 <primary sortas="b-g-ir-annotation-tool">g-ir-annotation-tool</primary>
189 </indexterm>
190 </listitem>
191 </varlistentry>
192
193 <varlistentry id="g-ir-compiler">
194 <term><command>g-ir-compiler</command></term>
195 <listitem>
196 <para>
197 converts one or more GIR files into one or more typelib.
198 </para>
199 <indexterm zone="gobject-introspection g-ir-compiler">
200 <primary sortas="b-g-ir-compiler">g-ir-compiler</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="g-ir-doc-tool">
206 <term><command>g-ir-doc-tool</command></term>
207 <listitem>
208 <para>
209 generates Mallard files that can be viewed with
210 <command>yelp</command> or rendered to HTML with
211 <command>yelp-build</command> from <ulink
212 url="http://ftp.acc.umu.se/pub/gnome/sources/yelp-tools">yelp-tools</ulink>.
213 </para>
214 <indexterm zone="gobject-introspection g-ir-doc-tool">
215 <primary sortas="b-g-ir-doc-tool">g-ir-doc-tool</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="g-ir-inspect">
221 <term><command>g-ir-inspect</command></term>
222 <listitem>
223 <para>
224 is a utility that gives information about a GI typelib.
225 </para>
226 <indexterm zone="gobject-introspection g-ir-inspect">
227 <primary sortas="b-g-ir-inspect">g-ir-inspect</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="g-ir-scanner">
233 <term><command>g-ir-scanner</command></term>
234 <listitem>
235 <para>
236 is a tool which generates GIR XML files by parsing headers and
237 introspecting GObject based libraries.
238 </para>
239 <indexterm zone="gobject-introspection g-ir-scanner">
240 <primary sortas="b-g-ir-scanner">g-ir-scanner</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry id="g-ir-generate">
246 <term><command>g-ir-generate</command></term>
247 <listitem>
248 <para>
249 is a GIR generator that uses the repository API.
250 </para>
251 <indexterm zone="gobject-introspection g-ir-generate">
252 <primary sortas="b-g-ir-generate">g-ir-generate</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="libgirepository-1.0">
258 <term><filename class="libraryfile">libgirepository-1.0.so</filename></term>
259 <listitem>
260 <para>
261 provides an API to access the typelib metadata.
262 </para>
263 <indexterm zone="gobject-introspection libgirepository-1.0">
264 <primary sortas="c-libgirepository-1.0">libgirepository-1.0.so</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 </variablelist>
270
271 </sect2>
272
273</sect1>
Note: See TracBrowser for help on using the repository browser.