source: x/lib/gdk-pixbuf.xml@ 14891a90

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 14891a90 was 14891a90, checked in by Xi Ruoyao <xry111@…>, 12 months ago

treewide: More "User Notes" clean up

Remove links to pages w/o real contents.
  • Property mode set to 100644
File size: 9.8 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 gdk-pixbuf-download-http
8 "&gnome-download-http;/gdk-pixbuf/2.42/gdk-pixbuf-&gdk-pixbuf-version;.tar.xz">
9 <!ENTITY gdk-pixbuf-download-ftp
10 "&gnome-download-ftp;/gdk-pixbuf/2.42/gdk-pixbuf-&gdk-pixbuf-version;.tar.xz">
11 <!ENTITY gdk-pixbuf-md5sum "4a62f339cb1424693fba9bb7ffef8150">
12 <!ENTITY gdk-pixbuf-size "6.2 MB">
13 <!ENTITY gdk-pixbuf-buildsize "36 MB (with tests)">
14 <!ENTITY gdk-pixbuf-time "0.2 SBU (With tests; both using parallelism=4)">
15]>
16
17<sect1 id="gdk-pixbuf" xreflabel="gdk-pixbuf-&gdk-pixbuf-version;">
18 <?dbhtml filename="gdk-pixbuf.html"?>
19
20
21 <title>gdk-pixbuf-&gdk-pixbuf-version;</title>
22
23 <indexterm zone="gdk-pixbuf">
24 <primary sortas="a-gdk-pixbuf">gdk-pixbuf</primary>
25 </indexterm>
26
27 <sect2 role="package">
28 <title>Introduction to Gdk Pixbuf</title>
29
30 <para>
31 The <application>Gdk Pixbuf</application> package is a toolkit for image
32 loading and pixel buffer manipulation. It is used by
33 <application>GTK+ 2</application> and <application>GTK+ 3</application> to
34 load and manipulate images. In the past it was distributed as part of
35 <application>GTK+ 2</application> but it was split off into a separate
36 package in preparation for the change to <application>GTK+ 3</application>.
37 </para>
38
39 &lfs113_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&gdk-pixbuf-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&gdk-pixbuf-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &gdk-pixbuf-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &gdk-pixbuf-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &gdk-pixbuf-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &gdk-pixbuf-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Gdk Pixbuf Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="glib2"/>,
80 <xref linkend="libjpeg"/>,
81 <xref linkend="libpng"/>, and
82 <xref linkend="shared-mime-info"/>
83 </para>
84
85 <bridgehead renderas="sect4">Recommended</bridgehead>
86 <para role="recommended">
87 <xref linkend="docutils"/>,
88 <xref role="runtime" linkend="librsvg"/> (runtime dependency, needed for
89 loading symbolic icons) and
90 <xref linkend="libtiff"/>
91 </para>
92
93 <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
94 <para role="optional">
95 <xref linkend="gobject-introspection"/>
96 </para>
97
98 <bridgehead renderas="sect4">Optional</bridgehead>
99 <para role="optional">
100 <xref role="runtime" linkend="gdk-pixbuf-xlib"/>
101 (runtime dependency, needed for loading XPM images),
102 <xref linkend="gi-docgen"/>
103 (to generate documentation),
104 <xref role="runtime" linkend="libavif"/>
105 (runtime dependency, needed for loading AVIF images), and
106 <xref role="runtime" linkend="webp-pixbuf-loader"/>
107 (runtime dependency, needed for loading WebP images)
108 </para>
109
110 </sect2>
111
112 <sect2 role="installation">
113 <title>Installation of Gdk Pixbuf</title>
114
115 <para>
116 Install <application>Gdk Pixbuf</application> by running the following
117 commands:
118 </para>
119
120<screen><userinput>mkdir build &amp;&amp;
121cd build &amp;&amp;
122
123meson setup .. \
124 --prefix=/usr \
125 --buildtype=release \
126 --wrap-mode=nofallback &amp;&amp;
127ninja</userinput></screen>
128
129 <para>
130 If you have <xref linkend='gi-docgen'/> installed and wish to build
131 the API documentation for this package, issue:
132 </para>
133
134<screen role='nodump'><userinput>sed "/docs_dir =/s@\$@ / 'gdk-pixbuf-&gdk-pixbuf-version;'@" -i ../docs/meson.build &amp;&amp;
135meson configure -Dgtk_doc=true &amp;&amp;
136ninja</userinput></screen>
137
138 <para>
139 To test the results, issue: <command>ninja test</command>. The tests
140 make a heavy use of disk.
141 </para>
142
143 <para>
144 Now, as the <systemitem class="username">root</systemitem> user:
145 </para>
146
147<screen role="root"><userinput>ninja install</userinput></screen>
148
149 <note>
150 <para>
151 If you installed the package on to your system using a
152 <quote>DESTDIR</quote> method, an important file was not installed and
153 should be copied and/or generated. Generate it using the following
154 command as the <systemitem class="username">root</systemitem> user:
155 </para>
156
157<screen role="root"><userinput>gdk-pixbuf-query-loaders --update-cache</userinput></screen>
158 </note>
159 </sect2>
160
161 <sect2 role="commands">
162 <title>Command Explanations</title>
163
164 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
165 href="../../xincludes/meson-buildtype-release.xml"/>
166
167 <!-- gi-docgen can get installed without this, if deps exist -->
168 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
169 href="../../xincludes/meson-wrap-nofallback.xml"/>
170
171 <!-- with 2.42.9, docutils must be installed to generate man pages.
172 Without this, you'll get the following output:
173 Program rst2man found: ../docs/meson.build:70:2: ERROR: Problem encountered:
174 No rst2man found, but man pages were explicitly enabled -->
175 <para>
176 <option>-Dman=false</option>: Use this option if you do not want to
177 generate manual pages, or if you do not want to install
178 <xref linkend="docutils" role="nodep"/>.
179 </para>
180 </sect2>
181
182 <sect2 role="content">
183 <title>Contents</title>
184
185 <segmentedlist>
186 <segtitle>Installed Programs</segtitle>
187 <segtitle>Installed Libraries</segtitle>
188 <segtitle>Installed Directories</segtitle>
189
190 <seglistitem>
191 <seg>
192 gdk-pixbuf-csource,
193 gdk-pixbuf-pixdata,
194 gdk-pixbuf-query-loaders, and
195 gdk-pixbuf-thumbnailer
196 </seg>
197 <seg>
198 libgdk_pixbuf-2.0.so
199 </seg>
200 <seg>
201 /usr/{include,lib}/gdk-pixbuf-2.0,
202 /usr/libexec/installed-tests/gdk-pixbuf,
203 /usr/share/installed-tests/gdk-pixbuf,
204 /usr/share/gtk-doc/html/gdk-pixbuf, and
205 /usr/share/thumbnailers
206 </seg>
207 </seglistitem>
208 </segmentedlist>
209
210 <variablelist>
211 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
212 <?dbfo list-presentation="list"?>
213 <?dbhtml list-presentation="table"?>
214
215 <varlistentry id="gdk-pixbuf-csource">
216 <term><command>gdk-pixbuf-csource</command></term>
217 <listitem>
218 <para>
219 is a small utility that generates C code containing images, used
220 for compiling images directly into programs
221 </para>
222 <indexterm zone="gdk-pixbuf gdk-pixbuf-csource">
223 <primary sortas="b-gdk-pixbuf-csource">gdk-pixbuf-csource</primary>
224 </indexterm>
225 </listitem>
226 </varlistentry>
227
228 <varlistentry id="gdk-pixbuf-pixdata">
229 <term><command>gdk-pixbuf-pixdata</command></term>
230 <listitem>
231 <para>
232 is a tool used to convert GdkPixbuf to GdkPixdata
233 </para>
234 <indexterm zone="gdk-pixbuf gdk-pixbuf-pixdata">
235 <primary sortas="b-gdk-pixbuf-pixdata">gdk-pixbuf-pixdata</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="gdk-pixbuf-query-loaders">
241 <term><command>gdk-pixbuf-query-loaders</command></term>
242 <listitem>
243 <para>
244 collects information about loadable modules for
245 <application>Gdk Pixbuf</application> and writes it
246 to the default cache file location, or to stdout
247 </para>
248 <indexterm zone="gdk-pixbuf gdk-pixbuf-query-loaders">
249 <primary sortas="b-gdk-pixbuf-query-loaders">gdk-pixbuf-query-loaders</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="gdk-pixbuf-thumbnailer">
255 <term><command>gdk-pixbuf-thumbnailer</command></term>
256 <listitem>
257 <para>
258 creates thumbnails of pictures for use in other applications
259 </para>
260 <indexterm zone="gdk-pixbuf gdk-pixbuf-thumbnailer">
261 <primary sortas="b-gdk-pixbuf-thumbnailer">gdk-pixbuf-thumbnailer</primary>
262 </indexterm>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry id="libgdk_pixbuf-2">
267 <term><filename class="libraryfile">libgdk_pixbuf-2.0.so</filename></term>
268 <listitem>
269 <para>
270 contains functions used to load and render images
271 </para>
272 <indexterm zone="gdk-pixbuf libgdk_pixbuf-2">
273 <primary sortas="c-libgdk_pixbuf-2">libgdk_pixbuf-2.0.so</primary>
274 </indexterm>
275 </listitem>
276 </varlistentry>
277
278 <!-- Split off into gdk-pixbuf-xlib
279 <varlistentry id="libgdk_pixbuf_xlib-2">
280 <term><filename class="libraryfile">libgdk_pixbuf_xlib-2.0.so</filename></term>
281 <listitem>
282 <para>
283 contains functions used to manipulate images and interfaces with
284 <application>Xlib</application>
285 </para>
286 <indexterm zone="gdk-pixbuf libgdk_pixbuf_xlib-2">
287 <primary sortas="c-libgdk_pixbuf_xlib-2">libgdk_pixbuf_xlib-2.0.so</primary>
288 </indexterm>
289 </listitem>
290 </varlistentry>
291 -->
292 </variablelist>
293
294 </sect2>
295
296</sect1>
Note: See TracBrowser for help on using the repository browser.