source: general/genlib/glib2.xml@ 91318eb

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 91318eb was 91318eb, checked in by Pierre Labastie <pierre.labastie@…>, 14 months ago

Add "setup" to meson commands

I've not been very consistent on typography, but it is a start

  • Property mode set to 100644
File size: 16.1 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 "38f81d4a06c03e667b1f4d73cb803da8">
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 &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 <!-- https://gitlab.gnome.org/GNOME/glib/-/issues/2913 -->
223 One test named <filename>glib:glib / error</filename> 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/glib-2.0,
274 /usr/share/glib-2.0,
275 /usr/share/doc/glib-&glib2-version;, and
276 /usr/share/gtk-doc/html/{gio,glib,gobject} (optional)
277 </seg>
278 </seglistitem>
279 </segmentedlist>
280
281 <variablelist>
282 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
283 <?dbfo list-presentation="list"?>
284 <?dbhtml list-presentation="table"?>
285
286 <varlistentry id="gapplication">
287 <term><command>gapplication</command></term>
288 <listitem>
289 <para>
290 can be used to start applications and to send
291 messages to already-running instances of other applications
292 </para>
293 <indexterm zone="glib2 gapplication">
294 <primary sortas="b-gapplication">application</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298 <varlistentry id="gdbus">
299 <term><command>gdbus</command></term>
300 <listitem>
301 <para>
302 is a simple tool used for working with
303 <application>D-Bus</application> objects
304 </para>
305 <indexterm zone="glib2 gdbus">
306 <primary sortas="b-gdbus">gdbus</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="gdbus-codegen">
312 <term><command>gdbus-codegen</command></term>
313 <listitem>
314 <para>
315 is used to generate code and/or documentation for one or
316 more <application>D-Bus</application> interfaces
317 </para>
318 <indexterm zone="glib2 gdbus-codegen">
319 <primary sortas="b-gdbus-codegen">gdbus-codegen</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 <varlistentry id="gio">
325 <term><command>gio</command></term>
326 <listitem>
327 <para>
328 is a utility that makes many <application>GIO</application>
329 features available from the command line
330 </para>
331 <indexterm zone="glib2 gio">
332 <primary sortas="b-gio">gio</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="gio-querymodules">
338 <term><command>gio-querymodules</command></term>
339 <listitem>
340 <para>
341 is used to create a <filename>giomodule.cache</filename> file in
342 the listed directories. This file lists the implemented extension
343 points for each module that has been found
344 </para>
345 <indexterm zone="glib2 gio-querymodules">
346 <primary sortas="b-gio-querymodules">gio-querymodules</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="glib-compile-resources">
352 <term><command>glib-compile-resources</command></term>
353 <listitem>
354 <para>
355 is used to read the resource description from a file and
356 the files that it references to create a binary resource
357 bundle that is suitable for use with the GResource API
358 </para>
359 <indexterm zone="glib2 glib-compile-resources">
360 <primary sortas="b-glib-compile-resources">glib-compile-resources</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="glib-compile-schemas">
366 <term><command>glib-compile-schemas</command></term>
367 <listitem>
368 <para>
369 is used to compile all the GSettings XML schema files
370 in a directory into a binary file with the name
371 <filename>gschemas.compiled</filename> that can be used by GSettings
372 </para>
373 <indexterm zone="glib2 glib-compile-schemas">
374 <primary sortas="b-glib-compile-resources">glib-compile-schemas</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="glib-genmarshal">
380 <term><command>glib-genmarshal</command></term>
381 <listitem>
382 <para>
383 is a C code marshaller generation utility for GLib closures
384 </para>
385 <indexterm zone="glib2 glib-genmarshal">
386 <primary sortas="b-glib-genmarshal">glib-genmarshal</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="glib-gettextize">
392 <term><command>glib-gettextize</command></term>
393 <listitem>
394 <para>
395 is a variant of the <application>gettext</application>
396 internationalization utility
397 </para>
398 <indexterm zone="glib2 glib-gettextize">
399 <primary sortas="b-glib-gettextize">glib-gettextize</primary>
400 </indexterm>
401 </listitem>
402 </varlistentry>
403
404 <varlistentry id="glib-mkenums">
405 <term><command>glib-mkenums</command></term>
406 <listitem>
407 <para>
408 is a C language enum description generation utility
409 </para>
410 <indexterm zone="glib2 glib-mkenums">
411 <primary sortas="b-glib-mkenums">glib-mkenums</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry id="gobject-query">
417 <term><command>gobject-query</command></term>
418 <listitem>
419 <para>
420 is a small utility that draws a tree of types
421 </para>
422 <indexterm zone="glib2 gobject-query">
423 <primary sortas="b-gobject-query">gobject-query</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="gresource">
429 <term><command>gresource</command></term>
430 <listitem>
431 <para>
432 offers a simple command line interface to GResource
433 </para>
434 <indexterm zone="glib2 gresource">
435 <primary sortas="b-gresource">gresource</primary>
436 </indexterm>
437 </listitem>
438 </varlistentry>
439
440 <varlistentry id="gsettings">
441 <term><command>gsettings</command></term>
442 <listitem>
443 <para>
444 offers a simple command line interface to GSettings
445 </para>
446 <indexterm zone="glib2 gsettings">
447 <primary sortas="b-gsettings">gsettings</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry id="gtester">
453 <term><command>gtester</command></term>
454 <listitem>
455 <para>
456 is a test running utility
457 </para>
458 <indexterm zone="glib2 gtester">
459 <primary sortas="b-gtester">gtester</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="gtester-report">
465 <term><command>gtester-report</command></term>
466 <listitem>
467 <para>
468 is a test report formatting utility
469 </para>
470 <indexterm zone="glib2 gtester-report">
471 <primary sortas="b-gtester-report">gtester-report</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="GLib-libraries">
477 <term>GLib libraries</term>
478 <listitem>
479 <para>
480 contain low-level core libraries for the
481 <application>GIMP</application> Toolkit
482 </para>
483 <indexterm zone="glib2 GLib-libraries">
484 <primary sortas="c-GLib-libraries">Glib libraries</primary>
485 </indexterm>
486 </listitem>
487 </varlistentry>
488
489 </variablelist>
490
491 </sect2>
492
493</sect1>
Note: See TracBrowser for help on using the repository browser.