source: x/lib/gdk-pixbuf.xml@ 36eff21

gimp3 lazarus trunk
Last change on this file since 36eff21 was 21049641, checked in by Xi Ruoyao <xry111@…>, 3 months ago

gdk-pixbuf: Fix the sed

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