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 glib2-download-http "&gnome-download-http;/glib/&glib2-minor;/glib-&glib2-version;.tar.xz">
|
---|
8 | <!ENTITY glib2-download-ftp "&gnome-download-ftp;/glib/&glib2-minor;/glib-&glib2-version;.tar.xz">
|
---|
9 | <!ENTITY glib2-md5sum "b0df5864ec08248e79c13f71a717aa03">
|
---|
10 | <!ENTITY glib2-size "5.0 MB">
|
---|
11 | <!ENTITY glib2-buildsize "150 MB (with tests)">
|
---|
12 | <!ENTITY glib2-time "0.7 SBU (add 0.4 SBU for tests; both using parallelism=4)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="glib2" xreflabel="GLib-&glib2-version;">
|
---|
16 | <?dbhtml filename="glib2.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>GLib-&glib2-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="glib2">
|
---|
22 | <primary sortas="a-GLib2">GLib2</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to GLib</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>GLib</application> package contains low-level
|
---|
30 | libraries useful for providing data structure handling for C, portability
|
---|
31 | wrappers and interfaces for such runtime functionality as an
|
---|
32 | event loop, threads, dynamic loading and an object system.
|
---|
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="&glib2-download-http;"/>
|
---|
42 | </para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>
|
---|
46 | Download (FTP): <ulink url="&glib2-download-ftp;"/>
|
---|
47 | </para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>
|
---|
51 | Download MD5 sum: &glib2-md5sum;
|
---|
52 | </para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download size: &glib2-size;
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Estimated disk space required: &glib2-buildsize;
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Estimated build time: &glib2-time;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | </itemizedlist>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
72 | <itemizedlist spacing="compact">
|
---|
73 | <listitem>
|
---|
74 | <para>
|
---|
75 | Optional patch:
|
---|
76 | <ulink url="&patch-root;/glib-skip_warnings-1.patch"/>
|
---|
77 | </para>
|
---|
78 | </listitem>
|
---|
79 | </itemizedlist>
|
---|
80 |
|
---|
81 | <bridgehead renderas="sect3">GLib Dependencies</bridgehead>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
84 | <para role="recommended">
|
---|
85 | <xref linkend="libxslt"/> and
|
---|
86 | <xref linkend="pcre2"/>
|
---|
87 | </para>
|
---|
88 |
|
---|
89 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
90 | <para role="optional">
|
---|
91 | <xref linkend="dbus"/> (for some tests),
|
---|
92 | <xref linkend="fuse3"/> and
|
---|
93 | <ulink url="https://bindfs.org/">bindfs</ulink>
|
---|
94 | (both needed for one test),
|
---|
95 | <xref linkend="gdb"/> (for bindings),
|
---|
96 | <xref linkend="DocBook"/>,
|
---|
97 | <xref linkend="docbook-xsl"/>,
|
---|
98 | <xref linkend="gtk-doc"/> (to build API documentation),
|
---|
99 | <xref linkend="glib-networking"/> (for some tests, but this is a circular
|
---|
100 | dependency), and
|
---|
101 | <xref linkend="sysprof"/>
|
---|
102 | </para>
|
---|
103 |
|
---|
104 | <bridgehead renderas="sect4">Additional Runtime Dependencies</bridgehead>
|
---|
105 | <para role="recommended">
|
---|
106 | <xref role="runtime" linkend="gobject-introspection"/>
|
---|
107 | (should be installed before gtk+, atk, etc.)
|
---|
108 | </para>
|
---|
109 | <para role="optional">
|
---|
110 | Quoted directly from the <filename>INSTALL</filename> file:
|
---|
111 | <quote>Some of the mimetype-related functionality in GIO requires the
|
---|
112 | <command>update-mime-database</command> and
|
---|
113 | <command>update-desktop-database</command> utilities</quote>,
|
---|
114 | which are part of
|
---|
115 | <xref role="runtime" linkend="shared-mime-info"/> and
|
---|
116 | <xref role="runtime" linkend="desktop-file-utils"/>, respectively.
|
---|
117 | These two utilities are also needed for some tests.
|
---|
118 | </para>
|
---|
119 |
|
---|
120 | </sect2>
|
---|
121 |
|
---|
122 | <sect2 role="installation">
|
---|
123 | <title>Installation of GLib</title>
|
---|
124 |
|
---|
125 | <para>
|
---|
126 | If desired, apply the optional patch. In many cases, applications that
|
---|
127 | use this library, either directly or indirectly via other libraries such
|
---|
128 | as <xref linkend="gtk3"/>, output numerous warnings when run from the
|
---|
129 | command line. This patch enables the use of an environment variable,
|
---|
130 | <envar>GLIB_LOG_LEVEL</envar>, that suppresses unwanted messages. The
|
---|
131 | value of the variable is a digit that corresponds to:
|
---|
132 | </para>
|
---|
133 |
|
---|
134 | <simplelist>
|
---|
135 | <member>1 Alert</member>
|
---|
136 | <member>2 Critical</member>
|
---|
137 | <member>3 Error</member>
|
---|
138 | <member>4 Warning</member>
|
---|
139 | <member>5 Notice</member>
|
---|
140 | </simplelist>
|
---|
141 |
|
---|
142 | <para>
|
---|
143 | For instance <userinput>export GLIB_LOG_LEVEL=4</userinput> will skip
|
---|
144 | output of Warning and Notice messages (and Info/Debug messages if they
|
---|
145 | are turned on). If <envar>GLIB_LOG_LEVEL</envar> is not defined, normal
|
---|
146 | message output will not be affected.
|
---|
147 | </para>
|
---|
148 |
|
---|
149 | <screen><userinput>patch -Np1 -i ../glib-skip_warnings-1.patch</userinput></screen>
|
---|
150 |
|
---|
151 | <warning>
|
---|
152 | <para>
|
---|
153 | If a previous version of glib is installed, move the headers out of the
|
---|
154 | way so that later packages do not encounter conflicts:
|
---|
155 | </para>
|
---|
156 |
|
---|
157 | <screen role="root"><userinput remap="pre">if [ -e /usr/include/glib-2.0 ]; then
|
---|
158 | rm -rf /usr/include/glib-2.0.old &&
|
---|
159 | mv -vf /usr/include/glib-2.0{,.old}
|
---|
160 | fi</userinput></screen>
|
---|
161 |
|
---|
162 | </warning>
|
---|
163 |
|
---|
164 | <para>
|
---|
165 | Install <application>GLib</application> by running the following
|
---|
166 | commands:
|
---|
167 | </para>
|
---|
168 |
|
---|
169 | <screen><userinput>mkdir build &&
|
---|
170 | cd build &&
|
---|
171 |
|
---|
172 | meson setup .. \
|
---|
173 | --prefix=/usr \
|
---|
174 | --buildtype=release \
|
---|
175 | -Dman=true &&
|
---|
176 | ninja</userinput></screen>
|
---|
177 |
|
---|
178 | <note><para>
|
---|
179 | If <xref linkend="libxslt"/> is installed, the above command may
|
---|
180 | indicate several (about 33) errors that start with "Error: no ID for
|
---|
181 | constraint linkend:" when generating the man pages. These are harmless.
|
---|
182 | </para></note>
|
---|
183 |
|
---|
184 | <para>
|
---|
185 | The <application>GLib</application> test suite requires
|
---|
186 | <application>desktop-file-utils</application> for some tests. However,
|
---|
187 | <application>desktop-file-utils</application> requires
|
---|
188 | <application>GLib</application> in order to compile; therefore, you must
|
---|
189 | first install <application>GLib</application> and then run the test
|
---|
190 | suite.
|
---|
191 | </para>
|
---|
192 |
|
---|
193 | <para>
|
---|
194 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
195 | </para>
|
---|
196 |
|
---|
197 | <screen role="root"><userinput>ninja install &&
|
---|
198 |
|
---|
199 | mkdir -p /usr/share/doc/glib-&glib2-version; &&
|
---|
200 | cp -r ../docs/reference/{gio,glib,gobject} /usr/share/doc/glib-&glib2-version;</userinput></screen>
|
---|
201 |
|
---|
202 | <para>
|
---|
203 | You should now install <xref linkend="desktop-file-utils"/> and
|
---|
204 | <xref linkend="shared-mime-info"/> and proceed to
|
---|
205 | run the test suite.
|
---|
206 | </para>
|
---|
207 |
|
---|
208 | <warning>
|
---|
209 | <para>
|
---|
210 | Do not run the test suite as &root; or some tests will fail
|
---|
211 | unexpectedly and leave some non-FHS-compliant directories in the
|
---|
212 | <filename class='directory'>/usr</filename> hierarchy.
|
---|
213 | </para>
|
---|
214 | </warning>
|
---|
215 |
|
---|
216 | <para>
|
---|
217 | To test the results, after having installed the package, issue:
|
---|
218 | <command>LC_ALL=C ninja test</command> as a non-&root; user.
|
---|
219 | <!-- https://gitlab.gnome.org/GNOME/glib/-/issues/2965
|
---|
220 | Fixed for 2.78, but NOT any 2.76.x patch releases.
|
---|
221 | PLEASE DO NOT REMOVE UNLESS YOU'VE TESTED WITH COREUTILS 9.2 OR
|
---|
222 | LATER! -->
|
---|
223 | One test named <literal>glib:gio / file</literal> is known to fail.
|
---|
224 | </para>
|
---|
225 | </sect2>
|
---|
226 |
|
---|
227 | <sect2 role="commands">
|
---|
228 | <title>Command Explanations</title>
|
---|
229 |
|
---|
230 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
231 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
232 |
|
---|
233 | <para>
|
---|
234 | <parameter>-Dman=true</parameter>: This switch causes the
|
---|
235 | build to create and install the package man pages.
|
---|
236 | </para>
|
---|
237 |
|
---|
238 | <para>
|
---|
239 | <option>-Dgtk_doc=true</option>: This switch causes the
|
---|
240 | build to create and install the API documentation.
|
---|
241 | </para>
|
---|
242 |
|
---|
243 | </sect2>
|
---|
244 |
|
---|
245 | <sect2 role="content">
|
---|
246 | <title>Contents</title>
|
---|
247 |
|
---|
248 | <segmentedlist>
|
---|
249 | <segtitle>Installed Programs</segtitle>
|
---|
250 | <segtitle>Installed Libraries</segtitle>
|
---|
251 | <segtitle>Installed Directories</segtitle>
|
---|
252 |
|
---|
253 | <seglistitem>
|
---|
254 | <seg>
|
---|
255 | gapplication, gdbus, gdbus-codegen,
|
---|
256 | gio, gio-querymodules,
|
---|
257 | glib-compile-resources, glib-compile-schemas,
|
---|
258 | glib-genmarshal, glib-gettextize,
|
---|
259 | glib-mkenums, gobject-query,
|
---|
260 | gresource, gsettings,
|
---|
261 | gtester, and gtester-report
|
---|
262 | </seg>
|
---|
263 | <seg>
|
---|
264 | libgio-2.0.so,
|
---|
265 | libglib-2.0.so,
|
---|
266 | libgmodule-2.0.so,
|
---|
267 | libgobject-2.0.so, and
|
---|
268 | libgthread-2.0.so
|
---|
269 | </seg>
|
---|
270 | <seg>
|
---|
271 | /usr/include/gio-unix-2.0,
|
---|
272 | /usr/include/glib-2.0,
|
---|
273 | /usr/lib/gio,
|
---|
274 | /usr/lib/glib-2.0,
|
---|
275 | /usr/share/glib-2.0,
|
---|
276 | /usr/share/doc/{glib-2.0,glib-&glib2-version;}, and
|
---|
277 | /usr/share/gtk-doc/html/{gio,glib,gobject} (optional)
|
---|
278 | </seg>
|
---|
279 | </seglistitem>
|
---|
280 | </segmentedlist>
|
---|
281 |
|
---|
282 | <variablelist>
|
---|
283 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
284 | <?dbfo list-presentation="list"?>
|
---|
285 | <?dbhtml list-presentation="table"?>
|
---|
286 |
|
---|
287 | <varlistentry id="gapplication">
|
---|
288 | <term><command>gapplication</command></term>
|
---|
289 | <listitem>
|
---|
290 | <para>
|
---|
291 | can be used to start applications and to send
|
---|
292 | messages to already-running instances of other applications
|
---|
293 | </para>
|
---|
294 | <indexterm zone="glib2 gapplication">
|
---|
295 | <primary sortas="b-gapplication">application</primary>
|
---|
296 | </indexterm>
|
---|
297 | </listitem>
|
---|
298 | </varlistentry>
|
---|
299 | <varlistentry id="gdbus">
|
---|
300 | <term><command>gdbus</command></term>
|
---|
301 | <listitem>
|
---|
302 | <para>
|
---|
303 | is a simple tool used for working with
|
---|
304 | <application>D-Bus</application> objects
|
---|
305 | </para>
|
---|
306 | <indexterm zone="glib2 gdbus">
|
---|
307 | <primary sortas="b-gdbus">gdbus</primary>
|
---|
308 | </indexterm>
|
---|
309 | </listitem>
|
---|
310 | </varlistentry>
|
---|
311 |
|
---|
312 | <varlistentry id="gdbus-codegen">
|
---|
313 | <term><command>gdbus-codegen</command></term>
|
---|
314 | <listitem>
|
---|
315 | <para>
|
---|
316 | is used to generate code and/or documentation for one or
|
---|
317 | more <application>D-Bus</application> interfaces
|
---|
318 | </para>
|
---|
319 | <indexterm zone="glib2 gdbus-codegen">
|
---|
320 | <primary sortas="b-gdbus-codegen">gdbus-codegen</primary>
|
---|
321 | </indexterm>
|
---|
322 | </listitem>
|
---|
323 | </varlistentry>
|
---|
324 |
|
---|
325 | <varlistentry id="gio">
|
---|
326 | <term><command>gio</command></term>
|
---|
327 | <listitem>
|
---|
328 | <para>
|
---|
329 | is a utility that makes many <application>GIO</application>
|
---|
330 | features available from the command line
|
---|
331 | </para>
|
---|
332 | <indexterm zone="glib2 gio">
|
---|
333 | <primary sortas="b-gio">gio</primary>
|
---|
334 | </indexterm>
|
---|
335 | </listitem>
|
---|
336 | </varlistentry>
|
---|
337 |
|
---|
338 | <varlistentry id="gio-querymodules">
|
---|
339 | <term><command>gio-querymodules</command></term>
|
---|
340 | <listitem>
|
---|
341 | <para>
|
---|
342 | is used to create a <filename>giomodule.cache</filename> file in
|
---|
343 | the listed directories. This file lists the implemented extension
|
---|
344 | points for each module that has been found
|
---|
345 | </para>
|
---|
346 | <indexterm zone="glib2 gio-querymodules">
|
---|
347 | <primary sortas="b-gio-querymodules">gio-querymodules</primary>
|
---|
348 | </indexterm>
|
---|
349 | </listitem>
|
---|
350 | </varlistentry>
|
---|
351 |
|
---|
352 | <varlistentry id="glib-compile-resources">
|
---|
353 | <term><command>glib-compile-resources</command></term>
|
---|
354 | <listitem>
|
---|
355 | <para>
|
---|
356 | is used to read the resource description from a file and
|
---|
357 | the files that it references to create a binary resource
|
---|
358 | bundle that is suitable for use with the GResource API
|
---|
359 | </para>
|
---|
360 | <indexterm zone="glib2 glib-compile-resources">
|
---|
361 | <primary sortas="b-glib-compile-resources">glib-compile-resources</primary>
|
---|
362 | </indexterm>
|
---|
363 | </listitem>
|
---|
364 | </varlistentry>
|
---|
365 |
|
---|
366 | <varlistentry id="glib-compile-schemas">
|
---|
367 | <term><command>glib-compile-schemas</command></term>
|
---|
368 | <listitem>
|
---|
369 | <para>
|
---|
370 | is used to compile all the GSettings XML schema files
|
---|
371 | in a directory into a binary file with the name
|
---|
372 | <filename>gschemas.compiled</filename> that can be used by GSettings
|
---|
373 | </para>
|
---|
374 | <indexterm zone="glib2 glib-compile-schemas">
|
---|
375 | <primary sortas="b-glib-compile-resources">glib-compile-schemas</primary>
|
---|
376 | </indexterm>
|
---|
377 | </listitem>
|
---|
378 | </varlistentry>
|
---|
379 |
|
---|
380 | <varlistentry id="glib-genmarshal">
|
---|
381 | <term><command>glib-genmarshal</command></term>
|
---|
382 | <listitem>
|
---|
383 | <para>
|
---|
384 | is a C code marshaller generation utility for GLib closures
|
---|
385 | </para>
|
---|
386 | <indexterm zone="glib2 glib-genmarshal">
|
---|
387 | <primary sortas="b-glib-genmarshal">glib-genmarshal</primary>
|
---|
388 | </indexterm>
|
---|
389 | </listitem>
|
---|
390 | </varlistentry>
|
---|
391 |
|
---|
392 | <varlistentry id="glib-gettextize">
|
---|
393 | <term><command>glib-gettextize</command></term>
|
---|
394 | <listitem>
|
---|
395 | <para>
|
---|
396 | is a variant of the <application>gettext</application>
|
---|
397 | internationalization utility
|
---|
398 | </para>
|
---|
399 | <indexterm zone="glib2 glib-gettextize">
|
---|
400 | <primary sortas="b-glib-gettextize">glib-gettextize</primary>
|
---|
401 | </indexterm>
|
---|
402 | </listitem>
|
---|
403 | </varlistentry>
|
---|
404 |
|
---|
405 | <varlistentry id="glib-mkenums">
|
---|
406 | <term><command>glib-mkenums</command></term>
|
---|
407 | <listitem>
|
---|
408 | <para>
|
---|
409 | is a C language enum description generation utility
|
---|
410 | </para>
|
---|
411 | <indexterm zone="glib2 glib-mkenums">
|
---|
412 | <primary sortas="b-glib-mkenums">glib-mkenums</primary>
|
---|
413 | </indexterm>
|
---|
414 | </listitem>
|
---|
415 | </varlistentry>
|
---|
416 |
|
---|
417 | <varlistentry id="gobject-query">
|
---|
418 | <term><command>gobject-query</command></term>
|
---|
419 | <listitem>
|
---|
420 | <para>
|
---|
421 | is a small utility that draws a tree of types
|
---|
422 | </para>
|
---|
423 | <indexterm zone="glib2 gobject-query">
|
---|
424 | <primary sortas="b-gobject-query">gobject-query</primary>
|
---|
425 | </indexterm>
|
---|
426 | </listitem>
|
---|
427 | </varlistentry>
|
---|
428 |
|
---|
429 | <varlistentry id="gresource">
|
---|
430 | <term><command>gresource</command></term>
|
---|
431 | <listitem>
|
---|
432 | <para>
|
---|
433 | offers a simple command line interface to GResource
|
---|
434 | </para>
|
---|
435 | <indexterm zone="glib2 gresource">
|
---|
436 | <primary sortas="b-gresource">gresource</primary>
|
---|
437 | </indexterm>
|
---|
438 | </listitem>
|
---|
439 | </varlistentry>
|
---|
440 |
|
---|
441 | <varlistentry id="gsettings">
|
---|
442 | <term><command>gsettings</command></term>
|
---|
443 | <listitem>
|
---|
444 | <para>
|
---|
445 | offers a simple command line interface to GSettings
|
---|
446 | </para>
|
---|
447 | <indexterm zone="glib2 gsettings">
|
---|
448 | <primary sortas="b-gsettings">gsettings</primary>
|
---|
449 | </indexterm>
|
---|
450 | </listitem>
|
---|
451 | </varlistentry>
|
---|
452 |
|
---|
453 | <varlistentry id="gtester">
|
---|
454 | <term><command>gtester</command></term>
|
---|
455 | <listitem>
|
---|
456 | <para>
|
---|
457 | is a test running utility
|
---|
458 | </para>
|
---|
459 | <indexterm zone="glib2 gtester">
|
---|
460 | <primary sortas="b-gtester">gtester</primary>
|
---|
461 | </indexterm>
|
---|
462 | </listitem>
|
---|
463 | </varlistentry>
|
---|
464 |
|
---|
465 | <varlistentry id="gtester-report">
|
---|
466 | <term><command>gtester-report</command></term>
|
---|
467 | <listitem>
|
---|
468 | <para>
|
---|
469 | is a test report formatting utility
|
---|
470 | </para>
|
---|
471 | <indexterm zone="glib2 gtester-report">
|
---|
472 | <primary sortas="b-gtester-report">gtester-report</primary>
|
---|
473 | </indexterm>
|
---|
474 | </listitem>
|
---|
475 | </varlistentry>
|
---|
476 |
|
---|
477 | <varlistentry id="GLib-libraries">
|
---|
478 | <term>GLib libraries</term>
|
---|
479 | <listitem>
|
---|
480 | <para>
|
---|
481 | contain low-level core libraries for the
|
---|
482 | <application>GIMP</application> Toolkit
|
---|
483 | </para>
|
---|
484 | <indexterm zone="glib2 GLib-libraries">
|
---|
485 | <primary sortas="c-GLib-libraries">Glib libraries</primary>
|
---|
486 | </indexterm>
|
---|
487 | </listitem>
|
---|
488 | </varlistentry>
|
---|
489 |
|
---|
490 | </variablelist>
|
---|
491 |
|
---|
492 | </sect2>
|
---|
493 |
|
---|
494 | </sect1>
|
---|