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">\r
   5 <head>\r
   6   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\r
   7   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   8   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   9   <style type="text/css" media="screen,projection"><!--\r
  10     @import url("../www/magick.css");\r
  11   --></style>\r
  12   <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  13   <title>ImageMagick: Command-line Tools: Conjure</title>
  14   <meta http-equiv="Content-Language" content="en-US"/>
  15   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  16   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  17   <meta name="Generator" content="PHP"/>
  18   <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"/>
  19   <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."/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28 </head>\r
  29 \r
  30 <body id="www-imagemagick-org">\r
  31 <div class="titlebar">\r
  32 <a href="../index.html">\r
  33   <img src="../images/script.png" alt="[ImageMagick]"\r
  34   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  35 <a href="http://www.networkredux.com">\r
  36   <img src="../images/networkredux.png" alt="[sponsor]"\r
  37   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  38 <a href="http://www.imagemagick.org/discourse-server/">\r
  39   <img src="../images/logo.jpg" alt=""\r
  40   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  41 <a href="../index.html">\r
  42   <img src="../images/sprite.jpg" alt=""\r
  43   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  44 </div>\r
  45 \r
  46 <div class="eastbar">\r
  47 \r
  48 <div class="menu">
  49   <a href="../index.html">About ImageMagick</a>
  50 </div>
  51 <div class="sep"></div>\r
  52 <div class="menu">
  53   <a href="../www/command-line-tools.html">Command-line Tools</a>
  54 </div>
  55 <div class="sub">
  56     <a href="../www/command-line-processing.html">Processing</a>
  57 </div>
  58 <div class="sub">
  59     <a href="../www/command-line-options.html">Options</a>
  60 </div>
  61 <div class="sub">
  62     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  63 </div>
  64 <div class="menu">
  65   <a href="../www/api.html">Program Interfaces</a>
  66 </div>
  67 <div class="sub">
  68     <a href="../www/magick-wand.html">MagickWand</a>
  69 </div>
  70 <div class="sub">
  71     <a href="../www/magick-core.html">MagickCore</a>
  72 </div>
  73 <div class="sub">
  74     <a href="../www/perl-magick.html">PerlMagick</a>
  75 </div>
  76 <div class="sub">
  77     <a href="../Magick++/">Magick++</a>
  78 </div>
  79 <div class="menu">
  80   <a href="../www/architecture.html">Architecture</a>
  81 </div>
  82 <div class="sep"></div>\r
  83 <div  class="menu">
  84    <a href="../www/install-source.html">Install from Source</a>
  85 </div>
  86 <div class="sub">
  87     <a href="../www/install-source.html#unix">Unix</a>
  88 </div>
  89 <div class="sub">
  90     <a href="../www/install-source.html#windows">Windows</a>
  91  </div>
  92 <div class="menu">
  93   <a href="../www/binary-releases.html">Binary Releases</a>
  94 </div>
  95 <div class="sub">
  96     <a href="../www/binary-releases.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a href="../www/binary-releases.html#macosx">Mac OS X</a>
 100 </div>
 101 <div class="sub">
 102     <a href="../www/binary-releases.html#windows">Windows</a>
 103 </div>
 104 <div class="menu">
 105   <a href="../www/resources.html">Resources</a>
 106 </div>
 107 <div class="sep"></div>\r
 108 <div class="menu">
 109   <a href="../www/download.html">Download</a>
 110 </div>
 111 <div class="sep"></div>\r
 112 <div class="menu">
 113   <a href="http://www.imagemagick.org/script/search.php">Search</a>
 114 </div>
 115 <div class="sep"></div>\r
 116 <div class="menu">
 117   <a href="../www/sitemap.html">Site Map</a>
 118 </div>
 119 <div  class="sub">
 120     <a href="../www/links.html">Links</a>
 121 </div>
 122 <div class="sep"></div>\r
 123 <div  class="menu">
 124   <a href="../www/sponsors.html">Sponsors:</a>
 125
 126 <div class="sponsbox">
 127 <div  class="sponsor">
 128    <a href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
 129 </div>
 130 <div  class="sponsor">
 131   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 132 </div>
 133 <div  class="sponsor">
 134   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 135 </div>
 136 <div  class="sponsor">
 137   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 138 </div>
 139 <div  class="sponsor">
 140   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 141 </div>
 142 <div  class="sponsor">
 143   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 144 </div>
 145 <div  class="sponsor">
 146    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 147 </div>
 148 <div  class="sponsor">
 149    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 150 </div>
 151 </div>
 152 </div>
 153 \r
 154 \r
 155 </div>\r
 156 \r
 157 <div class="main">\r
 158 \r
 159 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 160
 161 <div class="doc-section">
 162 <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>
 163 </div>
 164
 165 <h2><a name="usage"></a>Example Usage</h2>
 166 <div class="doc-section">
 167
 168 <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>
 169
 170 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>conjure -dimensions 400x400 incantation.msl</span></p>
 171 <p>The MSL script <a href="../www/source/incantation.msl">incantation.msl</a> used above is here:</p>
 172
 173 <pre class="text">
 174   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 175   &lt;image size="400x400"&gt;
 176     &lt;read filename="image.gif" /&gt;
 177     &lt;get width="base-width" height="base-height" /&gt;
 178     &lt;resize geometry="%[dimensions]" /&gt;
 179     &lt;get width="width" height="height" /&gt;
 180     &lt;print output="Image sized from %[base-width]x%[base-height] to %[width]x%[height].\n" /&gt;
 181     &lt;write filename="image.png" /&gt;
 182   &lt;/image&gt;
 183 </pre>
 184
 185 <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>
 186
 187 <pre class="text">
 188   &lt;?xml version="1.0" encoding="UTF-8"?>
 189   &lt;group>
 190       &lt;image id="family">
 191           &lt;read filename="family.gif"/>
 192           &lt;resize geometry="300x300"/>
 193       &lt;/image>
 194       &lt;image id="palm-trees">
 195           &lt;read filename="palm-trees.gif"/>
 196           &lt;resize geometry="300x100"/>
 197       &lt;/image>
 198       &lt;image>
 199           &lt;read filename="beach.jpg"/>
 200           &lt;composite image="family" geometry="+30+40"/>
 201           &lt;composite image="palm-trees" geometry="+320+90"/>
 202       &lt;/image>
 203       &lt;write filename="family-vacation.png"/>
 204   &lt;/group>
 205 </pre>
 206
 207 <p>Here we display the width in pixels of text for a particular font and pointsize.</p>
 208
 209 <pre class="text">
 210   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 211   &lt;image&gt;
 212     &lt;query-font-metrics text="ImageMagick" font="helvetica" pointsize="48" /&gt;
 213     &lt;print output="Text width is %[msl:font-metrics.width] pixels.\n" /&gt;
 214   &lt;/image&gt;
 215 </pre>
 216
 217 <p>The <kbd>query-font-metrics</kbd> tag supports these properties:</p>
 218
 219 <pre class="text">
 220     msl:font-metrics.pixels_per_em.x
 221     msl:font-metrics.pixels_per_em.y
 222     msl:font-metrics.ascent
 223     msl:font-metrics.descent
 224     msl:font-metrics.width
 225     msl:font-metrics.height
 226     msl:font-metrics.max_advance
 227     msl:font-metrics.bounds.x1
 228     msl:font-metrics.bounds.y1
 229     msl:font-metrics.bounds.x2
 230     msl:font-metrics.bounds.y2
 231     msl:font-metrics.origin.x
 232     msl:font-metrics.origin.y
 233 </pre>
 234
 235 <p>MSL supports most methods and attributes discussed in the <a href="../www/perl-magick.html">Perl API for ImageMagick</a>.
 236 </p>
 237
 238 <p>In addition, MSL supports the <kbd>swap</kbd> element with a single <kbd>indexes</kbd> element.</p>
 239
 240 <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>
 241
 242 </div>
 243
 244 <h2><a name="options"></a>Option Summary</h2>
 245 <div class="doc-section">
 246
 247 <p>The <kbd>conjure</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 248
 249 <table class="doc">
 250   <tbody>
 251   <tr>
 252     <th align="left">Option</th>
 253     <th align="left">Description</th>
 254   </tr>
 255
 256   <tr>
 257     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 258     <td valign="top">display copious debugging information</td>
 259   </tr>
 260
 261   <tr>
 262     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 263     <td valign="top">print program options</td>
 264   </tr>
 265
 266   <tr>
 267     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 268     <td valign="top">format of debugging information</td>
 269   </tr>
 270
 271   <tr>
 272     <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
 273     <td valign="top">monitor progress</td>
 274   </tr>
 275
 276   <tr>
 277     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 278     <td valign="top">suppress all warning messages</td>
 279   </tr>
 280
 281   <tr>
 282     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 283     <td valign="top">pay attention to warning messages.</td>
 284   </tr>
 285
 286   <tr>
 287     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 288     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 289   </tr>
 290
 291   <tr>
 292     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 293     <td valign="top">print detailed information about the image</td>
 294   </tr>
 295
 296   <tr>
 297     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 298     <td valign="top">print version information</td>
 299   </tr>
 300
 301   </tbody>
 302 </table>
 303
 304 </div>
 305 \r
 306 </div>\r
 307 \r
 308 <div id="linkbar">\r
 309  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 310     <span id="linkbar-center">\r
 311       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 312     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 313     </span>\r
 314     <span id="linkbar-east">&nbsp;</span>\r
 315   </div>\r
 316   <div class="footer">\r
 317     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 318     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 319   </div>\r
 320   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 321 </body>\r
 322 </html>\r