source: general/genlib/glib2.xml@ ad240ea0

11.0 qt5new trunk
Last change on this file since ad240ea0 was ad240ea0, checked in by Bruce Dubbs <bdubbs@…>, 4 months ago

Update to glib-2.68.2

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