source: x/lib/gtk4.xml@ 4b9e5e44

11.1 11.2 11.3 12.0 12.1 12.2 gimp3 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/for-12.3 xry111/intltool xry111/llvm18 xry111/soup3 xry111/spidermonkey128 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 4b9e5e44 was 2232977b, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

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