Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / d0bd44a61548be975c7049dcc0338a94d6b9b56b / . / www / conjure.html
blob: 31dbab3ac42ae0d71276dc09eb00457c46b594fd [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>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]6 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
7 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
8 <title>ImageMagick: Command-line Tools: Conjure</title/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]9 <meta http-equiv="Content-Language" content="en-US"/>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
11 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]12 <meta name="Application-name" content="ImageMagick"/>
13 <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."/>
14 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]15 <meta name="Generator" content="PHP"/>
16 <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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]17 <meta name="Rating" content="GENERAL"/>
18 <meta name="Robots" content="INDEX, FOLLOW"/>
19 <meta name="Generator" content="ImageMagick Studio LLC"/>
20 <meta name="Author" content="ImageMagick Studio LLC"/>
21 <meta name="Revisit-after" content="2 DAYS"/>
22 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]23 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]24 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]25 <link rel="icon" href="../images/wand.png" sizes="32x32"/>
26 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
27 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
28 <style type="text/css" media="all">
29 @import url("../www/magick.css");
30 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]31</head>
32
33<body id="www-imagemagick-org">
34<div class="titlebar">
35<a href="../index.html">
36 <img src="../images/script.png" alt="[ImageMagick]"
37 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
38<a href="http://www.networkredux.com">
39 <img src="../images/networkredux.png" alt="[sponsor]"
40 style="margin: 45px auto; border: 0px; float: left;" /></a>
41<a href="http://www.imagemagick.org/discourse-server/">
42 <img src="../images/logo.jpg" alt=""
43 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
44<a href="../index.html">
45 <img src="../images/sprite.jpg" alt=""
46 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
47</div>
48
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]49<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]52 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]53</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]55<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]56 <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
57</div>
58<div class="sub">
59 <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
60</div>
61<div class="sub">
62 <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
63</div>
64<div class="sub">
65 <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
66</div>
67<div class="sep"></div>
68<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]69 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</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: Processing" href="../www/command-line-processing.html">Processing</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: Options" href="../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]76</div>
77<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
80<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]81 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</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: MagickWand" href="../www/magick-wand.html">MagickWand</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: MagickCore" href="../www/magick-core.html">MagickCore</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: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91</div>
92<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]95<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]96<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Install from Source" href="../www/install-source.html">Install from Source</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: Unix" href="../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104 </div>
105<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]106 <a title="Resources" href="../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]108<div class="menu">
109 <a title="Architecture" href="../www/architecture.html">Architecture</a>
110</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Download" href="../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]118<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]119<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]120 <a title="Site Map"href="../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Site Map: Links"href="../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128
129<div class="sponsbox">
130<div class="sponsor">
cristyd0bd44a2010-09-24 12:38:11 +0000[diff] [blame^]131 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]132</div>
133<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]134 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
135</div>
136<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]137 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
138</div>
139<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <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]141</div>
142<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]143 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]144</div>
145<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]146 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]147</div>
148<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]149 <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]150</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]154
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]155<div class="eastbar">
156 <script type="text/javascript">
157 <!--
158 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]159 google_ad_slot = "0574824969";
160 google_ad_width = 160;
161 google_ad_height = 600;
162 //-->
163 </script>
164 <script type="text/javascript"
165 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
166 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]167</div>
168
169<div class="main">
170
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]171<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
172
173<div class="doc-section">
174<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>
175</div>
176
177<h2><a name="usage"></a>Example Usage</h2>
178<div class="doc-section">
179
180<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>
181
182<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>conjure -dimensions 400x400 incantation.msl</span></p>
183<p>The MSL script <a href="../www/source/incantation.msl">incantation.msl</a> used above is here:</p>
184
185<pre class="text">
186 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
187 &lt;image size="400x400"&gt;
188 &lt;read filename="image.gif" /&gt;
189 &lt;get width="base-width" height="base-height" /&gt;
190 &lt;resize geometry="%[dimensions]" /&gt;
191 &lt;get width="width" height="height" /&gt;
192 &lt;print output="Image sized from %[base-width]x%[base-height] to %[width]x%[height].\n" /&gt;
193 &lt;write filename="image.png" /&gt;
194 &lt;/image&gt;
195</pre>
196
197<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>
198
199<pre class="text">
200 &lt;?xml version="1.0" encoding="UTF-8"?>
201 &lt;group>
202 &lt;image id="family">
203 &lt;read filename="family.gif"/>
204 &lt;resize geometry="300x300"/>
205 &lt;/image>
206 &lt;image id="palm-trees">
207 &lt;read filename="palm-trees.gif"/>
208 &lt;resize geometry="300x100"/>
209 &lt;/image>
210 &lt;image>
211 &lt;read filename="beach.jpg"/>
212 &lt;composite image="family" geometry="+30+40"/>
213 &lt;composite image="palm-trees" geometry="+320+90"/>
214 &lt;/image>
215 &lt;write filename="family-vacation.png"/>
216 &lt;/group>
217</pre>
218
219<p>Here we display the width in pixels of text for a particular font and pointsize.</p>
220
221<pre class="text">
222 &lt;?xml version="1.0" encoding="UTF-8"?&gt;
223 &lt;image&gt;
224 &lt;query-font-metrics text="ImageMagick" font="helvetica" pointsize="48" /&gt;
225 &lt;print output="Text width is %[msl:font-metrics.width] pixels.\n" /&gt;
226 &lt;/image&gt;
227</pre>
228
229<p>The <kbd>query-font-metrics</kbd> tag supports these properties:</p>
230
231<pre class="text">
232 msl:font-metrics.pixels_per_em.x
233 msl:font-metrics.pixels_per_em.y
234 msl:font-metrics.ascent
235 msl:font-metrics.descent
236 msl:font-metrics.width
237 msl:font-metrics.height
238 msl:font-metrics.max_advance
239 msl:font-metrics.bounds.x1
240 msl:font-metrics.bounds.y1
241 msl:font-metrics.bounds.x2
242 msl:font-metrics.bounds.y2
243 msl:font-metrics.origin.x
244 msl:font-metrics.origin.y
245</pre>
246
247<p>MSL supports most methods and attributes discussed in the <a href="../www/perl-magick.html">Perl API for ImageMagick</a>.
248</p>
249
250<p>In addition, MSL supports the <kbd>swap</kbd> element with a single <kbd>indexes</kbd> element.</p>
251
252<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>
253
254</div>
255
256<h2><a name="options"></a>Option Summary</h2>
257<div class="doc-section">
258
259<p>The <kbd>conjure</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
260
261<table class="doc">
262 <tbody>
263 <tr>
264 <th align="left">Option</th>
265 <th align="left">Description</th>
266 </tr>
267
268 <tr>
269 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
270 <td valign="top">display copious debugging information</td>
271 </tr>
272
273 <tr>
274 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
275 <td valign="top">print program options</td>
276 </tr>
277
278 <tr>
279 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
280 <td valign="top">format of debugging information</td>
281 </tr>
282
283 <tr>
284 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
285 <td valign="top">monitor progress</td>
286 </tr>
287
288 <tr>
289 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
290 <td valign="top">suppress all warning messages</td>
291 </tr>
292
293 <tr>
294 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
295 <td valign="top">pay attention to warning messages.</td>
296 </tr>
297
298 <tr>
299 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
300 <td valign="top">seed a new sequence of pseudo-random numbers</td>
301 </tr>
302
303 <tr>
304 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
305 <td valign="top">print detailed information about the image</td>
306 </tr>
307
308 <tr>
309 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
310 <td valign="top">print version information</td>
311 </tr>
312
313 </tbody>
314</table>
315
316</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]317
318</div>
319
320<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]321 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]322 <span id="linkbar-center">
323 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]324 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]325 </span>
326 <span id="linkbar-east">&nbsp;</span>
327 </div>
328 <div class="footer">
329 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
330 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
331 </div>
332 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]333 <script type="text/javascript">
334 var _gaq = _gaq || [];
335 _gaq.push(['_setAccount', 'UA-17690367-1']);
336 _gaq.push(['_trackPageview']);
337
338 (function() {
339 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
340 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
341 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
342 })();
343 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]344</body>
345</html>