source: general/genlib/glib2.xml@ 2280e49

12.0 12.1 kea ken/TL2024 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 2280e49 was 2280e49, checked in by Bruce Dubbs <bdubbs@…>, 14 months ago

Update to glib-2.76.2.

  • Property mode set to 100644
File size: 16.0 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 "455b94549f2056957fa370a1f14c1662">
10 <!ENTITY glib2-size "5.0 MB">
11 <!ENTITY glib2-buildsize "126 MB (add 9 MB for tests)">
12 <!ENTITY glib2-time "0.5 SBU (add 0.3 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 &lfs113_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 setup .. \
176 --prefix=/usr \
177 --buildtype=release \
178 -Dman=true &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 </para>
223 </sect2>
224
225 <sect2 role="commands">
226 <title>Command Explanations</title>
227
228 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
229 href="../../xincludes/meson-buildtype-release.xml"/>
230
231 <para>
232 <parameter>-Dman=true</parameter>: This switch causes the
233 build to create and install the package man pages.
234 </para>
235
236 <para>
237 <option>-Dgtk_doc=true</option>: This switch causes the
238 build to create and install the API documentation.
239 </para>
240
241 </sect2>
242
243 <sect2 role="content">
244 <title>Contents</title>
245
246 <segmentedlist>
247 <segtitle>Installed Programs</segtitle>
248 <segtitle>Installed Libraries</segtitle>
249 <segtitle>Installed Directories</segtitle>
250
251 <seglistitem>
252 <seg>
253 gapplication, gdbus, gdbus-codegen,
254 gio, gio-querymodules,
255 glib-compile-resources, glib-compile-schemas,
256 glib-genmarshal, glib-gettextize,
257 glib-mkenums, gobject-query,
258 gresource, gsettings,
259 gtester, and gtester-report
260 </seg>
261 <seg>
262 libgio-2.0.so,
263 libglib-2.0.so,
264 libgmodule-2.0.so,
265 libgobject-2.0.so, and
266 libgthread-2.0.so
267 </seg>
268 <seg>
269 /usr/include/gio-unix-2.0,
270 /usr/include/glib-2.0,
271 /usr/lib/gio,
272 /usr/lib/glib-2.0,
273 /usr/share/glib-2.0,
274 /usr/share/doc/glib-&glib2-version;, and
275 /usr/share/gtk-doc/html/{gio,glib,gobject} (optional)
276 </seg>
277 </seglistitem>
278 </segmentedlist>
279
280 <variablelist>
281 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
282 <?dbfo list-presentation="list"?>
283 <?dbhtml list-presentation="table"?>
284
285 <varlistentry id="gapplication">
286 <term><command>gapplication</command></term>
287 <listitem>
288 <para>
289 can be used to start applications and to send
290 messages to already-running instances of other applications
291 </para>
292 <indexterm zone="glib2 gapplication">
293 <primary sortas="b-gapplication">application</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297 <varlistentry id="gdbus">
298 <term><command>gdbus</command></term>
299 <listitem>
300 <para>
301 is a simple tool used for working with
302 <application>D-Bus</application> objects
303 </para>
304 <indexterm zone="glib2 gdbus">
305 <primary sortas="b-gdbus">gdbus</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="gdbus-codegen">
311 <term><command>gdbus-codegen</command></term>
312 <listitem>
313 <para>
314 is used to generate code and/or documentation for one or
315 more <application>D-Bus</application> interfaces
316 </para>
317 <indexterm zone="glib2 gdbus-codegen">
318 <primary sortas="b-gdbus-codegen">gdbus-codegen</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="gio">
324 <term><command>gio</command></term>
325 <listitem>
326 <para>
327 is a utility that makes many <application>GIO</application>
328 features available from the command line
329 </para>
330 <indexterm zone="glib2 gio">
331 <primary sortas="b-gio">gio</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="gio-querymodules">
337 <term><command>gio-querymodules</command></term>
338 <listitem>
339 <para>
340 is used to create a <filename>giomodule.cache</filename> file in
341 the listed directories. This file lists the implemented extension
342 points for each module that has been found
343 </para>
344 <indexterm zone="glib2 gio-querymodules">
345 <primary sortas="b-gio-querymodules">gio-querymodules</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="glib-compile-resources">
351 <term><command>glib-compile-resources</command></term>
352 <listitem>
353 <para>
354 is used to read the resource description from a file and
355 the files that it references to create a binary resource
356 bundle that is suitable for use with the GResource API
357 </para>
358 <indexterm zone="glib2 glib-compile-resources">
359 <primary sortas="b-glib-compile-resources">glib-compile-resources</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="glib-compile-schemas">
365 <term><command>glib-compile-schemas</command></term>
366 <listitem>
367 <para>
368 is used to compile all the GSettings XML schema files
369 in a directory into a binary file with the name
370 <filename>gschemas.compiled</filename> that can be used by GSettings
371 </para>
372 <indexterm zone="glib2 glib-compile-schemas">
373 <primary sortas="b-glib-compile-resources">glib-compile-schemas</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="glib-genmarshal">
379 <term><command>glib-genmarshal</command></term>
380 <listitem>
381 <para>
382 is a C code marshaller generation utility for GLib closures
383 </para>
384 <indexterm zone="glib2 glib-genmarshal">
385 <primary sortas="b-glib-genmarshal">glib-genmarshal</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="glib-gettextize">
391 <term><command>glib-gettextize</command></term>
392 <listitem>
393 <para>
394 is a variant of the <application>gettext</application>
395 internationalization utility
396 </para>
397 <indexterm zone="glib2 glib-gettextize">
398 <primary sortas="b-glib-gettextize">glib-gettextize</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry id="glib-mkenums">
404 <term><command>glib-mkenums</command></term>
405 <listitem>
406 <para>
407 is a C language enum description generation utility
408 </para>
409 <indexterm zone="glib2 glib-mkenums">
410 <primary sortas="b-glib-mkenums">glib-mkenums</primary>
411 </indexterm>
412 </listitem>
413 </varlistentry>
414
415 <varlistentry id="gobject-query">
416 <term><command>gobject-query</command></term>
417 <listitem>
418 <para>
419 is a small utility that draws a tree of types
420 </para>
421 <indexterm zone="glib2 gobject-query">
422 <primary sortas="b-gobject-query">gobject-query</primary>
423 </indexterm>
424 </listitem>
425 </varlistentry>
426
427 <varlistentry id="gresource">
428 <term><command>gresource</command></term>
429 <listitem>
430 <para>
431 offers a simple command line interface to GResource
432 </para>
433 <indexterm zone="glib2 gresource">
434 <primary sortas="b-gresource">gresource</primary>
435 </indexterm>
436 </listitem>
437 </varlistentry>
438
439 <varlistentry id="gsettings">
440 <term><command>gsettings</command></term>
441 <listitem>
442 <para>
443 offers a simple command line interface to GSettings
444 </para>
445 <indexterm zone="glib2 gsettings">
446 <primary sortas="b-gsettings">gsettings</primary>
447 </indexterm>
448 </listitem>
449 </varlistentry>
450
451 <varlistentry id="gtester">
452 <term><command>gtester</command></term>
453 <listitem>
454 <para>
455 is a test running utility
456 </para>
457 <indexterm zone="glib2 gtester">
458 <primary sortas="b-gtester">gtester</primary>
459 </indexterm>
460 </listitem>
461 </varlistentry>
462
463 <varlistentry id="gtester-report">
464 <term><command>gtester-report</command></term>
465 <listitem>
466 <para>
467 is a test report formatting utility
468 </para>
469 <indexterm zone="glib2 gtester-report">
470 <primary sortas="b-gtester-report">gtester-report</primary>
471 </indexterm>
472 </listitem>
473 </varlistentry>
474
475 <varlistentry id="GLib-libraries">
476 <term>GLib libraries</term>
477 <listitem>
478 <para>
479 contain low-level core libraries for the
480 <application>GIMP</application> Toolkit
481 </para>
482 <indexterm zone="glib2 GLib-libraries">
483 <primary sortas="c-GLib-libraries">Glib libraries</primary>
484 </indexterm>
485 </listitem>
486 </varlistentry>
487
488 </variablelist>
489
490 </sect2>
491
492</sect1>
Note: See TracBrowser for help on using the repository browser.