source: x/lib/gtk4.xml@ 625040be

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 625040be was b20e01ae, checked in by Douglas R. Reno <renodr@…>, 6 months ago

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