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

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

Merge to HEAD 21704.

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

  • Property mode set to 100644
File size: 18.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 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 "7b20f3aa3b36214150ea7a12d6bc384b">
10 <!ENTITY gtk3-size "20 MB">
11 <!ENTITY gtk3-buildsize "556 MB (including tests)">
12 <!ENTITY gtk3-time "1.3 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 &lfs84_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>
132 Install <application>GTK+ 3</application> by running the following
133 commands:
134 </para>
135
136<!-- The build directory already exists since this package allows both Autotools
137 and Meson to be used
138 This may have to be changed in a few versions, or when GTK4 comes out.-->
139<screen><userinput>cd build &amp;&amp;
140meson --prefix=/usr \
141 -Dcolord=yes \
142 -Dgtk_doc=false \
143 -Dman=true \
144 -Dbroadway_backend=true .. &amp;&amp;
145ninja</userinput></screen>
146
147 <para>
148 Some tests fail if
149 <filename>/usr/share/glib-2.0/schemas/gschemas.compiled</filename> is not
150 found. If you wish to run the test suite, create (or update) the file
151 using the following command as the
152 <systemitem class="username">root</systemitem> user:
153 <command>glib-compile-schemas /usr/share/glib-2.0/schemas</command>.
154 </para>
155
156 <para>
157 To test the results you need a graphical session, then issue
158 <command>ninja test</command>. <!--There are several tests that
159 have subtests that are known to fail: scrolledwindow, treeview,
160 accessibility-dump, test-css-nodes, and gtk-reftest.
161 Additionally many tests will fail if the current
162 gtk theme (such as current XFCE themes) has deprecated elements.-->
163 9 tests are known to fail in the a11y suite and gtk/object suite.
164 </para>
165
166 <para>
167 Now, as the <systemitem class="username">root</systemitem> user:
168 </para>
169
170 <screen role="root"><userinput>ninja install</userinput></screen>
171
172 <note>
173 <para>
174 If you installed the package on to your system using a
175 <quote>DESTDIR</quote> method, an important file was not installed and
176 must be copied and/or generated. Generate it using the following
177 command as the <systemitem class="username">root</systemitem> user:
178 </para>
179
180<screen role="root"><userinput>gtk-query-immodules-3.0 --update-cache</userinput></screen>
181 </note>
182
183 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
184 href="../../xincludes/gsettings-destdir.xml"/>
185 </sect2>
186
187 <sect2 role="commands">
188 <title>Command Explanations</title>
189
190 <para>
191 <parameter>-Dbroadway_backend=true</parameter>: This switch enables the
192 HTML5 GTK backend.
193 </para>
194 <!--
195 <para>
196 <parameter>- -enable-x11-backend</parameter>: This switch enables the X11
197 GDK backend.
198 </para>
199 -->
200 <!--
201 <para>
202 <parameter>- -enable-wayland-backend</parameter>: This switch
203 enables the Wayland GDK backend. Replace with
204 <option>- -disable-wayland-backend</option> if you do not have
205 <xref linkend="wayland"/> and <xref linkend="wayland-protocols"/>
206 or you do not wish to build <application>GNOME</application> with Wayland
207 support. Other changes may be needed to allow the build to complete
208 without the wayland backend enabled. Note that a previous installation
209 of gtk+3 built with wayland will interfere with installation without
210 wayland. If this is desired, remove /usr/lib//usr/lib/libgtk-3* before
211 installation.
212 </para>
213 -->
214 <!--
215 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
216 href="../../xincludes/gtk-doc-rebuild.xml"/>
217 -->
218 <para>
219 <parameter>-Dcolord=yes</parameter>: This switch allows color support
220 in the GTK+ printing backend.
221 </para>
222
223 <para>
224 <parameter>-Dman=true</parameter>: This switch allows generating
225 manual pages.
226 </para>
227
228 <para>
229 <parameter>-Dgtk_doc=false</parameter>: This switch disables building
230 documentation. Replace with -Dgtk_doc=true if you have
231 <xref linkend="gtk-doc"/> installed and wish to generate documentation.
232 </para>
233
234 </sect2>
235
236 <sect2 role="configuration">
237 <title>Configuring GTK+ 3</title>
238
239 <sect3 id="gtk3-config">
240 <title>Config Files</title>
241 <para>
242 <filename>~/.config/gtk-3.0/settings.ini</filename> and
243 <filename>/etc/gtk-3.0/settings.ini</filename>
244 </para>
245
246 <indexterm zone="gtk3 gtk3-config">
247 <primary sortas="e-AA.home-settings.ini">~/.config/gtk-3.0/settings.ini</primary>
248 </indexterm>
249
250 <indexterm zone="gtk3 gtk3-config">
251 <primary sortas="e-etc-path-settings.ini">/etc/gtk-3.0/settings.ini</primary>
252 </indexterm>
253 </sect3>
254
255 <sect3><title>Configuration Information</title>
256
257 <para>
258 <application>GTK+ 3</application> themes change the way a
259 <application>GTK+ 3</application> application looks. An icon theme can
260 be used to change the icons that appear on the application's toolbar.
261 If you have installed a <application>GTK+ 3</application> theme (e.g.
262 <xref linkend="gnome-themes-extra"/>), an icon theme (such as <xref
263 linkend="oxygen-icons5"/>) and/or a font (<xref linkend="dejavu-fonts"/>),
264 you can set your preferences in <filename>~/.config/gtk-3.0/settings.ini</filename>,
265 or the default system wide configuration file (as the <systemitem
266 class="username">root</systemitem> user), in
267 <filename>/etc/gtk-3.0/settings.ini</filename>. For the local user an
268 example is:
269 </para>
270
271<screen><userinput>mkdir -vp ~/.config/gtk-3.0
272cat &gt; ~/.config/gtk-3.0/settings.ini &lt;&lt; "EOF"
273<literal>[Settings]
274gtk-theme-name = <replaceable>Adwaita</replaceable>
275gtk-icon-theme-name = <replaceable>oxygen</replaceable>
276gtk-font-name = <replaceable>DejaVu Sans 12</replaceable>
277gtk-cursor-theme-size = <replaceable>18</replaceable>
278gtk-toolbar-style = <replaceable>GTK_TOOLBAR_BOTH_HORIZ</replaceable>
279gtk-xft-antialias = <replaceable>1</replaceable>
280gtk-xft-hinting = <replaceable>1</replaceable>
281gtk-xft-hintstyle = <replaceable>hintslight</replaceable>
282gtk-xft-rgba = <replaceable>rgb</replaceable>
283gtk-cursor-theme-name = <replaceable>Adwaita</replaceable></literal>
284EOF</userinput></screen>
285
286 <para>
287 There are many settings keys, some with default values. You can find
288 them at <ulink
289 url="https://developer.gnome.org/gtk3/stable/GtkSettings.html">Settings:
290 GTK+ 3 Reference Manual</ulink>. There are many more themes available at
291 <ulink url="http://gnome-look.org/"/> and other places.
292 </para>
293
294 </sect3>
295 </sect2>
296
297 <sect2 role="content">
298 <title>Contents</title>
299
300 <segmentedlist>
301 <segtitle>Installed Programs</segtitle>
302 <segtitle>Installed Libraries</segtitle>
303 <segtitle>Installed Directories</segtitle>
304
305 <seglistitem>
306 <seg>
307 broadwayd,
308 gtk3-demo,
309 gtk3-demo-application,
310 gtk3-icon-browser,
311 gtk3-widget-factory,
312 gtk-builder-tool,
313 gtk-encode-symbolic-svg,
314 gtk-launch,
315 gtk-query-immodules-3.0,
316 gtk-query-settings, and
317 gtk-update-icon-cache
318 </seg>
319 <seg>
320 libgailutil-3.so, libgdk-3.so, and libgtk-3.so
321 </seg>
322 <seg>
323 /etc/gtk-3.0,
324 /usr/include/{gail,gtk}-3.0,
325 /usr/{lib,share}/gtk-3.0,
326 /usr/share/gtk-doc/html/{gail-libgail-util,gdk,gtk}3, and
327 /usr/share/themes/{Default,Emacs}/gtk-3.0
328 </seg>
329 </seglistitem>
330 </segmentedlist>
331
332 <variablelist>
333 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
334 <?dbfo list-presentation="list"?>
335 <?dbhtml list-presentation="table"?>
336
337 <varlistentry id="broadwayd">
338 <term><command>broadwayd</command></term>
339 <listitem>
340 <para>
341 provides support for displaying
342 <application>GTK+ 3</application> applications in a web browser,
343 using HTML5 and web sockets.
344 </para>
345 <indexterm zone="gtk3 broadwayd">
346 <primary sortas="b-broadwayd">broadwayd</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="gtk3-demo">
352 <term><command>gtk3-demo</command></term>
353 <listitem>
354 <para>
355 is a simple program that demonstrates some of the tasks that can be
356 done with <application>GTK+ 3</application>
357 </para>
358 <indexterm zone="gtk3 gtk3-demo">
359 <primary sortas="b-gtk3-demo">gtk3-demo</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="gtk3-demo-application">
365 <term><command>gtk3-demo-application</command></term>
366 <listitem>
367 <para>
368 is a simple <application>GTK+ 3</application> application.
369 </para>
370 <indexterm zone="gtk3 gtk3-demo-application">
371 <primary sortas="b-gtk3-demo-application">gtk3-demo-application</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="gtk3-icon-browser">
377 <term><command>gtk3-icon-browser</command></term>
378 <listitem>
379 <para>
380 is a utility to explore the icons in the current icon theme. It
381 shows icons in various sizes, their symbolic variants where
382 available, as well as a description of the icon and its context.
383 </para>
384 <indexterm zone="gtk3 gtk3-icon-browser">
385 <primary sortas="b-gtk3-icon-browser">gtk3-icon-browser</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="gtk3-widget-factory">
391 <term><command>gtk3-widget-factory</command></term>
392 <listitem>
393 <para>
394 is a program to view <application>GTK+ 3</application> themes and widgets.
395 </para>
396 <indexterm zone="gtk3 gtk3-widget-factory">
397 <primary sortas="b-gtk3-widget-factory">gtk3-widget-factory</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="gtk-builder-tool">
403 <term><command>gtk-builder-tool</command></term>
404 <listitem>
405 <para>
406 can perform various operations on GtkBuilder .ui files.
407 </para>
408 <indexterm zone="gtk3 gtk-builder-tool">
409 <primary sortas="b-gtk-builder-tool">gtk-builder-tool</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="gtk-encode-symbolic-svg">
415 <term><command>gtk-encode-symbolic-svg</command></term>
416 <listitem>
417 <para>
418 converts symbolic svg icons into specially prepared png files.
419 <application>GTK+ 3</application> can load and recolor these pngs,
420 just like original svgs, but loading them is much faster.
421 </para>
422 <indexterm zone="gtk3 gtk-encode-symbolic-svg">
423 <primary sortas="b-gtk-encode-symbolic-svg">gtk-encode-symbolic-svg</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="gtk-launch">
429 <term><command>gtk-launch</command></term>
430 <listitem>
431 <para>
432 launches an application using the given name. The name should match
433 the application desktop file name, as residing in
434 <filename class="directory">/usr/share/applications</filename>, with
435 or without the '.desktop' suffix.
436 </para>
437 <indexterm zone="gtk3 gtk-launch">
438 <primary sortas="b-gtk-launch">gtk-launch</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="gtk-query-immodules-3.0">
444 <term><command>gtk-query-immodules-3.0</command></term>
445 <listitem>
446 <para>
447 collects information about loadable input method modules for
448 <application>GTK+ 3</application> and writes it to the default cache
449 file location, or to standard output.
450 </para>
451 <indexterm zone="gtk3 gtk-query-immodules-3.0">
452 <primary sortas="b-gtk-query-immodules-3.0">gtk-query-immodules-3.0</primary>
453 </indexterm>
454 </listitem>
455 </varlistentry>
456
457 <varlistentry id="gtk-query-settings">
458 <term><command>gtk-query-settings</command></term>
459 <listitem>
460 <para>
461 provides a complete listing of all settings related to
462 <application>GTK+ 3</application>
463 </para>
464 <indexterm zone="gtk3 gtk-query-settings">
465 <primary sortas="b-gtk-query-settings">gtk-query-settings</primary>
466 </indexterm>
467 </listitem>
468 </varlistentry>
469
470 <varlistentry id="gtk-update-icon-cache3">
471 <term><command>gtk-update-icon-cache</command></term>
472 <listitem>
473 <para>
474 is an icon theme caching utility that creates mmap()able cache files
475 for icon themes.
476 </para>
477 <indexterm zone="gtk3 gtk-update-icon-cache3">
478 <primary sortas="b-gtk-update-icon-cache3">gtk-update-icon-cache</primary>
479 </indexterm>
480 </listitem>
481 </varlistentry>
482
483 <varlistentry id="libgailutil-3">
484 <term><filename class="libraryfile">libgailutil-3.so</filename></term>
485 <listitem>
486 <para>
487 contains functions that implement the accessibility interfaces
488 defined by the <application>GNOME</application> Accessibility
489 Toolkit.
490 </para>
491 <indexterm zone="gtk3 libgailutil-3">
492 <primary sortas="c-libgailutil-3">libgailutil-3.so</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 <varlistentry id="libgdk-3">
498 <term><filename class="libraryfile">libgdk-3.so</filename></term>
499 <listitem>
500 <para>
501 contains functions that act as a wrapper around the low-level
502 drawing and windowing functions provided by the underlying graphics
503 system.
504 </para>
505 <indexterm zone="gtk3 libgdk-3">
506 <primary sortas="c-libgdk-3">libgdk-3.so</primary>
507 </indexterm>
508 </listitem>
509 </varlistentry>
510
511 <varlistentry id="libgtk-3">
512 <term><filename class="libraryfile">libgtk-3.so</filename></term>
513 <listitem>
514 <para>
515 contains functions that provide an API to implement graphical user
516 interfaces.
517 </para>
518 <indexterm zone="gtk3 libgtk-3">
519 <primary sortas="c-libgtk-3">libgtk-3.so</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 </variablelist>
525
526 </sect2>
527
528</sect1>
Note: See TracBrowser for help on using the repository browser.