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.44/gobject-introspection-&gobject-introspection-version;.tar.xz">
|
---|
9 | <!ENTITY gobject-introspection-download-ftp
|
---|
10 | "&gnome-download-ftp;/gobject-introspection/1.44/gobject-introspection-&gobject-introspection-version;.tar.xz">
|
---|
11 | <!ENTITY gobject-introspection-md5sum "7ef8a1db7f74f4193a2397b1587eb913">
|
---|
12 | <!ENTITY gobject-introspection-size "1.3 MB">
|
---|
13 | <!ENTITY gobject-introspection-buildsize "37 MB (additional 6 MB for the tests)">
|
---|
14 | <!ENTITY gobject-introspection-time "0.2 SBU (additional 0.2 SBU for the 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 | &lfs77_checked; &gcc5_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">Optional</bridgehead>
|
---|
82 | <para role="optional">
|
---|
83 | <xref linkend="cairo"/> (required for the tests),
|
---|
84 | <xref linkend="gtk-doc"/> and
|
---|
85 | <ulink url="http://www.makotemplates.org/">Mako</ulink>
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | <para condition="html" role="usernotes">User Notes:
|
---|
89 | <ulink url="&blfs-wiki;/gobject-introspection"/>
|
---|
90 | </para>
|
---|
91 | </sect2>
|
---|
92 |
|
---|
93 | <sect2 role="installation">
|
---|
94 | <title>Installation of GObject Introspection</title>
|
---|
95 |
|
---|
96 | <para>
|
---|
97 | Install <application>GObject Introspection</application> by running
|
---|
98 | the following commands:
|
---|
99 | </para>
|
---|
100 |
|
---|
101 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
102 | make</userinput></screen>
|
---|
103 |
|
---|
104 | <para>
|
---|
105 | To test the results, issue: <command>make check</command>.
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <para>
|
---|
109 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
113 |
|
---|
114 | </sect2>
|
---|
115 |
|
---|
116 | <sect2 role="commands">
|
---|
117 | <title>Command Explanations</title>
|
---|
118 |
|
---|
119 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
120 | href="../../xincludes/static-libraries.xml"/>
|
---|
121 |
|
---|
122 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
123 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
124 |
|
---|
125 | </sect2>
|
---|
126 |
|
---|
127 | <sect2 role="content">
|
---|
128 | <title>Contents</title>
|
---|
129 |
|
---|
130 | <segmentedlist>
|
---|
131 | <segtitle>Installed Program</segtitle>
|
---|
132 | <segtitle>Installed Libraries</segtitle>
|
---|
133 | <segtitle>Installed Directories</segtitle>
|
---|
134 |
|
---|
135 | <!-- g-ir-doc-tool is installed if mako is presnet -->
|
---|
136 | <seglistitem>
|
---|
137 | <seg>
|
---|
138 | g-ir-annotation-tool, g-ir-compiler, g-ir-doc-tool,
|
---|
139 | g-ir-generate, and g-ir-scanner
|
---|
140 | </seg>
|
---|
141 | <seg>
|
---|
142 | libgirepository-1.0.so and
|
---|
143 | /usr/lib/gobject-introspection/giscanner/_giscanner.so
|
---|
144 | </seg>
|
---|
145 | <seg>
|
---|
146 | /usr/include/gobject-introspection-1.0,
|
---|
147 | /usr/lib/girepository-1.0,
|
---|
148 | /usr/lib/gobject-introspection,
|
---|
149 | /usr/share/gir-1.0, and
|
---|
150 | /usr/share/gobject-introspection-1.0
|
---|
151 | </seg>
|
---|
152 | </seglistitem>
|
---|
153 | </segmentedlist>
|
---|
154 |
|
---|
155 | <variablelist>
|
---|
156 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
157 | <?dbfo list-presentation="list"?>
|
---|
158 | <?dbhtml list-presentation="table"?>
|
---|
159 |
|
---|
160 | <varlistentry id="g-ir-compiler">
|
---|
161 | <term><command>g-ir-compiler</command></term>
|
---|
162 | <listitem>
|
---|
163 | <para>
|
---|
164 | converts one or more GIR files into one or more typelib.
|
---|
165 | </para>
|
---|
166 | <indexterm zone="gobject-introspection g-ir-compiler">
|
---|
167 | <primary sortas="b-g-ir-compiler">g-ir-compiler</primary>
|
---|
168 | </indexterm>
|
---|
169 | </listitem>
|
---|
170 | </varlistentry>
|
---|
171 |
|
---|
172 | <varlistentry id="g-ir-doc-tool">
|
---|
173 | <term><command>g-ir-doc-tool</command></term>
|
---|
174 | <listitem>
|
---|
175 | <para>
|
---|
176 | generates Mallard files that can be viewed with
|
---|
177 | <command>yelp</command> or rendered to HTML with
|
---|
178 | <command>yelp-build</command> from <ulink
|
---|
179 | url="http://ftp.acc.umu.se/pub/gnome/sources/yelp-tools/yelp-tools">yelp-tools</ulink>.
|
---|
180 | </para>
|
---|
181 | <indexterm zone="gobject-introspection g-ir-doc-tool">
|
---|
182 | <primary sortas="b-g-ir-doc-tool">g-ir-doc-tool</primary>
|
---|
183 | </indexterm>
|
---|
184 | </listitem>
|
---|
185 | </varlistentry>
|
---|
186 |
|
---|
187 | <varlistentry id="g-ir-scanner">
|
---|
188 | <term><command>g-ir-scanner</command></term>
|
---|
189 | <listitem>
|
---|
190 | <para>
|
---|
191 | is a tool which generates GIR XML files by parsing headers and
|
---|
192 | introspecting GObject based libraries.
|
---|
193 | </para>
|
---|
194 | <indexterm zone="gobject-introspection g-ir-scanner">
|
---|
195 | <primary sortas="b-g-ir-scanner">g-ir-scanner</primary>
|
---|
196 | </indexterm>
|
---|
197 | </listitem>
|
---|
198 | </varlistentry>
|
---|
199 |
|
---|
200 | <varlistentry id="g-ir-generate">
|
---|
201 | <term><command>g-ir-generate</command></term>
|
---|
202 | <listitem>
|
---|
203 | <para>
|
---|
204 | is a GIR generator using the repository API.
|
---|
205 | </para>
|
---|
206 | <indexterm zone="gobject-introspection g-ir-generate">
|
---|
207 | <primary sortas="b-g-ir-generate">g-ir-generate</primary>
|
---|
208 | </indexterm>
|
---|
209 | </listitem>
|
---|
210 | </varlistentry>
|
---|
211 |
|
---|
212 | <varlistentry id="libgirepository-1.0">
|
---|
213 | <term><filename class="libraryfile">libgirepository-1.0.so</filename></term>
|
---|
214 | <listitem>
|
---|
215 | <para>
|
---|
216 | provides an API to access to the typelib metadata.
|
---|
217 | </para>
|
---|
218 | <indexterm zone="gobject-introspection libgirepository-1.0">
|
---|
219 | <primary sortas="c-libgirepository-1.0">libgirepository-1.0.so</primary>
|
---|
220 | </indexterm>
|
---|
221 | </listitem>
|
---|
222 | </varlistentry>
|
---|
223 |
|
---|
224 | </variablelist>
|
---|
225 |
|
---|
226 | </sect2>
|
---|
227 |
|
---|
228 | </sect1>
|
---|