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