[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[52d29f7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[e91c678] | 7 | <!ENTITY imlib2-download-http "&sourceforge-dl;/enlightenment/imlib2-&imlib2-version;.tar.xz">
|
---|
[1ae5e7f] | 8 | <!ENTITY imlib2-download-ftp " ">
|
---|
[e407e64] | 9 | <!ENTITY imlib2-md5sum "93e5b769ed02a183dfd78569f7b0fbe3">
|
---|
[d7f9c0ec] | 10 | <!ENTITY imlib2-size "816 KB">
|
---|
[e407e64] | 11 | <!ENTITY imlib2-buildsize "13 MB (with docs)">
|
---|
[4b9ee83c] | 12 | <!ENTITY imlib2-time "0.2 SBU (with docs)">
|
---|
[52d29f7] | 13 | ]>
|
---|
| 14 |
|
---|
[fced775] | 15 | <sect1 id="imlib2" xreflabel="imlib2-&imlib2-version;">
|
---|
[6e393b07] | 16 | <?dbhtml filename="imlib2.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[fced775] | 19 | <title>imlib2-&imlib2-version;</title>
|
---|
[6e393b07] | 20 |
|
---|
| 21 | <indexterm zone="imlib2">
|
---|
[fced775] | 22 | <primary sortas="a-imlib2">imlib2</primary>
|
---|
[6e393b07] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[fced775] | 26 | <title>Introduction to imlib2</title>
|
---|
[6e393b07] | 27 |
|
---|
[baac59c] | 28 | <para>
|
---|
| 29 | <application>imlib2</application> is a graphics library for fast file
|
---|
| 30 | loading, saving, rendering and manipulation.
|
---|
| 31 | </para>
|
---|
[6e393b07] | 32 |
|
---|
[dfa5ffd] | 33 | &lfs122_checked;
|
---|
[e2e42c7] | 34 |
|
---|
[6e393b07] | 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
[baac59c] | 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&imlib2-download-http;"/>
|
---|
| 40 | </para>
|
---|
[6e393b07] | 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
[baac59c] | 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&imlib2-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
[6e393b07] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[baac59c] | 48 | <para>
|
---|
| 49 | Download MD5 sum: &imlib2-md5sum;
|
---|
| 50 | </para>
|
---|
[6e393b07] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[baac59c] | 53 | <para>
|
---|
| 54 | Download size: &imlib2-size;
|
---|
| 55 | </para>
|
---|
[6e393b07] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[baac59c] | 58 | <para>
|
---|
| 59 | Estimated disk space required: &imlib2-buildsize;
|
---|
| 60 | </para>
|
---|
[6e393b07] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[baac59c] | 63 | <para>
|
---|
| 64 | Estimated build time: &imlib2-time;
|
---|
| 65 | </para>
|
---|
[6e393b07] | 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
[fced775] | 69 | <bridgehead renderas="sect3">imlib2 Dependencies</bridgehead>
|
---|
[6e393b07] | 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[4b432b85] | 72 | <para role="required">
|
---|
[435a74c] | 73 | <xref linkend="xorg7-lib"/>
|
---|
[4b432b85] | 74 | </para>
|
---|
[1ae5e7f] | 75 |
|
---|
[944f353] | 76 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 77 | <para role="recommended">
|
---|
[013fd98] | 78 | <xref linkend="giflib"/> and
|
---|
| 79 | <xref linkend="librsvg"/>
|
---|
[944f353] | 80 | </para>
|
---|
| 81 |
|
---|
[6e393b07] | 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[4b432b85] | 83 | <para role="optional">
|
---|
[bf62a13] | 84 | <xref linkend="doxygen"/> (for API documentation),
|
---|
[abf1c589] | 85 | <xref linkend="highway"/>,
|
---|
[435a74c] | 86 | <xref linkend="libjpeg"/>,
|
---|
[abf1c589] | 87 | <xref linkend="libjxl"/>,
|
---|
[d7f9c0ec] | 88 | <xref linkend="libpng"/>,
|
---|
[8478356] | 89 | <xref linkend="libtiff"/>,
|
---|
[d7f9c0ec] | 90 | <xref linkend="libwebp"/>,
|
---|
[6646cae6] | 91 | <ulink url="https://github.com/strukturag/libheif">libheif</ulink>,
|
---|
[d7f9c0ec] | 92 | <ulink url="https://sourceforge.net/projects/mad">libid3tag</ulink>,
|
---|
| 93 | <ulink url="https://www.freedesktop.org/wiki/Software/libspectre">libspectre</ulink>
|
---|
[4b432b85] | 94 | </para>
|
---|
[6e393b07] | 95 |
|
---|
| 96 | </sect2>
|
---|
| 97 |
|
---|
| 98 | <sect2 role="installation">
|
---|
[fced775] | 99 | <title>Installation of imlib2</title>
|
---|
[6e393b07] | 100 |
|
---|
[baac59c] | 101 | <para>
|
---|
| 102 | Install <application>imlib2</application> by running the
|
---|
| 103 | following commands:
|
---|
| 104 | </para>
|
---|
[6e393b07] | 105 |
|
---|
[1a93b27] | 106 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[6e393b07] | 107 | make</userinput></screen>
|
---|
| 108 |
|
---|
[baac59c] | 109 | <para>
|
---|
| 110 | This package does not come with a test suite.
|
---|
| 111 | </para>
|
---|
[9f12e36] | 112 |
|
---|
[baac59c] | 113 | <para>
|
---|
[bf62a13] | 114 | Now, as the &root; user:
|
---|
[baac59c] | 115 | </para>
|
---|
[6e393b07] | 116 |
|
---|
[bf62a13] | 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 &&
|
---|
| 124 | install -v -m644 doc/html/* /usr/share/doc/imlib2-&imlib2-version;/html</userinput></screen>
|
---|
[3dea735] | 125 |
|
---|
[6e393b07] | 126 | </sect2>
|
---|
[52d29f7] | 127 |
|
---|
[6e393b07] | 128 | <sect2 role="commands">
|
---|
| 129 | <title>Command Explanations</title>
|
---|
[3dea735] | 130 |
|
---|
[db6a202] | 131 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 132 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 133 |
|
---|
[bf62a13] | 134 | <para>
|
---|
[875b3b57] | 135 | <option>--enable-doc-build</option>: This switch generates
|
---|
[bf62a13] | 136 | the API documentation. <xref linkend="doxygen"/> must be installed.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
[6e393b07] | 139 | </sect2>
|
---|
[3dea735] | 140 |
|
---|
[6e393b07] | 141 | <sect2 role="content">
|
---|
| 142 | <title>Contents</title>
|
---|
[3dea735] | 143 |
|
---|
[6e393b07] | 144 | <segmentedlist>
|
---|
| 145 | <segtitle>Installed Programs</segtitle>
|
---|
| 146 | <segtitle>Installed Libraries</segtitle>
|
---|
| 147 | <segtitle>Installed Directories</segtitle>
|
---|
[9e7ac06] | 148 |
|
---|
[1302dc68] | 149 | <!-- imlib2-config dropped in 1.7.5 -->
|
---|
[6e393b07] | 150 | <seglistitem>
|
---|
[d7f9c0ec] | 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>
|
---|
[db6a202] | 160 | <seg>libImlib2.so and various filters and image loader modules.</seg>
|
---|
[9f12e36] | 161 | <seg>/usr/lib/imlib2, /usr/share/doc/imlib2-&imlib2-version;, and
|
---|
[3569263] | 162 | /usr/share/imlib2</seg>
|
---|
[6e393b07] | 163 | </seglistitem>
|
---|
| 164 | </segmentedlist>
|
---|
[9e7ac06] | 165 |
|
---|
[6e393b07] | 166 | <variablelist>
|
---|
| 167 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 168 | <?dbfo list-presentation="list"?>
|
---|
| 169 | <?dbhtml list-presentation="table"?>
|
---|
[9e7ac06] | 170 |
|
---|
[8b9ad6e] | 171 | <varlistentry id="imlib2_bumpmap">
|
---|
| 172 | <term><command>imlib2_bumpmap</command></term>
|
---|
| 173 | <listitem>
|
---|
| 174 | <para>
|
---|
[4c24eb0a] | 175 | is to test the <application>imlib2</application> bumpmap function
|
---|
[8b9ad6e] | 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>
|
---|
[baac59c] | 187 | is to test the <application>imlib2</application> colorspace
|
---|
[4c24eb0a] | 188 | function
|
---|
[8b9ad6e] | 189 | </para>
|
---|
| 190 | <indexterm zone="imlib2 imlib2_colorspace">
|
---|
| 191 | <primary sortas="b-imlib2_colorspace">imlib2_colorspace</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
[d7f9c0ec] | 196 | <varlistentry id="imlib2_conv">
|
---|
| 197 | <term><command>imlib2_conv</command></term>
|
---|
[8b9ad6e] | 198 | <listitem>
|
---|
| 199 | <para>
|
---|
[d7f9c0ec] | 200 | converts images between formats
|
---|
[8b9ad6e] | 201 | </para>
|
---|
[d7f9c0ec] | 202 | <indexterm zone="imlib2 imlib2_conv">
|
---|
| 203 | <primary sortas="b-imlib2_conv">imlib2_conv</primary>
|
---|
[8b9ad6e] | 204 | </indexterm>
|
---|
| 205 | </listitem>
|
---|
| 206 | </varlistentry>
|
---|
| 207 |
|
---|
[d7f9c0ec] | 208 | <varlistentry id="imlib2_grab">
|
---|
| 209 | <term><command>imlib2_grab</command></term>
|
---|
[8b9ad6e] | 210 | <listitem>
|
---|
| 211 | <para>
|
---|
[d7f9c0ec] | 212 | takes screenshots
|
---|
[8b9ad6e] | 213 | </para>
|
---|
[d7f9c0ec] | 214 | <indexterm zone="imlib2 imlib2_grab">
|
---|
| 215 | <primary sortas="b-imlib2_grab">imlib2_grab</primary>
|
---|
[8b9ad6e] | 216 | </indexterm>
|
---|
| 217 | </listitem>
|
---|
[d7f9c0ec] | 218 | </varlistentry>
|
---|
[8b9ad6e] | 219 |
|
---|
[d7f9c0ec] | 220 | <varlistentry id="imlib2_load">
|
---|
[6646cae6] | 221 | <term><command>imlib2_load</command></term>
|
---|
[1a93b27] | 222 | <listitem>
|
---|
| 223 | <para>
|
---|
[d7f9c0ec] | 224 | loads and caches images
|
---|
[1a93b27] | 225 | </para>
|
---|
[d7f9c0ec] | 226 | <indexterm zone="imlib2 imlib2_load">
|
---|
| 227 | <primary sortas="b-imlib2_load">imlib2_load</primary>
|
---|
[1a93b27] | 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
[d7f9c0ec] | 230 | </varlistentry>
|
---|
[1a93b27] | 231 |
|
---|
[d7f9c0ec] | 232 | <varlistentry id="imlib2_poly">
|
---|
| 233 | <term><command>imlib2_poly</command></term>
|
---|
[8b9ad6e] | 234 | <listitem>
|
---|
| 235 | <para>
|
---|
[d7f9c0ec] | 236 | is to test the <application>imlib2</application> poly function
|
---|
[8b9ad6e] | 237 | </para>
|
---|
[d7f9c0ec] | 238 | <indexterm zone="imlib2 imlib2_poly">
|
---|
| 239 | <primary sortas="b-imlib2_poly">imlib2_poly</primary>
|
---|
[8b9ad6e] | 240 | </indexterm>
|
---|
| 241 | </listitem>
|
---|
| 242 | </varlistentry>
|
---|
| 243 |
|
---|
| 244 | <varlistentry id="imlib2_show">
|
---|
| 245 | <term><command>imlib2_show</command></term>
|
---|
| 246 | <listitem>
|
---|
| 247 | <para>
|
---|
[4c24eb0a] | 248 | is an <application>imlib2</application> program test
|
---|
[8b9ad6e] | 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>
|
---|
[4c24eb0a] | 260 | is an <application>imlib2</application> program test
|
---|
[8b9ad6e] | 261 | </para>
|
---|
| 262 | <indexterm zone="imlib2 imlib2_test">
|
---|
| 263 | <primary sortas="b-imlib2_test">imlib2_test</primary>
|
---|
| 264 | </indexterm>
|
---|
| 265 | </listitem>
|
---|
| 266 | </varlistentry>
|
---|
| 267 |
|
---|
[1a93b27] | 268 | <varlistentry id="imlib2_view">
|
---|
| 269 | <term><command>imlib2_view</command></term>
|
---|
| 270 | <listitem>
|
---|
| 271 | <para>
|
---|
[b9c353b] | 272 | displays image files
|
---|
[1a93b27] | 273 | </para>
|
---|
| 274 | <indexterm zone="imlib2 imlib2_view">
|
---|
| 275 | <primary sortas="b-imlib2_view">imlib2_view</primary>
|
---|
| 276 | </indexterm>
|
---|
| 277 | </listitem>
|
---|
| 278 | </varlistentry>
|
---|
| 279 |
|
---|
[6e393b07] | 280 | <varlistentry id="libImlib2">
|
---|
[4c24eb0a] | 281 | <term><filename class="libraryfile">libImlib2.so</filename></term>
|
---|
[6e393b07] | 282 | <listitem>
|
---|
[baac59c] | 283 | <para>
|
---|
[5f9ef8db] | 284 | provides the functions for programs to handle various
|
---|
[4c24eb0a] | 285 | image data formats
|
---|
[baac59c] | 286 | </para>
|
---|
[6e393b07] | 287 | <indexterm zone="imlib2 libImlib2">
|
---|
[db6a202] | 288 | <primary sortas="c-libImlib2">libImlib2.so</primary>
|
---|
[6e393b07] | 289 | </indexterm>
|
---|
| 290 | </listitem>
|
---|
| 291 | </varlistentry>
|
---|
[3dea735] | 292 |
|
---|
[6e393b07] | 293 | </variablelist>
|
---|
| 294 |
|
---|
| 295 | </sect2>
|
---|
[1aacd4b5] | 296 |
|
---|
| 297 | </sect1>
|
---|