source: x/lib/imlib2.xml@ db58e7ee

12.2 lazarus trunk xry111/for-12.3
Last change on this file since db58e7ee was 013fd98, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Add librsvg to imlib2 dependencies.
  • Property mode set to 100644
File size: 8.7 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 "93e5b769ed02a183dfd78569f7b0fbe3">
10 <!ENTITY imlib2-size "816 KB">
11 <!ENTITY imlib2-buildsize "13 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 &lfs121_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"/> and
79 <xref linkend="librsvg"/>
80 </para>
81
82 <bridgehead renderas="sect4">Optional</bridgehead>
83 <para role="optional">
84 <xref linkend="doxygen"/> (for API documentation),
85 <xref linkend="highway"/>,
86 <xref linkend="libjpeg"/>,
87 <xref linkend="libjxl"/>,
88 <xref linkend="libpng"/>,
89 <xref linkend="libtiff"/>,
90 <xref linkend="libwebp"/>,
91 <xref linkend="x265"/>,
92 <ulink url="https://github.com/strukturag/libheif">libheif</ulink>,
93 <ulink url="https://sourceforge.net/projects/mad">libid3tag</ulink>,
94 <ulink url="https://www.freedesktop.org/wiki/Software/libspectre">libspectre</ulink>
95 </para>
96
97 </sect2>
98
99 <sect2 role="installation">
100 <title>Installation of imlib2</title>
101
102 <para>
103 Install <application>imlib2</application> by running the
104 following commands:
105 </para>
106
107<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
108make</userinput></screen>
109
110 <para>
111 This package does not come with a test suite.
112 </para>
113
114 <para>
115 Now, as the &root; user:
116 </para>
117
118<screen role="root"><userinput>make install</userinput></screen>
119
120 <para>
121 If you generated the API documentation, install it as the &root; user:
122 </para>
123
124<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/imlib2-&imlib2-version;/html &amp;&amp;
125install -v -m644 doc/html/* /usr/share/doc/imlib2-&imlib2-version;/html</userinput></screen>
126
127 </sect2>
128
129 <sect2 role="commands">
130 <title>Command Explanations</title>
131
132 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
133 href="../../xincludes/static-libraries.xml"/>
134
135 <para>
136 <option>--enable-doc-build</option>: This switch generates
137 the API documentation. <xref linkend="doxygen"/> must be installed.
138 </para>
139
140 </sect2>
141
142 <sect2 role="content">
143 <title>Contents</title>
144
145 <segmentedlist>
146 <segtitle>Installed Programs</segtitle>
147 <segtitle>Installed Libraries</segtitle>
148 <segtitle>Installed Directories</segtitle>
149
150 <!-- imlib2-config dropped in 1.7.5 -->
151 <seglistitem>
152 <seg>imlib2_bumpmap,
153 imlib2_colorspace,
154 imlib2_conv,
155 imlib2_grab,
156 imlib2_load,
157 imlib2_poly,
158 imlib2_show,
159 imlib2_test, and
160 imlib2_view</seg>
161 <seg>libImlib2.so and various filters and image loader modules.</seg>
162 <seg>/usr/lib/imlib2, /usr/share/doc/imlib2-&imlib2-version;, and
163 /usr/share/imlib2</seg>
164 </seglistitem>
165 </segmentedlist>
166
167 <variablelist>
168 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
169 <?dbfo list-presentation="list"?>
170 <?dbhtml list-presentation="table"?>
171
172 <varlistentry id="imlib2_bumpmap">
173 <term><command>imlib2_bumpmap</command></term>
174 <listitem>
175 <para>
176 is to test the <application>imlib2</application> bumpmap function
177 </para>
178 <indexterm zone="imlib2 imlib2_bumpmap">
179 <primary sortas="b-imlib2_bumpmap">imlib2_bumpmap</primary>
180 </indexterm>
181 </listitem>
182 </varlistentry>
183
184 <varlistentry id="imlib2_colorspace">
185 <term><command>imlib2_colorspace</command></term>
186 <listitem>
187 <para>
188 is to test the <application>imlib2</application> colorspace
189 function
190 </para>
191 <indexterm zone="imlib2 imlib2_colorspace">
192 <primary sortas="b-imlib2_colorspace">imlib2_colorspace</primary>
193 </indexterm>
194 </listitem>
195 </varlistentry>
196
197 <varlistentry id="imlib2_conv">
198 <term><command>imlib2_conv</command></term>
199 <listitem>
200 <para>
201 converts images between formats
202 </para>
203 <indexterm zone="imlib2 imlib2_conv">
204 <primary sortas="b-imlib2_conv">imlib2_conv</primary>
205 </indexterm>
206 </listitem>
207 </varlistentry>
208
209 <varlistentry id="imlib2_grab">
210 <term><command>imlib2_grab</command></term>
211 <listitem>
212 <para>
213 takes screenshots
214 </para>
215 <indexterm zone="imlib2 imlib2_grab">
216 <primary sortas="b-imlib2_grab">imlib2_grab</primary>
217 </indexterm>
218 </listitem>
219 </varlistentry>
220
221 <varlistentry id="imlib2_load">
222 <term><command>imlib2_load</command></term>
223 <listitem>
224 <para>
225 loads and caches images
226 </para>
227 <indexterm zone="imlib2 imlib2_load">
228 <primary sortas="b-imlib2_load">imlib2_load</primary>
229 </indexterm>
230 </listitem>
231 </varlistentry>
232
233 <varlistentry id="imlib2_poly">
234 <term><command>imlib2_poly</command></term>
235 <listitem>
236 <para>
237 is to test the <application>imlib2</application> poly function
238 </para>
239 <indexterm zone="imlib2 imlib2_poly">
240 <primary sortas="b-imlib2_poly">imlib2_poly</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry id="imlib2_show">
246 <term><command>imlib2_show</command></term>
247 <listitem>
248 <para>
249 is an <application>imlib2</application> program test
250 </para>
251 <indexterm zone="imlib2 imlib2_show">
252 <primary sortas="b-imlib2_show">imlib2_show</primary>
253 </indexterm>
254 </listitem>
255 </varlistentry>
256
257 <varlistentry id="imlib2_test">
258 <term><command>imlib2_test</command></term>
259 <listitem>
260 <para>
261 is an <application>imlib2</application> program test
262 </para>
263 <indexterm zone="imlib2 imlib2_test">
264 <primary sortas="b-imlib2_test">imlib2_test</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="imlib2_view">
270 <term><command>imlib2_view</command></term>
271 <listitem>
272 <para>
273 displays image files
274 </para>
275 <indexterm zone="imlib2 imlib2_view">
276 <primary sortas="b-imlib2_view">imlib2_view</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="libImlib2">
282 <term><filename class="libraryfile">libImlib2.so</filename></term>
283 <listitem>
284 <para>
285 provides the functions for programs to handle various
286 image data formats
287 </para>
288 <indexterm zone="imlib2 libImlib2">
289 <primary sortas="c-libImlib2">libImlib2.so</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 </variablelist>
295
296 </sect2>
297
298</sect1>
Note: See TracBrowser for help on using the repository browser.