source: general/genlib/gobject-introspection.xml@ 89eb994f

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 89eb994f was 89eb994f, checked in by Douglas R. Reno <renodr@…>, 8 months ago

Update to gobject-introspection-1.78.0
  • Property mode set to 100644
File size: 8.4 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.78/gobject-introspection-&gobject-introspection-version;.tar.xz">
9 <!ENTITY gobject-introspection-download-ftp
10 "&gnome-download-ftp;/gobject-introspection/1.78/gobject-introspection-&gobject-introspection-version;.tar.xz">
11 <!ENTITY gobject-introspection-md5sum "53b36b83384134a5c50a3c0886d27c16">
12 <!ENTITY gobject-introspection-size "1.0 MB">
13 <!ENTITY gobject-introspection-buildsize "65 MB (with tests)">
14 <!ENTITY gobject-introspection-time "0.3 SBU (With tests; both using parallelism=4)">
15]>
16<sect1 id="gobject-introspection" xreflabel="gobject-introspection-&gobject-introspection-version;">
17 <?dbhtml filename="gobject-introspection.html"?>
18
19
20 <title>gobject-introspection-&gobject-introspection-version;</title>
21
22 <indexterm zone="gobject-introspection">
23 <primary sortas="a-gobject-introspection">gobject-introspection</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to GObject Introspection</title>
28
29 <para>
30 The <application>GObject Introspection</application> is used
31 to describe the program APIs and collect them in a uniform,
32 machine readable format.
33 </para>
34
35 &lfs120_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&gobject-introspection-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&gobject-introspection-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &gobject-introspection-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &gobject-introspection-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &gobject-introspection-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &gobject-introspection-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71 <bridgehead renderas="sect3">GObject Introspection Dependencies</bridgehead>
72
73 <bridgehead renderas="sect4">Required</bridgehead>
74 <para role="required">
75 <xref linkend="glib2"/>
76 </para>
77
78 <bridgehead renderas="sect4">Optional</bridgehead>
79 <para role="optional">
80 <xref linkend="cairo"/> (required for the tests),
81 <xref linkend="gjs"/> (to satisfy one test),
82 <xref linkend="gtk-doc"/>,
83 <xref linkend="Mako"/>, and
84 <xref linkend="markdown"/>
85 </para>
86
87 </sect2>
88
89 <sect2 role="installation">
90 <title>Installation of GObject Introspection</title>
91
92 <para>
93 Install <application>GObject Introspection</application> by running
94 the following commands:
95 </para>
96
97<screen><userinput>mkdir build &amp;&amp;
98cd build &amp;&amp;
99
100meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
101ninja</userinput></screen>
102
103 <para>
104 To test the results, issue: <command>ninja test</command>.
105 </para>
106
107 <para>
108 Now, as the <systemitem class="username">root</systemitem> user:
109 </para>
110
111<screen role="root"><userinput>ninja install</userinput></screen>
112
113 </sect2>
114
115 <sect2 role="commands">
116 <title>Command Explanations</title>
117
118 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
119 href="../../xincludes/meson-buildtype-release.xml"/>
120
121 <para>
122 <option>-Dgtk_doc=true</option>: Build and install
123 the documentation.
124 </para>
125
126 <para>
127 <option>-Dcairo=enabled</option>: Use cairo for tests.
128 </para>
129
130 <para>
131 <option>-Ddoctool=enabled</option>: Install g-ir-doc-tool
132 and run related tests. You must have
133 <xref linkend="Mako" role="nodep"/> and
134 <xref linkend="markdown" role="nodep"/> installed in order
135 to install this utility.
136 </para>
137
138 </sect2>
139
140 <sect2 role="content">
141 <title>Contents</title>
142
143 <segmentedlist>
144 <segtitle>Installed Program</segtitle>
145 <segtitle>Installed Libraries</segtitle>
146 <segtitle>Installed Directories</segtitle>
147
148 <!-- g-ir-doc-tool is installed if Mako and Markdown are present -->
149 <seglistitem>
150 <seg>
151 g-ir-annotation-tool, g-ir-compiler, g-ir-doc-tool,
152 g-ir-generate, g-ir-inspect, and g-ir-scanner
153 </seg>
154 <seg>
155 libgirepository-1.0.so and
156 _giscanner.&python3-lib-suffix;.so
157 </seg>
158 <seg>
159 /usr/include/gobject-introspection-1.0,
160 /usr/lib/girepository-1.0,
161 /usr/lib/gobject-introspection,
162 /usr/share/gir-1.0, and
163 /usr/share/gobject-introspection-1.0
164 </seg>
165 </seglistitem>
166 </segmentedlist>
167
168 <variablelist>
169 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
170 <?dbfo list-presentation="list"?>
171 <?dbhtml list-presentation="table"?>
172
173 <varlistentry id="g-ir-annotation-tool">
174 <term><command>g-ir-annotation-tool</command></term>
175 <listitem>
176 <para>
177 creates or extracts annotation data from GI typelibs
178 </para>
179 <indexterm zone="gobject-introspection g-ir-annotation-tool">
180 <primary sortas="b-g-ir-annotation-tool">g-ir-annotation-tool</primary>
181 </indexterm>
182 </listitem>
183 </varlistentry>
184
185 <varlistentry id="g-ir-compiler">
186 <term><command>g-ir-compiler</command></term>
187 <listitem>
188 <para>
189 converts one or more GIR files into one or more typelib
190 </para>
191 <indexterm zone="gobject-introspection g-ir-compiler">
192 <primary sortas="b-g-ir-compiler">g-ir-compiler</primary>
193 </indexterm>
194 </listitem>
195 </varlistentry>
196
197 <varlistentry id="g-ir-doc-tool">
198 <term><command>g-ir-doc-tool</command></term>
199 <listitem>
200 <para>
201 generates Mallard files that can be viewed with
202 <command>yelp</command> or rendered to HTML with
203 <command>yelp-build</command> from
204 <ulink url="&gnome-download-http;/yelp-tools">yelp-tools</ulink>
205 </para>
206 <indexterm zone="gobject-introspection g-ir-doc-tool">
207 <primary sortas="b-g-ir-doc-tool">g-ir-doc-tool</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="g-ir-inspect">
213 <term><command>g-ir-inspect</command></term>
214 <listitem>
215 <para>
216 is a utility that gives information about a GI typelib
217 </para>
218 <indexterm zone="gobject-introspection g-ir-inspect">
219 <primary sortas="b-g-ir-inspect">g-ir-inspect</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="g-ir-generate">
225 <term><command>g-ir-generate</command></term>
226 <listitem>
227 <para>
228 is a GIR generator that uses the repository API
229 </para>
230 <indexterm zone="gobject-introspection g-ir-generate">
231 <primary sortas="b-g-ir-generate">g-ir-generate</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="g-ir-scanner">
237 <term><command>g-ir-scanner</command></term>
238 <listitem>
239 <para>
240 is a tool which generates GIR XML files by parsing headers and
241 introspecting GObject based libraries
242 </para>
243 <indexterm zone="gobject-introspection g-ir-scanner">
244 <primary sortas="b-g-ir-scanner">g-ir-scanner</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="libgirepository-1.0">
250 <term><filename class="libraryfile">libgirepository-1.0.so</filename></term>
251 <listitem>
252 <para>
253 provides an API to access the typelib metadata
254 </para>
255 <indexterm zone="gobject-introspection libgirepository-1.0">
256 <primary sortas="c-libgirepository-1.0">libgirepository-1.0.so</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 </variablelist>
262
263 </sect2>
264
265</sect1>
Note: See TracBrowser for help on using the repository browser.