source: general/genlib/glib2.xml@ 337ef48

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 337ef48 was 337ef48, checked in by Bruce Dubbs <bdubbs@…>, 15 months ago

Update to glib-2.74.5.

  • Property mode set to 100644
File size: 17.2 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 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 "7561501d9f63f3418ddb23d2903cc968">
10 <!ENTITY glib2-size "5.0 MB">
11 <!ENTITY glib2-buildsize "122 MB (add 8 MB for tests)">
12 <!ENTITY glib2-time "0.5 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 &lfs112_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-&glib2-version;-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 <para condition="html" role="usernotes">User Notes:
121 <ulink url="&blfs-wiki;/glib2"/>
122 </para>
123 </sect2>
124
125 <sect2 role="installation">
126 <title>Installation of GLib</title>
127
128 <para>
129 If desired, apply the optional patch. In many cases, applications that
130 use this library, either directly or indirectly via other libraries such
131 as <xref linkend="gtk3"/>, output numerous warnings when run from the
132 command line. This patch enables the use of an environment variable,
133 <envar>GLIB_LOG_LEVEL</envar>, that suppresses unwanted messages. The
134 value of the variable is a digit that corresponds to:
135 </para>
136
137 <simplelist>
138 <member>1 Alert</member>
139 <member>2 Critical</member>
140 <member>3 Error</member>
141 <member>4 Warning</member>
142 <member>5 Notice</member>
143 </simplelist>
144
145 <para>
146 For instance <userinput>export GLIB_LOG_LEVEL=4</userinput> will skip
147 output of Warning and Notice messages (and Info/Debug messages if they
148 are turned on). If <envar>GLIB_LOG_LEVEL</envar> is not defined, normal
149 message output will not be affected.
150 </para>
151
152<screen><userinput>patch -Np1 -i ../glib-&glib2-version;-skip_warnings-1.patch</userinput></screen>
153
154 <warning>
155 <para>
156 If a previous version of glib is installed, move the headers out of the
157 way so that later packages do not encounter conflicts:
158 </para>
159
160<screen role="root"><userinput remap="pre">if [ -e /usr/include/glib-2.0 ]; then
161 rm -rf /usr/include/glib-2.0.old &amp;&amp;
162 mv -vf /usr/include/glib-2.0{,.old}
163fi</userinput></screen>
164
165 </warning>
166
167 <para>
168 Install <application>GLib</application> by running the following
169 commands:
170 </para>
171
172<screen><userinput>mkdir build &amp;&amp;
173cd build &amp;&amp;
174
175meson --prefix=/usr \
176 --buildtype=release \
177 -Dman=true \
178 .. &amp;&amp;
179ninja</userinput></screen>
180
181 <note><para>
182 If <xref linkend="libxslt"/> is installed, the above command may
183 indicate several (about 33) errors that start with "Error: no ID for
184 constraint linkend:" when generating the man pages. These are harmless.
185 </para></note>
186
187 <para>
188 The <application>GLib</application> test suite requires
189 <application>desktop-file-utils</application> for some tests. However,
190 <application>desktop-file-utils</application> requires
191 <application>GLib</application> in order to compile; therefore, you must
192 first install <application>GLib</application> and then run the test
193 suite.
194 </para>
195
196 <para>
197 Now, as the <systemitem class="username">root</systemitem> user:
198 </para>
199
200<screen role="root"><userinput>ninja install &amp;&amp;
201
202mkdir -p /usr/share/doc/glib-&glib2-version; &amp;&amp;
203cp -r ../docs/reference/{gio,glib,gobject} /usr/share/doc/glib-&glib2-version;</userinput></screen>
204
205 <para>
206 You should now install <xref linkend="desktop-file-utils"/> and
207 <xref linkend="shared-mime-info"/> and proceed to
208 run the test suite.
209 </para>
210
211 <warning>
212 <para>
213 Do not run the test suite as &root; or some tests will fail
214 unexpectedly and leave some non-FHS-compliant directories in the
215 <filename class='directory'>/usr</filename> hierarchy.
216 </para>
217 </warning>
218
219 <para>
220 To test the results, after having installed the package, issue:
221 <command>LC_ALL=C ninja test</command> as a non-&root; user.
222 <!-- glib issue #1954: -->
223 <!-- One test named gdbus-server-auth sometimes fails.-->
224 <!-- SysV has the symlink now, so gdatetime no longer fails.-->
225 <!-- Needs /etc/localtime to be a symbolic link. In addition
226 the link must be to some place like /usr/share/zoneinfo/...
227
228 This can be overcome if the line below in glib/tests/gdatetime.c
229 is removed or commented out.
230 g_assert_true (*g_time_zone_get_identifier (tz) != '/');
231
232 NOTE: systemd implements this as a hard requirement. -->
233 <!-- one test, g-file-info-filesystem-readonly.c, needs both
234 bindfs and fusermount. With fuse3, you need to either create
235 a fusermount->fusermount3 symlink or alter the source of the
236 test so that fusermount3 is seeked and used. bindfs can be
237 built against fuse3. The test is skipped if the dependencies
238 are not found, and reported to pass.-->
239 <!-- with 2.64.1 on sysV, all tests pass. -->
240 <!-- with 2.70.1 on sysV, all tests pass. -->
241 <!-- with 2.70.2 on sysV, all tests pass. -->
242 <!-- with 2.72.3 on sysV, all tests pass. [pierre, July 2022] -->
243 <!-- with 2.74.0 on sysV, all tests pass. [bdubbs, Sep 2022] -->
244 <!-- with 2.74.3 on sysV, all tests pass. [pierre, Dec 2022] -->
245 </para>
246 </sect2>
247
248 <sect2 role="commands">
249 <title>Command Explanations</title>
250
251 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
252 href="../../xincludes/meson-buildtype-release.xml"/>
253
254 <para>
255 <parameter>-Dman=true</parameter>: This switch causes the
256 build to create and install the package man pages.
257 </para>
258
259 <para>
260 <option>-Dgtk_doc=true</option>: This switch causes the
261 build to create and install the API documentation.
262 </para>
263
264 </sect2>
265
266 <sect2 role="content">
267 <title>Contents</title>
268
269 <segmentedlist>
270 <segtitle>Installed Programs</segtitle>
271 <segtitle>Installed Libraries</segtitle>
272 <segtitle>Installed Directories</segtitle>
273
274 <seglistitem>
275 <seg>
276 gapplication, gdbus, gdbus-codegen,
277 gio, gio-querymodules,
278 glib-compile-resources, glib-compile-schemas,
279 glib-genmarshal, glib-gettextize,
280 glib-mkenums, gobject-query,
281 gresource, gsettings,
282 gtester, and gtester-report
283 </seg>
284 <seg>
285 libgio-2.0.so,
286 libglib-2.0.so,
287 libgmodule-2.0.so,
288 libgobject-2.0.so, and
289 libgthread-2.0.so
290 </seg>
291 <seg>
292 /usr/include/gio-unix-2.0,
293 /usr/include/glib-2.0,
294 /usr/lib/glib-2.0,
295 /usr/share/glib-2.0,
296 /usr/share/doc/glib-&glib2-version;, and
297 /usr/share/gtk-doc/html/{gio,glib,gobject} (optional)
298 </seg>
299 </seglistitem>
300 </segmentedlist>
301
302 <variablelist>
303 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
304 <?dbfo list-presentation="list"?>
305 <?dbhtml list-presentation="table"?>
306
307 <varlistentry id="gapplication">
308 <term><command>gapplication</command></term>
309 <listitem>
310 <para>
311 can be used to start applications and to send
312 messages to already-running instances of other applications
313 </para>
314 <indexterm zone="glib2 gapplication">
315 <primary sortas="b-gapplication">application</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319 <varlistentry id="gdbus">
320 <term><command>gdbus</command></term>
321 <listitem>
322 <para>
323 is a simple tool used for working with
324 <application>D-Bus</application> objects
325 </para>
326 <indexterm zone="glib2 gdbus">
327 <primary sortas="b-gdbus">gdbus</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="gdbus-codegen">
333 <term><command>gdbus-codegen</command></term>
334 <listitem>
335 <para>
336 is used to generate code and/or documentation for one or
337 more <application>D-Bus</application> interfaces
338 </para>
339 <indexterm zone="glib2 gdbus-codegen">
340 <primary sortas="b-gdbus-codegen">gdbus-codegen</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="gio">
346 <term><command>gio</command></term>
347 <listitem>
348 <para>
349 is a utility that makes many <application>GIO</application>
350 features available from the command line
351 </para>
352 <indexterm zone="glib2 gio">
353 <primary sortas="b-gio">gio</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="gio-querymodules">
359 <term><command>gio-querymodules</command></term>
360 <listitem>
361 <para>
362 is used to create a <filename>giomodule.cache</filename> file in
363 the listed directories. This file lists the implemented extension
364 points for each module that has been found
365 </para>
366 <indexterm zone="glib2 gio-querymodules">
367 <primary sortas="b-gio-querymodules">gio-querymodules</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="glib-compile-resources">
373 <term><command>glib-compile-resources</command></term>
374 <listitem>
375 <para>
376 is used to read the resource description from a file and
377 the files that it references to create a binary resource
378 bundle that is suitable for use with the GResource API
379 </para>
380 <indexterm zone="glib2 glib-compile-resources">
381 <primary sortas="b-glib-compile-resources">glib-compile-resources</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="glib-compile-schemas">
387 <term><command>glib-compile-schemas</command></term>
388 <listitem>
389 <para>
390 is used to compile all the GSettings XML schema files
391 in a directory into a binary file with the name
392 <filename>gschemas.compiled</filename> that can be used by GSettings
393 </para>
394 <indexterm zone="glib2 glib-compile-schemas">
395 <primary sortas="b-glib-compile-resources">glib-compile-schemas</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="glib-genmarshal">
401 <term><command>glib-genmarshal</command></term>
402 <listitem>
403 <para>
404 is a C code marshaller generation utility for GLib closures
405 </para>
406 <indexterm zone="glib2 glib-genmarshal">
407 <primary sortas="b-glib-genmarshal">glib-genmarshal</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="glib-gettextize">
413 <term><command>glib-gettextize</command></term>
414 <listitem>
415 <para>
416 is a variant of the <application>gettext</application>
417 internationalization utility
418 </para>
419 <indexterm zone="glib2 glib-gettextize">
420 <primary sortas="b-glib-gettextize">glib-gettextize</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424
425 <varlistentry id="glib-mkenums">
426 <term><command>glib-mkenums</command></term>
427 <listitem>
428 <para>
429 is a C language enum description generation utility
430 </para>
431 <indexterm zone="glib2 glib-mkenums">
432 <primary sortas="b-glib-mkenums">glib-mkenums</primary>
433 </indexterm>
434 </listitem>
435 </varlistentry>
436
437 <varlistentry id="gobject-query">
438 <term><command>gobject-query</command></term>
439 <listitem>
440 <para>
441 is a small utility that draws a tree of types
442 </para>
443 <indexterm zone="glib2 gobject-query">
444 <primary sortas="b-gobject-query">gobject-query</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="gresource">
450 <term><command>gresource</command></term>
451 <listitem>
452 <para>
453 offers a simple command line interface to GResource
454 </para>
455 <indexterm zone="glib2 gresource">
456 <primary sortas="b-gresource">gresource</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="gsettings">
462 <term><command>gsettings</command></term>
463 <listitem>
464 <para>
465 offers a simple command line interface to GSettings
466 </para>
467 <indexterm zone="glib2 gsettings">
468 <primary sortas="b-gsettings">gsettings</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="gtester">
474 <term><command>gtester</command></term>
475 <listitem>
476 <para>
477 is a test running utility
478 </para>
479 <indexterm zone="glib2 gtester">
480 <primary sortas="b-gtester">gtester</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry id="gtester-report">
486 <term><command>gtester-report</command></term>
487 <listitem>
488 <para>
489 is a test report formatting utility
490 </para>
491 <indexterm zone="glib2 gtester-report">
492 <primary sortas="b-gtester-report">gtester-report</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 <varlistentry id="GLib-libraries">
498 <term>GLib libraries</term>
499 <listitem>
500 <para>
501 contain low-level core libraries for the
502 <application>GIMP</application> Toolkit
503 </para>
504 <indexterm zone="glib2 GLib-libraries">
505 <primary sortas="c-GLib-libraries">Glib libraries</primary>
506 </indexterm>
507 </listitem>
508 </varlistentry>
509
510 </variablelist>
511
512 </sect2>
513
514</sect1>
Note: See TracBrowser for help on using the repository browser.