source: x/lib/gtk4.xml@ 83c3980

lazarus trunk
Last change on this file since 83c3980 was d275cec2, checked in by Rahul Chandra <rahul@…>, 8 weeks ago

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