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 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 | <!ENTITY gdk-pixbuf-md5sum "f986fdbba5ec6233c96f8b6535811780">
|
---|
11 | <!ENTITY gdk-pixbuf-size "6.2 MB">
|
---|
12 | <!ENTITY gdk-pixbuf-buildsize "33 MB (with tests)">
|
---|
13 | <!ENTITY gdk-pixbuf-time "0.2 SBU (with tests)">
|
---|
14 | ]>
|
---|
15 |
|
---|
16 | <sect1 id="gdk-pixbuf" xreflabel="gdk-pixbuf-&gdk-pixbuf-version;">
|
---|
17 | <?dbhtml filename="gdk-pixbuf.html"?>
|
---|
18 |
|
---|
19 |
|
---|
20 | <title>gdk-pixbuf-&gdk-pixbuf-version;</title>
|
---|
21 |
|
---|
22 | <indexterm zone="gdk-pixbuf">
|
---|
23 | <primary sortas="a-gdk-pixbuf">gdk-pixbuf</primary>
|
---|
24 | </indexterm>
|
---|
25 |
|
---|
26 | <sect2 role="package">
|
---|
27 | <title>Introduction to Gdk Pixbuf</title>
|
---|
28 |
|
---|
29 | <para>
|
---|
30 | The <application>Gdk Pixbuf</application> package is a toolkit for image
|
---|
31 | loading and pixel buffer manipulation. It is used by
|
---|
32 | <application>GTK+ 3</application> to load and manipulate images. In the
|
---|
33 | past it was distributed as part of <application>GTK+ 2</application>, but
|
---|
34 | it was split off into a separate package in preparation for the change to
|
---|
35 | <application>GTK+ 3</application>.
|
---|
36 | </para>
|
---|
37 |
|
---|
38 | &lfs122_checked;
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (HTTP): <ulink url="&gdk-pixbuf-download-http;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download (FTP): <ulink url="&gdk-pixbuf-download-ftp;"/>
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download MD5 sum: &gdk-pixbuf-md5sum;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Download size: &gdk-pixbuf-size;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated disk space required: &gdk-pixbuf-buildsize;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Estimated build time: &gdk-pixbuf-time;
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect3">Gdk Pixbuf Dependencies</bridgehead>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
77 | <para role="required">
|
---|
78 | <xref linkend="glib2"/> (GObject Introspection required for GNOME),
|
---|
79 | <xref linkend="libjpeg"/>,
|
---|
80 | <xref linkend="libpng"/>, and
|
---|
81 | <xref linkend="shared-mime-info"/>
|
---|
82 | </para>
|
---|
83 |
|
---|
84 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
85 | <para role="recommended">
|
---|
86 | <xref linkend="docutils"/>,
|
---|
87 | <xref role="runtime" linkend="librsvg"/> (runtime dependency, needed for
|
---|
88 | loading symbolic icons) and
|
---|
89 | <xref linkend="libtiff"/>
|
---|
90 | </para>
|
---|
91 |
|
---|
92 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
93 | <para role="optional">
|
---|
94 | <xref linkend="gi-docgen"/>
|
---|
95 | (to generate documentation),
|
---|
96 | <xref role="runtime" linkend="libavif"/>
|
---|
97 | (runtime dependency, needed for loading AVIF images),
|
---|
98 | <xref role="runtime" linkend="libjxl"/>
|
---|
99 | (runtime dependency, needed for loading JPEG XL images), and
|
---|
100 | <xref role="runtime" linkend="webp-pixbuf-loader"/>
|
---|
101 | (runtime dependency, needed for loading WebP images)
|
---|
102 | </para>
|
---|
103 |
|
---|
104 | </sect2>
|
---|
105 |
|
---|
106 | <sect2 role="installation">
|
---|
107 | <title>Installation of Gdk Pixbuf</title>
|
---|
108 |
|
---|
109 | <para>
|
---|
110 | Install <application>Gdk Pixbuf</application> by running the following
|
---|
111 | commands:
|
---|
112 | </para>
|
---|
113 |
|
---|
114 | <screen><userinput>mkdir build &&
|
---|
115 | cd build &&
|
---|
116 |
|
---|
117 | meson setup .. \
|
---|
118 | --prefix=/usr \
|
---|
119 | --buildtype=release \
|
---|
120 | -D others=enabled \
|
---|
121 | --wrap-mode=nofallback &&
|
---|
122 | ninja</userinput></screen>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
126 | the API documentation for this package, issue:
|
---|
127 | </para>
|
---|
128 |
|
---|
129 | <screen role='nodump'><userinput>sed "/docs_dir =/s@\$@ / 'gdk-pixbuf-&gdk-pixbuf-version;'@" -i ../docs/meson.build &&
|
---|
130 | meson configure -D gtk_doc=true &&
|
---|
131 | ninja</userinput></screen>
|
---|
132 |
|
---|
133 | <para>
|
---|
134 | To test the results, issue: <command>ninja test</command>. The tests
|
---|
135 | make a heavy use of disk.
|
---|
136 | </para>
|
---|
137 |
|
---|
138 | <para>
|
---|
139 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
140 | </para>
|
---|
141 |
|
---|
142 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
143 |
|
---|
144 | <note>
|
---|
145 | <para>
|
---|
146 | If you installed the package on to your system using a
|
---|
147 | <quote>DESTDIR</quote> method, an important file was not installed and
|
---|
148 | should be copied and/or generated. Generate it using the following
|
---|
149 | command as the <systemitem class="username">root</systemitem> user:
|
---|
150 | </para>
|
---|
151 |
|
---|
152 | <screen role="root"><userinput>gdk-pixbuf-query-loaders --update-cache</userinput></screen>
|
---|
153 | </note>
|
---|
154 | </sect2>
|
---|
155 |
|
---|
156 | <sect2 role="commands">
|
---|
157 | <title>Command Explanations</title>
|
---|
158 |
|
---|
159 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
160 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
161 |
|
---|
162 | <!-- gi-docgen can get installed without this, if deps exist -->
|
---|
163 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
164 | href="../../xincludes/meson-wrap-nofallback.xml"/>
|
---|
165 |
|
---|
166 | <para>
|
---|
167 | <parameter>-D others=enabled</parameter>: Enable the loaders for various
|
---|
168 | image formats, for example BMP and XPM.
|
---|
169 | </para>
|
---|
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>-D man=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>
|
---|