source: general/genlib/glib2.xml@ 42e002d

11.2 trunk xry111/soup3
Last change on this file since 42e002d was 42e002d, checked in by Pierre Labastie <pierre.labastie@…>, 4 months ago

Fix MIME type detection in glib2

  • Property mode set to 100644
File size: 17.5 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 "6874205c81e9634fb47f4efb73183d00">
10 <!ENTITY glib2-size "4.7 MB">
11 <!ENTITY glib2-buildsize "184 MB (add 6 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 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>GLib-&glib2-version;</title>
23
24 <indexterm zone="glib2">
25 <primary sortas="a-GLib2">GLib2</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to GLib</title>
30
31 <para>
32 The <application>GLib</application> package contains low-level
33 libraries useful for providing data structure handling for C, portability
34 wrappers and interfaces for such runtime functionality as an
35 event loop, threads, dynamic loading and an object system.
36 </para>
37
38 &lfs111_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&glib2-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&glib2-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &glib2-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &glib2-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &glib2-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &glib2-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
75 <itemizedlist spacing="compact">
76 <!-- should be applied in glib-2.72.3 or above -->
77 <listitem>
78 <para>
79 Recommended patch, that fixes and issue in webkitgtk:
80 <ulink url="&patch-root;/glib-&glib2-version;-fix_xdgmime-1.patch"/>
81 </para>
82 </listitem>
83 <listitem>
84 <para>
85 Optional patch:
86 <ulink url="&patch-root;/glib-&glib2-version;-skip_warnings-1.patch"/>
87 </para>
88 </listitem>
89 </itemizedlist>
90
91 <bridgehead renderas="sect3">GLib Dependencies</bridgehead>
92
93 <bridgehead renderas="sect4">Recommended</bridgehead>
94 <para role="recommended">
95 <xref linkend="libxslt"/> and
96 <xref linkend="pcre"/> (built with Unicode properties)
97 </para>
98
99 <bridgehead renderas="sect4">Optional</bridgehead>
100 <para role="optional">
101 <xref linkend="dbus"/> and
102 <ulink url="https://bindfs.org/">bindfs</ulink>
103 (both may be used in some tests),
104 <xref linkend="gdb"/> (for bindings),
105 <xref linkend="DocBook"/>,
106 <xref linkend="docbook-xsl"/>,
107 <xref linkend="gtk-doc"/> (to build API documentation),
108 <xref linkend="glib-networking"/> (for some tests, but this is a circular
109 dependency), and
110 <xref linkend="sysprof"/>
111 </para>
112
113 <bridgehead renderas="sect4">Additional Runtime Dependencies</bridgehead>
114 <para role="recommended">
115 <xref role="runtime" linkend="gobject-introspection"/>
116 (should be installed before gtk+, atk, etc.)
117 </para>
118 <para role="optional">
119 Quoted directly from the <filename>INSTALL</filename> file:
120 <quote>Some of the mimetype-related functionality in GIO requires the
121 <command>update-mime-database</command> and
122 <command>update-desktop-database</command> utilities</quote>,
123 which are part of
124 <xref role="runtime" linkend="shared-mime-info"/> and
125 <xref role="runtime" linkend="desktop-file-utils"/>, respectively.
126 These two utilities are also needed for some tests.
127 </para>
128
129 <para condition="html" role="usernotes">User Notes:
130 <ulink url="&blfs-wiki;/glib2"/>
131 </para>
132 </sect2>
133
134 <sect2 role="installation">
135 <title>Installation of GLib</title>
136 <!-- Remove the next para and screen for glib-2.72.3 or above-->
137 <para>
138 First, fix an issue in MIME file content lookup, which may prevent
139 displaying <command>file://</command> URL's in webkitgtk based browsers.
140 </para>
141
142<screen><userinput>patch -Np1 -i ../glib-&glib2-version;-fix_xdgmime-1.patch</userinput></screen>
143
144 <para>
145 If desired, apply the optional patch. In many cases, applications that
146 use this library, either directly or indirectly via other libraries such
147 as <xref linkend="gtk3"/>, output numerous warnings when run from the
148 command line. This patch enables the use of an environment variable,
149 <envar>GLIB_LOG_LEVEL</envar>, that suppresses unwanted messages. The
150 value of the variable is a digit that corresponds to:
151 </para>
152
153 <simplelist>
154 <member>1 Alert</member>
155 <member>2 Critical</member>
156 <member>3 Error</member>
157 <member>4 Warning</member>
158 <member>5 Notice</member>
159 </simplelist>
160
161 <para>
162 For instance <userinput>export GLIB_LOG_LEVEL=4</userinput> will skip
163 output of Warning and Notice messages (and Info/Debug messages if they
164 are turned on). If <envar>GLIB_LOG_LEVEL</envar> is not defined, normal
165 message output will not be affected.
166 </para>
167
168<screen><userinput>patch -Np1 -i ../glib-&glib2-version;-skip_warnings-1.patch</userinput></screen>
169
170 <warning>
171 <para>
172 If a previous version of glib is installed, move the headers out of the
173 way so that later packages do not encounter conflicts:
174 </para>
175
176<screen role="root"><userinput remap="pre">if [ -e /usr/include/glib-2.0 ]; then
177 rm -rf /usr/include/glib-2.0.old &amp;&amp;
178 mv -vf /usr/include/glib-2.0{,.old}
179fi</userinput></screen>
180
181 </warning>
182
183 <para>
184 Install <application>GLib</application> by running the following
185 commands:
186 </para>
187
188<screen><userinput>mkdir build &amp;&amp;
189cd build &amp;&amp;
190
191meson --prefix=/usr \
192 --buildtype=release \
193 -Dman=true \
194 .. &amp;&amp;
195ninja</userinput></screen>
196
197 <note><para>
198 If <xref linkend="libxslt"/> is installed, the above command may
199 indicate several (about 33) errors that start with "Error: no ID for
200 constraint linkend:" when generating the man pages. These are harmless.
201 </para></note>
202
203 <para>
204 The <application>GLib</application> test suite requires
205 <application>desktop-file-utils</application> for some tests. However,
206 <application>desktop-file-utils</application> requires
207 <application>GLib</application> in order to compile; therefore, you must
208 first install <application>GLib</application> and then run the test
209 suite.
210 </para>
211
212 <para>
213 Now, as the <systemitem class="username">root</systemitem> user:
214 </para>
215
216<screen role="root"><userinput>ninja install &amp;&amp;
217
218mkdir -p /usr/share/doc/glib-&glib2-version; &amp;&amp;
219cp -r ../docs/reference/{gio,glib,gobject} /usr/share/doc/glib-&glib2-version;</userinput></screen>
220
221 <para>
222 You should now install <xref linkend="desktop-file-utils"/> and
223 <xref linkend="shared-mime-info"/> and proceed to
224 run the test suite.
225 </para>
226
227 <para>
228 To test the results, after having installed the package, issue:
229 <command>ninja test</command>. One test named
230 <literal>gio / file</literal> is known to fail if the test is run as
231 the <systemitem class="username">root</systemitem> user.
232 <!-- glib issue #1954: -->
233 <!-- One test named gdbus-server-auth sometimes fails.-->
234 <!-- SysV has the symlink now, so gdatetime no longer fails.-->
235 <!-- Needs /etc/localtime to be a symbolic link. In addition
236 the link must be to some place like /usr/share/zoneinfo/...
237
238 This can be overcome if the line below in glib/tests/gdatetime.c
239 is removed or commented out.
240 g_assert_true (*g_time_zone_get_identifier (tz) != '/');
241
242 NOTE: systemd implements this as a hard requirement. -->
243 <!-- with 2.60.4 on systemd, all tests pass. -->
244 <!-- with 2.64.1 on sysV, all tests pass. -->
245 <!-- with 2.70.1 on sysV, all tests pass. -->
246 <!-- with 2.70.2 on sysV, all tests pass. -->
247 </para>
248
249 <para>
250 Finally, if this is a reinstall from glib2-2.64.x or earlier, remove
251 (as the <systemitem class="username">root</systemitem> user) an
252 obsolete header file that interferes with some packages:
253 </para>
254
255<screen role="nodump"><userinput>rm -f /usr/include/glib-2.0/glib/gurifuncs.h</userinput></screen>
256
257 </sect2>
258
259 <sect2 role="commands">
260 <title>Command Explanations</title>
261
262 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
263 href="../../xincludes/meson-buildtype-release.xml"/>
264
265 <para>
266 <parameter>-Dman=true</parameter>: This switch causes the
267 build to create and install the package man pages.
268 </para>
269
270 <para>
271 <option>-Dgtk_doc=true</option>: This switch causes the
272 build to create and install the API documentation.
273 </para>
274
275 </sect2>
276
277 <sect2 role="content">
278 <title>Contents</title>
279
280 <segmentedlist>
281 <segtitle>Installed Programs</segtitle>
282 <segtitle>Installed Libraries</segtitle>
283 <segtitle>Installed Directories</segtitle>
284
285 <seglistitem>
286 <seg>
287 gapplication, gdbus, gdbus-codegen,
288 gio, gio-querymodules,
289 glib-compile-resources, glib-compile-schemas,
290 glib-genmarshal, glib-gettextize,
291 glib-mkenums, gobject-query,
292 gresource, gsettings,
293 gtester, and gtester-report
294 </seg>
295 <seg>
296 libgio-2.0.so,
297 libglib-2.0.so,
298 libgmodule-2.0.so,
299 libgobject-2.0.so, and
300 libgthread-2.0.so
301 </seg>
302 <seg>
303 /usr/include/gio-unix-2.0,
304 /usr/include/glib-2.0,
305 /usr/lib/glib-2.0,
306 /usr/share/glib-2.0,
307 /usr/share/doc/glib-&glib2-version;, and
308 /usr/share/gtk-doc/html/{gio,glib,gobject} (optional)
309 </seg>
310 </seglistitem>
311 </segmentedlist>
312
313 <variablelist>
314 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
315 <?dbfo list-presentation="list"?>
316 <?dbhtml list-presentation="table"?>
317
318 <varlistentry id="gapplication">
319 <term><command>gapplication</command></term>
320 <listitem>
321 <para>
322 can be used to start applications and to send
323 messages to already-running instances of other applications
324 </para>
325 <indexterm zone="glib2 gapplication">
326 <primary sortas="b-gapplication">application</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330 <varlistentry id="gdbus">
331 <term><command>gdbus</command></term>
332 <listitem>
333 <para>
334 is a simple tool used for working with
335 <application>D-Bus</application> objects
336 </para>
337 <indexterm zone="glib2 gdbus">
338 <primary sortas="b-gdbus">gdbus</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="gdbus-codegen">
344 <term><command>gdbus-codegen</command></term>
345 <listitem>
346 <para>
347 is used to generate code and/or documentation for one or
348 more <application>D-Bus</application> interfaces
349 </para>
350 <indexterm zone="glib2 gdbus-codegen">
351 <primary sortas="b-gdbus-codegen">gdbus-codegen</primary>
352 </indexterm>
353 </listitem>
354 </varlistentry>
355
356 <varlistentry id="gio">
357 <term><command>gio</command></term>
358 <listitem>
359 <para>
360 is a utility that makes many <application>GIO</application>
361 features available from the command line
362 </para>
363 <indexterm zone="glib2 gio">
364 <primary sortas="b-gio">gio</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="gio-querymodules">
370 <term><command>gio-querymodules</command></term>
371 <listitem>
372 <para>
373 is used to create a <filename>giomodule.cache</filename> file in
374 the listed directories. This file lists the implemented extension
375 points for each module that has been found
376 </para>
377 <indexterm zone="glib2 gio-querymodules">
378 <primary sortas="b-gio-querymodules">gio-querymodules</primary>
379 </indexterm>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry id="glib-compile-resources">
384 <term><command>glib-compile-resources</command></term>
385 <listitem>
386 <para>
387 is used to read the resource description from a file and
388 the files that it references to create a binary resource
389 bundle that is suitable for use with the GResource API
390 </para>
391 <indexterm zone="glib2 glib-compile-resources">
392 <primary sortas="b-glib-compile-resources">glib-compile-resources</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="glib-compile-schemas">
398 <term><command>glib-compile-schemas</command></term>
399 <listitem>
400 <para>
401 is used to compile all the GSettings XML schema files
402 in a directory into a binary file with the name
403 <filename>gschemas.compiled</filename> that can be used by GSettings
404 </para>
405 <indexterm zone="glib2 glib-compile-schemas">
406 <primary sortas="b-glib-compile-resources">glib-compile-schemas</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="glib-genmarshal">
412 <term><command>glib-genmarshal</command></term>
413 <listitem>
414 <para>
415 is a C code marshaller generation utility for GLib closures
416 </para>
417 <indexterm zone="glib2 glib-genmarshal">
418 <primary sortas="b-glib-genmarshal">glib-genmarshal</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="glib-gettextize">
424 <term><command>glib-gettextize</command></term>
425 <listitem>
426 <para>
427 is a variant of the <application>gettext</application>
428 internationalization utility
429 </para>
430 <indexterm zone="glib2 glib-gettextize">
431 <primary sortas="b-glib-gettextize">glib-gettextize</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="glib-mkenums">
437 <term><command>glib-mkenums</command></term>
438 <listitem>
439 <para>
440 is a C language enum description generation utility
441 </para>
442 <indexterm zone="glib2 glib-mkenums">
443 <primary sortas="b-glib-mkenums">glib-mkenums</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry id="gobject-query">
449 <term><command>gobject-query</command></term>
450 <listitem>
451 <para>
452 is a small utility that draws a tree of types
453 </para>
454 <indexterm zone="glib2 gobject-query">
455 <primary sortas="b-gobject-query">gobject-query</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="gresource">
461 <term><command>gresource</command></term>
462 <listitem>
463 <para>
464 offers a simple command line interface to GResource
465 </para>
466 <indexterm zone="glib2 gresource">
467 <primary sortas="b-gresource">gresource</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 <varlistentry id="gsettings">
473 <term><command>gsettings</command></term>
474 <listitem>
475 <para>
476 offers a simple command line interface to GSettings
477 </para>
478 <indexterm zone="glib2 gsettings">
479 <primary sortas="b-gsettings">gsettings</primary>
480 </indexterm>
481 </listitem>
482 </varlistentry>
483
484 <varlistentry id="gtester">
485 <term><command>gtester</command></term>
486 <listitem>
487 <para>
488 is a test running utility
489 </para>
490 <indexterm zone="glib2 gtester">
491 <primary sortas="b-gtester">gtester</primary>
492 </indexterm>
493 </listitem>
494 </varlistentry>
495
496 <varlistentry id="gtester-report">
497 <term><command>gtester-report</command></term>
498 <listitem>
499 <para>
500 is a test report formatting utility
501 </para>
502 <indexterm zone="glib2 gtester-report">
503 <primary sortas="b-gtester-report">gtester-report</primary>
504 </indexterm>
505 </listitem>
506 </varlistentry>
507
508 <varlistentry id="GLib-libraries">
509 <term>GLib libraries</term>
510 <listitem>
511 <para>
512 contain low-level core libraries for the
513 <application>GIMP</application> Toolkit
514 </para>
515 <indexterm zone="glib2 GLib-libraries">
516 <primary sortas="c-GLib-libraries">Glib libraries</primary>
517 </indexterm>
518 </listitem>
519 </varlistentry>
520
521 </variablelist>
522
523 </sect2>
524
525</sect1>
Note: See TracBrowser for help on using the repository browser.