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

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