granicus.if.org Git - imagemagick/blob - www/conjure.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html version="-//W3C//DTD XHTML 1.1//EN"
   5       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   6       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   7       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   8                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   9 <head>
  10   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  11   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
  12   <title>ImageMagick: Command-line Tools: Conjure</title>
  13   <meta http-equiv="content-language" content="en-US"/>
  14   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="application-name" content="ImageMagick"/>
  17   <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images automagically."/>
  18   <meta name="application-url" content="http://www.imagemagick.org"/>
  19   <meta name="generator" content="PHP"/>
  20   <meta name="keywords" content="command-line, tools:, conjure, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  21   <meta name="rating" content="GENERAL"/>
  22   <meta name="robots" content="INDEX, FOLLOW"/>
  23   <meta name="generator" content="ImageMagick Studio LLC"/>
  24   <meta name="author" content="ImageMagick Studio LLC"/>
  25   <meta name="revisit-after" content="2 DAYS"/>
  26   <meta name="resource-type" content="document"/>
  27   <meta name="copyright" content="Copyright (c) 1999-2013 ImageMagick Studio LLC"/>
  28   <meta name="distribution" content="Global"/>
  29   <link rel="icon" href="../images/wand.png"/>
  30   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
  31   <link rel="canonical" href="http://www.imagemagick.org" />
  32   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  33   <!-- Add jQuery library -->
  34   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  35
  36   <!-- Optionaly include easing and/or mousewheel plugins -->
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
  38   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
  39
  40   <!-- Add fancyBox -->
  41   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
  42   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
  43
  44   <!-- Optionaly include button and/or thumbnail helpers -->
  45   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
  46   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
  47
  48   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
  49   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
  50   <script type="text/javascript">
  51         $(document).ready(function() {
  52                 $(".fancybox").fancybox();
  53         });
  54   </script>
  55   <!-- ImageMagick style -->
  56   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
  57   <style type="text/css" media="all">
  58     @import url("../www/magick.css");
  59   </style>
  60 </head>
  61
  62 <body id="www-imagemagick-org">
  63 <div class="titlebar">
  64 <div style="margin: 17px auto; float: left;">
  65   <script type="text/javascript">
  66   <!--
  67     google_ad_client = "pub-3129977114552745";
  68     google_ad_slot = "5439289906";
  69     google_ad_width = 728;
  70     google_ad_height = 90;
  71   //-->
  72   </script>
  73   <script type="text/javascript"
  74     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  75   </script>
  76 </div>
  77 <a href="../discourse-server">
  78   <img src="../images/logo.jpg"
  79   alt="ImageMagick Logo"
  80   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  81 <a href="../index.html">
  82   <img src="../images/sprite.jpg"
  83   alt="ImageMagick Sprite"
  84   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  85 </div>
  86
  87 <div class="westbar">
  88
  89 <div class="menu">
  90   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  91 </div>
  92 <div class="menu">
  93   <a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
 103 </div>
 104 <div class="sub">
 105     <a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
 106 </div>
 107 <div class="sep"></div>
 108 <div class="menu">
 109   <a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
 116 </div>
 117 <div class="sub">
 118     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 119 </div>
 120 <div class="menu">
 121   <a title="Program Interfaces" href="api.html">Program Interfaces</a>
 122 </div>
 123 <div class="sub">
 124     <a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
 125 </div>
 126 <div class="sub">
 127     <a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
 128 </div>
 129 <div class="sub">
 130     <a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
 131 </div>
 132 <div class="sub">
 133     <a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
 134 </div>
 135 <div class="sep"></div>
 136 <div  class="menu">
 137    <a title="Install from Source" href="install-source.html">Install from Source</a>
 138 </div>
 139 <div class="sub">
 140     <a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
 141 </div>
 142 <div class="sub">
 143     <a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
 144  </div>
 145 <div class="menu">
 146   <a title="Resources" href="resources.html">Resources</a>
 147 </div>
 148 <div class="menu">
 149   <a title="Architecture" href="architecture.html">Architecture</a>
 150 </div>
 151 <div class="menu">
 152   <a title="Download" href="download.html">Download</a>
 153 </div>
 154 <div class="sep"></div>
 155 <div class="menu">
 156   <a title="Search" href="search.html">Search</a>
 157 </div>
 158 <div class="sep"></div>
 159 <div class="menu">
 160   <a title="Site Map" href="sitemap.html">Site Map</a>
 161 </div>
 162 <div  class="sub">
 163   <a title="Site Map: Links" href="links.html">Links</a>
 164 </div>
 165 <div class="sep"></div>
 166 <div class="menu">
 167   <a rel="follow" title="Sponsors" href="sponsors.html">Sponsors:</a>
 168
 169   <a href="http://www.networkredux.com"> <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 170   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 171 <div class="sponsbox">
 172 <div class="sponsor">
 173   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 174 </div>
 175 <div class="sponsor">
 176   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 177 </div>
 178 <div class="sponsor">
 179   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 180 </div>
 181 <div class="sponsor">
 182   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 183 </div>
 184 <div class="sponsor">
 185   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 186 </div>
 187 <div class="sponsor">
 188   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 189 </div>
 190 <div class="sponsor">
 191   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 192 </div>
 193 <div class="sponsor">
 194   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 195 </div>
 196 <div class="sponsor">
 197    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 198 </div>
 199 <div class="sponsor">
 200    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 201 </div>
 202 <div class="sponsor">
 203   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 204 </div>
 205 <div class="sponsor">
 206   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 207 </div>
 208 <div  class="sponsor">
 209    <a rel="follow" title="Sponsor: Kaffeemaschinen reparatur" href="http://www.kaffeemaschinen-reparatur.de">Kaffeemaschinen reparatur</a><!-- 2012080100030 Temurbas atlas-multimedia-->
 210 </div>
 211 <div class="sponsor">
 212    <a rel="follow" title="Sponsor: Web Hosting" href="http://www.hostucan.com">Web Hosting</a><!-- 2012120100150 racent marketing@webhosting...-->
 213 </div>
 214 </div>
 215 </div>
 216 </div>
 217
 218 <div class="eastbar">
 219   <div class="g-plusone" id="gplusone"></div>
 220   <script type="text/javascript">
 221     window.___gcfg = {
 222       lang: 'en-US'
 223     };
 224
 225     (function() {
 226       var po = document.createElement('script');
 227       po.type = 'text/javascript'; po.async = true;
 228       po.src = 'https://apis.google.com/js/plusone.js';
 229       var script = document.getElementsByTagName('script')[0];
 230       script.parentNode.insertBefore(po, script);
 231     })();
 232     var gplusone = document.getElementById("gplusone");
 233     gplusone.setAttribute("data-size","medium");
 234     gplusone.setAttribute("data-count","false");
 235   </script>
 236 </div>
 237
 238 <div class="main">
 239
 240 <h1>ImageMagick Conjure Command-line Tool</h1>
 241 <p class="navigation-index">[<a href="conjure.html#usage">Example Usage</a> &bull; <a href="conjure.html#options">Option Summary</a>]</p>
 242
 243 <div class="doc-section">
 244 <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="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>
 245 </div>
 246
 247 <h2><a id="usage"></a>Example Usage</h2>
 248 <div class="doc-section">
 249
 250 <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>
 251
 252 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>conjure -dimensions 400x400 incantation.msl</span></p>
 253 <p>The MSL script <a href="../www/source/incantation.msl">incantation.msl</a> used above is here:</p>
 254
 255 <pre class="text">
 256   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 257   &lt;image size="400x400"&gt;
 258     &lt;read filename="image.gif" /&gt;
 259     &lt;get width="base-width" height="base-height" /&gt;
 260     &lt;resize geometry="%[dimensions]" /&gt;
 261     &lt;get width="width" height="height" /&gt;
 262     &lt;print output="Image sized from %[base-width]x%[base-height] to %[width]x%[height].\n" /&gt;
 263     &lt;write filename="image.png" /&gt;
 264   &lt;/image&gt;
 265 </pre>
 266
 267 <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>
 268
 269 <pre class="text">
 270   &lt;?xml version="1.0" encoding="UTF-8"?>
 271   &lt;group>
 272       &lt;image id="family">
 273           &lt;read filename="family.gif"/>
 274           &lt;resize geometry="300x300"/>
 275       &lt;/image>
 276       &lt;image id="palm-trees">
 277           &lt;read filename="palm-trees.gif"/>
 278           &lt;resize geometry="300x100"/>
 279       &lt;/image>
 280       &lt;image>
 281           &lt;read filename="beach.jpg"/>
 282           &lt;composite image="family" geometry="+30+40"/>
 283           &lt;composite image="palm-trees" geometry="+320+90"/>
 284       &lt;/image>
 285       &lt;write filename="family-vacation.png"/>
 286   &lt;/group>
 287 </pre>
 288
 289 <p>Here we display the width in pixels of text for a particular font and pointsize.</p>
 290
 291 <pre class="text">
 292   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 293   &lt;image&gt;
 294     &lt;query-font-metrics text="ImageMagick" font="helvetica" pointsize="48" /&gt;
 295     &lt;print output="Text width is %[msl:font-metrics.width] pixels.\n" /&gt;
 296   &lt;/image&gt;
 297 </pre>
 298
 299 <p>The <kbd>query-font-metrics</kbd> tag supports these properties:</p>
 300
 301 <pre class="text">
 302     msl:font-metrics.pixels_per_em.x
 303     msl:font-metrics.pixels_per_em.y
 304     msl:font-metrics.ascent
 305     msl:font-metrics.descent
 306     msl:font-metrics.width
 307     msl:font-metrics.height
 308     msl:font-metrics.max_advance
 309     msl:font-metrics.bounds.x1
 310     msl:font-metrics.bounds.y1
 311     msl:font-metrics.bounds.x2
 312     msl:font-metrics.bounds.y2
 313     msl:font-metrics.origin.x
 314     msl:font-metrics.origin.y
 315 </pre>
 316
 317 <p>MSL supports most methods and attributes discussed in the <a href="perl-magick.html">Perl API for ImageMagick</a>.
 318 </p>
 319
 320 <p>In addition, MSL supports the <kbd>swap</kbd> element with a single <kbd>indexes</kbd> element.</p>
 321
 322 <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>
 323
 324 </div>
 325
 326 <h2><a id="options"></a>Option Summary</h2>
 327 <div class="doc-section">
 328
 329 <p>The <kbd>conjure</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 330
 331 <table class="doc">
 332   <tbody>
 333   <tr>
 334     <th align="left">Option</th>
 335     <th align="left">Description</th>
 336   </tr>
 337
 338   <tr>
 339     <td valign="top"><a href="command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 340     <td valign="top">display copious debugging information</td>
 341   </tr>
 342
 343   <tr>
 344     <td valign="top"><a href="command-line-options.html#help">-help</a></td>
 345     <td valign="top">print program options</td>
 346   </tr>
 347
 348   <tr>
 349     <td valign="top"><a href="command-line-options.html#log">-log <em class="option">format</em></a></td>
 350     <td valign="top">format of debugging information</td>
 351   </tr>
 352
 353   <tr>
 354     <td valign="top"><a href="command-line-options.html#monitor">-monitor</a></td>
 355     <td valign="top">monitor progress</td>
 356   </tr>
 357
 358   <tr>
 359     <td valign="top"><a href="command-line-options.html#quiet">-quiet</a></td>
 360     <td valign="top">suppress all warning messages</td>
 361   </tr>
 362
 363   <tr>
 364     <td valign="top"><a href="command-line-options.html#regard-warnings">-regard-warnings</a></td>
 365     <td valign="top">pay attention to warning messages.</td>
 366   </tr>
 367
 368   <tr>
 369     <td valign="top"><a href="command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 370     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 371   </tr>
 372
 373   <tr>
 374     <td valign="top"><a href="command-line-options.html#verbose">-verbose</a></td>
 375     <td valign="top">print detailed information about the image</td>
 376   </tr>
 377
 378   <tr>
 379     <td valign="top"><a href="command-line-options.html#version">-version</a></td>
 380     <td valign="top">print version information</td>
 381   </tr>
 382
 383   </tbody>
 384 </table>
 385
 386 </div>
 387
 388 </div>
 389
 390 <div id="linkbar">
 391     <span id="linkbar-west">&nbsp;</span>
 392     <span id="linkbar-center">
 393       <a href="../discourse-server">Discourse Server</a> &bull;
 394       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 395     </span>
 396     <span id="linkbar-east">&nbsp;</span>
 397   </div>
 398   <div class="footer">
 399     <span id="footer-west">&copy; 1999-2013 ImageMagick Studio LLC</span>
 400     <span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>
 401   </div>
 402   <div style="clear: both; margin: 0; width: 100%; "></div>
 403   <script type="text/javascript">
 404     var _gaq = _gaq || [];
 405     _gaq.push(['_setAccount', 'UA-17690367-1']);
 406     _gaq.push(['_trackPageview']);
 407
 408     (function() {
 409       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 410       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 411       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 412     })();
 413   </script>
 414 </body>
 415 </html>