source: x/lib/imlib2.xml@ f67c5c8

12.1 ken/TL2024 lazarus trunk xry111/llvm18
Last change on this file since f67c5c8 was ff5c8894, checked in by Bruce Dubbs <bdubbs@…>, 3 months ago

Update to imlib2-1.12.2.
  • Property mode set to 100644
File size: 8.8 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 imlib2-download-http "&sourceforge-dl;/enlightenment/imlib2-&imlib2-version;.tar.xz">
8 <!ENTITY imlib2-download-ftp " ">
9 <!ENTITY imlib2-md5sum "046e7b2c918ae612dbf61dea8b59f37a">
10 <!ENTITY imlib2-size "816 KB">
11 <!ENTITY imlib2-buildsize "14 MB (with docs)">
12 <!ENTITY imlib2-time "0.2 SBU (with docs)">
13]>
14
15<sect1 id="imlib2" xreflabel="imlib2-&imlib2-version;">
16 <?dbhtml filename="imlib2.html"?>
17
18
19 <title>imlib2-&imlib2-version;</title>
20
21 <indexterm zone="imlib2">
22 <primary sortas="a-imlib2">imlib2</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to imlib2</title>
27
28 <para>
29 <application>imlib2</application> is a graphics library for fast file
30 loading, saving, rendering and manipulation.
31 </para>
32
33 &lfs120_checked;
34
35 <bridgehead renderas="sect3">Package Information</bridgehead>
36 <itemizedlist spacing="compact">
37 <listitem>
38 <para>
39 Download (HTTP): <ulink url="&imlib2-download-http;"/>
40 </para>
41 </listitem>
42 <listitem>
43 <para>
44 Download (FTP): <ulink url="&imlib2-download-ftp;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download MD5 sum: &imlib2-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &imlib2-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &imlib2-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &imlib2-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68
69 <bridgehead renderas="sect3">imlib2 Dependencies</bridgehead>
70
71 <bridgehead renderas="sect4">Required</bridgehead>
72 <para role="required">
73 <xref linkend="xorg7-lib"/>
74 </para>
75
76 <bridgehead renderas="sect4">Recommended</bridgehead>
77 <para role="recommended">
78 <xref linkend="giflib"/>
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="doxygen"/> (for API documentation),
84 <xref linkend="libjpeg"/>,
85 <xref linkend="libpng"/>,
86 <xref linkend="libtiff"/>,
87 <xref linkend="libwebp"/>,
88 <xref linkend="x265"/>,
89 <ulink url="https://github.com/google/highway/">highway</ulink>,
90 <ulink url="https://github.com/strukturag/libheif">libheif</ulink>,
91 <ulink url="https://sourceforge.net/projects/mad">libid3tag</ulink>,
92 <ulink url="https://jpeg.org/jpegxl/">libjxl</ulink>, and
93 <ulink url="https://www.freedesktop.org/wiki/Software/libspectre">libspectre</ulink>
94 </para>
95
96 </sect2>
97
98 <sect2 role="installation">
99 <title>Installation of imlib2</title>
100
101 <para>
102 Install <application>imlib2</application> by running the
103 following commands:
104 </para>
105
106<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
107make</userinput></screen>
108
109 <para>
110 This package does not come with a test suite.
111 </para>
112
113 <para>
114 Now, as the &root; user:
115 </para>
116
117<screen role="root"><userinput>make install</userinput></screen>
118
119 <para>
120 If you generated the API documentation, install it as the &root; user:
121 </para>
122
123<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/imlib2-&imlib2-version;/html &amp;&amp;
124install -v -m644 doc/html/* /usr/share/doc/imlib2-&imlib2-version;/html</userinput></screen>
125
126 </sect2>
127
128 <sect2 role="commands">
129 <title>Command Explanations</title>
130
131 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
132 href="../../xincludes/static-libraries.xml"/>
133
134 <para>
135 <option>--enable-doc-build</option>: This switch generates
136 the API documentation. <xref linkend="doxygen"/> must be installed.
137 </para>
138
139 </sect2>
140
141 <sect2 role="content">
142 <title>Contents</title>
143
144 <segmentedlist>
145 <segtitle>Installed Programs</segtitle>
146 <segtitle>Installed Libraries</segtitle>
147 <segtitle>Installed Directories</segtitle>
148
149 <!-- imlib2-config dropped in 1.7.5 -->
150 <seglistitem>
151 <seg>imlib2_bumpmap,
152 imlib2_colorspace,
153 imlib2_conv,
154 imlib2_grab,
155 imlib2_load,
156 imlib2_poly,
157 imlib2_show,
158 imlib2_test, and
159 imlib2_view</seg>
160 <seg>libImlib2.so and various filters and image loader modules.</seg>
161 <seg>/usr/lib/imlib2, /usr/share/doc/imlib2-&imlib2-version;, and
162 /usr/share/imlib2</seg>
163 </seglistitem>
164 </segmentedlist>
165
166 <variablelist>
167 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
168 <?dbfo list-presentation="list"?>
169 <?dbhtml list-presentation="table"?>
170
171 <varlistentry id="imlib2_bumpmap">
172 <term><command>imlib2_bumpmap</command></term>
173 <listitem>
174 <para>
175 is to test the <application>imlib2</application> bumpmap function
176 </para>
177 <indexterm zone="imlib2 imlib2_bumpmap">
178 <primary sortas="b-imlib2_bumpmap">imlib2_bumpmap</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry id="imlib2_colorspace">
184 <term><command>imlib2_colorspace</command></term>
185 <listitem>
186 <para>
187 is to test the <application>imlib2</application> colorspace
188 function
189 </para>
190 <indexterm zone="imlib2 imlib2_colorspace">
191 <primary sortas="b-imlib2_colorspace">imlib2_colorspace</primary>
192 </indexterm>
193 </listitem>
194 </varlistentry>
195
196 <varlistentry id="imlib2_conv">
197 <term><command>imlib2_conv</command></term>
198 <listitem>
199 <para>
200 converts images between formats
201 </para>
202 <indexterm zone="imlib2 imlib2_conv">
203 <primary sortas="b-imlib2_conv">imlib2_conv</primary>
204 </indexterm>
205 </listitem>
206 </varlistentry>
207
208 <varlistentry id="imlib2_grab">
209 <term><command>imlib2_grab</command></term>
210 <listitem>
211 <para>
212 takes screenshots
213 </para>
214 <indexterm zone="imlib2 imlib2_grab">
215 <primary sortas="b-imlib2_grab">imlib2_grab</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="imlib2_load">
221 <term><command>imlib2_load</command></term>
222 <listitem>
223 <para>
224 loads and caches images
225 </para>
226 <indexterm zone="imlib2 imlib2_load">
227 <primary sortas="b-imlib2_load">imlib2_load</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="imlib2_poly">
233 <term><command>imlib2_poly</command></term>
234 <listitem>
235 <para>
236 is to test the <application>imlib2</application> poly function
237 </para>
238 <indexterm zone="imlib2 imlib2_poly">
239 <primary sortas="b-imlib2_poly">imlib2_poly</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="imlib2_show">
245 <term><command>imlib2_show</command></term>
246 <listitem>
247 <para>
248 is an <application>imlib2</application> program test
249 </para>
250 <indexterm zone="imlib2 imlib2_show">
251 <primary sortas="b-imlib2_show">imlib2_show</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="imlib2_test">
257 <term><command>imlib2_test</command></term>
258 <listitem>
259 <para>
260 is an <application>imlib2</application> program test
261 </para>
262 <indexterm zone="imlib2 imlib2_test">
263 <primary sortas="b-imlib2_test">imlib2_test</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="imlib2_view">
269 <term><command>imlib2_view</command></term>
270 <listitem>
271 <para>
272 displays image files
273 </para>
274 <indexterm zone="imlib2 imlib2_view">
275 <primary sortas="b-imlib2_view">imlib2_view</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="libImlib2">
281 <term><filename class="libraryfile">libImlib2.so</filename></term>
282 <listitem>
283 <para>
284 provides the functions for programs to handle various
285 image data formats
286 </para>
287 <indexterm zone="imlib2 libImlib2">
288 <primary sortas="c-libImlib2">libImlib2.so</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 </variablelist>
294
295 </sect2>
296
297</sect1>
Note: See TracBrowser for help on using the repository browser.