source: x/lib/gtk4.xml@ ffef0bb

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since ffef0bb was 2cb86885, checked in by Douglas R. Reno <renodr@…>, 14 months ago

Update to gtk-4.10.3
  • Property mode set to 100644
File size: 17.2 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 gtk4-download-http "&gnome-download-http;/gtk/&gtk4-minor;/gtk-&gtk4-version;.tar.xz">
8 <!ENTITY gtk4-download-ftp "&gnome-download-ftp;/gtk/&gtk4-minor;/gtk-&gtk4-version;.tar.xz">
9 <!ENTITY gtk4-md5sum "722f6c3422ac3d27d00dd171c2e7c048">
10 <!ENTITY gtk4-size "20 MB">
11 <!ENTITY gtk4-buildsize "517 MB (with docs; add 18 MB for tests)">
12 <!ENTITY gtk4-time "1.0 SBU (using parallelism=4; with docs; add 0.4 SBU for tests)">
13]>
14
15<sect1 id="gtk4" xreflabel="GTK-&gtk4-version;">
16 <?dbhtml filename="gtk4.html"?>
17
18 <title>GTK-&gtk4-version;</title>
19
20 <indexterm zone="gtk4">
21 <primary sortas="a-gtk4">GTK-4</primary>
22 </indexterm>
23
24 <sect2 role="package">
25 <title>Introduction to GTK 4</title>
26
27 <para>
28 The <application>GTK 4</application> package contains libraries used for
29 creating graphical user interfaces for applications.
30 </para>
31
32 &lfs113_checked;
33
34 <bridgehead renderas="sect3">Package Information</bridgehead>
35 <itemizedlist spacing="compact">
36 <listitem>
37 <para>
38 Download (HTTP): <ulink url="&gtk4-download-http;"/>
39 </para>
40 </listitem>
41 <listitem>
42 <para>
43 Download (FTP): <ulink url="&gtk4-download-ftp;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download MD5 sum: &gtk4-md5sum;
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download size: &gtk4-size;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Estimated disk space required: &gtk4-buildsize;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated build time: &gtk4-time;
64 </para>
65 </listitem>
66 </itemizedlist>
67
68 <bridgehead renderas="sect3">GTK 4 Dependencies</bridgehead>
69
70 <bridgehead renderas="sect4">Required</bridgehead>
71 <para role="required">
72 <xref linkend="fribidi"/>,
73 <xref linkend="gdk-pixbuf"/>,
74 <xref linkend="graphene"/>,
75 <xref linkend="iso-codes"/>,
76 <xref linkend="libepoxy"/>,
77 <xref linkend="libxkbcommon"/>,
78 <xref linkend="pango"/>,
79 <xref linkend="pygobject3"/>, and
80 <xref linkend="wayland-protocols"/>
81 </para>
82
83 <bridgehead renderas="sect4">Recommended</bridgehead>
84 <para role="recommended">
85 <xref linkend="adwaita-icon-theme"/> (default for some gtk4 settings keys),
86 <xref linkend="gst10-plugins-bad"/>,
87 <xref role='runtime' linkend="gst10-plugins-good"/> (runtime,
88 built with <xref role='nodep' linkend='libvpx'/>),
89 <xref linkend="hicolor-icon-theme"/> (needed for tests and for defaults), and
90 <xref linkend="librsvg"/>
91 </para>
92
93 <bridgehead renderas="sect4">Recommended (Required if building GNOME)</bridgehead>
94 <para role="recommended">
95 <xref linkend="gobject-introspection"/>
96 </para>
97
98 <bridgehead renderas="sect4">Optional</bridgehead>
99 <para role="optional">
100 <xref linkend="colord"/>,
101 <xref linkend="cups"/>,
102 <xref linkend="docutils"/>,
103 <xref linkend="ffmpeg"/> (built with
104 <xref role='nodep' linkend='libvpx'/>),
105 <xref linkend="gi-docgen"/>,
106 <xref role="runtime" linkend="highlight"/>
107 (runtime, only used by <command>gtk4-demo</command> for syntax
108 highlighting of demo source code),
109 <xref linkend="libcloudproviders"/>,
110 <xref linkend="sassc"/>,
111 <xref linkend="tracker3"/>,
112 <ulink url="https://github.com/OpenPrinting/cpdb-libs">cpdb</ulink>, and
113 <ulink url="https://vulkan.lunarg.com/sdk/home">vulkan</ulink>
114 </para>
115
116 <para condition="html" role="usernotes">
117 User Notes: <ulink url="&blfs-wiki;/gtk4"/>
118 </para>
119 </sect2>
120
121 <sect2 role="installation">
122 <title>Installation of GTK 4</title>
123
124 <para>
125 Install <application>GTK 4</application> by running the following
126 commands:
127 </para>
128
129<screen><userinput>mkdir build &amp;&amp;
130cd build &amp;&amp;
131
132meson setup --prefix=/usr \
133 --buildtype=release \
134 -Dbroadway-backend=true \
135 -Dintrospection=enabled \
136 .. &amp;&amp;
137ninja</userinput></screen>
138
139 <para>
140 If you have <xref linkend='gi-docgen'/> installed and wish to build
141 the API documentation for this package, issue:
142 </para>
143
144<screen remap='doc'><userinput>sed "s@'doc'@&amp; / 'gtk-&gtk4-version;'@" -i ../docs/reference/meson.build &amp;&amp;
145meson configure -Dgtk_doc=true &amp;&amp;
146ninja</userinput></screen>
147
148 <para>
149 To run the tests, issue: <command>meson test --setup x11</command>. If you
150 are in a Wayland session, replace x11 with wayland. A few tests may fail.
151 On systems with NVIDIA graphics cards, the tests may take significantly
152 longer than the advertised test time.
153 </para>
154<!-- [pierre]: 4.6.0, wayland: 727 ok; 2 Expected Fail; 1 Fail; 1 Skipped
155 [bdubbs]: 4.6.3, x11, 724 OK, 2 Expected Fail, 12 Fail. 1 Skipped
156 [pierre]: 4.6.6, wayland, 738 OK, 2 Expected Fail, 1 Fail. 1 Skipped
157 [pierre]: 4.6.7, wayland, 737 OK, 2 Expected Fail, 1 Fail. 1 Skipped. 1 Timeout
158 [bdubbs]: 4.6.7, x11, 758 OK, 2 Expected Fail, 9 Fail. 1 Skipped. 1 Timeout
159 [pierre]: 4.8.1, wayland, 765 OK, 2 Expected Fail, 2 Fail. 1 Skipped
160 [bdubbs]: 4.8.2, x11, 753 OK, 2 Expected Fail, 14 Fail. 1 Skipped
161 [pierre]: 4.8.3, wayland, 760 OK, 2 Expected Fail, 5 Fail. 3 Skipped
162 [bdubbs]: 4.10.0, x11, 701 OK, 0 Expected Fail, 15 Fail. 1 Skipped, 2 Timeout
163 above over ssh
164 [bdubbs]: 4.10.0, x11, 712 OK, 0 Expected Fail, 6 Fail. 1 Skipped, 0 Timeout
165 above on native x11
166-->
167
168 <para>
169 Now, as the <systemitem class="username">root</systemitem> user:
170 </para>
171
172<screen role="root"><userinput>ninja install</userinput></screen>
173 </sect2>
174
175 <sect2 role="commands">
176 <title>Command Explanations</title>
177
178 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
179 href="../../xincludes/meson-buildtype-release.xml"/>
180
181 <para>
182 <parameter>-Dbroadway-backend=true</parameter>: This switch enables the
183 HTML5 GDK backend.
184 </para>
185
186 <para>
187 <parameter>-Dintrospection=enabled</parameter>: This switch enables
188 using <xref linkend='gobject-introspection'/> to generate GIR bindings
189 of this packages. These bindings are required by GNOME.
190 </para>
191
192 <para>
193 <option>-Dcloudproviders=enabled</option>: Use this switch if you have
194 <xref linkend="libcloudproviders" role="nodep"/> installed and wish to
195 enable support for cloud providers in a file chooser window.
196 </para>
197
198 <para>
199 <option>-Dsysprof=enabled</option>: Use this switch if you have
200 <xref linkend="sysprof"/> installed and wish to enable tracing support for
201 GTK4-based applications.
202 </para>
203
204 <para>
205 <option>-Dtracker=enabled</option>: Use this switch if you have
206 <xref linkend="tracker3"/> installed and wish to use search functionality
207 when running a file chooser.
208 </para>
209
210 <para>
211 <option>-Dcolord=enabled</option>: Use this switch if you have
212 <xref linkend="colord"/> installed and wish to use colord with the CUPS
213 printing backend.
214 </para>
215
216 <para>
217 <!-- The tarball ships a copy of gi-docgen but we need the Python
218 dependencies, so we require gi-docgen to be installed. -->
219 <option>-Dgtk_doc=true</option>: &gi-doc-disable;
220 </para>
221
222 <para>
223 <option>-Dman-pages=true</option>: Use this switch if you have
224 <xref linkend='docutils'/> installed and wish to generate the man
225 pages.
226 </para>
227
228 </sect2>
229
230 <sect2 role="configuration">
231 <title>Configuring GTK 4</title>
232
233 <sect3 id="gtk4-config">
234 <title>Config Files</title>
235 <para>
236 <filename>~/.config/gtk-4.0/settings.ini</filename> and
237 <filename>/usr/share/gtk-4.0/settings.ini</filename>
238 </para>
239
240 <indexterm zone="gtk4 gtk4-config">
241 <primary sortas="e-AA.home-gtk4-settings.ini">~/.config/gtk-4.0/settings.ini</primary>
242 </indexterm>
243
244 <indexterm zone="gtk4 gtk4-config">
245 <primary
246 sortas="e-usr-share-path-settings.ini">/usr/share/gtk-4.0/settings.ini</primary>
247 </indexterm>
248 </sect3>
249
250 <sect3><title>Configuration Information</title>
251
252 <para>
253 <application>GTK 4</application> themes change the way a
254 <application>GTK 4</application> application looks. An icon theme can
255 be used to change the icons that appear on the application's toolbar.
256 If you have installed a <application>GTK 4</application> theme (e.g.
257 the Adwaita theme built in <application>GTK 4</application>),
258 an icon theme (such as <xref linkend="oxygen-icons5"/>) and/or a font
259 (<xref linkend="dejavu-fonts"/>), you can set your preferences in
260 <filename>~/.config/gtk-4.0/settings.ini</filename>, or the default
261 system-wide configuration file (as the
262 <systemitem class="username">root</systemitem> user), in
263 <filename>/usr/share/gtk-4.0/settings.ini</filename>. For the local
264 user, an example is:
265 </para>
266
267<screen><userinput>mkdir -pv ~/.config/gtk-4.0
268cat &gt; ~/.config/gtk-4.0/settings.ini &lt;&lt; "EOF"
269<literal>[Settings]
270gtk-theme-name = <replaceable>Adwaita</replaceable>
271gtk-icon-theme-name = <replaceable>oxygen</replaceable>
272gtk-font-name = <replaceable>DejaVu Sans 12</replaceable>
273gtk-cursor-theme-size = <replaceable>18</replaceable>
274gtk-xft-antialias = <replaceable>1</replaceable>
275gtk-xft-hinting = <replaceable>1</replaceable>
276gtk-xft-hintstyle = <replaceable>hintslight</replaceable>
277gtk-xft-rgba = <replaceable>rgb</replaceable>
278gtk-cursor-theme-name = <replaceable>Adwaita</replaceable></literal>
279EOF</userinput></screen>
280
281 <para>
282 There are many settings keys, some with default values. You can find
283 them at <ulink
284 url="https://developer.gnome.org/gtk4/stable/GtkSettings.html">Settings:
285 GTK 4 Reference Manual</ulink>.
286 </para>
287
288 </sect3>
289 </sect2>
290
291 <sect2 role="content">
292 <title>Contents</title>
293
294 <segmentedlist>
295 <segtitle>Installed Programs</segtitle>
296 <segtitle>Installed Libraries</segtitle>
297 <segtitle>Installed Directories</segtitle>
298
299 <seglistitem>
300 <seg>
301 gtk4-broadwayd,
302 gtk4-builder-tool,
303 gtk4-demo,
304 gtk4-demo-application,
305 gtk4-encode-symbolic-svg,
306 gtk4-icon-browser,
307 gtk4-launch,
308 gtk4-node-editor,
309 gtk4-print-editor,
310 gtk4-query-settings,
311 gtk4-update-icon-cache, and
312 gtk4-widget-factory
313 </seg>
314 <seg>
315 libgtk-4.so
316 </seg>
317 <seg>
318 /usr/include/gtk-4.0,
319 /usr/lib/gtk-4.0, and
320 /usr/share/gtk-4.0
321 </seg>
322 </seglistitem>
323 </segmentedlist>
324
325 <variablelist>
326 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
327 <?dbfo list-presentation="list"?>
328 <?dbhtml list-presentation="table"?>
329
330 <varlistentry id="gtk4-broadwayd">
331 <term><command>gtk4-broadwayd</command></term>
332 <listitem>
333 <para>
334 provides support for displaying GTK 4 applications in a web
335 browser using HTML5 and web sockets
336 </para>
337 <indexterm zone="gtk4 gtk4-broadwayd">
338 <primary sortas="b-gtk4-broadwayd">gtk4-broadwayd</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="gtk4-builder-tool">
344 <term><command>gtk4-builder-tool</command></term>
345 <listitem>
346 <para>
347 performs various operations on GtkBuilder .ui files
348 </para>
349 <indexterm zone="gtk4 gtk4-builder-tool">
350 <primary sortas="b-gtk4-builder-tool">gtk4-builder-tool</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="gtk4-demo">
356 <term><command>gtk4-demo</command></term>
357 <listitem>
358 <para>
359 is a simple program that demonstrates some of the tasks that can be
360 done with GTK 4
361 </para>
362 <indexterm zone="gtk4 gtk4-demo">
363 <primary sortas="b-gtk4-demo">gtk4-demo</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="gtk4-demo-application">
369 <term><command>gtk4-demo-application</command></term>
370 <listitem>
371 <para>
372 is a simple GTK 4 application which is useful for testing
373 </para>
374 <indexterm zone="gtk4 gtk4-demo-application">
375 <primary sortas="b-gtk4-demo-application">gtk4-demo-application</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="gtk4-encode-symbolic-svg">
381 <term><command>gtk4-encode-symbolic-svg</command></term>
382 <listitem>
383 <para>
384 converts symbolic SVG icons into special PNG files. GTK 4 can load
385 and recolor these PNGs, just like original SVGs, but loading them
386 is much faster
387 </para>
388 <indexterm zone="gtk4 gtk4-encode-symbolic-svg">
389 <primary sortas="b-gtk4-encode-symbolic-svg">gtk4-encode-symbolic-svg</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="gtk4-icon-browser">
395 <term><command>gtk4-icon-browser</command></term>
396 <listitem>
397 <para>
398 is a utility to explore the icons in the current icon theme. It
399 shows icons in various sizes, their symbolic variants when
400 available, as well as a description of the icon and its context
401 </para>
402 <indexterm zone="gtk4 gtk4-icon-browser">
403 <primary sortas="b-gtk4-icon-browser">gtk4-icon-browser</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="gtk4-launch">
409 <term><command>gtk4-launch</command></term>
410 <listitem>
411 <para>
412 launches an application using the given name. The name should match
413 the application .desktop file name (as seen in
414 <filename class="directory">/usr/share/applications</filename>),
415 with or without the '.desktop' extension
416 </para>
417 <indexterm zone="gtk4 gtk-launch">
418 <primary sortas="b-gtk4-launch">gtk4-launch</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="gtk4-node-editor">
424 <term><command>gtk4-node-editor</command></term>
425 <listitem>
426 <para>
427 is a utility to show and edit render node files. Such render
428 node files can be obtained e.g. from the GTK inspector
429 </para>
430 <indexterm zone="gtk4 gtk4-node-editor">
431 <primary sortas="b-gtk4-node-editor">gtk4-node-editor</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="gtk4-print-editor">
437 <term><command>gtk4-print-editor</command></term>
438 <listitem>
439 <para>
440 is a simple program to demonstrate printing using GTK 4
441 applications
442 </para>
443 <indexterm zone="gtk4 gtk4-print-editor">
444 <primary sortas="b-gtk4-print-editor">gtk4-print-editor</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="gtk4-query-settings">
450 <term><command>gtk4-query-settings</command></term>
451 <listitem>
452 <para>
453 provides a complete listing of all settings related to GTK 4
454 </para>
455 <indexterm zone="gtk4 gtk4-query-settings">
456 <primary sortas="b-gtk4-query-settings">gtk4-query-settings</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="gtk4-update-icon-cache">
462 <term><command>gtk4-update-icon-cache</command></term>
463 <listitem>
464 <para>
465 is an icon theme caching utility that creates mmap()able cache
466 files for icon themes
467 </para>
468 <indexterm zone="gtk4 gtk4-update-icon-cache">
469 <primary sortas="b-gtk4-update-icon-cache">gtk4-update-icon-cache</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="gtk4-widget-factory">
475 <term><command>gtk4-widget-factory</command></term>
476 <listitem>
477 <para>
478 is a program to view GTK 4 themes and widgets
479 </para>
480 <indexterm zone="gtk4 gtk4-widget-factory">
481 <primary sortas="b-gtk4-widget-factory">gtk4-widget-factory</primary>
482 </indexterm>
483 </listitem>
484 </varlistentry>
485
486 <varlistentry id="libgtk-4">
487 <term><filename class="libraryfile">libgtk-4.so</filename></term>
488 <listitem>
489 <para>
490 contains functions that provide an API to implement graphical user
491 interfaces
492 </para>
493 <indexterm zone="gtk4 libgtk-4">
494 <primary sortas="c-libgtk-4">libgtk-4.so</primary>
495 </indexterm>
496 </listitem>
497 </varlistentry>
498 </variablelist>
499 </sect2>
500</sect1>
Note: See TracBrowser for help on using the repository browser.