source: general/genlib/glib2.xml@ e7d893b

elogind
Last change on this file since e7d893b was e7d893b, checked in by DJ Lucas <dj@…>, 2 years ago

Merge to HEAD 21602.

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

  • Property mode set to 100644
File size: 16.4 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/2.60/glib-&glib2-version;.tar.xz">
8 <!ENTITY glib2-download-ftp "&gnome-download-ftp;/glib/2.60/glib-&glib2-version;.tar.xz">
9 <!ENTITY glib2-md5sum "f28f2228e2b369cc866f18770baafe2b">
10 <!ENTITY glib2-size "4.4 MB">
11 <!ENTITY glib2-buildsize "164 MB (add 4 MB for tests)">
12 <!ENTITY glib2-time "0.5 SBU (add 0.6 SBU for tests; both using paralleism=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 &lfs84_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"/>, and
101 <xref linkend="gtk-doc"/>
102 (to build API documentation)
103 </para>
104
105 <bridgehead renderas="sect4">Additional Runtime Dependencies</bridgehead>
106 <para role="recommended">
107 <xref role="runtime" linkend="gobject-introspection"/>
108 (should be installed before gtk+, atk, etc.)
109 </para>
110 <para role="optional">
111 Quoted directly from the <filename>INSTALL</filename> file:
112 <quote>Some of the mimetype-related functionality in GIO requires the
113 <command>update-mime-database</command> and
114 <command>update-desktop-database</command> utilities</quote>,
115 which are part of
116 <xref role="runtime" linkend="shared-mime-info"/> and
117 <xref role="runtime" linkend="desktop-file-utils"/>, respectively.
118 These two utilities are also needed for some tests.
119 </para>
120
121 <para condition="html" role="usernotes">User Notes:
122 <ulink url="&blfs-wiki;/glib2"/>
123 </para>
124 </sect2>
125
126 <sect2 role="installation">
127 <title>Installation of GLib</title>
128
129 <para>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 GLIB_LOG_LEVEL, that supresses unwanted messages. The value of the
134 variable is a digit that corresponds to:</para>
135
136 <simplelist>
137 <member>1 Alert</member>
138 <member>2 Critical</member>
139 <member>3 Error</member>
140 <member>4 Warning</member>
141 <member>5 Notice</member>
142 </simplelist>
143
144 <para>For instance GLIB_LOG_LEVEL=4 will skip output of Warning and
145 Notice messages (and Info/Debug messages if they are turned on).
146 If GLIB_LOG_LEVEL is not defined, normal message output will not
147 be affected.</para>
148
149<screen><userinput>patch -Np1 -i ../glib-&glib2-version;-skip_warnings-1.patch</userinput></screen>
150
151 <warning>
152 <para>
153
154 If upgrading from a previous version of GLib that was built using
155 autotools, and the <application>libtool</application> archives (.la
156 files) were installed, you will need to adjust all installed libtool
157 archives,
158 <filename>/usr/lib/libg{io,lib,module,object,thread}-2.0.la</filename>,
159 to replace references to the libtool archives for this package with the
160 appropriate linker library flag (-l),
161 <command>-lg{io,lib,module,object,thread}</command>. 600+ files must be
162 modified on a complete gnome desktop.
163
164 </para>
165
166 <para>
167 Alternatively, you can just remove the unneeded .la files
168 with the script at <xref linkend="la-files"/>.
169 </para>
170 </warning>
171
172 <para>
173 Install <application>GLib</application> by running the following
174 commands:
175 </para>
176
177<screen><userinput>mkdir build &amp;&amp;
178cd build &amp;&amp;
179
180meson --prefix=/usr \
181 -Dman=true \
182 -Dselinux=disabled \
183 .. &amp;&amp;
184ninja</userinput></screen>
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 <note><para>
200 If <xref linkend="libxslt"/> is installed, the following command may
201 indicate several (about 33) errors that start with "Error: no ID for
202 constraint linkend:" when installing the man pages. These are harmless.
203 </para></note>
204
205<screen role="root"><userinput>ninja install &amp;&amp;
206
207mkdir -p /usr/share/doc/glib-&glib2-version; &amp;&amp;
208cp -r ../docs/reference/{NEWS,gio,glib,gobject} /usr/share/doc/glib-&glib2-version;</userinput></screen>
209
210 <para>
211 You should now install <xref linkend="desktop-file-utils"/> and proceed to
212 run the test suite.
213 </para>
214
215 <para>
216 To test the results, after having installed the package, issue:
217 <command>ninja test</command>.
218 One test, gdatetime, is known to fail on sysvinit systems.
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 -->
228 </para>
229
230 </sect2>
231
232 <sect2 role="commands">
233 <title>Command Explanations</title>
234
235 <para>
236 <parameter>-Dman=true</parameter>: This switch causes the
237 build to create and install the package man pages.
238 </para>
239
240 <para>
241 <parameter>-Dselinux=false</parameter>: This switch disables
242 support for selinux which is not supported in BLFS.
243 </para>
244
245 <para>
246 <parameter>-Ddoc=true</parameter>: This switch causes the
247 build to create and install the API documentation.
248 </para>
249
250 </sect2>
251
252 <sect2 role="content">
253 <title>Contents</title>
254
255 <segmentedlist>
256 <segtitle>Installed Programs</segtitle>
257 <segtitle>Installed Libraries</segtitle>
258 <segtitle>Installed Directories</segtitle>
259
260 <seglistitem>
261 <seg>
262 gapplication, gdbus, gdbus-codegen,
263 gio, gio-launch-desktop, gio-querymodules,
264 glib-compile-resources, glib-compile-schemas,
265 glib-genmarshal, glib-gettextize,
266 glib-mkenums, gobject-query,
267 gresource, gsettings,
268 gtester, and gtester-report
269 </seg>
270 <seg>
271 libgio-2.0.so,
272 libglib-2.0.so,
273 libgmodule-2.0.so,
274 libgobject-2.0.so, and
275 libgthread-2.0.so
276 </seg>
277 <seg>
278 /usr/include/gio-unix-2.0,
279 /usr/include/glib-2.0,
280 /usr/lib/glib-2.0,
281 /usr/share/glib-2.0, and
282 /usr/share/gtk-doc/html/{gio,glib,gobject}
283 </seg>
284 </seglistitem>
285 </segmentedlist>
286
287 <variablelist>
288 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
289 <?dbfo list-presentation="list"?>
290 <?dbhtml list-presentation="table"?>
291
292 <varlistentry id="gapplication">
293 <term><command>gapplication</command></term>
294 <listitem>
295 <para>
296 can be used to start applications and to send
297 messages to already-running instances of other applications.
298 </para>
299 <indexterm zone="glib2 gapplication">
300 <primary sortas="b-gapplication">application</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304 <varlistentry id="gdbus">
305 <term><command>gdbus</command></term>
306 <listitem>
307 <para>
308 is a simple tool used for working with
309 <application>D-Bus</application> objects.
310 </para>
311 <indexterm zone="glib2 gdbus">
312 <primary sortas="b-gdbus">gdbus</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="gdbus-codegen">
318 <term><command>gdbus-codegen</command></term>
319 <listitem>
320 <para>
321 is used to generate code and/or documentation for one or
322 more <application>D-Bus</application> interfaces.
323 </para>
324 <indexterm zone="glib2 gdbus-codegen">
325 <primary sortas="b-gdbus-codegen">gdbus-codegen</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="gio">
331 <term><command>gio</command></term>
332 <listitem>
333 <para>
334 is a utility that makes many <application>GIO</application>
335 features available from the command line.
336 </para>
337 <indexterm zone="glib2 gio">
338 <primary sortas="b-gio">gio</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="gio-querymodules">
344 <term><command>gio-querymodules</command></term>
345 <listitem>
346 <para>
347 is used to create a <filename>giomodule.cache</filename> file in
348 the listed directories. This file lists the implemented extension
349 points for each module that has been found.
350 </para>
351 <indexterm zone="glib2 gio-querymodules">
352 <primary sortas="b-gio-querymodules">gio-querymodules</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="glib-compile-resources">
358 <term><command>glib-compile-resources</command></term>
359 <listitem>
360 <para>
361 is used to read the resource description from a file and
362 the files that it references to create a binary resource
363 bundle that is suitable for use with the GResource API.
364 </para>
365 <indexterm zone="glib2 glib-compile-resources">
366 <primary sortas="b-glib-compile-resources">glib-compile-resources</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="glib-compile-schemas">
372 <term><command>glib-compile-schemas</command></term>
373 <listitem>
374 <para>
375 is used to compile all the GSettings XML schema files
376 in a directory into a binary file with the name
377 <filename>gschemas.compiled</filename> that can be used by GSettings.
378 </para>
379 <indexterm zone="glib2 glib-compile-schemas">
380 <primary sortas="b-glib-compile-resources">glib-compile-schemas</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="glib-genmarshal">
386 <term><command>glib-genmarshal</command></term>
387 <listitem>
388 <para>
389 is a C code marshaller generation utility for GLib closures.
390 </para>
391 <indexterm zone="glib2 glib-genmarshal">
392 <primary sortas="b-glib-genmarshal">glib-genmarshal</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="glib-gettextize">
398 <term><command>glib-gettextize</command></term>
399 <listitem>
400 <para>
401 is a variant of the <application>gettext</application>
402 internationalization utility.
403 </para>
404 <indexterm zone="glib2 glib-gettextize">
405 <primary sortas="b-glib-gettextize">glib-gettextize</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="glib-mkenums">
411 <term><command>glib-mkenums</command></term>
412 <listitem>
413 <para>
414 is a C language enum description generation utility.
415 </para>
416 <indexterm zone="glib2 glib-mkenums">
417 <primary sortas="b-glib-mkenums">glib-mkenums</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="gobject-query">
423 <term><command>gobject-query</command></term>
424 <listitem>
425 <para>
426 is a small utility that draws a tree of types.
427 </para>
428 <indexterm zone="glib2 gobject-query">
429 <primary sortas="b-gobject-query">gobject-query</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="gresource">
435 <term><command>gresource</command></term>
436 <listitem>
437 <para>
438 offers a simple command line interface to GResource.
439 </para>
440 <indexterm zone="glib2 gresource">
441 <primary sortas="b-gresource">gresource</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="gsettings">
447 <term><command>gsettings</command></term>
448 <listitem>
449 <para>
450 offers a simple command line interface to GSettings.
451 </para>
452 <indexterm zone="glib2 gsettings">
453 <primary sortas="b-gsettings">gsettings</primary>
454 </indexterm>
455 </listitem>
456 </varlistentry>
457
458 <varlistentry id="gtester">
459 <term><command>gtester</command></term>
460 <listitem>
461 <para>
462 is a test running utility.
463 </para>
464 <indexterm zone="glib2 gtester">
465 <primary sortas="b-gtester">gtester</primary>
466 </indexterm>
467 </listitem>
468 </varlistentry>
469
470 <varlistentry id="gtester-report">
471 <term><command>gtester-report</command></term>
472 <listitem>
473 <para>
474 is a test report formatting utility.
475 </para>
476 <indexterm zone="glib2 gtester-report">
477 <primary sortas="b-gtester-report">gtester-report</primary>
478 </indexterm>
479 </listitem>
480 </varlistentry>
481
482 <varlistentry id="GLib-libraries">
483 <term>GLib libraries</term>
484 <listitem>
485 <para>
486 contain low-level core libraries for the
487 <application>GIMP</application> Toolkit.
488 </para>
489 <indexterm zone="glib2 GLib-libraries">
490 <primary sortas="c-GLib-libraries">Glib libraries</primary>
491 </indexterm>
492 </listitem>
493 </varlistentry>
494
495 </variablelist>
496
497 </sect2>
498
499</sect1>
Note: See TracBrowser for help on using the repository browser.