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   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   9   <style type="text/css" media="all">\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 title="About ImageMagick" href="../index.html">About ImageMagick</a>
  50 </div>
  51 <div class="sep"></div>\r
  52 <div class="menu">
  53   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  54 </div>
  55 <div class="sub">
  56     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  57 </div>
  58 <div class="sub">
  59     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  60 </div>
  61 <div class="sub">
  62     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
  63 </div>
  64 <div class="sep"></div>\r
  65 <div class="menu">
  66   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
  67 </div>
  68 <div class="sub">
  69     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
  70 </div>
  71 <div class="sub">
  72     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
  73 </div>
  74 <div class="sub">
  75     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  76 </div>
  77 <div class="menu">
  78   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
  79 </div>
  80 <div class="sub">
  81     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
  82 </div>
  83 <div class="sub">
  84     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
  91 </div>
  92 <div class="sep"></div>\r
  93 <div  class="menu">
  94    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
  95 </div>
  96 <div class="sub">
  97     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
  98 </div>
  99 <div class="sub">
 100     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
 101  </div>
 102 <div class="menu">
 103   <a title="Resources" href="../www/resources.html">Resources</a>
 104 </div>
 105 <div class="menu">
 106   <a title="Architecture" href="../www/architecture.html">Architecture</a>
 107 </div>
 108 <div class="menu">
 109   <a title="Download" href="../www/download.html">Download</a>
 110 </div>
 111 <div class="sep"></div>\r
 112 <div class="menu">
 113   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 114 </div>
 115 <div class="sep"></div>\r
 116 <div class="menu">
 117   <a title="Site Map"href="../www/sitemap.html">Site Map</a>
 118 </div>
 119 <div  class="sub">
 120     <a title="Site Map: Links"href="../www/links.html">Links</a>
 121 </div>
 122 <div class="sep"></div>\r
 123 <div  class="menu">
 124   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 125
 126 <div class="sponsbox">
 127 <div  class="sponsor">
 128   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 129 </div>
 130 <div  class="sponsor">
 131   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 132 </div>
 133 <div  class="sponsor">
 134   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 135 </div>
 136 <div  class="sponsor">
 137   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 138 </div>
 139 <div  class="sponsor">
 140   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 141 </div>
 142 <div  class="sponsor">
 143    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 144 </div>
 145 </div>
 146 </div>
 147 \r
 148 \r
 149 </div>\r
 150 \r
 151 <div class="main">\r
 152 \r
 153 <p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
 154
 155 <div class="doc-section">
 156 <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>
 157 </div>
 158
 159 <h2><a name="usage"></a>Example Usage</h2>
 160 <div class="doc-section">
 161
 162 <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>
 163
 164 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>conjure -dimensions 400x400 incantation.msl</span></p>
 165 <p>The MSL script <a href="../www/source/incantation.msl">incantation.msl</a> used above is here:</p>
 166
 167 <pre class="text">
 168   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 169   &lt;image size="400x400"&gt;
 170     &lt;read filename="image.gif" /&gt;
 171     &lt;get width="base-width" height="base-height" /&gt;
 172     &lt;resize geometry="%[dimensions]" /&gt;
 173     &lt;get width="width" height="height" /&gt;
 174     &lt;print output="Image sized from %[base-width]x%[base-height] to %[width]x%[height].\n" /&gt;
 175     &lt;write filename="image.png" /&gt;
 176   &lt;/image&gt;
 177 </pre>
 178
 179 <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>
 180
 181 <pre class="text">
 182   &lt;?xml version="1.0" encoding="UTF-8"?>
 183   &lt;group>
 184       &lt;image id="family">
 185           &lt;read filename="family.gif"/>
 186           &lt;resize geometry="300x300"/>
 187       &lt;/image>
 188       &lt;image id="palm-trees">
 189           &lt;read filename="palm-trees.gif"/>
 190           &lt;resize geometry="300x100"/>
 191       &lt;/image>
 192       &lt;image>
 193           &lt;read filename="beach.jpg"/>
 194           &lt;composite image="family" geometry="+30+40"/>
 195           &lt;composite image="palm-trees" geometry="+320+90"/>
 196       &lt;/image>
 197       &lt;write filename="family-vacation.png"/>
 198   &lt;/group>
 199 </pre>
 200
 201 <p>Here we display the width in pixels of text for a particular font and pointsize.</p>
 202
 203 <pre class="text">
 204   &lt;?xml version="1.0" encoding="UTF-8"?&gt;
 205   &lt;image&gt;
 206     &lt;query-font-metrics text="ImageMagick" font="helvetica" pointsize="48" /&gt;
 207     &lt;print output="Text width is %[msl:font-metrics.width] pixels.\n" /&gt;
 208   &lt;/image&gt;
 209 </pre>
 210
 211 <p>The <kbd>query-font-metrics</kbd> tag supports these properties:</p>
 212
 213 <pre class="text">
 214     msl:font-metrics.pixels_per_em.x
 215     msl:font-metrics.pixels_per_em.y
 216     msl:font-metrics.ascent
 217     msl:font-metrics.descent
 218     msl:font-metrics.width
 219     msl:font-metrics.height
 220     msl:font-metrics.max_advance
 221     msl:font-metrics.bounds.x1
 222     msl:font-metrics.bounds.y1
 223     msl:font-metrics.bounds.x2
 224     msl:font-metrics.bounds.y2
 225     msl:font-metrics.origin.x
 226     msl:font-metrics.origin.y
 227 </pre>
 228
 229 <p>MSL supports most methods and attributes discussed in the <a href="../www/perl-magick.html">Perl API for ImageMagick</a>.
 230 </p>
 231
 232 <p>In addition, MSL supports the <kbd>swap</kbd> element with a single <kbd>indexes</kbd> element.</p>
 233
 234 <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>
 235
 236 </div>
 237
 238 <h2><a name="options"></a>Option Summary</h2>
 239 <div class="doc-section">
 240
 241 <p>The <kbd>conjure</kbd> command recognizes these options.  Click on an option to get more details about how that option works.</p>
 242
 243 <table class="doc">
 244   <tbody>
 245   <tr>
 246     <th align="left">Option</th>
 247     <th align="left">Description</th>
 248   </tr>
 249
 250   <tr>
 251     <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
 252     <td valign="top">display copious debugging information</td>
 253   </tr>
 254
 255   <tr>
 256     <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
 257     <td valign="top">print program options</td>
 258   </tr>
 259
 260   <tr>
 261     <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
 262     <td valign="top">format of debugging information</td>
 263   </tr>
 264
 265   <tr>
 266     <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
 267     <td valign="top">monitor progress</td>
 268   </tr>
 269
 270   <tr>
 271     <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
 272     <td valign="top">suppress all warning messages</td>
 273   </tr>
 274
 275   <tr>
 276     <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
 277     <td valign="top">pay attention to warning messages.</td>
 278   </tr>
 279
 280   <tr>
 281     <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
 282     <td valign="top">seed a new sequence of pseudo-random numbers</td>
 283   </tr>
 284
 285   <tr>
 286     <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
 287     <td valign="top">print detailed information about the image</td>
 288   </tr>
 289
 290   <tr>
 291     <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
 292     <td valign="top">print version information</td>
 293   </tr>
 294
 295   </tbody>
 296 </table>
 297
 298 </div>
 299 \r
 300 </div>\r
 301 \r
 302 <div id="linkbar">\r
 303  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 304     <span id="linkbar-center">\r
 305       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</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-2010 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