1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
|
<!DOCTYPE html>
<html lang="en" data-bs-theme="dark">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ImageMagick – Resources</title>
<meta name="keywords" content="Resources, Image Processing, Digital Image Editing, Image Conversion, Open-Source Software, Image Manipulation, Command-Line Image Tools" />
<meta name="description" content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
<meta name="application-name" content="ImageMagick" />
<meta name="application-url" content="https://imagemagick.org" />
<meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
<meta itemprop='url' content='../' />
<meta itemprop='title' content='ImageMagick' />
<meta itemprop='description' content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
<meta property='og:url' content='../' />
<meta property='og:name' content='ImageMagick' />
<meta property='og:image' content='../images/logo.png' />
<meta property='og:type' content='website' />
<meta property='og:site_name' content='ImageMagick' />
<meta property='og:description' content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
<meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
<link type="images/png" sizes="64x64" href="../images/wand.png" rel="icon" />
<link type="images/icon" sizes="16x16" href="../images/wand.ico" rel="shortcut icon" />
<link href="resources.html" rel="canonical" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
<link href="assets/magick.css" rel="stylesheet" />
<script src="assets/color-modes.js" ></script>
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
<symbol id="check2" viewBox="0 0 16 16">
<path d="M13.854 3.646a.5.5 0 0 1 0 .708l-7 7a.5.5 0 0 1-.708 0l-3.5-3.5a.5.5 0 1 1 .708-.708L6.5 10.293l6.646-6.647a.5.5 0 0 1 .708 0z"/>
</symbol>
<symbol id="circle-half" viewBox="0 0 16 16">
<path d="M8 15A7 7 0 1 0 8 1v14zm0 1A8 8 0 1 1 8 0a8 8 0 0 1 0 16z"/>
</symbol>
<symbol id="moon-stars-fill" viewBox="0 0 16 16">
<path d="M6 .278a.768.768 0 0 1 .08.858 7.208 7.208 0 0 0-.878 3.46c0 4.021 3.278 7.277 7.318 7.277.527 0 1.04-.055 1.533-.16a.787.787 0 0 1 .81.316.733.733 0 0 1-.031.893A8.349 8.349 0 0 1 8.344 16C3.734 16 0 12.286 0 7.71 0 4.266 2.114 1.312 5.124.06A.752.752 0 0 1 6 .278z"/>
<path d="M10.794 3.148a.217.217 0 0 1 .412 0l.387 1.162c.173.518.579.924 1.097 1.097l1.162.387a.217.217 0 0 1 0 .412l-1.162.387a1.734 1.734 0 0 0-1.097 1.097l-.387 1.162a.217.217 0 0 1-.412 0l-.387-1.162A1.734 1.734 0 0 0 9.31 6.593l-1.162-.387a.217.217 0 0 1 0-.412l1.162-.387a1.734 1.734 0 0 0 1.097-1.097l.387-1.162zM13.863.099a.145.145 0 0 1 .274 0l.258.774c.115.346.386.617.732.732l.774.258a.145.145 0 0 1 0 .274l-.774.258a1.156 1.156 0 0 0-.732.732l-.258.774a.145.145 0 0 1-.274 0l-.258-.774a1.156 1.156 0 0 0-.732-.732l-.774-.258a.145.145 0 0 1 0-.274l.774-.258c.346-.115.617-.386.732-.732L13.863.1z"/>
</symbol>
<symbol id="sun-fill" viewBox="0 0 16 16">
<path d="M8 12a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM8 0a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 0zm0 13a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 13zm8-5a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2a.5.5 0 0 1 .5.5zM3 8a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2A.5.5 0 0 1 3 8zm10.657-5.657a.5.5 0 0 1 0 .707l-1.414 1.415a.5.5 0 1 1-.707-.708l1.414-1.414a.5.5 0 0 1 .707 0zm-9.193 9.193a.5.5 0 0 1 0 .707L3.05 13.657a.5.5 0 0 1-.707-.707l1.414-1.414a.5.5 0 0 1 .707 0zm9.193 2.121a.5.5 0 0 1-.707 0l-1.414-1.414a.5.5 0 0 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .707zM4.464 4.465a.5.5 0 0 1-.707 0L2.343 3.05a.5.5 0 1 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .708z"/>
</symbol>
</svg>
<div class="dropdown position-fixed bottom-0 end-0 mb-3 me-3 bd-mode-toggle">
<button class="btn btn-bd-secondary py-2 dropdown-toggle d-flex align-items-center"
id="bd-theme"
type="button"
aria-expanded="false"
data-bs-toggle="dropdown"
aria-label="Toggle theme (auto)">
<svg class="bi my-1 theme-icon-active" width="1em" height="1em"><use href="#circle-half"></use></svg>
<span class="visually-hidden" id="bd-theme-text">Toggle theme</span>
</button>
<ul class="dropdown-menu dropdown-menu-end shadow" aria-labelledby="bd-theme-text">
<li>
<button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="light" aria-pressed="false">
<svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#sun-fill"></use></svg>
Light
<svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
</button>
</li>
<li>
<button type="button" class="dropdown-item d-flex align-items-center active" data-bs-theme-value="dark" aria-pressed="false">
<svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#moon-stars-fill"></use></svg>
Dark
<svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
</button>
</li>
<li>
<button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="auto" aria-pressed="true">
<svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#circle-half"></use></svg>
Auto
<svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
</button>
</li>
</ul>
</div>
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
<symbol id="arrow-right-circle" viewBox="0 0 16 16">
<path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0zM4.5 7.5a.5.5 0 0 0 0 1h5.793l-2.147 2.146a.5.5 0 0 0 .708.708l3-3a.5.5 0 0 0 0-.708l-3-3a.5.5 0 1 0-.708.708L10.293 7.5H4.5z"/>
</symbol>
<symbol id="color-mode" viewBox="0 0 118 94">
<title>Color Modes</title>
<path fill-rule="evenodd" clip-rule="evenodd" d="M24.509 0c-6.733 0-11.715 5.893-11.492 12.284.214 6.14-.064 14.092-2.066 20.577C8.943 39.365 5.547 43.485 0 44.014v5.972c5.547.529 8.943 4.649 10.951 11.153 2.002 6.485 2.28 14.437 2.066 20.577C12.794 88.106 17.776 94 24.51 94H93.5c6.733 0 11.714-5.893 11.491-12.284-.214-6.14.064-14.092 2.066-20.577 2.009-6.504 5.396-10.624 10.943-11.153v-5.972c-5.547-.529-8.934-4.649-10.943-11.153-2.002-6.484-2.28-14.437-2.066-20.577C105.214 5.894 100.233 0 93.5 0H24.508zM80 57.863C80 66.663 73.436 72 62.543 72H44a2 2 0 01-2-2V24a2 2 0 012-2h18.437c9.083 0 15.044 4.92 15.044 12.474 0 5.302-4.01 10.049-9.119 10.88v.277C75.317 46.394 80 51.21 80 57.863zM60.521 28.34H49.948v14.934h8.905c6.884 0 10.68-2.772 10.68-7.727 0-4.643-3.264-7.207-9.012-7.207zM49.948 49.2v16.458H60.91c7.167 0 10.964-2.876 10.964-8.281 0-5.406-3.903-8.178-11.425-8.178H49.948z"></path>
</symbol>
</svg>
<nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
<div class="container-fluid">
<a class="navbar-brand" href="../index.html"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="magick-navbars">
<ul class="navbar-nav me-auto mb-2 mb-md-0">
<li class="nav-item">
<a class="nav-link " href="download.html">Download</a>
</li>
<li class="nav-item">
<a class="nav-link " href="command-line-tools.html">Tools</a>
</li>
<li class="nav-item">
<a class="nav-link " href="command-line-processing.html">CLI</a>
</li>
<li class="nav-item">
<a class="nav-link " href="develop.html">Develop</a>
</li>
<li class="nav-item">
<a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
</li>
<li class="nav-item">
</li>
</ul>
<form class="d-flex form-inline" action="search.html">
<input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search" />
<button class="btn btn-outline-success" type="submit" name="sa">Search</button>
</form>
</div>
</div>
</nav>
<div class="col-lg-8 mx-auto p-4 py-md-5 text-body-secondary">
<header class="d-flex align-items-center pb-3 mb-5 border-bottom">
<a href="../index.html" class="d-flex align-items-center text-decoration-none">
<h1 class="fs-4">Resources</h1>
</a>
</header>
<main class="container">
<div>
<p class="text-center"><a href="#configure">Configuration Files</a> • <a href="#modules">Modules</a> • <a href="#fonts">Fonts</a> • <a href="#environment">Environment Variables</a></p>
<p class="lead">ImageMagick depends on a number of external resources including configuration files, loadable modules, fonts, and environment variables.</p>
<h2><a class="anchor" id="configure"></a>Configuration Files</h2>
<p>ImageMagick depends on a number of external configuration files detailed here:</p>
<dl class="row">
<dt class="col-md-4"><a href="https://imagemagick.org/source/coder.xml">coder.xml</a></dt>
<dd class="col-md-8">Associate an image format with the specified coder module.
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.
</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/colors.xml">colors.xml</a></dt>
<dd class="col-md-8">Associate a color name with its red, green, blue, and alpha intensities.
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).
</dd>
<dt class="col-md-4"><a class="anchor" id="configure.xml"/><a href="https://imagemagick.org/source/configure.xml">configure.xml</a></dt>
<dd class="col-md-8">Set ImageMagick build parameters and system-wide environment variables (e.g. MAGICK_TEMPORARY_PATH).
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.
</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/delegates.xml">delegates.xml</a></dt>
<dd class="col-md-8">Associate delegate programs with certain image formats.
ImageMagick relies on a number of delegate programs to support certain image formats such as <a href="../index.html">darktable</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.
</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/english.xml">english.xml</a></dt>
<dd class="col-md-8">Associate message tags with English translations.</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/francais.xml">francais.xml</a></dt>
<dd class="col-md-8">Associate message tags with French translations. </dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/locale.xml">locale.xml</a></dt>
<dd class="col-md-8">Associate message tags with a translation for your locale.
ImageMagick has a number of informational, warning, and error messages that are represented as tags. Tags are short descriptions of a message such as
<var>FileNotFound</var> or <var>MemoryAllocationFailed</var>. 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 <samp>english.xml</samp> and <samp>francais.xml</samp> configuration files.
</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/log.xml">log.xml</a></dt>
<dd class="col-md-8">Configure logging parameters.
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.
</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/mime.xml">mime.xml</a></dt>
<dd class="col-md-8">Associate an internet media type with a unique identifier.
Many files and data streams have identifiers that uniquely identify a
particular internet media type. For example, files in the "Corel Draw
drawing" format (mime type="application/vnd.corel-draw") are associated with
the filename pattern <samp>*.cdr</samp>, and also have an initial string of the
characters "CDRXvrsn". ImageMagick uses combinations of this information,
when available, to attempt to quickly determine the internet media type of a
file or data stream.
</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/policy-open.xml">policy.xml</a></dt>
<dd class="col-md-8">Configure ImageMagick <a href="security-policy.html">security policies</a>.
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 100MP:
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp><policy domain="resource" name="area" value="100MP"/></samp></pre>
Any image larger than this area limit is cached to disk rather than memory.
Use <samp>width</samp> to limit the maximum width of an image in pixels. Exceed this limit and an exception is thrown and processing stops.
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp><policy domain="resource" name="width" value="8KP"/></samp></pre>
To limit the elapsed time of any ImageMagick command to 5 minutes, use this policy:
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp><policy domain="resource" name="time" value="300"/></samp></pre>
For convenience, define arguments for the memory, map, and disk resources with SI prefixes (.e.g 100MB). In addition, resource policies are maximums for each instance of ImageMagick (e.g. policy memory limit 1GB, the <samp>-limit 2GB</samp> option exceeds policy maximum so memory limit is 1GB). </dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/quantization-table.xml">quantization-table.xml</a></dt>
<dd class="col-md-8">Custom JPEG quantization tables. Activate with <samp>-define:q-table=quantization-table.xml</samp>.</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/thresholds.xml">thresholds.xml</a></dt>
<dd class="col-md-8">Set threshold maps for ordered posterized dither.</dd>
<dt class="col-md-4"><a class="anchor" id="type.xml"></a><a href="https://imagemagick.org/source/type.xml">type.xml</a></dt>
<dd class="col-md-8">Configure fonts.
Define the font name, family, foundry, style, format, metrics, and glyphs for any font you want to use within ImageMagick.
</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/type-ghostscript.xml">type-ghostscript.xml</a></dt>
<dd class="col-md-8">Configure <a href="http://www.cs.wisc.edu/~ghost/">Ghostscript</a> fonts.
The Ghostscript package includes a number of <a href="https://sourceforge.net/projects/gs-fonts/">fonts</a> that can be accessed with ImageMagick.
</dd>
<dt class="col-md-4"><a href="https://imagemagick.org/source/type-windows.xml">type-windows.xml</a></dt>
<dd class="col-md-8">Associate names with Windows font glyphs.</dd>
</dl>
<p>Under Linux 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>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp>$MAGICK_CONFIGURE_PATH
$PREFIX/etc/ImageMagick-7
$PREFIX/share/ImageMagick-7
$XDG_CACHE_HOME/ImageMagick
$HOME/.config/ImageMagick
<<var>client path</var>>/etc/ImageMagick</samp></pre>
<p>The environmental variable $PREFIX is the default install path (e.g. <samp>/usr/local</samp>). The <var>client path</var> is the execution path of your ImageMagick client (e.g. <samp>/usr/local</samp>) .</p>
<p>For the Linux or Linux pre-compiled uninstalled binary distributions, the configuration load order is:</p>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp>$MAGICK_CONFIGURE_PATH
$MAGICK_HOME/etc/ImageMagick-7
$MAGICK_HOME/share/ImageMagick-7
$PREFIX/share/ImageMagick-7
$XDG_CACHE_HOME/ImageMagick
$HOME/.config/ImageMagick/
<<var>client path</var>>/etc/ImageMagick
<<var>current directory</var>></samp></pre>
<p>Under Windows, ImageMagick searches for these configuration files in the following order, and loads them if found:</p>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp>$MAGICK_CONFIGURE_PATH
<<var>windows registry</var>>
$PREFIX/config
$USERPROFILE/.config/ImageMagick
<<var>client path</var>></samp></pre>
<p>Above, $PREFIX is the default install path, typically <samp>c:\\Program Files\\ImageMagick-7.1.1</samp>.</p>
<p>For an uninstalled Windows installation, the configuration load order is:</p>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp>$MAGICK_CONFIGURE_PATH
$MAGICK_HOME
$USERPROFILE/.config/ImageMagick
<var>client path</var>
<<var>current directory</var>></samp></pre>
<p>If a configuration file cannot not be found, ImageMagick relies on built-in default values.</p>
<h2><a class="anchor" id="modules"></a>Modules</h2>
<h4>Coders</h4>
<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>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp>$MAGICK_HOME/lib/ImageMagick-7.1.1/modules-Q16/coders
<<var>client path</var>>/../lib/ImageMagick-7.1.1/modules-Q16/coders
$MAGICK_HOME/lib/ImageMagick-7.1.1/modules-Q16/coders
$MAGICK_HOME/share/ImageMagick-7.1.1/modules-Q16/coders
$XDG_CACHE_HOME/ImageMagick
$HOME/.config/ImageMagick
<<var>client path</var>>/lib/ImageMagick-7.1.1/modules-Q16/coders</samp></pre>
<h4>Filters</h4>
<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>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp>$MAGICK_HOME/lib/ImageMagick-7.1.1/modules-Q16/filters
<<var>client path</var>>/../lib/ImageMagick-7.1.1/modules-Q16/filters
$MAGICK_HOME/lib/ImageMagick-7.1.1/modules-Q16/filters
$MAGICK_HOME/share/ImageMagick-7.1.1/modules-Q16/filters
$XDG_CACHE_HOME/ImageMagick
$HOME/.config/ImageMagick
<<var>client path</var>>/lib/ImageMagick-7.1.1/modules-Q16/filters</samp></pre>
<h2><a class="anchor" id="fonts"></a>Fonts</h2>
<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>
<pre class="p-3 mb-2 text-body-secondary bg-body-tertiary"><samp>$MAGICK_CONFIGURE_PATH
$MAGICK_HOME/etc/ImageMagick/-7.1.1
$MAGICK_HOME/share/ImageMagick-7.1.1
$XDG_CACHE_HOME/ImageMagick
$HOME/.config/ImageMagick
<<var>client path</var>>/etc/ImageMagick
$MAGICK_FONT_PATH</samp></pre>
<h2><a class="anchor" id="environment"></a>Environment Variables</h2>
<p>Environment variables recognized by ImageMagick include:</p>
<div>
<table class="table table-sm table-hover table-striped table-responsive">
<tr>
<td>HOME</td>
<td>Set path to search for configuration files in <samp>$HOME/.config/ImageMagick</samp> if the directory exists.</td>
</tr>
<tr>
<td>LD_LIBRARY_PATH</td>
<td>Set path to the ImageMagick shareable libraries and other dependent libraries.</td>
</tr>
<tr>
<td>MAGICK_AREA_LIMIT</td>
<td>Set the maximum <var>width * height</var> of an image that can reside in the pixel cache memory. Images that exceed the area limit are cached to disk (see <a href="#disk-limit">MAGICK_DISK_LIMIT</a>) and optionally memory-mapped.</td>
</tr>
<tr>
<td>MAGICK_CODER_FILTER_PATH</td>
<td>Set search path to use when searching for filter process modules (invoked via <a href="command-line-options.html#process">-process</a>). 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 Linux, and semi-colon delimited for Microsoft Windows). This user specified search path is searched before trying the <a href="#modules">default search path</a>.</td>
</tr>
<tr>
<td>MAGICK_CODER_MODULE_PATH</td>
<td>Set path where ImageMagick can locate its coder modules. 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 Linux, and semi-colon delimited for Microsoft Windows). This user specified search path is searched before trying the <a href="#modules">default search path</a>.</td>
</tr>
<tr>
<td>MAGICK_CONFIGURE_PATH</td>
<td>Set path where ImageMagick can locate its configuration files. 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 Linux, and semi-colon delimited for Microsoft Windows). This user specified search path is searched before trying the <a href="#configure">default search path</a>.</td>
</tr>
<tr>
<td>MAGICK_DATE_PRECISION</td>
<td>Set the maximum number of characters printed for any timestamp.</td>
</tr>
<tr>
<td>MAGICK_DEBUG</td>
<td>Set debug options. See <a href="command-line-options.html#debug">-debug</a> for a description of debugging options.</td>
</tr>
<tr>
<td><a class="anchor" id="disk-limit"></a>MAGICK_DISK_LIMIT</td>
<td>Set maximum amount of disk space in bytes permitted for use by the pixel cache. When this limit is exceeded, the pixel cache is not be created and an error message is returned.</td>
</tr>
<tr>
<td>MAGICK_ERRORMODE</td>
<td>Set the process error mode (Windows only). A typical use might be a value of 1 to prevent error mode dialogs from displaying a message box and hanging the application.</td>
</tr>
<tr>
<td>MAGICK_FILE_LIMIT</td>
<td>Set maximum number of open pixel cache files. 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.</td>
</tr>
<tr>
<td>MAGICK_FONT_PATH</td>
<td>Set path ImageMagick searches for TrueType and Postscript Type1 font files. This path is only consulted if a particular font file is not found in the current directory.</td>
</tr>
<tr>
<td>MAGICK_HEIGHT_LIMIT</td>
<td>Set the maximum <var>height</var> of an image.</td>
</tr>
<tr>
<td>MAGICK_HOME</td>
<td>Set the path at the top of ImageMagick installation directory. This path is consulted by <var>uninstalled</var> builds of ImageMagick which do not have their location hard-coded or set by an installer.</td>
</tr>
<tr>
<td>MAGICK_LIST_LENGTH_LIMIT</td>
<td>Set the maximum length of an image sequence.</td>
</tr>
<tr>
<td><a class="anchor" id="map-limit"></a>MAGICK_MAP_LIMIT</td>
<td>Set maximum amount of memory map in bytes to allocate for the pixel cache. When this limit is exceeded, the image pixels are cached to disk (see MAGICK_DISK_LIMIT).</td>
</tr>
<tr>
<td>MAGICK_MEMORY_LIMIT</td>
<td>Set maximum amount of memory in bytes to allocate for the pixel cache from the heap. When this limit is exceeded, the image pixels are cached to memory-mapped disk (see <a href="#map-limit">MAGICK_MAP_LIMIT</a>).</td>
</tr>
<tr>
<td>MAGICK_OCL_DEVICE</td>
<td>Set to <samp>off</samp> to disable hardware acceleration of certain accelerated algorithms (e.g. blur, convolve, etc.).</td>
</tr>
<tr>
<td>MAGICK_PRECISION</td>
<td>Set the maximum number of significant digits to be printed.</td>
</tr>
<tr>
<td>MAGICK_SHRED_PASSES</td>
<td>If you want to keep the temporary files ImageMagick creates private, overwrite them with zeros or random data before they are removed. On the first pass, the file is zeroed. For subsequent passes, random data is written.</td>
</tr>
<tr>
<td>MAGICK_SYNCHRONIZE</td>
<td>Set to "true" to ensure all image data is fully flushed and synchronized to disk. There is a performance penalty, however, the benefits include ensuring a valid image file in the event of a system crash and early reporting if there is not enough disk space for the image pixel cache.</td>
</tr>
<tr>
<td>MAGICK_TEMPORARY_PATH</td>
<td>Set path to store temporary files.</td>
</tr>
<tr>
<td>MAGICK_THREAD_LIMIT</td>
<td>Set maximum parallel threads. Many ImageMagick algorithms run in parallel on multi-processor systems. Use this environment variable to set the maximum number of threads that are permitted to run in parallel.</td>
</tr>
<tr>
<td>MAGICK_THROTTLE_LIMIT</td>
<td>Periodically yield the CPU for at least the time specified in milliseconds.</td>
</tr>
<tr>
<td>MAGICK_TIME_LIMIT</td>
<td>Set maximum time in seconds. When this limit is exceeded, an exception is thrown and processing stops.</td>
</tr>
<tr>
<td>MAGICK_WIDTH_LIMIT</td>
<td>Set the maximum <var>width</var> of an image.</td>
</tr>
<tr>
<td>SOURCE_DATE_EPOCH</td>
<td>A UNIX timestamp, defined as the number of seconds, excluding leap seconds, since <samp>01 Jan 1970 00:00:00 UTC</samp>. Special-purpose setting for pipeline builds. This setting disables the time-to-live settings.</td>
</tr>
</table></div>
<p>Define arguments for the <samp>MAGICK_MEMORY_LIMIT</samp>, <samp>MAGICK_DISK_LIMIT</samp>, and <samp>MAGICK_MEMORY_LIMIT</samp> environment variables with SI prefixes (.e.g <samp>100MB</samp>). <samp>MAGICK_WIDTH_LIMIT</samp>, <samp>MAGICK_HEIGHT_LIMIT</samp> and <samp>MAGICK_AREA_LIMIT</samp> accepts pixel suffixes such as MP for mega-pixels (e.g. 100MP). Note, you can restrict limits relative to any <a href="../www/policy-open.xml">security policies</a>, but you cannot relax them.</p>
</div>
</main><!-- /.container -->
<footer class="py-5 text-center text-body-secondary bg-body-tertiary">
<div class="container-fluid">
<a href="security-policy.html">Security</a> •
<a href="news.html">News</a>
<a href="#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico"/></a>
<a href="links.html">Related</a> •
<a href="sitemap.html">Sitemap</a>
<br/>
<a href="support.html">Sponsor</a> •
<a href="cite.html">Cite</a> •
<a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> •
<a href="https://imagemagick.org/script/contact.php">Contact Us</a>
<br/>
<a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
<a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
<br/>
<small>Copyright © 1999 ImageMagick Studio LLC</small>
</div>
</footer>
</div>
<!-- Javascript assets -->
<script src="assets/magick.js" ></script>
</body>
</html>
|
