source: general/genlib/glib2.xml@ 06a9f57

10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 06a9f57 was 1a27983, checked in by Douglas R. Reno <renodr@…>, 4 years ago

Mention the correct switch for gtk-doc in glib2

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23735 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 16.3 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 "5fbccd13eba61294a3e6ba01bb2f9b83">
10 <!ENTITY glib2-size "4.6 MB">
11 <!ENTITY glib2-buildsize "205 MB (add 5 MB for tests)">
12 <!ENTITY glib2-time "0.6 SBU (add 0.9 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 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>GLib-&glib2-version;</title>
24
25 <indexterm zone="glib2">
26 <primary sortas="a-GLib2">GLib2</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to GLib</title>
31
32 <para>
33 The <application>GLib</application> package contains low-level
34 libraries useful for providing data structure handling for C, portability
35 wrappers and interfaces for such runtime functionality as an
36 event loop, threads, dynamic loading and an object system.
37 </para>
38
39 &lfs10_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&glib2-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&glib2-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &glib2-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &glib2-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &glib2-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &glib2-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
76 <itemizedlist spacing="compact">
77 <listitem>
78 <para>
79 Optional patch:
80 <ulink url="&patch-root;/glib-&glib2-version;-skip_warnings-1.patch"/>
81 </para>
82 </listitem>
83 </itemizedlist>
84
85 <bridgehead renderas="sect3">GLib Dependencies</bridgehead>
86
87 <bridgehead renderas="sect4">Recommended</bridgehead>
88 <para role="recommended">
89 <xref linkend="libxslt"/> and
90 <xref linkend="pcre"/> (built with Unicode properties)
91 </para>
92
93 <bridgehead renderas="sect4">Optional</bridgehead>
94 <para role="optional">
95 <xref linkend="dbus"/> and
96 <ulink url="https://bindfs.org/">bindfs</ulink>
97 (both may be used in some tests),
98 <xref linkend="gdb"/> (for bindings),
99 <xref linkend="DocBook"/>,
100 <xref linkend="docbook-xsl"/>,
101 <xref linkend="gtk-doc"/> (to build API documentation), and
102 <xref linkend="glib-networking"/> (for some tests, but this is a circular
103 dependency)
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><userinput remap="pre">[ -e /usr/include/glib-2.0 ] &amp;&amp; mv -vf /usr/include/glib-2.0{,.old}</userinput></screen>
163
164 </warning>
165
166 <para>
167 Install <application>GLib</application> by running the following
168 commands:
169 </para>
170
171<screen><userinput>mkdir build &amp;&amp;
172cd build &amp;&amp;
173
174meson --prefix=/usr \
175 -Dman=true \
176 -Dselinux=disabled \
177 .. &amp;&amp;
178ninja</userinput></screen>
179
180 <note><para>
181 If <xref linkend="libxslt"/> is installed, the above command may
182 indicate several (about 33) errors that start with "Error: no ID for
183 constraint linkend:" when gnerating the man pages. These are harmless.
184 </para></note>
185
186 <para>
187 The <application>GLib</application> test suite requires
188 <application>desktop-file-utils</application> for some tests. However,
189 <application>desktop-file-utils</application> requires
190 <application>GLib</application> in order to compile; therefore, you must
191 first install <application>GLib</application> and then run the test
192 suite.
193 </para>
194
195 <para>
196 Now, as the <systemitem class="username">root</systemitem> user:
197 </para>
198
199<screen role="root"><userinput>ninja install &amp;&amp;
200
201mkdir -p /usr/share/doc/glib-&glib2-version; &amp;&amp;
202cp -r ../docs/reference/{NEWS,gio,glib,gobject} /usr/share/doc/glib-&glib2-version;</userinput></screen>
203
204 <para>
205 You should now install <xref linkend="desktop-file-utils"/> and
206 <xref linkend="shared-mime-info"/> and proceed to
207 run the test suite.
208 </para>
209
210 <para>
211 To test the results, after having installed the package, issue:
212 <command>ninja test</command>.
213 <!-- glib issue #1954: -->
214 <!-- One test named gdbus-server-auth sometimes fails.-->
215 <!-- SysV has the symlink now, so gdatetime no longer fails.-->
216 <!-- Needs /etc/localtime to be a symbolic link. In addition
217 the link must be to some place like /usr/share/zoneinfo/...
218
219 This can be overcome if the line below in glib/tests/gdatetime.c
220 is removed or commented out.
221 g_assert_true (*g_time_zone_get_identifier (tz) != '/');
222
223 NOTE: systemd implements this as a hard requirement. -->
224 <!-- with 2.60.4 on systemd, all tests pass. -->
225 <!-- with 2.64.1 on sysV, all tests pass. -->
226 </para>
227
228 </sect2>
229
230 <sect2 role="commands">
231 <title>Command Explanations</title>
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 <parameter>-Dselinux=disabled</parameter>: This switch disables
240 support for selinux which is not supported in BLFS.
241 </para>
242
243 <para>
244 <option>-Dgtk_doc=true</option>: This switch causes the
245 build to create and install the API documentation.
246 </para>
247
248 </sect2>
249
250 <sect2 role="content">
251 <title>Contents</title>
252
253 <segmentedlist>
254 <segtitle>Installed Programs</segtitle>
255 <segtitle>Installed Libraries</segtitle>
256 <segtitle>Installed Directories</segtitle>
257
258 <seglistitem>
259 <seg>
260 gapplication, gdbus, gdbus-codegen,
261 gio, gio-querymodules,
262 glib-compile-resources, glib-compile-schemas,
263 glib-genmarshal, glib-gettextize,
264 glib-mkenums, gobject-query,
265 gresource, gsettings,
266 gtester, and gtester-report
267 </seg>
268 <seg>
269 libgio-2.0.so,
270 libglib-2.0.so,
271 libgmodule-2.0.so,
272 libgobject-2.0.so, and
273 libgthread-2.0.so
274 </seg>
275 <seg>
276 /usr/include/gio-unix-2.0,
277 /usr/include/glib-2.0,
278 /usr/lib/glib-2.0,
279 /usr/share/glib-2.0, and
280 /usr/share/gtk-doc/html/{gio,glib,gobject}
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.