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

   1 \r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   3   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   4 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   5       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   6       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   7       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   8                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   9 <head>\r
  10   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  11   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>\r
  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, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
  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-2011 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" />\r
  32   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  33   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  34   <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  35   <style type="text/css" media="all">\r
  36     @import url("../www/magick.css");\r
  37   </style>\r
  38   <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>\r
  39   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>\r
  40   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  41   <script type="text/javascript">\r
  42     $(document).ready(function() {\r
  43       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  44         'transitionIn'  : 'elastic',\r
  45         'transitionOut' : 'elastic',\r
  46         'overlayShow'   : false,\r
  47         'opacity'       : true\r
  48       });\r
  49     });\r
  50   </script>\r
  51 </head>\r
  52 \r
  53 <body id="www-imagemagick-org">\r
  54 <div class="titlebar">\r
  55 <div style="margin: 17px auto; float: left;">\r
  56   <script type="text/javascript">\r
  57   <!--\r
  58     google_ad_client = "pub-3129977114552745";\r
  59     google_ad_slot = "5439289906";\r
  60     google_ad_width = 728;\r
  61     google_ad_height = 90;\r
  62   //-->\r
  63   </script>\r
  64   <script type="text/javascript"\r
  65     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  66   </script>\r
  67 </div>\r
  68 <a href="http://www.imagemagick.org/discourse-server/">\r
  69   <img src="../images/logo.jpg"\r
  70   alt="ImageMagick Logo"\r
  71   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  72 <a href="../index.html">\r
  73   <img src="../images/sprite.jpg"\r
  74   alt="ImageMagick Sprite"\r
  75   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  76 </div>\r
  77 \r
  78 <div class="westbar">\r
  79 \r
  80 <div class="menu">
  81   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  82 </div>
  83 <div class="menu">
  84   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  91 </div>
  92 <div class="sub">
  93     <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
  97 </div>
  98 <div class="sep"></div>\r
  99 <div class="menu">
 100   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
 101 </div>
 102 <div class="sub">
 103     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
 104 </div>
 105 <div class="sub">
 106     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
 107 </div>
 108 <div class="sub">
 109     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 110 </div>
 111 <div class="menu">
 112   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
 116 </div>
 117 <div class="sub">
 118     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
 119 </div>
 120 <div class="sub">
 121     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
 122 </div>
 123 <div class="sub">
 124     <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
 125 </div>
 126 <div class="sep"></div>\r
 127 <div  class="menu">
 128    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
 129 </div>
 130 <div class="sub">
 131     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
 132 </div>
 133 <div class="sub">
 134     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
 135  </div>
 136 <div class="menu">
 137   <a title="Resources" href="../www/resources.html">Resources</a>
 138 </div>
 139 <div class="menu">
 140   <a title="Architecture" href="../www/architecture.html">Architecture</a>
 141 </div>
 142 <div class="menu">
 143   <a title="Download" href="../www/download.html">Download</a>
 144 </div>
 145 <div class="sep"></div>\r
 146 <div class="menu">
 147   <a title="Search" href="../www/search.html">Search</a>
 148 </div>
 149 <div class="sep"></div>\r
 150 <div class="menu">
 151   <a title="Site Map" href="../www/sitemap.html">Site Map</a>
 152 </div>
 153 <div  class="sub">
 154   <a title="Site Map: Links" href="../www/links.html">Links</a>
 155 </div>
 156 <div class="sep"></div>\r
 157 <div  class="menu">
 158   <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 159
 160 <a href="http://www.networkredux.com">
 161   <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]"
 162   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 163 <div class="sponsbox">
 164 <div  class="sponsor">
 165   <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540s suvalj -->
 166 </div>
 167 <div  class="sponsor">
 168   <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
 169 </div>
 170 <div  class="sponsor">
 171   <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
 172 </div>
 173 <div  class="sponsor">
 174   <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 175 </div>
 176 <div  class="sponsor">
 177   <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
 178 </div>
 179 <div  class="sponsor">
 180   <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
 181 </div>
 182 <div  class="sponsor">
 183   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
 184 </div>
 185 <div  class="sponsor">
 186   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
 187 </div>
 188 <div  class="sponsor">
 189   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 190 </div>
 191 <div  class="sponsor">
 192   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
 193 </div>
 194 <div  class="sponsor">
 195   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 196 </div>
 197 <div  class="sponsor">
 198   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 199 </div>
 200 <div  class="sponsor">
 201   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 202 </div>
 203 <div  class="sponsor">
 204   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 205 </div>
 206 <div  class="sponsor">
 207    <a rel="follow" title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
 208 </div>
 209 </div>
 210 </div>
 211 </div>\r
 212 \r
 213 <div class="eastbar">\r
 214   <div class="g-plusone" data-size="standard" data-count="false"></div>\r
 215 </div>\r
 216 \r
 217 <div class="main">\r
 218 \r
 219 <h1>ImageMagick Conjure Command-line Tool</h1>
 220 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 221
 222 <div class="doc-section">
 223 <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>
 224 </div>
 225
 226 <h2><a id="usage"></a>Example Usage</h2>
 227 <div class="doc-section">
 228
 229 <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>
 230
 231 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>conjure -dimensions 400x400 incantation.msl</span></p>
 232 <p>The MSL script <a href="../www/source/incantation.msl">incantation.msl</a> used above is here:</p>
 233
 234 <pre class="text">
 235   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 236   &lt;image size="400x400"&gt;
 237     &lt;read filename="image.gif" /&gt;
 238     &lt;get width="base-width" height="base-height" /&gt;
 239     &lt;resize geometry="%[dimensions]" /&gt;
 240     &lt;get width="width" height="height" /&gt;
 241     &lt;print output="Image sized from %[base-width]x%[base-height] to %[width]x%[height].\n" /&gt;
 242     &lt;write filename="image.png" /&gt;
 243   &lt;/image&gt;
 244 </pre>
 245
 246 <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>
 247
 248 <pre class="text">
 249   &lt;?xml version="1.0" encoding="UTF-8"?>
 250   &lt;group>
 251       &lt;image id="family">
 252           &lt;read filename="family.gif"/>
 253           &lt;resize geometry="300x300"/>
 254       &lt;/image>
 255       &lt;image id="palm-trees">
 256           &lt;read filename="palm-trees.gif"/>
 257           &lt;resize geometry="300x100"/>
 258       &lt;/image>
 259       &lt;image>
 260           &lt;read filename="beach.jpg"/>
 261           &lt;composite image="family" geometry="+30+40"/>
 262           &lt;composite image="palm-trees" geometry="+320+90"/>
 263       &lt;/image>
 264       &lt;write filename="family-vacation.png"/>
 265   &lt;/group>
 266 </pre>
 267
 268 <p>Here we display the width in pixels of text for a particular font and pointsize.</p>
 269
 270 <pre class="text">
 271   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 272   &lt;image&gt;
 273     &lt;query-font-metrics text="ImageMagick" font="helvetica" pointsize="48" /&gt;
 274     &lt;print output="Text width is %[msl:font-metrics.width] pixels.\n" /&gt;
 275   &lt;/image&gt;
 276 </pre>
 277
 278 <p>The <kbd>query-font-metrics</kbd> tag supports these properties:</p>
 279
 280 <pre class="text">
 281     msl:font-metrics.pixels_per_em.x
 282     msl:font-metrics.pixels_per_em.y
 283     msl:font-metrics.ascent
 284     msl:font-metrics.descent
 285     msl:font-metrics.width
 286     msl:font-metrics.height
 287     msl:font-metrics.max_advance
 288     msl:font-metrics.bounds.x1
 289     msl:font-metrics.bounds.y1
 290     msl:font-metrics.bounds.x2
 291     msl:font-metrics.bounds.y2
 292     msl:font-metrics.origin.x
 293     msl:font-metrics.origin.y
 294 </pre>
 295
 296 <p>MSL supports most methods and attributes discussed in the <a href="../www/perl-magick.html">Perl API for ImageMagick</a>.
 297 </p>
 298
 299 <p>In addition, MSL supports the <kbd>swap</kbd> element with a single <kbd>indexes</kbd> element.</p>
 300
 301 <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>
 302
 303 </div>
 304
 305 <h2><a id="options"></a>Option Summary</h2>
 306 <div class="doc-section">
 307
 308 <p>The <kbd>conjure</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 309
 310 <table class="doc">
 311   <tbody>
 312   <tr>
 313     <th align="left">Option</th>
 314     <th align="left">Description</th>
 315   </tr>
 316
 317   <tr>
 318     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 319     <td valign="top">display copious debugging information</td>
 320   </tr>
 321
 322   <tr>
 323     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 324     <td valign="top">print program options</td>
 325   </tr>
 326
 327   <tr>
 328     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 329     <td valign="top">format of debugging information</td>
 330   </tr>
 331
 332   <tr>
 333     <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
 334     <td valign="top">monitor progress</td>
 335   </tr>
 336
 337   <tr>
 338     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 339     <td valign="top">suppress all warning messages</td>
 340   </tr>
 341
 342   <tr>
 343     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 344     <td valign="top">pay attention to warning messages.</td>
 345   </tr>
 346
 347   <tr>
 348     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 349     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 350   </tr>
 351
 352   <tr>
 353     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 354     <td valign="top">print detailed information about the image</td>
 355   </tr>
 356
 357   <tr>
 358     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 359     <td valign="top">print version information</td>
 360   </tr>
 361
 362   </tbody>
 363 </table>
 364
 365 </div>
 366 \r
 367 </div>\r
 368 \r
 369 <div id="linkbar">\r
 370     <span id="linkbar-west">&nbsp;</span>\r
 371     <span id="linkbar-center">\r
 372       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 373       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 374     </span>\r
 375     <span id="linkbar-east">&nbsp;</span>\r
 376   </div>\r
 377   <div class="footer">\r
 378     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 379     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 380   </div>\r
 381   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 382   <script type="text/javascript">\r
 383     var _gaq = _gaq || [];\r
 384     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 385     _gaq.push(['_trackPageview']);\r
 386 \r
 387     (function() {\r
 388       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 389       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 390       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 391     })();\r
 392   </script>\r
 393 </body>\r
 394 </html>\r