source: general/genlib/glib2.xml@ a6a7db1

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

glib2: trivial commit, just remove an extra period that was bugging me

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