source: x/lib/gdk-pixbuf.xml

trunk
Last change on this file was 34cc338, checked in by Douglas R. Reno <renodr@…>, 11 days ago

gdk-pixbuf: remove unnecessary sed

  • Property mode set to 100644
File size: 10.1 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 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+ 2</application> and <application>GTK+ 3</application> to
33 load and manipulate images. In the past it was distributed as part of
34 <application>GTK+ 2</application> but it was split off into a separate
35 package in preparation for the change to <application>GTK+ 3</application>.
36 </para>
37
38 &lfs121_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<!-- Fixed in 2.42.12
110 <para>
111 Fix an issue causing the package fail to build with
112 <parameter>-Dothers=enabled</parameter>:
113 </para>
114
115<screen><userinput>sed 's/enabled_loaders_contains/enabled_loaders.contains/' \
116 -i tests/meson.build</userinput></screen>
117-->
118
119 <para>
120 Install <application>Gdk Pixbuf</application> by running the following
121 commands:
122 </para>
123
124<screen><userinput>mkdir build &amp;&amp;
125cd build &amp;&amp;
126
127meson setup .. \
128 --prefix=/usr \
129 --buildtype=release \
130 -Dothers=enabled \
131 --wrap-mode=nofallback &amp;&amp;
132ninja</userinput></screen>
133
134 <para>
135 If you have <xref linkend='gi-docgen'/> installed and wish to build
136 the API documentation for this package, issue:
137 </para>
138
139<screen role='nodump'><userinput>sed "/docs_dir =/s@\$@ / 'gdk-pixbuf-&gdk-pixbuf-version;'@" -i ../docs/meson.build &amp;&amp;
140meson configure -Dgtk_doc=true &amp;&amp;
141ninja</userinput></screen>
142
143 <para>
144 To test the results, issue: <command>ninja test</command>. The tests
145 make a heavy use of disk.
146 </para>
147
148 <para>
149 Now, as the <systemitem class="username">root</systemitem> user:
150 </para>
151
152<screen role="root"><userinput>ninja install</userinput></screen>
153
154 <note>
155 <para>
156 If you installed the package on to your system using a
157 <quote>DESTDIR</quote> method, an important file was not installed and
158 should be copied and/or generated. Generate it using the following
159 command as the <systemitem class="username">root</systemitem> user:
160 </para>
161
162<screen role="root"><userinput>gdk-pixbuf-query-loaders --update-cache</userinput></screen>
163 </note>
164 </sect2>
165
166 <sect2 role="commands">
167 <title>Command Explanations</title>
168
169 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
170 href="../../xincludes/meson-buildtype-release.xml"/>
171
172 <!-- gi-docgen can get installed without this, if deps exist -->
173 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
174 href="../../xincludes/meson-wrap-nofallback.xml"/>
175
176 <para>
177 <parameter>-Dothers=enabled</parameter>: Enable the loaders for various
178 image formats, for example BMP and XPM.
179 </para>
180
181 <!-- with 2.42.9, docutils must be installed to generate man pages.
182 Without this, you'll get the following output:
183 Program rst2man found: ../docs/meson.build:70:2: ERROR: Problem encountered:
184 No rst2man found, but man pages were explicitly enabled -->
185 <para>
186 <option>-Dman=false</option>: Use this option if you do not want to
187 generate manual pages, or if you do not want to install
188 <xref linkend="docutils" role="nodep"/>.
189 </para>
190 </sect2>
191
192 <sect2 role="content">
193 <title>Contents</title>
194
195 <segmentedlist>
196 <segtitle>Installed Programs</segtitle>
197 <segtitle>Installed Libraries</segtitle>
198 <segtitle>Installed Directories</segtitle>
199
200 <seglistitem>
201 <seg>
202 gdk-pixbuf-csource,
203 gdk-pixbuf-pixdata,
204 gdk-pixbuf-query-loaders, and
205 gdk-pixbuf-thumbnailer
206 </seg>
207 <seg>
208 libgdk_pixbuf-2.0.so
209 </seg>
210 <seg>
211 /usr/{include,lib}/gdk-pixbuf-2.0,
212 /usr/libexec/installed-tests/gdk-pixbuf,
213 /usr/share/installed-tests/gdk-pixbuf,
214 /usr/share/gtk-doc/html/gdk-pixbuf, and
215 /usr/share/thumbnailers
216 </seg>
217 </seglistitem>
218 </segmentedlist>
219
220 <variablelist>
221 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
222 <?dbfo list-presentation="list"?>
223 <?dbhtml list-presentation="table"?>
224
225 <varlistentry id="gdk-pixbuf-csource">
226 <term><command>gdk-pixbuf-csource</command></term>
227 <listitem>
228 <para>
229 is a small utility that generates C code containing images, used
230 for compiling images directly into programs
231 </para>
232 <indexterm zone="gdk-pixbuf gdk-pixbuf-csource">
233 <primary sortas="b-gdk-pixbuf-csource">gdk-pixbuf-csource</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="gdk-pixbuf-pixdata">
239 <term><command>gdk-pixbuf-pixdata</command></term>
240 <listitem>
241 <para>
242 is a tool used to convert GdkPixbuf to GdkPixdata
243 </para>
244 <indexterm zone="gdk-pixbuf gdk-pixbuf-pixdata">
245 <primary sortas="b-gdk-pixbuf-pixdata">gdk-pixbuf-pixdata</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="gdk-pixbuf-query-loaders">
251 <term><command>gdk-pixbuf-query-loaders</command></term>
252 <listitem>
253 <para>
254 collects information about loadable modules for
255 <application>Gdk Pixbuf</application> and writes it
256 to the default cache file location, or to stdout
257 </para>
258 <indexterm zone="gdk-pixbuf gdk-pixbuf-query-loaders">
259 <primary sortas="b-gdk-pixbuf-query-loaders">gdk-pixbuf-query-loaders</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="gdk-pixbuf-thumbnailer">
265 <term><command>gdk-pixbuf-thumbnailer</command></term>
266 <listitem>
267 <para>
268 creates thumbnails of pictures for use in other applications
269 </para>
270 <indexterm zone="gdk-pixbuf gdk-pixbuf-thumbnailer">
271 <primary sortas="b-gdk-pixbuf-thumbnailer">gdk-pixbuf-thumbnailer</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="libgdk_pixbuf-2">
277 <term><filename class="libraryfile">libgdk_pixbuf-2.0.so</filename></term>
278 <listitem>
279 <para>
280 contains functions used to load and render images
281 </para>
282 <indexterm zone="gdk-pixbuf libgdk_pixbuf-2">
283 <primary sortas="c-libgdk_pixbuf-2">libgdk_pixbuf-2.0.so</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288 <!-- Split off into gdk-pixbuf-xlib
289 <varlistentry id="libgdk_pixbuf_xlib-2">
290 <term><filename class="libraryfile">libgdk_pixbuf_xlib-2.0.so</filename></term>
291 <listitem>
292 <para>
293 contains functions used to manipulate images and interfaces with
294 <application>Xlib</application>
295 </para>
296 <indexterm zone="gdk-pixbuf libgdk_pixbuf_xlib-2">
297 <primary sortas="c-libgdk_pixbuf_xlib-2">libgdk_pixbuf_xlib-2.0.so</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301 -->
302 </variablelist>
303
304 </sect2>
305
306</sect1>
Note: See TracBrowser for help on using the repository browser.