Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / a890294753108889ed477181e5dd0ff5fc605f43 / . / www / resources.html
blob: 30ce3220d65193884a3898d54ac1b20193b3ca01 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]10 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: Resources</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <meta name="Keywords" content="resources, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../index.html">
32 <img src="../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../index.html">
41 <img src="../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]45<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]52 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]91<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]104<div class="menu">
105 <a title="Architecture" href="../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Site Map"href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map: Links"href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy031b7a82010-04-08 00:33:24 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]140</div>
cristyfbb4a972010-06-30 17:42:22 +0000[diff] [blame]141<div class="sponsor">
cristya8902942010-07-30 00:49:52 +0000[diff] [blame^]142 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyfbb4a972010-06-30 17:42:22 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
145</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]148<div class="eastbar">
149 <script type="text/javascript">
150 <!--
151 google_ad_client = "pub-3129977114552745";
152 /* 160x600, created 7/27/10 */
153 google_ad_slot = "0574824969";
154 google_ad_width = 160;
155 google_ad_height = 600;
156 //-->
157 </script>
158 <script type="text/javascript"
159 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
160 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]161</div>
162
163<div class="main">
164
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]165<p class="navigation-index">[<a href="#configure">Configuration Files</a> &bull; <a href="#modules">Modules</a> &bull; <a href="#fonts">Fonts</a> &bull; <a href="#environment">Environment Variables</a>]</p>
166
167<div class="doc-section">
168<p>ImageMagick depends on a number of external resources including configuration files, loadable modules, fonts, and environment variables.</p>
169</div>
170
171<h2><a name="configure"></a>Configuration Files</h2>
172<div class="doc-section">
173
174<p>ImageMagick depends on a number of external configuration files detailed here:</p>
175
176<dl class="doc">
177<dt class="doc"><a href="../www/source/coder.xml">coder.xml</a></dt>
178 <dd>Associate an image format with the specified coder module.
179
180 <p>ImageMagick has a number of coder modules to support the reading and/or writing of an image format (e.g. JPEG). Some coder modules support more than one associated image format and the mapping between an associated format and its respective coder module is defined in this configuration file. For example, the PNG coder module not only supports the PNG image format, but the JNG and MNG formats as well.</p>
181 </dd>
182
183<dt class="doc"><a href="../www/source/colors.xml">colors.xml</a></dt>
184 <dd>Associate a color name with its red, green, blue, and alpha intensities.
185
186 <p>A number of command line options require a <a href="../www/color.html">color parameter</a>. It is often convenient to refer to a color by name (e.g. white) rather than by hex value (e.g. #fff). This file maps a color name to its equivalent red, green, blue, and alpha intensities (e.g. for white, red = 255, green = 255, blue = 255, and alpha = 0).</p>
187 </dd>
188
189<dt class="doc"><a name="configure.xml"/><a href="../www/source/configure.xml">configure.xml</a></dt>
190 <dd>Set ImageMagick build parameters and system-wide environment variables (e.g. MAGICK_TEMPORARY_PATH).
191 <p>
192 As ImageMagick is built, a number of build parameters are saved to this configuration file. They include the version, release date, dependent delegate libraries, and quantum depth among others.</p>
193 </dd>
194
195<dt class="doc"><a href="../www/source/delegates.xml">delegates.xml</a></dt>
196 <dd>Associate delegate programs with certain image formats.
197
198 <p>ImageMagick relies on a number of delegate programs to support certain image formats such as <a href="http://ufraw.sourceforge.net/">ufraw-batch</a> to read raw camera formats or <a href="http://www.cs.wisc.edu/~ghost/">Ghostscript</a> to read Postscript images. Use this configuration file to map an input or output format to an external delegate program.</p>
199 </dd>
200
201<dt class="doc"><a href="../www/source/english.xml">english.xml</a></dt>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]202 <dd>Associate message tags with English translations.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]203
204<dt class="doc"><a href="../www/source/francais.xml">francais.xml</a></dt>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]205 <dd>Associate message tags with French translations. </dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]206
207<dt class="doc"><a href="../www/source/locale.xml">locale.xml</a></dt>
208 <dd>Associate message tags with a translation for your locale.
209
210 <p>ImageMagick has a number of informational, warning, and error messages that are represented as tags. Tags are short descriptions of a message such as
211 <em>FileNotFound</em> or <em>MemoryAllocationFailed</em>. This configuration file lists locales that have a translation for each tag recognized by ImageMagick. Currently only English and French translations are available in the <kbd>english.xml</kbd> and <kbd>francais.xml</kbd> configuration files.</p>
212 </dd>
213
214<dt class="doc"><a href="../www/source/log.xml">log.xml</a></dt>
215 <dd>Configure logging parameters.
216 <p>ImageMagick is capable of spewing copious amounts of informational or debugging statements. Use this file to configure how the information will appear in a log message and where you want the logging messages posted.</p>
217 </dd>
218
219<dt class="doc"><a href="../www/source/magic.xml">magic.xml</a></dt>
220 <dd>Associate an image format with a unique identifier.
221 <p>Many image formats have identifiers that uniquely identify a particular image format. For example, the GIF image format always begins with <kbd>GIF8</kbd> as the first 4 characters of the image. ImageMagick uses this information to quickly determine the type of image it is dealing with when it reads an image.</p>
222 </dd>
223
224<dt class="doc"><a href="../www/source/mime.xml">mime.xml</a></dt>
225 <dd>Associate an internet media type with a unique identifier.
226 <p>Many files and data streams have identifiers that uniquely identify a
227particular internet media type. For example, files in the "Corel Draw
228drawing" format (mime type="application/vnd.corel-draw") are associated with
229the filename pattern <kbd>*.cdr</kbd>, and also have an initial string of the
230characters "CDRXvrsn". ImageMagick uses combinations of this information,
231when available, to attempt to quickly determine the internet media type of a
232file or data stream.</p>
233</dd>
234
235<dt class="doc"><a href="../www/source/policy.xml">policy.xml</a></dt>
236 <dd>Configure ImageMagick policies.
cristyd75d5d12010-02-16 02:04:50 +0000[diff] [blame]237 <p>By default any coder, delegate, filter, or file path is permitted. Use a policy to deny access to, for example, the MPEG video delegate, or permit reading images from a file system but deny writing to that same file system. Or use the resource policy to set resource limits. Policies are useful for multi-user servers that want to limit the overall impact ImageMagick has on the system. For example, to limit the maximum image size in memory to 100MB:</p>
238
239<pre class="text">
240 &lt;policy domain="resource" name="area" value="100MB"/>
241</pre>
242
243<p>Any image larger than this area limit is cached to disk rather than memory.</p>
244
245<p>To limit the elapsed time of any ImageMagick command to 5 minutes, use this policy:</p>
246
247<pre class="text">
248 &lt;policy domain="resource" name="time" value="300"/>
249</pre>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]250 </dd>
251
252<dt class="doc"><a href="../www/source/thresholds.xml">thresholds.xml</a></dt>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]253 <dd>Set threshold maps for ordered posterized dither.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]254
255<dt class="doc"><a name="type.xml"></a><a href="../www/source/type.xml">type.xml</a></dt>
256 <dd>Configure fonts.
257 <p>Define the font name, family, foundry, style, format, metrics, and glyphs for any font you want to use within ImageMagick.</p>
258 </dd>
259
260<dt class="doc"><a href="../www/source/type-ghostscript.xml">type-ghostscript.xml</a></dt>
261 <dd>Configure <a href="http://www.cs.wisc.edu/~ghost/">Ghostscript</a> fonts.
262 <p>The Ghostscript package includes a number of fonts that can be accessed with ImageMagick.</p>
263 </dd>
264
265<dt class="doc"><a href="../www/source/type-windows.xml">type-windows.xml</a></dt>
266 <dd>Associate names with Windows font glyphs.</dd>
267
268</dl>
269
270<p>Under Unix and Linux, ImageMagick searches for each of the configuration files listed above by looking in the locations given below, in order, and loads them if found:</p>
271
272<pre class="text">
273 $MAGICK_CONFIGURE_PATH
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]274 $PREFIX/lib/ImageMagick-6.6.3/config
275 $PREFIX/share/ImageMagick-6.6.3/config
276 $PREFIX/share/ImageMagick-6.6.3 $HOME/.magick/
277 &lt;<em>client path</em>&gt;/lib/ImageMagick-6.6.3/
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]278 &lt;<em>current directory</em>&gt;/
279</pre>
280
281<p>The environmental variable $PREFIX is the default install path (e.g. <kbd>/usr/local</kbd>). The <em>client path</em> is the execution path of your ImageMagick client (e.g. <kbd>/usr/local</kbd>) .</p>
282
283<p>For the Unix or Linux pre-compiled binary distribution, the configuration load order is:</p>
284
285<pre class="text">
286 $MAGICK_CONFIGURE_PATH
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]287 $MAGICK_HOME/lib/ImageMagick-6.6.3/config
288 $MAGICK_HOME/share/ImageMagick-6.6.3/config
289 $PREFIX/share/ImageMagick-6.6.3 $HOME/.magick/
290 &lt;<em>client path</em>&gt;/lib/ImageMagick-6.6.3/
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]291 &lt;<em>current directory</em>&gt;/
292</pre>
293
294<p>Under Windows, ImageMagick searches for these configuration files in the following order, and loads them if found:</p>
295
296<pre class="text">
297 $MAGICK_CONFIGURE_PATH
298 &lt;<em>windows registry</em>&gt;
299 $PREFIX/config
300 $USERPROFILE/.magick/
301 &lt;<em>client path</em>&gt;
302 &lt;<em>current directory</em>&gt;
303</pre>
304
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]305<p>Above, $PREFIX is the default install path, typically <kbd>c:\\Program Files\\ImageMagick-6.6.3</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]306
307<p>For an uninstalled Windows installation, the configuration load order is:</p>
308
309<pre class="text">
310 $MAGICK_CONFIGURE_PATH
311 $MAGICK_HOME
312 $USERPROFILE/.magick/
313 <em>client path</em>
314 &lt;<em>current directory</em>&gt;
315</pre>
316
317<p>If a configuration file cannot not be found, ImageMagick relies on built-in default values.</p>
318
319</div>
320
321<h2><a name="modules"></a>Modules</h2>
322<div class="doc-section">
323
324<p>ImageMagick's image format support is usually provided in the form of loadable modules. It searches for loadable modules in the following order and it uses the first match found:</p>
325
326<pre class="text">
327 &lt;<em>current directory</em>&gt;/
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]328 $MAGICK_HOME/lib/ImageMagick-6.6.3/modules-Q16/coders/
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]329 $HOME/.magick/
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]330 &lt;<em>client path</em>&gt;/../lib/ImageMagick-6.6.3/modules-Q16/coders/
331 $MAGICK_HOME/lib/ImageMagick-6.6.3/modules-Q16/coders
332 $MAGICK_HOME/share/ImageMagick-6.6.3/modules-Q16/coders
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]333 $HOME/.magick/
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]334 &lt;<em>client path</em>&gt;/lib/ImageMagick-6.6.3/modules-Q16/coders
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]335 &lt;<em>current directory</em>&gt;/
336</pre>
337
338</div>
339
340<h2><a name="fonts"></a>Fonts</h2>
341<div class="doc-section">
342
343<p>ImageMagick is able to load raw TrueType and Postscript font files. It searches for the font configuration file, <a href="#type.xml">type.xml</a>, in the following order, and loads them if found:</p>
344
345<pre class="text">
346 $MAGICK_CONFIGURE_PATH
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]347 $MAGICK_HOME/lib/ImageMagick-6.6.3/config
348 $MAGICK_HOME/share/ImageMagick-6.6.3/config
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]349 $HOME/.magick/
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]350 &lt;<em>client path</em>&gt;/lib/ImageMagick-6.6.3/
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]351 &lt;<em>current directory</em>&gt;/
352 $MAGICK_FONT_PATH
353</pre>
354
355</div>
356
357<h2><a name="environment"></a>Environment Variables</h2>
358<div class="doc-section">
359
360<p>Environment variables recognized by ImageMagick include:</p>
361
362<dl class="doc">
363<dt class="doc">HOME</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]364 <dd>Set path to search for configuration files in <em>$HOME/.magick</em> if the directory exists.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]365<dt class="doc">LD_LIBRARY_PATH</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]366 <dd>Set path to the ImageMagick shareable libraries and other dependent libraries.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]367<dt class="doc">MAGICK_AREA_LIMIT</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]368 <dd>Set the maximum <em>width * height</em> of an image that can reside in the pixel cache memory.</dd><br />
369 <dd>Images that exceed the area limit are cached to disk (see <a href="#disk-limit">MAGICK_DISK_LIMIT</a>).</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]370<dt class="doc">MAGICK_CODER_FILTER_PATH</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]371 <dd>Set search path to use when searching for filter process modules (invoked via <a href="../www/command-line-options.html#process">-process</a>).<dd><br />
372 <dd>This path permits the user to extend ImageMagick's image processing functionality by adding loadable modules to a preferred location rather than copying them into the ImageMagick installation directory. The formatting of the search path is similar to operating system search paths (i.e. colon delimited for Unix, and semi-colon delimited for Microsoft Windows). This user specified search path is searched before trying the <a href="#modules">default search path</a>.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]373<dt class="doc">MAGICK_CODER_MODULE_PATH</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]374 <dd>Set path where ImageMagick can locate its coder modules.</dd><br />
375 <dd>This path permits the user to arbitrarily extend the image formats supported by ImageMagick by adding loadable coder modules from an preferred location rather than copying them into the ImageMagick installation directory. The formatting of the search path is similar to operating system search paths (i.e. colon delimited for Unix, and semi-colon delimited for Microsoft Windows). This user specified search path is searched before trying the <a href="#modules">default search path</a>.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]376<dt class="doc">MAGICK_CONFIGURE_PATH</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]377 <dd>Set path where ImageMagick can locate its configuration files</dd><br />
378 <dd>Use this search path to search for configuration (.xml) files. The formatting of the search path is similar to operating system search paths (i.e. colon delimited for Unix, and semi-colon delimited for Microsoft Windows). This user specified search path is searched before trying the <a href="#configure">default search path</a>.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]379<dt class="doc">MAGICK_DEBUG</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]380 <dd>Set debug options.</dd><br />
381 <dd>See <a href="../www/command-line-options.html#debug">-debug</a> for a description of debugging options.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]382<dt class="doc"><a name="disk-limit"></a>MAGICK_DISK_LIMIT</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]383 <dd>Set maximum amount of disk space in bytes permitted for use by the pixel cache.</dd><br />
384 <dd>When this limit is exceeded, the pixel cache is not be created and an error message is returned.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]385<dt class="doc">MAGICK_FILE_LIMIT</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]386 <dd>Set maximum number of open pixel cache files.</dd><br />
387 <dd>When this limit is exceeded, any subsequent pixels cached to disk are closed and reopened on demand. This behavior permits a large number of images to be accessed simultaneously on disk, but with a speed penalty due to repeated open/close calls.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]388<dt class="doc">MAGICK_FONT_PATH</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]389 <dd>Set path ImageMagick searches for TrueType and Postscript Type1 font files.</dd><br />
390 <dd>This path is only consulted if a particular font file is not found in the current directory.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]391<dt class="doc">MAGICK_HOME</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]392 <dd>Set the path at the top of ImageMagick installation directory.</dd><br />
393 <dd>This path is consulted by <em>uninstalled</em> builds of ImageMagick which do not have their location hard-coded or set by an installer.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]394<dt class="doc"><a name="map-limit"></a>MAGICK_MAP_LIMIT</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]395 <dd>Set maximum amount of memory map in bytes to allocate for the pixel cache.</dd><br />
396 <dd>When this limit is exceeded, the image pixels are cached to disk (see MAGICK_DISK_LIMIT).</dd>
397 </dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]398<dt class="doc">MAGICK_MEMORY_LIMIT</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]399 <dd>Set maximum amount of memory in bytes to allocate for the pixel cache from the heap.</dd><br />
400 <dd>When this limit is exceeded, the image pixels are cached to memory-mapped disk (see <a href="#map-limit">MAGICK_MAP_LIMIT</a>).</dd><br />
401<dt class="doc">MAGICK_PRECISION</dt>
402 <dd>Set the maximum number of significant digits to be printed.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]403<dt class="doc">MAGICK_TEMPORARY_PATH</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]404 <dd>Set path to store temporary files.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]405<dt class="doc">MAGICK_THREAD_LIMIT</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]406 <dd>Set maximum parallel threads.</dd><br />
407 <dd>Many ImageMagick algorithms run in parallel on multi-processor systems. Use this enviroment variable to set the maximum number of threads that are permitted to run in parallel.</dd><br />
cristyb15553d2010-07-03 22:53:14 +0000[diff] [blame]408<dt class="doc">MAGICK_THROTTLE</dt>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]409 <dd>Periodically yield the CPU for at least the time specified in milliseconds.</dd><br />
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]410<dt class="doc">MAGICK_TIME_LIMIT</dt>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]411 <dd>Set maximum time in seconds.</dd><br />
412 <dd>When this limit is exceeded, an exception is thrown and processing stops.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]413</dl>
414</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]415
416</div>
417
418<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]419 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]420 <span id="linkbar-center">
421 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame^]422 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]423 </span>
424 <span id="linkbar-east">&nbsp;</span>
425 </div>
426 <div class="footer">
427 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
428 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
429 </div>
430 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame^]431 <script type="text/javascript">
432 var _gaq = _gaq || [];
433 _gaq.push(['_setAccount', 'UA-17690367-1']);
434 _gaq.push(['_trackPageview']);
435
436 (function() {
437 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
438 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
439 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
440 })();
441 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]442</body>
443</html>