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.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 129 </div>
 130 <div  class="sponsor">
 131   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201006010120 Buchhorn -->
 132 </div>
 133 <div  class="sponsor">
 134   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 135 </div>
 136 <div  class="sponsor">
 137   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 138 </div>
 139 <div  class="sponsor">
 140    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 141 </div>
 142 <div  class="sponsor">
 143    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 144 </div>
 145 <div  class="sponsor">
 146   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 147 </div>
 148 </div>
 149 </div>
 150 \r
 151 \r
 152 </div>\r
 153 \r
 154 <div class="main">\r
 155 \r
 156 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 157
 158 <div class="doc-section">
 159 <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>
 160 </div>
 161
 162 <h2><a name="usage"></a>Example Usage</h2>
 163 <div class="doc-section">
 164
 165 <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>
 166
 167 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>conjure -dimensions 400x400 incantation.msl</span></p>
 168 <p>The MSL script <a href="../www/source/incantation.msl">incantation.msl</a> used above is here:</p>
 169
 170 <pre class="text">
 171   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 172   &lt;image size="400x400"&gt;
 173     &lt;read filename="image.gif" /&gt;
 174     &lt;get width="base-width" height="base-height" /&gt;
 175     &lt;resize geometry="%[dimensions]" /&gt;
 176     &lt;get width="width" height="height" /&gt;
 177     &lt;print output="Image sized from %[base-width]x%[base-height] to %[width]x%[height].\n" /&gt;
 178     &lt;write filename="image.png" /&gt;
 179   &lt;/image&gt;
 180 </pre>
 181
 182 <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>
 183
 184 <pre class="text">
 185   &lt;?xml version="1.0" encoding="UTF-8"?>
 186   &lt;group>
 187       &lt;image id="family">
 188           &lt;read filename="family.gif"/>
 189           &lt;resize geometry="300x300"/>
 190       &lt;/image>
 191       &lt;image id="palm-trees">
 192           &lt;read filename="palm-trees.gif"/>
 193           &lt;resize geometry="300x100"/>
 194       &lt;/image>
 195       &lt;image>
 196           &lt;read filename="beach.jpg"/>
 197           &lt;composite image="family" geometry="+30+40"/>
 198           &lt;composite image="palm-trees" geometry="+320+90"/>
 199       &lt;/image>
 200       &lt;write filename="family-vacation.png"/>
 201   &lt;/group>
 202 </pre>
 203
 204 <p>Here we display the width in pixels of text for a particular font and pointsize.</p>
 205
 206 <pre class="text">
 207   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 208   &lt;image&gt;
 209     &lt;query-font-metrics text="ImageMagick" font="helvetica" pointsize="48" /&gt;
 210     &lt;print output="Text width is %[msl:font-metrics.width] pixels.\n" /&gt;
 211   &lt;/image&gt;
 212 </pre>
 213
 214 <p>The <kbd>query-font-metrics</kbd> tag supports these properties:</p>
 215
 216 <pre class="text">
 217     msl:font-metrics.pixels_per_em.x
 218     msl:font-metrics.pixels_per_em.y
 219     msl:font-metrics.ascent
 220     msl:font-metrics.descent
 221     msl:font-metrics.width
 222     msl:font-metrics.height
 223     msl:font-metrics.max_advance
 224     msl:font-metrics.bounds.x1
 225     msl:font-metrics.bounds.y1
 226     msl:font-metrics.bounds.x2
 227     msl:font-metrics.bounds.y2
 228     msl:font-metrics.origin.x
 229     msl:font-metrics.origin.y
 230 </pre>
 231
 232 <p>MSL supports most methods and attributes discussed in the <a href="../www/perl-magick.html">Perl API for ImageMagick</a>.
 233 </p>
 234
 235 <p>In addition, MSL supports the <kbd>swap</kbd> element with a single <kbd>indexes</kbd> element.</p>
 236
 237 <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>
 238
 239 </div>
 240
 241 <h2><a name="options"></a>Option Summary</h2>
 242 <div class="doc-section">
 243
 244 <p>The <kbd>conjure</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 245
 246 <table class="doc">
 247   <tbody>
 248   <tr>
 249     <th align="left">Option</th>
 250     <th align="left">Description</th>
 251   </tr>
 252
 253   <tr>
 254     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 255     <td valign="top">display copious debugging information</td>
 256   </tr>
 257
 258   <tr>
 259     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 260     <td valign="top">print program options</td>
 261   </tr>
 262
 263   <tr>
 264     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 265     <td valign="top">format of debugging information</td>
 266   </tr>
 267
 268   <tr>
 269     <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
 270     <td valign="top">monitor progress</td>
 271   </tr>
 272
 273   <tr>
 274     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 275     <td valign="top">suppress all warning messages</td>
 276   </tr>
 277
 278   <tr>
 279     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 280     <td valign="top">pay attention to warning messages.</td>
 281   </tr>
 282
 283   <tr>
 284     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 285     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 286   </tr>
 287
 288   <tr>
 289     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 290     <td valign="top">print detailed information about the image</td>
 291   </tr>
 292
 293   <tr>
 294     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 295     <td valign="top">print version information</td>
 296   </tr>
 297
 298   </tbody>
 299 </table>
 300
 301 </div>
 302 \r
 303 </div>\r
 304 \r
 305 <div id="linkbar">\r
 306  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 307     <span id="linkbar-center">\r
 308       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 309     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 310     </span>\r
 311     <span id="linkbar-east">&nbsp;</span>\r
 312   </div>\r
 313   <div class="footer">\r
 314     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 315     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 316   </div>\r
 317   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 318 </body>\r
 319 </html>\r