Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 162a01c87c9ef84d6427f55d196ee6064d50f537 / . / www / resources.html
blob: b9da52670ffc8c99ea0986f850abb201beda2b93 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!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 +0000[diff] [blame]3<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 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: Resources</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]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."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
19 <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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy7e41fe82010-12-04 23:12:08 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]32 <style type="text/css" media="all">
33 @import url("../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]48</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]52<div style="margin: 17px auto; float: left;">
53 <script type="text/javascript">
54 <!--
55 google_ad_client = "pub-3129977114552745";
56 google_ad_slot = "5439289906";
57 google_ad_width = 728;
58 google_ad_height = 90;
59 //-->
60 </script>
61 <script type="text/javascript"
62 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
63 </script>
64</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]66 <img src="../images/logo.jpg"
67 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]68 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<a href="../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]70 <img src="../images/sprite.jpg"
71 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]72 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
73</div>
74
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]75<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]76
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]82 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
83</div>
84<div class="sub">
85 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
89</div>
90<div class="sub">
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]91 <a title="Binary Release: iPhone" href="../www/binary-releases.html#iPhone">iPhone</a>
92</div>
93<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]94 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
95</div>
96<div class="sep"></div>
97<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]98 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]101 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]104 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
106<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]107 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108</div>
109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</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="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]122 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
128<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
131<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]132 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133 </div>
134<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]135 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]137<div class="menu">
138 <a title="Architecture" href="../www/architecture.html">Architecture</a>
139</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]141 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]143<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]145 <a title="Search" href="../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]149 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]152 <a title="Site Map: Links" href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]154<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]156 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]158<a href="http://www.networkredux.com">
159 <img src="../images/networkredux.png" alt="[sponsor]"
160 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]162<div class="sponsor">
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]163 <a title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
164</div>
165<div class="sponsor">
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]166 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
167</div>
168<div class="sponsor">
cristybe3c5be2011-03-05 17:35:07 +0000[diff] [blame]169 <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
170</div>
171<div class="sponsor">
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]172 <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201107010090 alexanian media -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]173</div>
174<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]175 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]176</div>
177<div class="sponsor">
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]178 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
179</div>
180<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]181 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
182</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]183<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]184 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
185</div>
186<div class="sponsor">
cristye9a32c32011-04-07 01:11:05 +0000[diff] [blame]187 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011080100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]188</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]189</div>
190</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]191</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]192
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]193<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]194
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]195</div>
196
197<div class="main">
198
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]199<h1>Customize ImageMagick With Resources</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]200<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>
201
202<div class="doc-section">
203<p>ImageMagick depends on a number of external resources including configuration files, loadable modules, fonts, and environment variables.</p>
204</div>
205
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]206<h2><a id="configure"></a>Configuration Files</h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]207<div class="doc-section">
208
209<p>ImageMagick depends on a number of external configuration files detailed here:</p>
210
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]211<dl>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]212<dt class="doc"><a href="../www/source/coder.xml">coder.xml</a></dt>
213 <dd>Associate an image format with the specified coder module.
214
215 <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>
216 </dd>
217
218<dt class="doc"><a href="../www/source/colors.xml">colors.xml</a></dt>
219 <dd>Associate a color name with its red, green, blue, and alpha intensities.
220
221 <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>
222 </dd>
223
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]224<dt class="doc"><a id="configure.xml"/><a href="../www/source/configure.xml">configure.xml</a></dt>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]225 <dd>Set ImageMagick build parameters and system-wide environment variables (e.g. MAGICK_TEMPORARY_PATH).
226 <p>
227 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>
228 </dd>
229
230<dt class="doc"><a href="../www/source/delegates.xml">delegates.xml</a></dt>
231 <dd>Associate delegate programs with certain image formats.
232
233 <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>
234 </dd>
235
236<dt class="doc"><a href="../www/source/english.xml">english.xml</a></dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]237 <dd>Associate message tags with English translations.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]238
239<dt class="doc"><a href="../www/source/francais.xml">francais.xml</a></dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]240 <dd>Associate message tags with French translations. </dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]241
242<dt class="doc"><a href="../www/source/locale.xml">locale.xml</a></dt>
243 <dd>Associate message tags with a translation for your locale.
244
245 <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
246 <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>
247 </dd>
248
249<dt class="doc"><a href="../www/source/log.xml">log.xml</a></dt>
250 <dd>Configure logging parameters.
251 <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>
252 </dd>
253
254<dt class="doc"><a href="../www/source/magic.xml">magic.xml</a></dt>
255 <dd>Associate an image format with a unique identifier.
256 <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>
257 </dd>
258
259<dt class="doc"><a href="../www/source/mime.xml">mime.xml</a></dt>
260 <dd>Associate an internet media type with a unique identifier.
261 <p>Many files and data streams have identifiers that uniquely identify a
262particular internet media type. For example, files in the "Corel Draw
263drawing" format (mime type="application/vnd.corel-draw") are associated with
264the filename pattern <kbd>*.cdr</kbd>, and also have an initial string of the
265characters "CDRXvrsn". ImageMagick uses combinations of this information,
266when available, to attempt to quickly determine the internet media type of a
267file or data stream.</p>
268</dd>
269
270<dt class="doc"><a href="../www/source/policy.xml">policy.xml</a></dt>
271 <dd>Configure ImageMagick policies.
cristyd75d5d12010-02-16 02:04:50 +0000[diff] [blame]272 <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>
273
274<pre class="text">
275 &lt;policy domain="resource" name="area" value="100MB"/>
276</pre>
277
278<p>Any image larger than this area limit is cached to disk rather than memory.</p>
279
280<p>To limit the elapsed time of any ImageMagick command to 5 minutes, use this policy:</p>
281
282<pre class="text">
283 &lt;policy domain="resource" name="time" value="300"/>
284</pre>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]285 </dd>
286
287<dt class="doc"><a href="../www/source/thresholds.xml">thresholds.xml</a></dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]288 <dd>Set threshold maps for ordered posterized dither.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]289
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]290<dt class="doc"><a id="type.xml"></a><a href="../www/source/type.xml">type.xml</a></dt>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]291 <dd>Configure fonts.
292 <p>Define the font name, family, foundry, style, format, metrics, and glyphs for any font you want to use within ImageMagick.</p>
293 </dd>
294
295<dt class="doc"><a href="../www/source/type-ghostscript.xml">type-ghostscript.xml</a></dt>
296 <dd>Configure <a href="http://www.cs.wisc.edu/~ghost/">Ghostscript</a> fonts.
297 <p>The Ghostscript package includes a number of fonts that can be accessed with ImageMagick.</p>
298 </dd>
299
300<dt class="doc"><a href="../www/source/type-windows.xml">type-windows.xml</a></dt>
301 <dd>Associate names with Windows font glyphs.</dd>
302
303</dl>
304
305<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>
306
307<pre class="text">
308 $MAGICK_CONFIGURE_PATH
cristy3cd7cc92011-04-01 01:00:28 +0000[diff] [blame]309 $PREFIX/etc/ImageMagick
cristye9a32c32011-04-07 01:11:05 +0000[diff] [blame]310 $PREFIX/share/ImageMagick-6.6.9
cristy31fd8c42011-04-01 15:45:16 +0000[diff] [blame]311 $HOME/.magick/
cristy721a6932011-04-01 14:33:28 +0000[diff] [blame]312 &lt;<em>client path</em>&gt;/etc/ImageMagick/
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]313</pre>
314
315<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>
316
cristy075ad252010-10-30 21:56:17 +0000[diff] [blame]317<p>For the Unix or Linux pre-compiled uninstalled binary distributions, the configuration load order is:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]318
319<pre class="text">
320 $MAGICK_CONFIGURE_PATH
cristy3cd7cc92011-04-01 01:00:28 +0000[diff] [blame]321 $MAGICK_HOME/etc/ImageMagick
cristye9a32c32011-04-07 01:11:05 +0000[diff] [blame]322 $MAGICK_HOME/share/ImageMagick-6.6.9
323 $PREFIX/share/ImageMagick-6.6.9
324 $HOME/.magick/
cristy945bb352011-04-01 15:39:28 +0000[diff] [blame]325 &lt;<em>client path</em>&gt;/etc/ImageMagick/
cristy075ad252010-10-30 21:56:17 +0000[diff] [blame]326 &lt;<em>current directory</em>&gt;
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]327</pre>
328
329<p>Under Windows, ImageMagick searches for these configuration files in the following order, and loads them if found:</p>
330
331<pre class="text">
332 $MAGICK_CONFIGURE_PATH
333 &lt;<em>windows registry</em>&gt;
334 $PREFIX/config
335 $USERPROFILE/.magick/
336 &lt;<em>client path</em>&gt;
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]337</pre>
338
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]339<p>Above, $PREFIX is the default install path, typically <kbd>c:\\Program Files\\ImageMagick-6.6.9</kbd>.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]340
341<p>For an uninstalled Windows installation, the configuration load order is:</p>
342
343<pre class="text">
344 $MAGICK_CONFIGURE_PATH
345 $MAGICK_HOME
346 $USERPROFILE/.magick/
347 <em>client path</em>
348 &lt;<em>current directory</em>&gt;
349</pre>
350
351<p>If a configuration file cannot not be found, ImageMagick relies on built-in default values.</p>
352
353</div>
354
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]355<h2><a id="modules"></a>Modules</h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]356<div class="doc-section">
357
cristye9a32c32011-04-07 01:11:05 +0000[diff] [blame]358<h4>Coders</h4>
359<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 +0000[diff] [blame]360
361<pre class="text">
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]362 $MAGICK_HOME/lib/ImageMagick-6.6.9/modules-Q16/coders/
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]363 &lt;<em>client path</em>&gt;/../lib/ImageMagick-6.6.9/modules-Q16/coders/
364 $MAGICK_HOME/lib/ImageMagick-6.6.9/modules-Q16/coders
365 $MAGICK_HOME/share/ImageMagick-6.6.9/modules-Q16/coders
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]366 $HOME/.magick/
cristy8e6cb722011-03-28 19:17:44 +0000[diff] [blame]367 &lt;<em>client path</em>&gt;/lib/ImageMagick-6.6.9/modules-Q16/coders
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]368</pre>
369
cristye9a32c32011-04-07 01:11:05 +0000[diff] [blame]370<h4>Filters</h4>
371<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>
372<pre class="text">
373 $MAGICK_HOME/lib/ImageMagick-6.6.9/modules-Q16/filters/
374 &lt;<em>client path</em>&gt;/../lib/ImageMagick-6.6.9/modules-Q16/filters/
375 $MAGICK_HOME/lib/ImageMagick-6.6.9/modules-Q16/filters
376 $MAGICK_HOME/share/ImageMagick-6.6.9/modules-Q16/filters
377 $HOME/.magick/
378 &lt;<em>client path</em>&gt;/lib/ImageMagick-6.6.9/modules-Q16/filters
379</pre>
380
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]381</div>
382
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]383<h2><a id="fonts"></a>Fonts</h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]384<div class="doc-section">
385
386<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>
387
388<pre class="text">
389 $MAGICK_CONFIGURE_PATH
cristy945bb352011-04-01 15:39:28 +0000[diff] [blame]390 $MAGICK_HOME/etc/ImageMagick/
391 $MAGICK_HOME/share/ImageMagick-6.6.9/
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]392 $HOME/.magick/
cristy945bb352011-04-01 15:39:28 +0000[diff] [blame]393 &lt;<em>client path</em>&gt;/etc/ImageMagick/
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]394 $MAGICK_FONT_PATH
395</pre>
396
397</div>
398
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]399<h2><a id="environment"></a>Environment Variables</h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]400<div class="doc-section">
401
402<p>Environment variables recognized by ImageMagick include:</p>
403
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]404<dl>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]405<dt class="doc">HOME</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]406 <dd>Set path to search for configuration files in <em>$HOME/.magick</em> if the directory exists.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]407<dt class="doc">LD_LIBRARY_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]408 <dd>Set path to the ImageMagick shareable libraries and other dependent libraries.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]409<dt class="doc">MAGICK_AREA_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]410 <dd>Set the maximum <em>width * height</em> of an image that can reside in the pixel cache memory.</dd>
411 <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 +0000[diff] [blame]412<dt class="doc">MAGICK_CODER_FILTER_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]413 <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>
414 <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 +0000[diff] [blame]415<dt class="doc">MAGICK_CODER_MODULE_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]416 <dd>Set path where ImageMagick can locate its coder modules.</dd>
417 <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 +0000[diff] [blame]418<dt class="doc">MAGICK_CONFIGURE_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]419 <dd>Set path where ImageMagick can locate its configuration files</dd>
420 <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 +0000[diff] [blame]421<dt class="doc">MAGICK_DEBUG</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]422 <dd>Set debug options.</dd>
423 <dd>See <a href="../www/command-line-options.html#debug">-debug</a> for a description of debugging options.</dd>
424<dt class="doc"><a id="disk-limit"></a>MAGICK_DISK_LIMIT</dt>
425 <dd>Set maximum amount of disk space in bytes permitted for use by the pixel cache.</dd>
426 <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 +0000[diff] [blame]427<dt class="doc">MAGICK_FILE_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]428 <dd>Set maximum number of open pixel cache files.</dd>
429 <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 +0000[diff] [blame]430<dt class="doc">MAGICK_FONT_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]431 <dd>Set path ImageMagick searches for TrueType and Postscript Type1 font files.</dd>
432 <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 +0000[diff] [blame]433<dt class="doc">MAGICK_HOME</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]434 <dd>Set the path at the top of ImageMagick installation directory.</dd>
435 <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>
436<dt class="doc"><a id="map-limit"></a>MAGICK_MAP_LIMIT</dt>
437 <dd>Set maximum amount of memory map in bytes to allocate for the pixel cache.</dd>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]438 <dd>When this limit is exceeded, the image pixels are cached to disk (see MAGICK_DISK_LIMIT).</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]439<dt class="doc">MAGICK_MEMORY_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]440 <dd>Set maximum amount of memory in bytes to allocate for the pixel cache from the heap.</dd>
441 <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 +0000[diff] [blame]442<dt class="doc">MAGICK_PRECISION</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]443 <dd>Set the maximum number of significant digits to be printed.</dd>
cristy5063d812010-10-19 16:28:10 +0000[diff] [blame]444<dt class="doc">MAGICK_SYNCHRONIZE</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]445 <dd>Set to true to synchronize image to storage device.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]446<dt class="doc">MAGICK_TEMPORARY_PATH</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]447 <dd>Set path to store temporary files.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]448<dt class="doc">MAGICK_THREAD_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]449 <dd>Set maximum parallel threads.</dd>
450 <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 +0000[diff] [blame]451<dt class="doc">MAGICK_THROTTLE</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]452 <dd>Periodically yield the CPU for at least the time specified in milliseconds.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]453<dt class="doc">MAGICK_TIME_LIMIT</dt>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]454 <dd>Set maximum time in seconds.</dd>
cristyd43a46b2010-01-21 02:13:41 +0000[diff] [blame]455 <dd>When this limit is exceeded, an exception is thrown and processing stops.</dd>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]456</dl>
457</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]458
459</div>
460
461<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]462 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]463 <span id="linkbar-center">
464 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]465 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]466 </span>
467 <span id="linkbar-east">&nbsp;</span>
468 </div>
469 <div class="footer">
cristy7e41fe82010-12-04 23:12:08 +0000[diff] [blame]470 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]471 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
472 </div>
473 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]474 <script type="text/javascript">
475 var _gaq = _gaq || [];
476 _gaq.push(['_setAccount', 'UA-17690367-1']);
477 _gaq.push(['_trackPageview']);
478
479 (function() {
480 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
481 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
482 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
483 })();
484 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]485</body>
486</html>