]> granicus.if.org Git - imagemagick/blob - www/resources.html
(no commit message)
[imagemagick] / www / resources.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
8 <head>\r
9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>\r
10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>\r
11   <title>ImageMagick: Resources</title>
12   <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"/>
15   <meta name="application-name" content="ImageMagick"/>
16   <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."/>
17   <meta name="application-url" content="http://www.imagemagick.org"/>
18   <meta name="generator" content="PHP"/>
19   <meta name="keywords" content="resources, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
20   <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"/>
26   <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
27   <meta name="distribution" content="Global"/>
28   <link rel="icon" href="../images/wand.png"/>
29   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
30   <link rel="canonical" href="http://www.imagemagick.org" />\r
31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
32   <!-- Add jQuery library -->\r
33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>\r
34   \r
35   <!-- Optionaly include easing and/or mousewheel plugins -->\r
36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>\r
37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>\r
38   \r
39   <!-- Add fancyBox -->\r
40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />\r
41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>\r
42   \r
43   <!-- Optionaly include button and/or thumbnail helpers -->\r
44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />\r
45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>\r
46   \r
47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />\r
48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>\r
49   <script type="text/javascript">\r
50         $(document).ready(function() {\r
51                 $(".fancybox").fancybox();\r
52         });\r
53   </script>\r
54   <!-- ImageMagick style -->\r
55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
56   <style type="text/css" media="all">\r
57     @import url("../www/magick.css");\r
58   </style>\r
59 </head>\r
60 \r
61 <body id="www-imagemagick-org">\r
62 <div class="titlebar">\r
63 <div style="margin: 17px auto; float: left;">\r
64   <script type="text/javascript">\r
65   <!--\r
66     google_ad_client = "pub-3129977114552745";\r
67     google_ad_slot = "5439289906";\r
68     google_ad_width = 728;\r
69     google_ad_height = 90;\r
70   //-->\r
71   </script>\r
72   <script type="text/javascript"\r
73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
74   </script>\r
75 </div>\r
76 <a href="../discourse-server">\r
77   <img src="../images/logo.jpg"\r
78   alt="ImageMagick Logo"\r
79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
80 <a href="../index.html">\r
81   <img src="../images/sprite.jpg"\r
82   alt="ImageMagick Sprite"\r
83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
84 </div>\r
85 \r
86 <div class="westbar">\r
87 \r
88 <div class="menu">
89   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
90 </div>
91 <div class="menu">
92   <a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
93 </div>
94 <div class="sub">
95     <a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
96 </div>
97 <div class="sub">
98     <a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
99 </div>
100 <div class="sub">
101     <a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
102 </div>
103 <div class="sub">
104     <a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
105 </div>
106 <div class="sep"></div>\r
107 <div class="menu">
108   <a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
109 </div>
110 <div class="sub">
111     <a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
112 </div>
113 <div class="sub">
114     <a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
115 </div>
116 <div class="sub">
117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
118 </div>
119 <div class="menu">
120   <a title="Program Interfaces" href="api.html">Program Interfaces</a>
121 </div>
122 <div class="sub">
123     <a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
124 </div>
125 <div class="sub">
126     <a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
127 </div>
128 <div class="sub">
129     <a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
130 </div>
131 <div class="sub">
132     <a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
133 </div>
134 <div class="sep"></div>\r
135 <div  class="menu">
136    <a title="Install from Source" href="install-source.html">Install from Source</a>
137 </div>
138 <div class="sub">
139     <a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
140 </div>
141 <div class="sub">
142     <a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
143  </div>
144 <div class="menu">
145   <a title="Resources" href="resources.html">Resources</a>
146 </div>
147 <div class="menu">
148   <a title="Architecture" href="architecture.html">Architecture</a>
149 </div>
150 <div class="menu">
151   <a title="Download" href="download.html">Download</a>
152 </div>
153 <div class="sep"></div>\r
154 <div class="menu">
155   <a title="Search" href="search.html">Search</a>
156 </div>
157 <div class="sep"></div>\r
158 <div class="menu">
159   <a title="Site Map" href="sitemap.html">Site Map</a>
160 </div>
161 <div  class="sub">
162   <a title="Site Map: Links" href="links.html">Links</a>
163 </div>
164 <div class="sep"></div>\r
165 <div class="menu">
166   <a rel="follow" title="Sponsors" href="sponsors.html">Sponsors:</a>
167
168   <a href="http://www.networkredux.com"> <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
170 <div class="sponsbox">
171 <div class="sponsor">
172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
173 </div>
174 <div class="sponsor">
175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
176 </div>
177 <div class="sponsor">
178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
179 </div>
180 <div class="sponsor">
181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
182 </div>
183 <div class="sponsor">
184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
185 </div>
186 <div class="sponsor">
187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
188 </div>
189 <div class="sponsor">
190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
191 </div>
192 <div class="sponsor">
193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
194 </div>
195 <div class="sponsor">
196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
197 </div>
198 <div class="sponsor">
199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
200 </div>
201 <div class="sponsor">
202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
203 </div>
204 <div class="sponsor">
205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
206 </div>
207 <div class="sponsor">
208    <a rel="follow" title="Sponsor: Best Web Hosting" href="http://www.webhostingclue.com">Best Web Hosting</a><!-- 2012120100150 racent marketing@webhosting...-->
209 </div>
210 <div  class="sponsor">
211    <a rel="follow" title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2012080100030 atlas-multimedia-->
212 </div>
213 </div>
214 </div>
215 </div>\r
216 \r
217 <div class="eastbar">\r
218   <div class="g-plusone" id="gplusone"></div>\r
219   <script type="text/javascript">\r
220     window.___gcfg = {\r
221       lang: 'en-US'\r
222     };\r
223 \r
224     (function() {\r
225       var po = document.createElement('script');\r
226       po.type = 'text/javascript'; po.async = true;\r
227       po.src = 'https://apis.google.com/js/plusone.js';\r
228       var script = document.getElementsByTagName('script')[0];\r
229       script.parentNode.insertBefore(po, script);\r
230     })();\r
231     var gplusone = document.getElementById("gplusone");\r
232     gplusone.setAttribute("data-size","medium");\r
233     gplusone.setAttribute("data-count","false");\r
234   </script>\r
235 </div>\r
236 \r
237 <div class="main">\r
238 \r
239 <h1>Customize ImageMagick With Resources</h1>
240 <p class="navigation-index">[<a href="resources.html#configure">Configuration Files</a> &bull; <a href="resources.html#modules">Modules</a> &bull; <a href="resources.html#fonts">Fonts</a> &bull; <a href="resources.html#environment">Environment Variables</a>]</p>
241
242 <div class="doc-section">
243 <p>ImageMagick depends on a number of external resources including configuration files, loadable modules, fonts, and environment variables.</p>
244 </div>
245
246 <h2><a id="configure"></a>Configuration Files</h2>
247 <div class="doc-section">
248
249 <p>ImageMagick depends on a number of external configuration files detailed here:</p>
250
251 <dl>
252 <dt class="doc"><a href="../www/source/coder.xml">coder.xml</a></dt>
253   <dd>Associate an image format with the specified coder module.
254
255   <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>
256   </dd>
257
258 <dt class="doc"><a href="../www/source/colors.xml">colors.xml</a></dt>
259   <dd>Associate a color name with its red, green, blue, and alpha intensities.
260
261   <p>A number of command line options require a <a href="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>
262   </dd>
263
264 <dt class="doc"><a id="configure.xml"/><a href="../www/source/configure.xml">configure.xml</a></dt>
265   <dd>Set ImageMagick build parameters and system-wide environment variables (e.g. MAGICK_TEMPORARY_PATH).
266   <p>
267   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>
268   </dd>
269
270 <dt class="doc"><a href="../www/source/delegates.xml">delegates.xml</a></dt>
271   <dd>Associate delegate programs with certain image formats.
272
273   <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>
274   </dd>
275
276 <dt class="doc"><a href="../www/source/english.xml">english.xml</a></dt>
277   <dd>Associate message tags with English translations.</dd>
278
279 <dt class="doc"><a href="../www/source/francais.xml">francais.xml</a></dt>
280   <dd>Associate message tags with French translations.  </dd>
281
282 <dt class="doc"><a href="../www/source/locale.xml">locale.xml</a></dt>
283   <dd>Associate message tags with a  translation for your locale.
284
285   <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
286   <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>
287   </dd>
288
289 <dt class="doc"><a href="../www/source/log.xml">log.xml</a></dt>
290   <dd>Configure logging parameters.
291   <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>
292   </dd>
293
294 <dt class="doc"><a href="../www/source/magic.xml">magic.xml</a></dt>
295   <dd>Associate an image format with a unique identifier.
296   <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>
297   </dd>
298
299 <dt class="doc"><a href="../www/source/mime.xml">mime.xml</a></dt>
300   <dd>Associate an internet media type with a unique identifier.
301   <p>Many files and data streams have identifiers that uniquely identify a
302 particular internet media type. For example, files in the "Corel Draw
303 drawing" format (mime type="application/vnd.corel-draw") are associated with
304 the filename pattern <kbd>*.cdr</kbd>, and also have an initial string of the
305 characters "CDRXvrsn". ImageMagick uses combinations of this information,
306 when available, to attempt to quickly determine the internet media type of a
307 file or data stream.</p>
308 </dd>
309
310 <dt class="doc"><a href="../www/source/policy.xml">policy.xml</a></dt>
311   <dd>Configure ImageMagick policies.
312   <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>
313
314 <pre class="text">
315   &lt;policy domain="resource" name="area" value="100MB"/>
316 </pre>
317
318 <p>Any image larger than this area limit is cached to disk rather than memory.</p>
319
320 <p>To limit the elapsed time of any ImageMagick command to 5 minutes, use this policy:</p>
321
322 <pre class="text">
323   &lt;policy domain="resource" name="time" value="300"/>
324 </pre>
325 <p>Define arguments for the memory, map, area, and disk resources with
326   SI prefixes (.e.g 100MB).  In addition, resource policies are maximums for
327   each instance of ImageMagick (e.g. policy memory limit 1GB, -limit 2GB
328   exceeds policy maximum so memory limit is 1GB).</p>
329   </dd>
330
331 <dt class="doc"><a href="../www/source/thresholds.xml">thresholds.xml</a></dt>
332   <dd>Set threshold maps for ordered posterized dither.</dd>
333
334 <dt class="doc"><a id="type.xml"></a><a href="../www/source/type.xml">type.xml</a></dt>
335   <dd>Configure fonts.
336   <p>Define the font name, family, foundry, style, format, metrics, and glyphs for any font you want to use within ImageMagick.</p>
337   </dd>
338
339 <dt class="doc"><a href="../www/source/type-ghostscript.xml">type-ghostscript.xml</a></dt>
340   <dd>Configure <a href="http://www.cs.wisc.edu/~ghost/">Ghostscript</a> fonts.
341   <p>The Ghostscript package includes a number of fonts that can be accessed with ImageMagick.</p>
342   </dd>
343
344 <dt class="doc"><a href="../www/source/type-windows.xml">type-windows.xml</a></dt>
345   <dd>Associate names with Windows font glyphs.</dd>
346
347 </dl>
348
349 <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>
350
351 <pre class="text">
352   $MAGICK_CONFIGURE_PATH
353   $PREFIX/etc/ImageMagick
354   $PREFIX/share/ImageMagick-6.7.7 
355   $HOME/.magick/
356   &lt;<em>client path</em>&gt;/etc/ImageMagick/
357 </pre>
358
359 <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>
360
361 <p>For the Unix or Linux pre-compiled uninstalled binary distributions, the configuration load order is:</p>
362
363 <pre class="text">
364   $MAGICK_CONFIGURE_PATH
365   $MAGICK_HOME/etc/ImageMagick
366   $MAGICK_HOME/share/ImageMagick-6.7.7 
367   $PREFIX/share/ImageMagick-6.7.7 
368   $HOME/.magick/
369   &lt;<em>client path</em>&gt;/etc/ImageMagick/
370   &lt;<em>current directory</em>&gt;
371 </pre>
372
373 <p>Under Windows, ImageMagick searches for these configuration files in the following order, and loads them if found:</p>
374
375 <pre class="text">
376   $MAGICK_CONFIGURE_PATH
377   &lt;<em>windows registry</em>&gt;
378   $PREFIX/config
379   $USERPROFILE/.magick/
380   &lt;<em>client path</em>&gt;
381 </pre>
382
383 <p>Above, $PREFIX is the default install path, typically <kbd>c:\\Program Files\\ImageMagick-6.7.7</kbd>.</p>
384
385 <p>For an uninstalled Windows installation, the configuration load order is:</p>
386
387 <pre class="text">
388   $MAGICK_CONFIGURE_PATH
389   $MAGICK_HOME
390   $USERPROFILE/.magick/
391   <em>client path</em>
392   &lt;<em>current directory</em>&gt;
393 </pre>
394
395 <p>If a configuration file cannot not be found, ImageMagick relies on built-in default values.</p>
396
397 </div>
398
399 <h2><a id="modules"></a>Modules</h2>
400 <div class="doc-section">
401
402 <h4>Coders</h4>
403 <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>
404
405 <pre class="text">
406   $MAGICK_HOME/lib/ImageMagick-6.7.7/modules-Q16/coders/
407   &lt;<em>client path</em>&gt;/../lib/ImageMagick-6.7.7/modules-Q16/coders/
408   $MAGICK_HOME/lib/ImageMagick-6.7.7/modules-Q16/coders
409   $MAGICK_HOME/share/ImageMagick-6.7.7/modules-Q16/coders
410   $HOME/.magick/
411   &lt;<em>client path</em>&gt;/lib/ImageMagick-6.7.7/modules-Q16/coders
412 </pre>
413
414 <h4>Filters</h4>
415 <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>
416 <pre class="text">
417   $MAGICK_HOME/lib/ImageMagick-6.7.7/modules-Q16/filters/
418   &lt;<em>client path</em>&gt;/../lib/ImageMagick-6.7.7/modules-Q16/filters/
419   $MAGICK_HOME/lib/ImageMagick-6.7.7/modules-Q16/filters
420   $MAGICK_HOME/share/ImageMagick-6.7.7/modules-Q16/filters
421   $HOME/.magick/
422   &lt;<em>client path</em>&gt;/lib/ImageMagick-6.7.7/modules-Q16/filters
423 </pre>
424
425 </div>
426
427 <h2><a id="fonts"></a>Fonts</h2>
428 <div class="doc-section">
429
430 <p>ImageMagick is able to load raw TrueType and Postscript font files.  It searches for the font configuration file, <a href="resources.html#type.xml">type.xml</a>, in the following order, and loads them if found:</p>
431
432 <pre class="text">
433   $MAGICK_CONFIGURE_PATH
434   $MAGICK_HOME/etc/ImageMagick/
435   $MAGICK_HOME/share/ImageMagick-6.7.7/
436   $HOME/.magick/
437   &lt;<em>client path</em>&gt;/etc/ImageMagick/
438   $MAGICK_FONT_PATH
439 </pre>
440
441 </div>
442
443 <h2><a id="environment"></a>Environment Variables</h2>
444 <div class="doc-section">
445
446 <p>Environment variables recognized by ImageMagick include:</p>
447
448 <dl>
449 <dt class="doc">HOME</dt>
450   <dd>Set path to search for configuration files in <em>$HOME/.magick</em> if the directory exists.</dd>
451 <dt class="doc">LD_LIBRARY_PATH</dt>
452   <dd>Set path to the ImageMagick shareable libraries and other dependent libraries.</dd>
453 <dt class="doc">MAGICK_AREA_LIMIT</dt>
454   <dd>Set the maximum <em>width * height</em> of an image that can reside in the pixel cache memory.</dd>
455   <dd>Images that exceed the area limit are cached to disk (see <a href="resources.html#disk-limit">MAGICK_DISK_LIMIT</a>) and optionally memory-mapped.</dd>
456 <dt class="doc">MAGICK_CODER_FILTER_PATH</dt>
457   <dd>Set search path to use when searching for filter process modules (invoked via  <a href="command-line-options.html#process">-process</a>).</dd>
458   <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="resources.html#modules">default search path</a>.</dd>
459 <dt class="doc">MAGICK_CODER_MODULE_PATH</dt>
460   <dd>Set path where ImageMagick can locate its coder modules.</dd>
461   <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="resources.html#modules">default search path</a>.</dd>
462 <dt class="doc">MAGICK_CONFIGURE_PATH</dt>
463   <dd>Set path where ImageMagick can locate its configuration files</dd>
464   <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="resources.html#configure">default search path</a>.</dd>
465 <dt class="doc">MAGICK_DEBUG</dt>
466   <dd>Set debug options.</dd>
467   <dd>See <a href="command-line-options.html#debug">-debug</a> for a description of debugging options.</dd>
468 <dt class="doc"><a id="disk-limit"></a>MAGICK_DISK_LIMIT</dt>
469   <dd>Set maximum amount of disk space in bytes permitted for use by the pixel cache.</dd>
470   <dd>When this limit is exceeded, the pixel cache is not be created and an error message is returned.</dd>
471 <dt class="doc">MAGICK_FILE_LIMIT</dt>
472   <dd>Set maximum number of open pixel cache files.</dd>
473   <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>
474 <dt class="doc">MAGICK_FONT_PATH</dt>
475   <dd>Set path ImageMagick searches for TrueType and Postscript Type1 font files.</dd>
476   <dd>This path is only consulted if a particular font file is not found in the current directory.</dd>
477 <dt class="doc">MAGICK_HOME</dt>
478   <dd>Set the path at the top of ImageMagick installation directory.</dd>
479   <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>
480 <dt class="doc"><a id="map-limit"></a>MAGICK_MAP_LIMIT</dt>
481   <dd>Set maximum amount of memory map in bytes to allocate for the pixel cache.</dd>
482   <dd>When this limit is exceeded, the image pixels are cached to disk (see MAGICK_DISK_LIMIT).</dd>
483 <dt class="doc">MAGICK_MEMORY_LIMIT</dt>
484   <dd>Set maximum amount of memory in bytes to allocate for the pixel cache from the heap.</dd>
485   <dd>When this limit is exceeded, the image pixels are cached to memory-mapped disk (see <a href="resources.html#map-limit">MAGICK_MAP_LIMIT</a>).</dd>
486 <dt class="doc">MAGICK_PRECISION</dt>
487   <dd>Set the maximum number of significant digits to be printed.</dd>
488 <dt class="doc">MAGICK_SYNCHRONIZE</dt>
489   <dd>Set to true to synchronize image to storage device.</dd>
490 <dt class="doc">MAGICK_TEMPORARY_PATH</dt>
491   <dd>Set path to store temporary files.</dd>
492 <dt class="doc">MAGICK_THREAD_LIMIT</dt>
493   <dd>Set maximum parallel threads.</dd>
494   <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>
495 <dt class="doc">MAGICK_THROTTLE</dt>
496   <dd>Periodically yield the CPU for at least the time specified in milliseconds.</dd>
497 <dt class="doc">MAGICK_TIME_LIMIT</dt>
498   <dd>Set maximum time in seconds.</dd>
499   <dd>When this limit is exceeded, an exception is thrown and processing stops.</dd>
500 </dl>
501 <p>Define arguments for the MAGICK_AREA_LIMIT, MAGICK_DISK_LIMIT, MAGICK_MAP_LIMIT, and MAGICK_MEMORY_LIMIT environment variables with SI prefixes (.e.g 100MB).</p>
502 </div>
503 \r
504 </div>\r
505 \r
506 <div id="linkbar">\r
507     <span id="linkbar-west">&nbsp;</span>\r
508     <span id="linkbar-center">\r
509       <a href="../discourse-server">Discourse Server</a> &bull;\r
510       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
511     </span>\r
512     <span id="linkbar-east">&nbsp;</span>\r
513   </div>\r
514   <div class="footer">\r
515     <span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>\r
516     <span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>\r
517   </div>\r
518   <div style="clear: both; margin: 0; width: 100%; "></div>\r
519   <script type="text/javascript">\r
520     var _gaq = _gaq || [];\r
521     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
522     _gaq.push(['_trackPageview']);\r
523 \r
524     (function() {\r
525       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
526       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
527       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
528     })();\r
529   </script>\r
530 </body>\r
531 </html>\r