source: x/lib/gtk+3.xml@ ab4fdfc

12.1 ken/TL2024 lazarus plabs/newcss rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since ab4fdfc was ab4fdfc, checked in by Pierre Labastie <pierre.labastie@…>, 4 months ago

Change all xml decl to encoding=utf-8

  • Property mode set to 100644
File size: 16.5 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 gtk3-download-http "&gnome-download-http;/gtk+/&gnome-minor-24;/gtk+-&gtk3-version;.tar.xz">
8 <!ENTITY gtk3-download-ftp " ">
9 <!ENTITY gtk3-md5sum "0164d65a03fd308ee3b10af41b61c41f">
10 <!ENTITY gtk3-size "13 MB">
11 <!ENTITY gtk3-buildsize "244 MB (add 8 MB for tests)">
12 <!ENTITY gtk3-time "0.8 SBU (using parallelism=4; add 0.2 SBU for tests)">
13]>
14
15<sect1 id="gtk3" xreflabel="GTK+-&gtk3-version;">
16 <?dbhtml filename="gtk3.html"?>
17
18
19 <title>GTK+-&gtk3-version;</title>
20
21 <indexterm zone="gtk3">
22 <primary sortas="a-GTK+3">GTK+3</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to GTK+ 3</title>
27
28 <para>
29 The <application>GTK+ 3</application> package contains
30 libraries used for creating graphical user interfaces for
31 applications.
32 </para>
33
34 &lfs120_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&gtk3-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&gtk3-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &gtk3-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &gtk3-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &gtk3-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &gtk3-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70 <bridgehead renderas="sect3">GTK+ 3 Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Required</bridgehead>
73 <para role="required">
74 <xref linkend="at-spi2-core"/>,
75 <xref linkend="gdk-pixbuf"/>,
76 <xref linkend="libepoxy"/>, and
77 <xref linkend="pango"/>
78 </para>
79
80 <bridgehead renderas="sect4">Recommended</bridgehead>
81 <para role="recommended">
82 <xref role='runtime' linkend="adwaita-icon-theme"/>
83 (at runtime; default for some gtk+3 settings keys and
84 also needed for one test),
85 <xref linkend="docbook-xsl"/> (for generating manual pages),
86 <xref linkend="hicolor-icon-theme"/> (needed for tests),
87 <xref linkend="iso-codes"/>,
88 <xref linkend="libxkbcommon"/>,
89 <xref linkend="libxslt"/> (for generating manual pages),
90 <xref linkend="sassc"/>,
91 <xref linkend="wayland"/>, and
92 <xref linkend="wayland-protocols"/>
93 </para>
94
95 <bridgehead renderas="sect4">Recommended (Required if building GNOME)</bridgehead>
96 <para role="recommended">
97 <xref linkend="gobject-introspection"/>
98 </para>
99
100 <bridgehead renderas="sect4">Optional</bridgehead>
101 <para role="optional">
102 <xref linkend="colord"/>,
103 <xref linkend="cups"/>,
104 <xref linkend="gtk-doc"/>,
105 <xref linkend="pyatspi2"/> (for tests),
106 <xref linkend='tracker3'/>, and
107 <ulink url="https://icl.utk.edu/papi/">PAPI</ulink>
108 </para>
109
110 </sect2>
111
112 <sect2 role="installation">
113 <title>Installation of GTK+ 3</title>
114
115 <para>
116 Install <application>GTK+ 3</application> by running the following
117 commands:
118 </para>
119
120 <screen><userinput>mkdir build &amp;&amp;
121cd build &amp;&amp;
122meson setup --prefix=/usr \
123 --buildtype=release \
124 -Dman=true \
125 -Dbroadway_backend=true \
126 .. &amp;&amp;
127ninja</userinput></screen>
128
129 <para>
130 To test the results you need a graphical session, then issue
131 <command>dbus-run-session ninja test</command>.
132 </para>
133
134 <para>
135 Now, as the <systemitem class="username">root</systemitem> user:
136 </para>
137
138<screen role="root"><userinput>ninja install</userinput></screen>
139
140 <para>
141 One test named <filename>check-cursor-names</filename> is known
142 to fail if <xref linkend='adwaita-icon-theme'/> is not installed.
143 </para>
144
145 <note>
146 <para>
147 If you installed the package on to your system using a
148 <quote>DESTDIR</quote> method, an important file was not installed and
149 must be copied and/or generated. Generate it using the following
150 command as the <systemitem class="username">root</systemitem> user:
151 </para>
152
153<screen role="root"><userinput>gtk-query-immodules-3.0 --update-cache</userinput></screen>
154 </note>
155
156 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
157 href="../../xincludes/gsettings-destdir.xml"/>
158 </sect2>
159
160 <sect2 role="commands">
161 <title>Command Explanations</title>
162
163 <para>
164 <parameter>-Dbroadway_backend=true</parameter>: This switch enables the
165 HTML5 GTK backend.
166 </para>
167
168 <para>
169 <parameter>-Dman=true</parameter>: This switch allows generating
170 manual pages.
171 </para>
172
173 <para>
174 <option>-Dgtk_doc=true</option>: This switch enables building
175 documentation. It requires <xref linkend="gtk-doc"/>.
176 </para>
177
178 <para>
179 <option>-Dtracker3=true</option>: This switch enables the search
180 function based on Tracker 3 in the GTK+-3 file chooser dialog.
181 It requires <xref linkend="tracker3"/>.
182 </para>
183
184 </sect2>
185
186 <sect2 role="configuration">
187 <title>Configuring GTK+ 3</title>
188
189 <sect3 id="gtk3-config">
190 <title>Config Files</title>
191 <para>
192 <filename>~/.config/gtk-3.0/settings.ini</filename> and
193 <filename>/etc/gtk-3.0/settings.ini</filename>
194 </para>
195
196 <indexterm zone="gtk3 gtk3-config">
197 <primary sortas="e-AA.home-settings.ini">~/.config/gtk-3.0/settings.ini</primary>
198 </indexterm>
199
200 <indexterm zone="gtk3 gtk3-config">
201 <primary sortas="e-etc-path-settings.ini">/etc/gtk-3.0/settings.ini</primary>
202 </indexterm>
203 </sect3>
204
205 <sect3><title>Configuration Information</title>
206
207 <para>
208 <application>GTK+ 3</application> themes change the way a
209 <application>GTK+ 3</application> application looks. An icon theme can
210 be used to change the icons that appear on the application's toolbar.
211 If you have installed a <application>GTK+ 3</application> theme (e.g.
212 the Adwaita theme built in <application>GTK+ 3</application>),
213 an icon theme (such as <xref
214 linkend="oxygen-icons"/>) and/or a font (<xref linkend="dejavu-fonts"/>),
215 you can set your preferences in <filename>~/.config/gtk-3.0/settings.ini</filename>,
216 or the default system wide configuration file (as the <systemitem
217 class="username">root</systemitem> user), in
218 <filename>/etc/gtk-3.0/settings.ini</filename>. For the local user an
219 example is:
220 </para>
221
222<screen><userinput>mkdir -vp ~/.config/gtk-3.0
223cat &gt; ~/.config/gtk-3.0/settings.ini &lt;&lt; "EOF"
224<literal>[Settings]
225gtk-theme-name = <replaceable>Adwaita</replaceable>
226gtk-icon-theme-name = <replaceable>oxygen</replaceable>
227gtk-font-name = <replaceable>DejaVu Sans 12</replaceable>
228gtk-cursor-theme-size = <replaceable>18</replaceable>
229gtk-toolbar-style = <replaceable>GTK_TOOLBAR_BOTH_HORIZ</replaceable>
230gtk-xft-antialias = <replaceable>1</replaceable>
231gtk-xft-hinting = <replaceable>1</replaceable>
232gtk-xft-hintstyle = <replaceable>hintslight</replaceable>
233gtk-xft-rgba = <replaceable>rgb</replaceable>
234gtk-cursor-theme-name = <replaceable>Adwaita</replaceable></literal>
235EOF</userinput></screen>
236
237 <para>
238 There are many settings keys, some with default values. You can find
239 them at <ulink
240 url="https://developer.gnome.org/gtk3/stable/GtkSettings.html">Settings:
241 GTK+ 3 Reference Manual</ulink>. There are many more themes available at
242 <ulink url="https://www.gnome-look.org/browse/"/> and other places.
243 </para>
244
245 <para>
246 As part of GTK+-3.0's redesign, the scroll bar buttons are no longer
247 visible on the scrollbar in many applications. If this functionality
248 is desired, modify the <filename>gtk.css</filename> file and restore
249 them using the following command:
250 </para>
251
252<screen><userinput>cat &gt; ~/.config/gtk-3.0/gtk.css &lt;&lt; "EOF"
253<literal>* {
254 -GtkScrollbar-has-backward-stepper: 1;
255 -GtkScrollbar-has-forward-stepper: 1;
256}</literal>
257EOF</userinput></screen>
258
259 <!-- This trick was discovered in the Seamonkey-2.53.2 release notes:
260 http://www.seamonkey-project.org/releases/seamonkey2.53.2/ -->
261
262 </sect3>
263 </sect2>
264
265 <sect2 role="content">
266 <title>Contents</title>
267
268 <segmentedlist>
269 <segtitle>Installed Programs</segtitle>
270 <segtitle>Installed Libraries</segtitle>
271 <segtitle>Installed Directories</segtitle>
272
273 <seglistitem>
274 <seg>
275 broadwayd,
276 gtk3-demo,
277 gtk3-demo-application,
278 gtk3-icon-browser,
279 gtk3-widget-factory,
280 gtk-builder-tool,
281 gtk-encode-symbolic-svg,
282 gtk-launch,
283 gtk-query-immodules-3.0,
284 gtk-query-settings, and
285 gtk-update-icon-cache
286 </seg>
287 <seg>
288 libgailutil-3.so, libgdk-3.so, and libgtk-3.so
289 </seg>
290 <seg>
291 /etc/gtk-3.0,
292 /usr/include/{gail,gtk}-3.0,
293 /usr/{lib,share}/gtk-3.0, and
294 /usr/share/themes/{Default,Emacs}/gtk-3.0
295 </seg>
296 </seglistitem>
297 </segmentedlist>
298
299 <variablelist>
300 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
301 <?dbfo list-presentation="list"?>
302 <?dbhtml list-presentation="table"?>
303
304 <varlistentry id="broadwayd">
305 <term><command>broadwayd</command></term>
306 <listitem>
307 <para>
308 provides support for displaying
309 <application>GTK+ 3</application> applications in a web browser,
310 using HTML5 and web sockets
311 </para>
312 <indexterm zone="gtk3 broadwayd">
313 <primary sortas="b-broadwayd">broadwayd</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="gtk3-demo">
319 <term><command>gtk3-demo</command></term>
320 <listitem>
321 <para>
322 is a simple program that demonstrates some of the tasks that can be
323 done with <application>GTK+ 3</application>
324 </para>
325 <indexterm zone="gtk3 gtk3-demo">
326 <primary sortas="b-gtk3-demo">gtk3-demo</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="gtk3-demo-application">
332 <term><command>gtk3-demo-application</command></term>
333 <listitem>
334 <para>
335 is a simple <application>GTK+ 3</application> application
336 </para>
337 <indexterm zone="gtk3 gtk3-demo-application">
338 <primary sortas="b-gtk3-demo-application">gtk3-demo-application</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="gtk3-icon-browser">
344 <term><command>gtk3-icon-browser</command></term>
345 <listitem>
346 <para>
347 is a utility to explore the icons in the current icon theme. It
348 shows icons in various sizes, their symbolic variants where
349 available, as well as a description of the icon and its context
350 </para>
351 <indexterm zone="gtk3 gtk3-icon-browser">
352 <primary sortas="b-gtk3-icon-browser">gtk3-icon-browser</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="gtk3-widget-factory">
358 <term><command>gtk3-widget-factory</command></term>
359 <listitem>
360 <para>
361 is a program to view <application>GTK+ 3</application> themes and widgets
362 </para>
363 <indexterm zone="gtk3 gtk3-widget-factory">
364 <primary sortas="b-gtk3-widget-factory">gtk3-widget-factory</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="gtk-builder-tool">
370 <term><command>gtk-builder-tool</command></term>
371 <listitem>
372 <para>
373 performs various operations on GtkBuilder .ui files
374 </para>
375 <indexterm zone="gtk3 gtk-builder-tool">
376 <primary sortas="b-gtk-builder-tool">gtk-builder-tool</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="gtk-encode-symbolic-svg">
382 <term><command>gtk-encode-symbolic-svg</command></term>
383 <listitem>
384 <para>
385 converts symbolic SVG icons into specially prepared PNG files.
386 <application>GTK+ 3</application> can load and recolor these PNGs,
387 just like original SVGs, but loading them is much faster
388 </para>
389 <indexterm zone="gtk3 gtk-encode-symbolic-svg">
390 <primary sortas="b-gtk-encode-symbolic-svg">gtk-encode-symbolic-svg</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="gtk-launch">
396 <term><command>gtk-launch</command></term>
397 <listitem>
398 <para>
399 launches an application using the given name. The name should match
400 the application desktop file name, as residing in
401 <filename class="directory">/usr/share/applications</filename>, with
402 or without the '.desktop' suffix
403 </para>
404 <indexterm zone="gtk3 gtk-launch">
405 <primary sortas="b-gtk-launch">gtk-launch</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="gtk-query-immodules-3.0">
411 <term><command>gtk-query-immodules-3.0</command></term>
412 <listitem>
413 <para>
414 collects information about loadable input method modules for
415 <application>GTK+ 3</application> and writes it to the default cache
416 file location, or to standard output
417 </para>
418 <indexterm zone="gtk3 gtk-query-immodules-3.0">
419 <primary sortas="b-gtk-query-immodules-3.0">gtk-query-immodules-3.0</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="gtk-query-settings">
425 <term><command>gtk-query-settings</command></term>
426 <listitem>
427 <para>
428 provides a complete listing of all settings related to
429 <application>GTK+ 3</application>
430 </para>
431 <indexterm zone="gtk3 gtk-query-settings">
432 <primary sortas="b-gtk-query-settings">gtk-query-settings</primary>
433 </indexterm>
434 </listitem>
435 </varlistentry>
436
437 <varlistentry id="gtk-update-icon-cache3">
438 <term><command>gtk-update-icon-cache</command></term>
439 <listitem>
440 <para>
441 is an icon theme caching utility that creates mmap()able cache files
442 for icon themes
443 </para>
444 <indexterm zone="gtk3 gtk-update-icon-cache3">
445 <primary sortas="b-gtk-update-icon-cache3">gtk-update-icon-cache</primary>
446 </indexterm>
447 </listitem>
448 </varlistentry>
449
450 <varlistentry id="libgailutil-3">
451 <term><filename class="libraryfile">libgailutil-3.so</filename></term>
452 <listitem>
453 <para>
454 contains functions that implement the accessibility interfaces
455 defined by the <application>GNOME</application> Accessibility
456 Toolkit
457 </para>
458 <indexterm zone="gtk3 libgailutil-3">
459 <primary sortas="c-libgailutil-3">libgailutil-3.so</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="libgdk-3">
465 <term><filename class="libraryfile">libgdk-3.so</filename></term>
466 <listitem>
467 <para>
468 contains functions that act as a wrapper around the low-level
469 drawing and windowing functions provided by the underlying graphics
470 system
471 </para>
472 <indexterm zone="gtk3 libgdk-3">
473 <primary sortas="c-libgdk-3">libgdk-3.so</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry id="libgtk-3">
479 <term><filename class="libraryfile">libgtk-3.so</filename></term>
480 <listitem>
481 <para>
482 contains functions that provide an API to implement graphical user
483 interfaces
484 </para>
485 <indexterm zone="gtk3 libgtk-3">
486 <primary sortas="c-libgtk-3">libgtk-3.so</primary>
487 </indexterm>
488 </listitem>
489 </varlistentry>
490
491 </variablelist>
492
493 </sect2>
494
495</sect1>
Note: See TracBrowser for help on using the repository browser.