source: x/lib/gtk+3.xml@ 7398442

10.0 10.1 11.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 7398442 was 7398442, checked in by Bruce Dubbs <bdubbs@…>, 2 years ago

Tweak gtk3 build instructions

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

  • Property mode set to 100644
File size: 18.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 gtk3-download-http "&gnome-download-http;/gtk+/&gnome-minor-24;/gtk+-&gtk3-version;.tar.xz">
8 <!ENTITY gtk3-download-ftp "&gnome-download-ftp;/gtk+/&gnome-minor-24;/gtk+-&gtk3-version;.tar.xz">
9 <!ENTITY gtk3-md5sum "0a9581f9a1b71d1a2f57fae3adf46b94">
10 <!ENTITY gtk3-size "20 MB">
11 <!ENTITY gtk3-buildsize "460 MB (including tests)">
12 <!ENTITY gtk3-time "1.1 SBU (using parallelism=4, add 0.1 SBU for tests)">
13]>
14
15<sect1 id="gtk3" xreflabel="GTK+-&gtk3-version;">
16 <?dbhtml filename="gtk3.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>GTK+-&gtk3-version;</title>
24
25 <indexterm zone="gtk3">
26 <primary sortas="a-GTK+3">GTK+3</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to GTK+ 3</title>
31
32 <para>
33 The <application>GTK+ 3</application> package contains
34 libraries used for creating graphical user interfaces for
35 applications.
36 </para>
37
38 &lfs90_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&gtk3-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&gtk3-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &gtk3-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &gtk3-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &gtk3-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &gtk3-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">GTK+ 3 Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="at-spi2-atk"/>,
79 <xref linkend="fribidi"/>,
80 <xref linkend="gdk-pixbuf"/>,
81 <xref linkend="libepoxy"/>, and
82 <xref linkend="pango"/>
83<!-- does not seem to be needed anymore
84 <xref linkend="six"/>-->
85 </para>
86
87 <bridgehead renderas="sect4">Recommended</bridgehead>
88 <para role="recommended">
89 <xref linkend="adwaita-icon-theme"/> (default for some gtk+3 settings
90 keys, also needed for tests),
91 <xref linkend="hicolor-icon-theme"/> (needed for tests),
92 <xref linkend="iso-codes"/>,
93 <xref linkend="libxkbcommon"/>,
94 <xref linkend="sassc"/>,
95 <xref linkend="wayland"/>, and
96 <xref linkend="wayland-protocols"/>
97 </para>
98
99 <bridgehead renderas="sect4">Recommended (Required if building GNOME)</bridgehead>
100 <para role="recommended">
101 <xref linkend="gobject-introspection"/>
102 </para>
103
104 <bridgehead renderas="sect4">Optional</bridgehead>
105 <para role="optional">
106 <xref linkend="colord"/>,
107 <xref linkend="cups"/>,
108 <xref linkend="docbook-utils"/>,
109 <xref linkend="gtk-doc"/>,
110 <xref linkend="json-glib"/>,
111 <xref linkend="pyatspi2"/> (for tests),
112 <xref linkend="rest"/>, and
113 <ulink url="http://icl.cs.utk.edu/papi/">PAPI</ulink>
114 </para>
115
116 <para condition="html" role="usernotes">
117 User Notes: <ulink url="&blfs-wiki;/gtk3"/>
118 </para>
119 </sect2>
120
121 <sect2 role="installation">
122 <title>Installation of GTK+ 3</title>
123
124 <!-- This is due to the meson transition -->
125 <caution>
126 <para>If you are upgrading from a version of GTK+3 prior to 3.24.9,
127 you must run the <filename>remove-la-files.sh</filename> script from
128 <xref linkend="la-files"/> after installing GTK+.</para>
129 </caution>
130
131 <para>First, fix a minor problem in the meson configuration:</para>
132
133 <screen><userinput>sed -i 's/3.24.10/3.24.11/' meson.build</userinput></screen>
134
135 <para>
136 Install <application>GTK+ 3</application> by running the following
137 commands:
138 </para>
139
140<!-- The build directory already exists since this package allows both Autotools
141 and Meson to be used
142 This may have to be changed in a few versions, or when GTK4 comes out.-->
143<screen><userinput>mkdir build-gtk3 &amp;&amp;
144cd build-gtk3 &amp;&amp;
145
146meson --prefix=/usr \
147 -Dcolord=yes \
148 -Dgtk_doc=false \
149 -Dman=true \
150 -Dbroadway_backend=true .. &amp;&amp;
151ninja</userinput></screen>
152
153 <para>
154 Some tests fail if
155 <filename>/usr/share/glib-2.0/schemas/gschemas.compiled</filename> is not
156 found. If you wish to run the test suite, create (or update) the file
157 using the following command as the
158 <systemitem class="username">root</systemitem> user:
159 <command>glib-compile-schemas /usr/share/glib-2.0/schemas</command>.
160 </para>
161
162 <para>
163 To test the results you need a graphical session, then issue
164 <command>ninja test</command>. <!--There are several tests that
165 have subtests that are known to fail: scrolledwindow, treeview,
166 accessibility-dump, test-css-nodes, and gtk-reftest.
167 Additionally many tests will fail if the current
168 gtk theme (such as current XFCE themes) has deprecated elements.-->
169 six tests are known to fail in the a11y suite.
170 </para>
171
172 <para>
173 Now, as the <systemitem class="username">root</systemitem> user:
174 </para>
175
176 <screen role="root"><userinput>ninja install</userinput></screen>
177
178 <note>
179 <para>
180 If you installed the package on to your system using a
181 <quote>DESTDIR</quote> method, an important file was not installed and
182 must be copied and/or generated. Generate it using the following
183 command as the <systemitem class="username">root</systemitem> user:
184 </para>
185
186<screen role="root"><userinput>gtk-query-immodules-3.0 --update-cache</userinput></screen>
187 </note>
188
189 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
190 href="../../xincludes/gsettings-destdir.xml"/>
191 </sect2>
192
193 <sect2 role="commands">
194 <title>Command Explanations</title>
195
196 <para>
197 <parameter>-Dbroadway_backend=true</parameter>: This switch enables the
198 HTML5 GTK backend.
199 </para>
200 <!--
201 <para>
202 <parameter>- -enable-x11-backend</parameter>: This switch enables the X11
203 GDK backend.
204 </para>
205 -->
206 <!--
207 <para>
208 <parameter>- -enable-wayland-backend</parameter>: This switch
209 enables the Wayland GDK backend. Replace with
210 <option>- -disable-wayland-backend</option> if you do not have
211 <xref linkend="wayland"/> and <xref linkend="wayland-protocols"/>
212 or you do not wish to build <application>GNOME</application> with Wayland
213 support. Other changes may be needed to allow the build to complete
214 without the wayland backend enabled. Note that a previous installation
215 of gtk+3 built with wayland will interfere with installation without
216 wayland. If this is desired, remove /usr/lib//usr/lib/libgtk-3* before
217 installation.
218 </para>
219 -->
220 <!--
221 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
222 href="../../xincludes/gtk-doc-rebuild.xml"/>
223 -->
224 <para>
225 <parameter>-Dcolord=yes</parameter>: This switch allows color support
226 in the GTK+ printing backend.
227 </para>
228
229 <para>
230 <parameter>-Dman=true</parameter>: This switch allows generating
231 manual pages.
232 </para>
233
234 <para>
235 <parameter>-Dgtk_doc=false</parameter>: This switch disables building
236 documentation. Replace with -Dgtk_doc=true if you have
237 <xref linkend="gtk-doc"/> installed and wish to generate documentation.
238 </para>
239
240 </sect2>
241
242 <sect2 role="configuration">
243 <title>Configuring GTK+ 3</title>
244
245 <sect3 id="gtk3-config">
246 <title>Config Files</title>
247 <para>
248 <filename>~/.config/gtk-3.0/settings.ini</filename> and
249 <filename>/etc/gtk-3.0/settings.ini</filename>
250 </para>
251
252 <indexterm zone="gtk3 gtk3-config">
253 <primary sortas="e-AA.home-settings.ini">~/.config/gtk-3.0/settings.ini</primary>
254 </indexterm>
255
256 <indexterm zone="gtk3 gtk3-config">
257 <primary sortas="e-etc-path-settings.ini">/etc/gtk-3.0/settings.ini</primary>
258 </indexterm>
259 </sect3>
260
261 <sect3><title>Configuration Information</title>
262
263 <para>
264 <application>GTK+ 3</application> themes change the way a
265 <application>GTK+ 3</application> application looks. An icon theme can
266 be used to change the icons that appear on the application's toolbar.
267 If you have installed a <application>GTK+ 3</application> theme (e.g.
268 <xref linkend="gnome-themes-extra"/>), an icon theme (such as <xref
269 linkend="oxygen-icons5"/>) and/or a font (<xref linkend="dejavu-fonts"/>),
270 you can set your preferences in <filename>~/.config/gtk-3.0/settings.ini</filename>,
271 or the default system wide configuration file (as the <systemitem
272 class="username">root</systemitem> user), in
273 <filename>/etc/gtk-3.0/settings.ini</filename>. For the local user an
274 example is:
275 </para>
276
277<screen><userinput>mkdir -vp ~/.config/gtk-3.0
278cat &gt; ~/.config/gtk-3.0/settings.ini &lt;&lt; "EOF"
279<literal>[Settings]
280gtk-theme-name = <replaceable>Adwaita</replaceable>
281gtk-icon-theme-name = <replaceable>oxygen</replaceable>
282gtk-font-name = <replaceable>DejaVu Sans 12</replaceable>
283gtk-cursor-theme-size = <replaceable>18</replaceable>
284gtk-toolbar-style = <replaceable>GTK_TOOLBAR_BOTH_HORIZ</replaceable>
285gtk-xft-antialias = <replaceable>1</replaceable>
286gtk-xft-hinting = <replaceable>1</replaceable>
287gtk-xft-hintstyle = <replaceable>hintslight</replaceable>
288gtk-xft-rgba = <replaceable>rgb</replaceable>
289gtk-cursor-theme-name = <replaceable>Adwaita</replaceable></literal>
290EOF</userinput></screen>
291
292 <para>
293 There are many settings keys, some with default values. You can find
294 them at <ulink
295 url="https://developer.gnome.org/gtk3/stable/GtkSettings.html">Settings:
296 GTK+ 3 Reference Manual</ulink>. There are many more themes available at
297 <ulink url="http://gnome-look.org/"/> and other places.
298 </para>
299
300 </sect3>
301 </sect2>
302
303 <sect2 role="content">
304 <title>Contents</title>
305
306 <segmentedlist>
307 <segtitle>Installed Programs</segtitle>
308 <segtitle>Installed Libraries</segtitle>
309 <segtitle>Installed Directories</segtitle>
310
311 <seglistitem>
312 <seg>
313 broadwayd,
314 gtk3-demo,
315 gtk3-demo-application,
316 gtk3-icon-browser,
317 gtk3-widget-factory,
318 gtk-builder-tool,
319 gtk-encode-symbolic-svg,
320 gtk-launch,
321 gtk-query-immodules-3.0,
322 gtk-query-settings, and
323 gtk-update-icon-cache
324 </seg>
325 <seg>
326 libgailutil-3.so, libgdk-3.so, and libgtk-3.so
327 </seg>
328 <seg>
329 /etc/gtk-3.0,
330 /usr/include/{gail,gtk}-3.0,
331 /usr/{lib,share}/gtk-3.0,
332 /usr/share/gtk-doc/html/{gail-libgail-util,gdk,gtk}3, and
333 /usr/share/themes/{Default,Emacs}/gtk-3.0
334 </seg>
335 </seglistitem>
336 </segmentedlist>
337
338 <variablelist>
339 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
340 <?dbfo list-presentation="list"?>
341 <?dbhtml list-presentation="table"?>
342
343 <varlistentry id="broadwayd">
344 <term><command>broadwayd</command></term>
345 <listitem>
346 <para>
347 provides support for displaying
348 <application>GTK+ 3</application> applications in a web browser,
349 using HTML5 and web sockets.
350 </para>
351 <indexterm zone="gtk3 broadwayd">
352 <primary sortas="b-broadwayd">broadwayd</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="gtk3-demo">
358 <term><command>gtk3-demo</command></term>
359 <listitem>
360 <para>
361 is a simple program that demonstrates some of the tasks that can be
362 done with <application>GTK+ 3</application>
363 </para>
364 <indexterm zone="gtk3 gtk3-demo">
365 <primary sortas="b-gtk3-demo">gtk3-demo</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="gtk3-demo-application">
371 <term><command>gtk3-demo-application</command></term>
372 <listitem>
373 <para>
374 is a simple <application>GTK+ 3</application> application.
375 </para>
376 <indexterm zone="gtk3 gtk3-demo-application">
377 <primary sortas="b-gtk3-demo-application">gtk3-demo-application</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="gtk3-icon-browser">
383 <term><command>gtk3-icon-browser</command></term>
384 <listitem>
385 <para>
386 is a utility to explore the icons in the current icon theme. It
387 shows icons in various sizes, their symbolic variants where
388 available, as well as a description of the icon and its context.
389 </para>
390 <indexterm zone="gtk3 gtk3-icon-browser">
391 <primary sortas="b-gtk3-icon-browser">gtk3-icon-browser</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="gtk3-widget-factory">
397 <term><command>gtk3-widget-factory</command></term>
398 <listitem>
399 <para>
400 is a program to view <application>GTK+ 3</application> themes and widgets.
401 </para>
402 <indexterm zone="gtk3 gtk3-widget-factory">
403 <primary sortas="b-gtk3-widget-factory">gtk3-widget-factory</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="gtk-builder-tool">
409 <term><command>gtk-builder-tool</command></term>
410 <listitem>
411 <para>
412 can perform various operations on GtkBuilder .ui files.
413 </para>
414 <indexterm zone="gtk3 gtk-builder-tool">
415 <primary sortas="b-gtk-builder-tool">gtk-builder-tool</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="gtk-encode-symbolic-svg">
421 <term><command>gtk-encode-symbolic-svg</command></term>
422 <listitem>
423 <para>
424 converts symbolic svg icons into specially prepared png files.
425 <application>GTK+ 3</application> can load and recolor these pngs,
426 just like original svgs, but loading them is much faster.
427 </para>
428 <indexterm zone="gtk3 gtk-encode-symbolic-svg">
429 <primary sortas="b-gtk-encode-symbolic-svg">gtk-encode-symbolic-svg</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="gtk-launch">
435 <term><command>gtk-launch</command></term>
436 <listitem>
437 <para>
438 launches an application using the given name. The name should match
439 the application desktop file name, as residing in
440 <filename class="directory">/usr/share/applications</filename>, with
441 or without the '.desktop' suffix.
442 </para>
443 <indexterm zone="gtk3 gtk-launch">
444 <primary sortas="b-gtk-launch">gtk-launch</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="gtk-query-immodules-3.0">
450 <term><command>gtk-query-immodules-3.0</command></term>
451 <listitem>
452 <para>
453 collects information about loadable input method modules for
454 <application>GTK+ 3</application> and writes it to the default cache
455 file location, or to standard output.
456 </para>
457 <indexterm zone="gtk3 gtk-query-immodules-3.0">
458 <primary sortas="b-gtk-query-immodules-3.0">gtk-query-immodules-3.0</primary>
459 </indexterm>
460 </listitem>
461 </varlistentry>
462
463 <varlistentry id="gtk-query-settings">
464 <term><command>gtk-query-settings</command></term>
465 <listitem>
466 <para>
467 provides a complete listing of all settings related to
468 <application>GTK+ 3</application>
469 </para>
470 <indexterm zone="gtk3 gtk-query-settings">
471 <primary sortas="b-gtk-query-settings">gtk-query-settings</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="gtk-update-icon-cache3">
477 <term><command>gtk-update-icon-cache</command></term>
478 <listitem>
479 <para>
480 is an icon theme caching utility that creates mmap()able cache files
481 for icon themes.
482 </para>
483 <indexterm zone="gtk3 gtk-update-icon-cache3">
484 <primary sortas="b-gtk-update-icon-cache3">gtk-update-icon-cache</primary>
485 </indexterm>
486 </listitem>
487 </varlistentry>
488
489 <varlistentry id="libgailutil-3">
490 <term><filename class="libraryfile">libgailutil-3.so</filename></term>
491 <listitem>
492 <para>
493 contains functions that implement the accessibility interfaces
494 defined by the <application>GNOME</application> Accessibility
495 Toolkit.
496 </para>
497 <indexterm zone="gtk3 libgailutil-3">
498 <primary sortas="c-libgailutil-3">libgailutil-3.so</primary>
499 </indexterm>
500 </listitem>
501 </varlistentry>
502
503 <varlistentry id="libgdk-3">
504 <term><filename class="libraryfile">libgdk-3.so</filename></term>
505 <listitem>
506 <para>
507 contains functions that act as a wrapper around the low-level
508 drawing and windowing functions provided by the underlying graphics
509 system.
510 </para>
511 <indexterm zone="gtk3 libgdk-3">
512 <primary sortas="c-libgdk-3">libgdk-3.so</primary>
513 </indexterm>
514 </listitem>
515 </varlistentry>
516
517 <varlistentry id="libgtk-3">
518 <term><filename class="libraryfile">libgtk-3.so</filename></term>
519 <listitem>
520 <para>
521 contains functions that provide an API to implement graphical user
522 interfaces.
523 </para>
524 <indexterm zone="gtk3 libgtk-3">
525 <primary sortas="c-libgtk-3">libgtk-3.so</primary>
526 </indexterm>
527 </listitem>
528 </varlistentry>
529
530 </variablelist>
531
532 </sect2>
533
534</sect1>
Note: See TracBrowser for help on using the repository browser.