source: x/lib/gtk4.xml@ 0fcc7398

11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since 0fcc7398 was 6e5707e, checked in by Bruce Dubbs <bdubbs@…>, 2 years ago

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