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