]> granicus.if.org Git - imagemagick/blob - www/resources.html
(no commit message)
[imagemagick] / www / resources.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
4 <head>\r
5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
7   <style type="text/css" media="screen,projection"><!--\r
8     @import url("../www/magick.css");\r
9   --></style>\r
10   <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
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="Generator" content="PHP"/>
16   <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"/>
17   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
18   <meta name="Rating" content="GENERAL"/>
19   <meta name="Robots" content="INDEX, FOLLOW"/>
20   <meta name="Generator" content="ImageMagick Studio LLC"/>
21   <meta name="Author" content="ImageMagick Studio LLC"/>
22   <meta name="Revisit-after" content="2 DAYS"/>
23   <meta name="Resource-type" content="document"/>
24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25   <meta name="Distribution" content="Global"/>
26 </head>\r
27 \r
28 <body id="www-imagemagick-org">\r
29 <div class="titlebar">\r
30 <a href="../index.html">\r
31   <img src="../images/script.png" alt="[ImageMagick]"\r
32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
33 <a href="http://www.networkredux.com">\r
34   <img src="../images/networkredux.png" alt="[sponsor]"\r
35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
36 <a href="http://www.imagemagick.org/discourse-server/">\r
37   <img src="../images/logo.jpg" alt=""\r
38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
39 <a href="../index.html">\r
40   <img src="../images/sprite.jpg" alt=""\r
41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
42 </div>\r
43 \r
44 <div class="eastbar">\r
45 \r
46 <div class="menu">
47   <a href="../index.html">About ImageMagick</a>
48 </div>
49 <div class="sep"></div>\r
50 <div class="menu">
51   <a href="../www/command-line-tools.html">Command-line Tools</a>
52 </div>
53 <div class="sub">
54     <a href="../www/command-line-processing.html">Processing</a>
55 </div>
56 <div class="sub">
57     <a href="../www/command-line-options.html">Options</a>
58 </div>
59 <div class="sub">
60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
61 </div>
62 <div class="menu">
63   <a href="../www/api.html">Program Interfaces</a>
64 </div>
65 <div class="sub">
66     <a href="../www/magick-wand.html">MagickWand</a>
67 </div>
68 <div class="sub">
69     <a href="../www/magick-core.html">MagickCore</a>
70 </div>
71 <div class="sub">
72     <a href="../www/perl-magick.html">PerlMagick</a>
73 </div>
74 <div class="sub">
75     <a href="../Magick++/">Magick++</a>
76 </div>
77 <div class="menu">
78   <a href="../www/architecture.html">Architecture</a>
79 </div>
80 <div class="sep"></div>\r
81 <div  class="menu">
82    <a href="../www/install-source.html">Install from Source</a>
83 </div>
84 <div class="sub">
85     <a href="../www/install-source.html#unix">Unix</a>
86 </div>
87 <div class="sub">
88     <a href="../www/install-source.html#windows">Windows</a>
89  </div>
90 <div class="menu">
91   <a href="../www/binary-releases.html">Binary Releases</a>
92 </div>
93 <div class="sub">
94     <a href="../www/binary-releases.html#unix">Unix</a>
95 </div>
96 <div class="sub">
97     <a href="../www/binary-releases.html#macosx">Mac OS X</a>
98 </div>
99 <div class="sub">
100     <a href="../www/binary-releases.html#windows">Windows</a>
101 </div>
102 <div class="menu">
103   <a href="../www/resources.html">Resources</a>
104 </div>
105 <div class="sep"></div>\r
106 <div class="menu">
107   <a href="../www/download.html">Download</a>
108 </div>
109 <div class="sep"></div>\r
110 <div class="menu">
111   <a href="http://www.imagemagick.org/script/search.php">Search</a>
112 </div>
113 <div class="sep"></div>\r
114 <div class="menu">
115   <a href="../www/sitemap.html">Site Map</a>
116 </div>
117 <div  class="sub">
118     <a href="../www/links.html">Links</a>
119 </div>
120 <div class="sep"></div>\r
121 <div  class="menu">
122   <a href="../www/sponsors.html">Sponsors:</a>
123
124 <div class="sponsbox">
125 <div  class="sponsor">
126    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
127 </div>
128 <div  class="sponsor">
129    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
130 </div>
131 <div  class="sponsor">
132   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
133 </div>
134 <div  class="sponsor">
135   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
136 </div>
137 <div  class="sponsor">
138   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
139 </div>
140 <div  class="sponsor">
141   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
142 </div>
143 </div>
144 </div>
145 \r
146 \r
147 </div>\r
148 \r
149 <div class="main">\r
150 \r
151 <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>
152
153 <div class="doc-section">
154 <p>ImageMagick depends on a number of external resources including configuration files, loadable modules, fonts, and environment variables.</p>
155 </div>
156
157 <h2><a name="configure"></a>Configuration Files</h2>
158 <div class="doc-section">
159
160 <p>ImageMagick depends on a number of external configuration files detailed here:</p>
161
162 <dl class="doc">
163 <dt class="doc"><a href="../www/source/coder.xml">coder.xml</a></dt>
164   <dd>Associate an image format with the specified coder module.
165
166   <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>
167   </dd>
168
169 <dt class="doc"><a href="../www/source/colors.xml">colors.xml</a></dt>
170   <dd>Associate a color name with its red, green, blue, and alpha intensities.
171
172   <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>
173   </dd>
174
175 <dt class="doc"><a name="configure.xml"/><a href="../www/source/configure.xml">configure.xml</a></dt>
176   <dd>Set ImageMagick build parameters and system-wide environment variables (e.g. MAGICK_TEMPORARY_PATH).
177   <p>
178   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>
179   </dd>
180
181 <dt class="doc"><a href="../www/source/delegates.xml">delegates.xml</a></dt>
182   <dd>Associate delegate programs with certain image formats.
183
184   <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>
185   </dd>
186
187 <dt class="doc"><a href="../www/source/english.xml">english.xml</a></dt>
188   <dd>Associate message tags with English translations.</dd>
189
190 <dt class="doc"><a href="../www/source/francais.xml">francais.xml</a></dt>
191   <dd>Associate message tags with French translations.  </dd>
192
193 <dt class="doc"><a href="../www/source/locale.xml">locale.xml</a></dt>
194   <dd>Associate message tags with a  translation for your locale.
195
196   <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
197   <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>
198   </dd>
199
200 <dt class="doc"><a href="../www/source/log.xml">log.xml</a></dt>
201   <dd>Configure logging parameters.
202   <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>
203   </dd>
204
205 <dt class="doc"><a href="../www/source/magic.xml">magic.xml</a></dt>
206   <dd>Associate an image format with a unique identifier.
207   <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>
208   </dd>
209
210 <dt class="doc"><a href="../www/source/mime.xml">mime.xml</a></dt>
211   <dd>Associate an internet media type with a unique identifier.
212   <p>Many files and data streams have identifiers that uniquely identify a
213 particular internet media type. For example, files in the "Corel Draw
214 drawing" format (mime type="application/vnd.corel-draw") are associated with
215 the filename pattern <kbd>*.cdr</kbd>, and also have an initial string of the
216 characters "CDRXvrsn". ImageMagick uses combinations of this information,
217 when available, to attempt to quickly determine the internet media type of a
218 file or data stream.</p>
219 </dd>
220
221 <dt class="doc"><a href="../www/source/policy.xml">policy.xml</a></dt>
222   <dd>Configure ImageMagick policies.
223   <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 (e.g. large images are cached to disk rather than memory).</p>
224   </dd>
225
226 <dt class="doc"><a href="../www/source/thresholds.xml">thresholds.xml</a></dt>
227   <dd>Set threshold maps for ordered posterized dither.</dd>
228
229 <dt class="doc"><a name="type.xml"></a><a href="../www/source/type.xml">type.xml</a></dt>
230   <dd>Configure fonts.
231   <p>Define the font name, family, foundry, style, format, metrics, and glyphs for any font you want to use within ImageMagick.</p>
232   </dd>
233
234 <dt class="doc"><a href="../www/source/type-ghostscript.xml">type-ghostscript.xml</a></dt>
235   <dd>Configure <a href="http://www.cs.wisc.edu/~ghost/">Ghostscript</a> fonts.
236   <p>The Ghostscript package includes a number of fonts that can be accessed with ImageMagick.</p>
237   </dd>
238
239 <dt class="doc"><a href="../www/source/type-windows.xml">type-windows.xml</a></dt>
240   <dd>Associate names with Windows font glyphs.</dd>
241
242 </dl>
243
244 <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>
245
246 <pre class="text">
247   $MAGICK_CONFIGURE_PATH
248   $PREFIX/lib/ImageMagick-6.5.6/config
249   $PREFIX/share/ImageMagick-6.5.6/config
250   $PREFIX/share/ImageMagick-6.5.6  $HOME/.magick/
251   &lt;<em>client path</em>&gt;/lib/ImageMagick-6.5.6/
252   &lt;<em>current directory</em>&gt;/
253 </pre>
254
255 <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>
256
257 <p>For the Unix or Linux pre-compiled binary distribution, the configuration load order is:</p>
258
259 <pre class="text">
260   $MAGICK_CONFIGURE_PATH
261   $MAGICK_HOME/lib/ImageMagick-6.5.6/config
262   $MAGICK_HOME/share/ImageMagick-6.5.6/config
263   $PREFIX/share/ImageMagick-6.5.6  $HOME/.magick/
264   &lt;<em>client path</em>&gt;/lib/ImageMagick-6.5.6/
265   &lt;<em>current directory</em>&gt;/
266 </pre>
267
268 <p>Under Windows, ImageMagick searches for these configuration files in the following order, and loads them if found:</p>
269
270 <pre class="text">
271   $MAGICK_CONFIGURE_PATH
272   &lt;<em>windows registry</em>&gt;
273   $PREFIX/config
274   $USERPROFILE/.magick/
275   &lt;<em>client path</em>&gt;
276   &lt;<em>current directory</em>&gt;
277 </pre>
278
279 <p>Above, $PREFIX is the default install path, typically <kbd>c:\\Program Files\\ImageMagick-6.5.6</kbd>.</p>
280
281 <p>For an uninstalled Windows installation, the configuration load order is:</p>
282
283 <pre class="text">
284   $MAGICK_CONFIGURE_PATH
285   $MAGICK_HOME
286   $USERPROFILE/.magick/
287   <em>client path</em>
288   &lt;<em>current directory</em>&gt;
289 </pre>
290
291 <p>If a configuration file cannot not be found, ImageMagick relies on built-in default values.</p>
292
293 </div>
294
295 <h2><a name="modules"></a>Modules</h2>
296 <div class="doc-section">
297
298 <p>ImageMagick's image format support is usually provided in the form of loadable modules. It searches for loadable modules in the following order and it uses the first match found:</p>
299
300 <pre class="text">
301   &lt;<em>current directory</em>&gt;/
302   $MAGICK_HOME/lib/ImageMagick-6.5.6/modules-Q16/coders/
303   $HOME/.magick/
304   &lt;<em>client path</em>&gt;/../lib/ImageMagick-6.5.6/modules-Q16/coders/
305   $MAGICK_HOME/lib/ImageMagick-6.5.6/modules-Q16/coders
306   $MAGICK_HOME/share/ImageMagick-6.5.6/modules-Q16/coders
307   $HOME/.magick/
308   &lt;<em>client path</em>&gt;/lib/ImageMagick-6.5.6/modules-Q16/coders
309   &lt;<em>current directory</em>&gt;/
310 </pre>
311
312 </div>
313
314 <h2><a name="fonts"></a>Fonts</h2>
315 <div class="doc-section">
316
317 <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>
318
319 <pre class="text">
320   $MAGICK_CONFIGURE_PATH
321   $MAGICK_HOME/lib/ImageMagick-6.5.6/config
322   $MAGICK_HOME/share/ImageMagick-6.5.6/config
323   $HOME/.magick/
324   &lt;<em>client path</em>&gt;/lib/ImageMagick-6.5.6/
325   &lt;<em>current directory</em>&gt;/
326   $MAGICK_FONT_PATH
327 </pre>
328
329 </div>
330
331 <h2><a name="environment"></a>Environment Variables</h2>
332 <div class="doc-section">
333
334 <p>Environment variables recognized by ImageMagick include:</p>
335
336 <dl class="doc">
337 <dt class="doc">HOME</dt>
338   <dd>Set path to search for configuration files in <em>$HOME/.magick</em> if the directory exists.</dd>
339 <dt class="doc">LD_LIBRARY_PATH</dt>
340   <dd>Set path to the ImageMagick shareable libraries and other dependent libraries.</dd>
341 <dt class="doc">MAGICK_AREA_LIMIT</dt>
342   <dd>Set the maximum <em>width * height</em> of an image that can reside in the pixel cache memory.
343   <p>Images that exceed the area limit are cached to disk (see <a href="#disk-limit">MAGICK_DISK_LIMIT</a>).</p>
344   </dd>
345 <dt class="doc">MAGICK_CODER_FILTER_PATH</dt>
346   <dd>Set search path to use when searching for filter process modules (invoked via  <a href="../www/command-line-options.html#process">-process</a>).
347   <p>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>.</p>
348   </dd>
349 <dt class="doc">MAGICK_CODER_MODULE_PATH</dt>
350   <dd>Set path where ImageMagick can locate its coder modules.
351   <p>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>.</p>
352   </dd>
353 <dt class="doc">MAGICK_CONFIGURE_PATH</dt>
354   <dd>Set path where ImageMagick can locate its configuration files
355   <p>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>.</p>
356   </dd>
357 <dt class="doc">MAGICK_DEBUG</dt>
358   <dd>Set debug options.
359   <p>See <a href="../www/command-line-options.html#debug">-debug</a> for a description of debugging options.</p>
360   </dd>
361 <dt class="doc"><a name="disk-limit"></a>MAGICK_DISK_LIMIT</dt>
362   <dd>Set maximum amount of disk space in bytes permitted for use by the pixel cache.
363   <p>When this limit is exceeded, the pixel cache is not be created and an error message is returned.</p>
364   </dd>
365 <dt class="doc">MAGICK_FILE_LIMIT</dt>
366   <dd>Set maximum number of open pixel cache files.
367   <p>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.</p>
368   </dd>
369 <dt class="doc">MAGICK_FONT_PATH</dt>
370   <dd>Set path ImageMagick searches for TrueType and Postscript Type1 font files.
371   <p>This path is only consulted if a particular font file is not found in the current directory.</p>
372   </dd>
373 <dt class="doc">MAGICK_HOME</dt>
374   <dd>Set the path at the top of ImageMagick installation directory.
375   <p>This path is consulted by <em>uninstalled</em> builds of ImageMagick which do not have their location hard-coded or set by an installer.</p>
376   </dd>
377 <dt class="doc"><a name="map-limit"></a>MAGICK_MAP_LIMIT</dt>
378   <dd>Set maximum amount of memory map in bytes to allocate for the pixel cache.
379   <p>When this limit is exceeded, the image pixels are cached to disk (see MAGICK_DISK_LIMIT).</p>
380   </dd>
381 <dt class="doc">MAGICK_MEMORY_LIMIT</dt>
382   <dd>Set maximum amount of memory in bytes to allocate for the pixel cache from the heap.
383   <p>When this limit is exceeded, the image pixels are cached to memory-mapped disk (see <a href="#map-limit">MAGICK_MAP_LIMIT</a>).</p>
384   </dd>
385 <dt class="doc">MAGICK_TEMPORARY_PATH</dt>
386   <dd>Set path to store temporary files.</dd>
387 <dt class="doc">MAGICK_THREAD_LIMIT</dt>
388   <dd>Set maximum parallel threads.
389   <p>Many ImageMagick algorithms run in parallel on multi-processor systems.  Use this enviroment variable to set the maximum number of threads that is permitted to run in parallel.</p>
390   </dd>
391 <dt class="doc">MAGICK_TIME_LIMIT</dt>
392   <dd>Set maximum time in seconds.
393   <p>When this limit is exceeded, an exception is thrown and processing stops.</p>
394   </dd>
395 </dl>
396 </div>
397 \r
398 </div>\r
399 \r
400 <div id="linkbar">\r
401  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
402     <span id="linkbar-center">\r
403       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
404       <a href="../www/mailing-list.html">Mailing Lists</a> &bull;\r
405     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
406     </span>\r
407     <span id="linkbar-east">&nbsp;</span>\r
408   </div>\r
409   <div class="footer">\r
410     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
411     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
412   </div>\r
413   <div style="clear: both; margin: 0; width: 100%; "></div>\r
414 </body>\r
415 </html>\r