Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / a890294753108889ed477181e5dd0ff5fc605f43 / . / www / conjure.html
blob: de8956ff30e3a23616949a36914b0586dd52dd77 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]5<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]6 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]7 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
8 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]9 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]10 @import url("../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]11 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]12 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
13 <title>ImageMagick: Command-line Tools: Conjure</title>
14 <meta http-equiv="Content-Language" content="en-US"/>
15 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
16 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
17 <meta name="Generator" content="PHP"/>
18 <meta name="Keywords" content="command-line, tools:, conjure, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
19 <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."/>
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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]28</head>
29
30<body id="www-imagemagick-org">
31<div class="titlebar">
32<a href="../index.html">
33 <img src="../images/script.png" alt="[ImageMagick]"
34 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
35<a href="http://www.networkredux.com">
36 <img src="../images/networkredux.png" alt="[sponsor]"
37 style="margin: 45px auto; border: 0px; float: left;" /></a>
38<a href="http://www.imagemagick.org/discourse-server/">
39 <img src="../images/logo.jpg" alt=""
40 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
41<a href="../index.html">
42 <img src="../images/sprite.jpg" alt=""
43 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
44</div>
45
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]46<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]47
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]48<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]49 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]51<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]53 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
54</div>
55<div class="sub">
56 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
57</div>
58<div class="sub">
59 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
60</div>
61<div class="sub">
62 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
63</div>
64<div class="sep"></div>
65<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]66 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]67</div>
68<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]69 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70</div>
71<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]72 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]73</div>
74<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]75 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]76</div>
77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
80<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]81 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82</div>
83<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]84 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]87 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]88</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]90 <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]92<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101 </div>
102<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]105<div class="menu">
106 <a title="Architecture" href="../www/architecture.html">Architecture</a>
107</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]109 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]111<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]115<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]117 <a title="Site Map"href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]120 <a title="Site Map: Links"href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]122<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]124 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125
126<div class="sponsbox">
127<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]128 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]129</div>
130<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]131 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]132</div>
133<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]134 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]135</div>
136<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]137 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]138</div>
139<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000[diff] [blame]141</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]142<div class="sponsor">
143 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
145</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]146</div>
147</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]148
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]149<div class="eastbar">
150 <script type="text/javascript">
151 <!--
152 google_ad_client = "pub-3129977114552745";
153 /* 160x600, created 7/27/10 */
154 google_ad_slot = "0574824969";
155 google_ad_width = 160;
156 google_ad_height = 600;
157 //-->
158 </script>
159 <script type="text/javascript"
160 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
161 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]162</div>
163
164<div class="main">
165
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]166<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
167
168<div class="doc-section">
169<p>The <kbd>conjure</kbd> program gives you the ability to perform custom image processing tasks from a script written in the Magick Scripting Language (MSL). MSL is XML-based and consists of action statements with attributes. Actions include reading an image, processing an image, getting attributes from an image, writing an image, and more. An attribute is a key/value pair that modifies the behavior of an action. See <a href="../www/command-line-processing.html">Command Line Processing</a> for advice on how to structure your <kbd>conjure</kbd> command or see below for example usages of the command.</p>
170</div>
171
172<h2><a name="usage"></a>Example Usage</h2>
173<div class="doc-section">
174
175<p>We list a few examples of the <kbd>conjure</kbd> command here to illustrate its usefulness and ease of use. To get started, here is simple <kbd>conjure</kbd> command:</p>
176
177<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>conjure -dimensions 400x400 incantation.msl</span></p>
178<p>The MSL script <a href="../www/source/incantation.msl">incantation.msl</a> used above is here:</p>
179
180<pre class="text">
181 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
182 &lt;image size="400x400"&gt;
183 &lt;read filename="image.gif" /&gt;
184 &lt;get width="base-width" height="base-height" /&gt;
185 &lt;resize geometry="%[dimensions]" /&gt;
186 &lt;get width="width" height="height" /&gt;
187 &lt;print output="Image sized from %[base-width]x%[base-height] to %[width]x%[height].\n" /&gt;
188 &lt;write filename="image.png" /&gt;
189 &lt;/image&gt;
190</pre>
191
192<p>In this example, a family stayed home for their vacation but as far as their friends are concerned they went to a beautiful beach in the Caribbean:</p>
193
194<pre class="text">
195 &lt;?xml version="1.0" encoding="UTF-8"?>
196 &lt;group>
197 &lt;image id="family">
198 &lt;read filename="family.gif"/>
199 &lt;resize geometry="300x300"/>
200 &lt;/image>
201 &lt;image id="palm-trees">
202 &lt;read filename="palm-trees.gif"/>
203 &lt;resize geometry="300x100"/>
204 &lt;/image>
205 &lt;image>
206 &lt;read filename="beach.jpg"/>
207 &lt;composite image="family" geometry="+30+40"/>
208 &lt;composite image="palm-trees" geometry="+320+90"/>
209 &lt;/image>
210 &lt;write filename="family-vacation.png"/>
211 &lt;/group>
212</pre>
213
214<p>Here we display the width in pixels of text for a particular font and pointsize.</p>
215
216<pre class="text">
217 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
218 &lt;image&gt;
219 &lt;query-font-metrics text="ImageMagick" font="helvetica" pointsize="48" /&gt;
220 &lt;print output="Text width is %[msl:font-metrics.width] pixels.\n" /&gt;
221 &lt;/image&gt;
222</pre>
223
224<p>The <kbd>query-font-metrics</kbd> tag supports these properties:</p>
225
226<pre class="text">
227 msl:font-metrics.pixels_per_em.x
228 msl:font-metrics.pixels_per_em.y
229 msl:font-metrics.ascent
230 msl:font-metrics.descent
231 msl:font-metrics.width
232 msl:font-metrics.height
233 msl:font-metrics.max_advance
234 msl:font-metrics.bounds.x1
235 msl:font-metrics.bounds.y1
236 msl:font-metrics.bounds.x2
237 msl:font-metrics.bounds.y2
238 msl:font-metrics.origin.x
239 msl:font-metrics.origin.y
240</pre>
241
242<p>MSL supports most methods and attributes discussed in the <a href="../www/perl-magick.html">Perl API for ImageMagick</a>.
243</p>
244
245<p>In addition, MSL supports the <kbd>swap</kbd> element with a single <kbd>indexes</kbd> element.</p>
246
247<p>You can find additional examples of using <kbd>conjure</kbd> in <a href="http://www-106.ibm.com/developerworks/library/l-graf/?ca=dnt-428">Graphics from the Command Line</a>. Further discussion is available in <a href="http://www-106.ibm.com/developerworks/library/l-graf2/?ca=dgr-lnxw15GraphicsLine">More Graphics from the Command Line</a> and <a href="http://www.imagemagick.org/Usage/">Examples of ImageMagick Usage</a>.</p>
248
249</div>
250
251<h2><a name="options"></a>Option Summary</h2>
252<div class="doc-section">
253
254<p>The <kbd>conjure</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
255
256<table class="doc">
257 <tbody>
258 <tr>
259 <th align="left">Option</th>
260 <th align="left">Description</th>
261 </tr>
262
263 <tr>
264 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
265 <td valign="top">display copious debugging information</td>
266 </tr>
267
268 <tr>
269 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
270 <td valign="top">print program options</td>
271 </tr>
272
273 <tr>
274 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
275 <td valign="top">format of debugging information</td>
276 </tr>
277
278 <tr>
279 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
280 <td valign="top">monitor progress</td>
281 </tr>
282
283 <tr>
284 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
285 <td valign="top">suppress all warning messages</td>
286 </tr>
287
288 <tr>
289 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
290 <td valign="top">pay attention to warning messages.</td>
291 </tr>
292
293 <tr>
294 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
295 <td valign="top">seed a new sequence of pseudo-random numbers</td>
296 </tr>
297
298 <tr>
299 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
300 <td valign="top">print detailed information about the image</td>
301 </tr>
302
303 <tr>
304 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
305 <td valign="top">print version information</td>
306 </tr>
307
308 </tbody>
309</table>
310
311</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]312
313</div>
314
315<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]316 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]317 <span id="linkbar-center">
318 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame^]319 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]320 </span>
321 <span id="linkbar-east">&nbsp;</span>
322 </div>
323 <div class="footer">
324 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
325 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
326 </div>
327 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame^]328 <script type="text/javascript">
329 var _gaq = _gaq || [];
330 _gaq.push(['_setAccount', 'UA-17690367-1']);
331 _gaq.push(['_trackPageview']);
332
333 (function() {
334 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
335 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
336 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
337 })();
338 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]339</body>
340</html>