blob: 7e26237d5120c2f87ce75ecfd0a24b5024f97b52 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +00003<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +00008<head>
cristy3c98a4f2010-08-13 20:09:41 +00009 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
cristy1efc1ab2011-08-01 14:47:02 +000010 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
cristyffb69ed2010-12-25 00:06:48 +000011 <title>ImageMagick: Resources</title>
cristy3ed852e2009-09-05 21:47:34 +000012 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000015 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +000016 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/>
cristy3c98a4f2010-08-13 20:09:41 +000017 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000018 <meta name="Generator" content="PHP"/>
cristye6e84152011-06-06 14:16:49 +000019 <meta name="Keywords" content="resources, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
cristy3ed852e2009-09-05 21:47:34 +000020 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy7e41fe82010-12-04 23:12:08 +000026 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000028 <link rel="icon" href="../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000029 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
cristy29c5c992011-06-25 13:58:49 +000030 <link rel="canonical" href="http://www.imagemagick.org" />
cristy3c98a4f2010-08-13 20:09:41 +000031 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000032 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy1efc1ab2011-08-01 14:47:02 +000033 <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy3c98a4f2010-08-13 20:09:41 +000034 <style type="text/css" media="all">
35 @import url("../www/magick.css");
36 </style>
cristy29c5c992011-06-25 13:58:49 +000037 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
cristy1efc1ab2011-08-01 14:47:02 +000038 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
39 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>
cristy361f4662010-12-31 23:02:52 +000040 <script type="text/javascript">
41 $(document).ready(function() {
42 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
43 'transitionIn' : 'elastic',
44 'transitionOut' : 'elastic',
45 'overlayShow' : false,
46 'opacity' : true
47 });
48 });
49 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000050</head>
51
52<body id="www-imagemagick-org">
53<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +000054<div style="margin: 17px auto; float: left;">
55 <script type="text/javascript">
56 <!--
57 google_ad_client = "pub-3129977114552745";
58 google_ad_slot = "5439289906";
59 google_ad_width = 728;
60 google_ad_height = 90;
61 //-->
62 </script>
63 <script type="text/javascript"
64 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
65 </script>
66</div>
cristy3eaa0ef2010-03-06 20:35:26 +000067<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000068 <img src="../images/logo.jpg"
69 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000070 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000071<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +000072 <img src="../images/sprite.jpg"
73 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000074 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
75</div>
76
cristyce69bb02010-07-27 19:49:46 +000077<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000078
cristy3ed852e2009-09-05 21:47:34 +000079<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
cristy3ed852e2009-09-05 21:47:34 +000082<div class="menu">
cristybb503372010-05-27 20:51:26 +000083 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
84</div>
85<div class="sub">
86 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
90</div>
91<div class="sub">
cristye6e84152011-06-06 14:16:49 +000092 <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +000093</div>
94<div class="sub">
cristybb503372010-05-27 20:51:26 +000095 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
96</div>
97<div class="sep"></div>
98<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
104<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
107<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
113<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000114 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000115</div>
116<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000117 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000120 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000121</div>
122<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000123 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000124</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000131</div>
132<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000134 </div>
135<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
cristybb503372010-05-27 20:51:26 +0000138<div class="menu">
139 <a title="Architecture" href="../www/architecture.html">Architecture</a>
140</div>
cristy3ed852e2009-09-05 21:47:34 +0000141<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000145<div class="menu">
cristy52923442011-01-15 22:54:31 +0000146 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000147</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000149<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000150 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000151</div>
152<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000153 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000154</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000155<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000156<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000157 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000158
cristyb52981c2011-03-19 17:09:31 +0000159<a href="http://www.networkredux.com">
160 <img src="../images/networkredux.png" alt="[sponsor]"
161 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000162<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000163<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000164 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
165</div>
166<div class="sponsor">
cristy1efc1ab2011-08-01 14:47:02 +0000167 <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
168</div>
169<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000170 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
171</div>
172<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000173 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
174</div>
175<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000176 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
177</div>
178<div class="sponsor">
179 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
180</div>
181<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000182 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000183</div>
184<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000185 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000186</div>
187<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000188 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000189</div>
190<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000191 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000194 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000195</div>
196<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000197 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000198</div>
199<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000200 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000201</div>
202<div class="sponsor">
cristy1efc1ab2011-08-01 14:47:02 +0000203 <a rel="follow" title="Sponsor: Kaffeemaschinen reparatur" href="http://www.kaffeemaschinen-reparatur.de">Kaffeemaschinen reparatur</a><!-- 2011090100060 Temurbas atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000204</div>
cristy3ed852e2009-09-05 21:47:34 +0000205</div>
206</div>
cristyce69bb02010-07-27 19:49:46 +0000207</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000208
cristyce69bb02010-07-27 19:49:46 +0000209<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000210 <div class="g-plusone" data-size="standard" data-count="false"></div>
211</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000212
213<div class="main">
214
cristydcca3fa2010-12-29 21:50:07 +0000215<h1>Customize ImageMagick With Resources</h1>
cristy3ed852e2009-09-05 21:47:34 +0000216<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>
217
218<div class="doc-section">
219<p>ImageMagick depends on a number of external resources including configuration files, loadable modules, fonts, and environment variables.</p>
220</div>
221
cristydcca3fa2010-12-29 21:50:07 +0000222<h2><a id="configure"></a>Configuration Files</h2>
cristy3ed852e2009-09-05 21:47:34 +0000223<div class="doc-section">
224
225<p>ImageMagick depends on a number of external configuration files detailed here:</p>
226
cristydcca3fa2010-12-29 21:50:07 +0000227<dl>
cristy3ed852e2009-09-05 21:47:34 +0000228<dt class="doc"><a href="../www/source/coder.xml">coder.xml</a></dt>
229 <dd>Associate an image format with the specified coder module.
230
231 <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>
232 </dd>
233
234<dt class="doc"><a href="../www/source/colors.xml">colors.xml</a></dt>
235 <dd>Associate a color name with its red, green, blue, and alpha intensities.
236
237 <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>
238 </dd>
239
cristydcca3fa2010-12-29 21:50:07 +0000240<dt class="doc"><a id="configure.xml"/><a href="../www/source/configure.xml">configure.xml</a></dt>
cristy3ed852e2009-09-05 21:47:34 +0000241 <dd>Set ImageMagick build parameters and system-wide environment variables (e.g. MAGICK_TEMPORARY_PATH).
242 <p>
243 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>
244 </dd>
245
246<dt class="doc"><a href="../www/source/delegates.xml">delegates.xml</a></dt>
247 <dd>Associate delegate programs with certain image formats.
248
249 <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>
250 </dd>
251
252<dt class="doc"><a href="../www/source/english.xml">english.xml</a></dt>
cristydcca3fa2010-12-29 21:50:07 +0000253 <dd>Associate message tags with English translations.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000254
255<dt class="doc"><a href="../www/source/francais.xml">francais.xml</a></dt>
cristydcca3fa2010-12-29 21:50:07 +0000256 <dd>Associate message tags with French translations. </dd>
cristy3ed852e2009-09-05 21:47:34 +0000257
258<dt class="doc"><a href="../www/source/locale.xml">locale.xml</a></dt>
259 <dd>Associate message tags with a translation for your locale.
260
261 <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
262 <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>
263 </dd>
264
265<dt class="doc"><a href="../www/source/log.xml">log.xml</a></dt>
266 <dd>Configure logging parameters.
267 <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>
268 </dd>
269
270<dt class="doc"><a href="../www/source/magic.xml">magic.xml</a></dt>
271 <dd>Associate an image format with a unique identifier.
272 <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>
273 </dd>
274
275<dt class="doc"><a href="../www/source/mime.xml">mime.xml</a></dt>
276 <dd>Associate an internet media type with a unique identifier.
277 <p>Many files and data streams have identifiers that uniquely identify a
278particular internet media type. For example, files in the "Corel Draw
279drawing" format (mime type="application/vnd.corel-draw") are associated with
280the filename pattern <kbd>*.cdr</kbd>, and also have an initial string of the
281characters "CDRXvrsn". ImageMagick uses combinations of this information,
282when available, to attempt to quickly determine the internet media type of a
283file or data stream.</p>
284</dd>
285
286<dt class="doc"><a href="../www/source/policy.xml">policy.xml</a></dt>
287 <dd>Configure ImageMagick policies.
cristyd75d5d12010-02-16 02:04:50 +0000288 <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>
289
290<pre class="text">
291 &lt;policy domain="resource" name="area" value="100MB"/>
292</pre>
293
294<p>Any image larger than this area limit is cached to disk rather than memory.</p>
295
296<p>To limit the elapsed time of any ImageMagick command to 5 minutes, use this policy:</p>
297
298<pre class="text">
299 &lt;policy domain="resource" name="time" value="300"/>
300</pre>
cristy3ed852e2009-09-05 21:47:34 +0000301 </dd>
302
303<dt class="doc"><a href="../www/source/thresholds.xml">thresholds.xml</a></dt>
cristydcca3fa2010-12-29 21:50:07 +0000304 <dd>Set threshold maps for ordered posterized dither.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000305
cristydcca3fa2010-12-29 21:50:07 +0000306<dt class="doc"><a id="type.xml"></a><a href="../www/source/type.xml">type.xml</a></dt>
cristy3ed852e2009-09-05 21:47:34 +0000307 <dd>Configure fonts.
308 <p>Define the font name, family, foundry, style, format, metrics, and glyphs for any font you want to use within ImageMagick.</p>
309 </dd>
310
311<dt class="doc"><a href="../www/source/type-ghostscript.xml">type-ghostscript.xml</a></dt>
312 <dd>Configure <a href="http://www.cs.wisc.edu/~ghost/">Ghostscript</a> fonts.
313 <p>The Ghostscript package includes a number of fonts that can be accessed with ImageMagick.</p>
314 </dd>
315
316<dt class="doc"><a href="../www/source/type-windows.xml">type-windows.xml</a></dt>
317 <dd>Associate names with Windows font glyphs.</dd>
318
319</dl>
320
321<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>
322
323<pre class="text">
324 $MAGICK_CONFIGURE_PATH
cristy3cd7cc92011-04-01 01:00:28 +0000325 $PREFIX/etc/ImageMagick
cristyd48f07c2011-07-09 23:09:26 +0000326 $PREFIX/share/ImageMagick-6.7.1
cristy31fd8c42011-04-01 15:45:16 +0000327 $HOME/.magick/
cristy721a6932011-04-01 14:33:28 +0000328 &lt;<em>client path</em>&gt;/etc/ImageMagick/
cristy3ed852e2009-09-05 21:47:34 +0000329</pre>
330
331<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>
332
cristy075ad252010-10-30 21:56:17 +0000333<p>For the Unix or Linux pre-compiled uninstalled binary distributions, the configuration load order is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000334
335<pre class="text">
336 $MAGICK_CONFIGURE_PATH
cristy3cd7cc92011-04-01 01:00:28 +0000337 $MAGICK_HOME/etc/ImageMagick
cristyd48f07c2011-07-09 23:09:26 +0000338 $MAGICK_HOME/share/ImageMagick-6.7.1
339 $PREFIX/share/ImageMagick-6.7.1
cristye9a32c32011-04-07 01:11:05 +0000340 $HOME/.magick/
cristy945bb352011-04-01 15:39:28 +0000341 &lt;<em>client path</em>&gt;/etc/ImageMagick/
cristy075ad252010-10-30 21:56:17 +0000342 &lt;<em>current directory</em>&gt;
cristy3ed852e2009-09-05 21:47:34 +0000343</pre>
344
345<p>Under Windows, ImageMagick searches for these configuration files in the following order, and loads them if found:</p>
346
347<pre class="text">
348 $MAGICK_CONFIGURE_PATH
349 &lt;<em>windows registry</em>&gt;
350 $PREFIX/config
351 $USERPROFILE/.magick/
352 &lt;<em>client path</em>&gt;
cristy3ed852e2009-09-05 21:47:34 +0000353</pre>
354
cristyd48f07c2011-07-09 23:09:26 +0000355<p>Above, $PREFIX is the default install path, typically <kbd>c:\\Program Files\\ImageMagick-6.7.1</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000356
357<p>For an uninstalled Windows installation, the configuration load order is:</p>
358
359<pre class="text">
360 $MAGICK_CONFIGURE_PATH
361 $MAGICK_HOME
362 $USERPROFILE/.magick/
363 <em>client path</em>
364 &lt;<em>current directory</em>&gt;
365</pre>
366
367<p>If a configuration file cannot not be found, ImageMagick relies on built-in default values.</p>
368
369</div>
370
cristydcca3fa2010-12-29 21:50:07 +0000371<h2><a id="modules"></a>Modules</h2>
cristy3ed852e2009-09-05 21:47:34 +0000372<div class="doc-section">
373
cristye9a32c32011-04-07 01:11:05 +0000374<h4>Coders</h4>
375<p>An image coder (i.e. encoder / decoder) is responsible for registering, optionally classifying, optionally reading, optionally writing, and unregistering one image format (e.g. PNG, GIF, JPEG, etc.). ImageMagick searches for coders in the following order and it uses the first match found:</p>
cristy3ed852e2009-09-05 21:47:34 +0000376
377<pre class="text">
cristyd48f07c2011-07-09 23:09:26 +0000378 $MAGICK_HOME/lib/ImageMagick-6.7.1/modules-Q16/coders/
379 &lt;<em>client path</em>&gt;/../lib/ImageMagick-6.7.1/modules-Q16/coders/
380 $MAGICK_HOME/lib/ImageMagick-6.7.1/modules-Q16/coders
381 $MAGICK_HOME/share/ImageMagick-6.7.1/modules-Q16/coders
cristy3ed852e2009-09-05 21:47:34 +0000382 $HOME/.magick/
cristyd48f07c2011-07-09 23:09:26 +0000383 &lt;<em>client path</em>&gt;/lib/ImageMagick-6.7.1/modules-Q16/coders
cristy3ed852e2009-09-05 21:47:34 +0000384</pre>
385
cristye9a32c32011-04-07 01:11:05 +0000386<h4>Filters</h4>
387<p>ImageMagick provides a convenient mechanism for adding your own custom image processing algorithms. ImageMagick searches for filters in the following order and it uses the first match found:</p>
388<pre class="text">
cristyd48f07c2011-07-09 23:09:26 +0000389 $MAGICK_HOME/lib/ImageMagick-6.7.1/modules-Q16/filters/
390 &lt;<em>client path</em>&gt;/../lib/ImageMagick-6.7.1/modules-Q16/filters/
391 $MAGICK_HOME/lib/ImageMagick-6.7.1/modules-Q16/filters
392 $MAGICK_HOME/share/ImageMagick-6.7.1/modules-Q16/filters
cristye9a32c32011-04-07 01:11:05 +0000393 $HOME/.magick/
cristyd48f07c2011-07-09 23:09:26 +0000394 &lt;<em>client path</em>&gt;/lib/ImageMagick-6.7.1/modules-Q16/filters
cristye9a32c32011-04-07 01:11:05 +0000395</pre>
396
cristy3ed852e2009-09-05 21:47:34 +0000397</div>
398
cristydcca3fa2010-12-29 21:50:07 +0000399<h2><a id="fonts"></a>Fonts</h2>
cristy3ed852e2009-09-05 21:47:34 +0000400<div class="doc-section">
401
402<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>
403
404<pre class="text">
405 $MAGICK_CONFIGURE_PATH
cristy945bb352011-04-01 15:39:28 +0000406 $MAGICK_HOME/etc/ImageMagick/
cristyd48f07c2011-07-09 23:09:26 +0000407 $MAGICK_HOME/share/ImageMagick-6.7.1/
cristy3ed852e2009-09-05 21:47:34 +0000408 $HOME/.magick/
cristy945bb352011-04-01 15:39:28 +0000409 &lt;<em>client path</em>&gt;/etc/ImageMagick/
cristy3ed852e2009-09-05 21:47:34 +0000410 $MAGICK_FONT_PATH
411</pre>
412
413</div>
414
cristydcca3fa2010-12-29 21:50:07 +0000415<h2><a id="environment"></a>Environment Variables</h2>
cristy3ed852e2009-09-05 21:47:34 +0000416<div class="doc-section">
417
418<p>Environment variables recognized by ImageMagick include:</p>
419
cristydcca3fa2010-12-29 21:50:07 +0000420<dl>
cristy3ed852e2009-09-05 21:47:34 +0000421<dt class="doc">HOME</dt>
cristydcca3fa2010-12-29 21:50:07 +0000422 <dd>Set path to search for configuration files in <em>$HOME/.magick</em> if the directory exists.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000423<dt class="doc">LD_LIBRARY_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000424 <dd>Set path to the ImageMagick shareable libraries and other dependent libraries.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000425<dt class="doc">MAGICK_AREA_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000426 <dd>Set the maximum <em>width * height</em> of an image that can reside in the pixel cache memory.</dd>
427 <dd>Images that exceed the area limit are cached to disk (see <a href="#disk-limit">MAGICK_DISK_LIMIT</a>).</dd>
cristy3ed852e2009-09-05 21:47:34 +0000428<dt class="doc">MAGICK_CODER_FILTER_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000429 <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>
430 <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>
cristy3ed852e2009-09-05 21:47:34 +0000431<dt class="doc">MAGICK_CODER_MODULE_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000432 <dd>Set path where ImageMagick can locate its coder modules.</dd>
433 <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>
cristy3ed852e2009-09-05 21:47:34 +0000434<dt class="doc">MAGICK_CONFIGURE_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000435 <dd>Set path where ImageMagick can locate its configuration files</dd>
436 <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>
cristy3ed852e2009-09-05 21:47:34 +0000437<dt class="doc">MAGICK_DEBUG</dt>
cristydcca3fa2010-12-29 21:50:07 +0000438 <dd>Set debug options.</dd>
439 <dd>See <a href="../www/command-line-options.html#debug">-debug</a> for a description of debugging options.</dd>
440<dt class="doc"><a id="disk-limit"></a>MAGICK_DISK_LIMIT</dt>
441 <dd>Set maximum amount of disk space in bytes permitted for use by the pixel cache.</dd>
442 <dd>When this limit is exceeded, the pixel cache is not be created and an error message is returned.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000443<dt class="doc">MAGICK_FILE_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000444 <dd>Set maximum number of open pixel cache files.</dd>
445 <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>
cristy3ed852e2009-09-05 21:47:34 +0000446<dt class="doc">MAGICK_FONT_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000447 <dd>Set path ImageMagick searches for TrueType and Postscript Type1 font files.</dd>
448 <dd>This path is only consulted if a particular font file is not found in the current directory.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000449<dt class="doc">MAGICK_HOME</dt>
cristydcca3fa2010-12-29 21:50:07 +0000450 <dd>Set the path at the top of ImageMagick installation directory.</dd>
451 <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>
452<dt class="doc"><a id="map-limit"></a>MAGICK_MAP_LIMIT</dt>
453 <dd>Set maximum amount of memory map in bytes to allocate for the pixel cache.</dd>
cristyd43a46b2010-01-21 02:13:41 +0000454 <dd>When this limit is exceeded, the image pixels are cached to disk (see MAGICK_DISK_LIMIT).</dd>
cristy3ed852e2009-09-05 21:47:34 +0000455<dt class="doc">MAGICK_MEMORY_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000456 <dd>Set maximum amount of memory in bytes to allocate for the pixel cache from the heap.</dd>
457 <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>
cristyd43a46b2010-01-21 02:13:41 +0000458<dt class="doc">MAGICK_PRECISION</dt>
cristydcca3fa2010-12-29 21:50:07 +0000459 <dd>Set the maximum number of significant digits to be printed.</dd>
cristy5063d812010-10-19 16:28:10 +0000460<dt class="doc">MAGICK_SYNCHRONIZE</dt>
cristydcca3fa2010-12-29 21:50:07 +0000461 <dd>Set to true to synchronize image to storage device.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000462<dt class="doc">MAGICK_TEMPORARY_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000463 <dd>Set path to store temporary files.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000464<dt class="doc">MAGICK_THREAD_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000465 <dd>Set maximum parallel threads.</dd>
466 <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>
cristyb15553d2010-07-03 22:53:14 +0000467<dt class="doc">MAGICK_THROTTLE</dt>
cristydcca3fa2010-12-29 21:50:07 +0000468 <dd>Periodically yield the CPU for at least the time specified in milliseconds.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000469<dt class="doc">MAGICK_TIME_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000470 <dd>Set maximum time in seconds.</dd>
cristyd43a46b2010-01-21 02:13:41 +0000471 <dd>When this limit is exceeded, an exception is thrown and processing stops.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000472</dl>
473</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000474
475</div>
476
477<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000478 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000479 <span id="linkbar-center">
480 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000481 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000482 </span>
483 <span id="linkbar-east">&nbsp;</span>
484 </div>
485 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +0000486 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000487 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
488 </div>
489 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000490 <script type="text/javascript">
491 var _gaq = _gaq || [];
492 _gaq.push(['_setAccount', 'UA-17690367-1']);
493 _gaq.push(['_trackPageview']);
494
495 (function() {
496 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
497 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
498 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
499 })();
500 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000501</body>
502</html>