Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / d24320148584319a96989fa12104c4d18501e554 / . / www / command-line-processing.html
blob: 18d77ae20291e23485d59cb44a42e921386774eb [file] [log] [blame]
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html lang="en">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]3<head>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: Command-line Processing</title>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]8 <meta http-equiv="content-language" content="en-US">
9 <meta http-equiv="content-type" content="text/html; charset=utf-8">
10 <meta http-equiv="reply-to" content="magick-users@imagemagick.org">
11 <meta name="application-name" content="ImageMagick">
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="command-line, processing, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
16 <meta name="rating" content="GENERAL">
17 <meta name="robots" content="INDEX, FOLLOW">
18 <meta name="generator" content="ImageMagick Studio LLC">
19 <meta name="author" content="ImageMagick Studio LLC">
20 <meta name="revisit-after" content="2 DAYS">
21 <meta name="resource-type" content="document">
22 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC">
23 <meta name="distribution" content="Global">
24 <link rel="icon" href="../images/wand.png">
25 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon">
26 <link rel="stylesheet" href="www/css/bootstrap.min.css">
27 <link rel="stylesheet" href="www/css/magick.css">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]28</head>
29
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]30<body>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]31<div class="main">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]32<div class="magick-masthead">
33 <div class="container">
34 <script type="text/javascript">
35 <!--
36 google_ad_client = "pub-3129977114552745";
37 google_ad_slot = "5439289906";
38 google_ad_width = 728;
39 google_ad_height = 90;
40 //-->
41 </script>
42 <center><script type="text/javascript" src="http://localhost/pagead/show_ads.js">
43 </script></center>
44 <nav class="magick-nav">
45 <a class="magick-nav-item " href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">Home</a>
46 <a class="magick-nav-item " href="binary-releases.html">Downloads</a>
47 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
48 <a class="magick-nav-item " href="command-line-options.html">Options</a>
49 <a class="magick-nav-item " href="api.html">Development</a>
50 <a class="magick-nav-item" href="../discourse-server">Community</a>
51 <a class="magick-nav-item navbar-right " href="search.html">Search</a>
52 </nav>
53 </div>
54</div>
55<div class="container">
56<div class="magick-header">
57<p class="text-center"><a href="command-line-processing.html#anatomy">The Anatomy of the Command Line</a> • <a href="command-line-processing.html#input">Input Filename</a> • <a href="command-line-processing.html#setting">Image Setting</a> • <a href="command-line-processing.html#operator">Image Operator</a> • <a href="command-line-processing.html#sequence">Image Sequence Operator</a> • <a href="command-line-processing.html#geometry">Image Geometry</a> • <a href="command-line-processing.html#stack">Image Stack</a> • <a href="command-line-processing.html#output">Output Filename</a></p>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]58
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]59<p class="lead magick-description">The ImageMagick command line can be as simple as this.</p>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]60
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]61<pre>
62convert image.jpg image.png
63</pre>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]64
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]65<p>Or it can be very complex, as in the following.</p>
66
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]67<pre>
68convert label.gif +matte \
69 \( +clone -shade 110x90 -normalize -negate +clone -compose Plus -composite \) \
70 \( -clone 0 -shade 110x50 -normalize -channel BG -fx 0 +channel -matte \) \
71 -delete 0 +swap -compose Multiply -composite button.gif");
72</pre>
73
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]74<p>Without knowing much about the ImageMagick command line, you can probably figure out that the first command above converts an image in the JPEG format to one in the PNG format. However, very few may realize the second, more complex command, gives a flat two-dimensional label a three-dimensional look with rich textures and simulated depth:</p>
75
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]76<ul>
77 <a href="../images/label.gif"><img src="../images/label.gif" width="78" height="53" alt="label"></a>
78<img style="margin-top:16px; margin-bottom:17px;" src="../images/right.gif" width="20" height="20" alt="==&gt;">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]79 <a href="../images/button.gif">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]80 <img src="../images/button.gif" width="78" height="53" alt="button"></a>
81</ul>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]82
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]83<p class="warn">[ <var>A quick word about our formatting of commands:</var> The second example above is long enough that the command must be written across several lines, so we formatted it for clarity by inserting backslashes (<code>\</code>). The backslash is the Unix <var>line continuation</var> character. In the Windows shell, use a carat character (<code>^</code>) for line continuation. We use the Unix style on these web pages, as above. Sometimes, however, the lines are wrapped by your browser if the browser window is small enough, but the command lines, shown in white, are still intended to be typed as one line. Line continuation characters need not be entered. The <var>parentheses</var> that are <var>escaped</var> above using the backslash are not escaped in Windows. There are some other differences between Windows and Unix (involving quotation marks, for instance), but we'll discuss some of those issues later, as they arise. </p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]84
85<p>Here we show percent completion of a task as a shaded cylinder:</p>
86
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]87<ul>
88 <img src="../images/cylinder_shaded.png" width="320" height="200" alt="Shaded Cylinder">
89</ul>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]90
91<p>Given the complexity of the rendering, you might be surprised it is accomplished by a single command-line:</p>
92
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]93<pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]94convert -size 320x90 canvas:none -stroke snow4 -size 1x90 -tile gradient:white-snow4 \
95 -draw 'roundrectangle 16, 5, 304, 85 20,40' +tile -fill snow \
96 -draw 'roundrectangle 264, 5, 304, 85 20,40' -tile gradient:chartreuse-green \
97 -draw 'roundrectangle 16, 5, 180, 85 20,40' -tile gradient:chartreuse1-chartreuse3 \
98 -draw 'roundrectangle 140, 5, 180, 85 20,40' +tile -fill none \
99 -draw 'roundrectangle 264, 5, 304, 85 20,40' -strokewidth 2 \
100 -draw 'roundrectangle 16, 5, 304, 85 20,40' \( +clone -background snow4 \
101 -shadow 80x3+3+3 \) +swap -background none -layers merge \( +size -font Helvetica \
102 -pointsize 90 -strokewidth 1 -fill red label:'50 %' -trim +repage \( +clone \
103 -background firebrick3 -shadow 80x3+3+3 \) +swap -background none -layers merge \) \
104 -insert 0 -gravity center -append -background white -gravity center -extent 320x200 \
105 cylinder_shaded.png
106</pre>
107
108<p>In the next sections we dissect the anatomy of the ImageMagick command line. Hopefully, after carefully reading and better understanding how the command line works, you should be able to accomplish complex image-processing tasks without resorting to the sometimes daunting <a href="api.html">program interfaces</a>.</p>
109
110<p>See <a href="http://www.imagemagick.org/Usage/">Examples of ImageMagick Usage</a> for additional help when using ImageMagick from the command-line.</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]111
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]112<h2 class="magick-header"><a id="anatomy"></a>The Anatomy of the Command Line</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]113<p>The ImageMagick command line consists of</p>
114
115<ol>
116<li>one or more required input filenames.</li>
117<li>zero, one, or more image settings.</li>
118<li>zero, one, or more image operators.</li>
119<li>zero, one, or more image sequence operators.</li>
120<li>zero, one, or more image stacks.</li>
121<li>zero or one output image filenames (required by
122<a href="convert.html">convert</a>,
123<a href="composite.html">composite</a>,
124<a href="montage.html">montage</a>,
125<a href="compare.html">compare</a>,
126<a href="import.html">import</a>,
127<a href="conjure.html">conjure</a>).
128</li>
129</ol>
130
131<p>You can find a detailed explanation of each of the constituent parts of the command line in the sections that follow.</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]132
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]133<h2 class="magick-header"><a id="input"></a>Input Filename</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]134
135<p>ImageMagick extends the concept of an input filename to include:</p>
136<ul>
137<li>filename globbing</li>
138<li>an explicit image format</li>
139<li>using built-in images and patterns</li>
140<li>STDIN, STDOUT, and file descriptors</li>
141<li>selecting certain frames from an image</li>
142<li>selecting a region of an image</li>
143<li>forcing an inline image resize</li>
144<li>forcing an inline image crop</li>
145<li>using filename references</li>
146</ul>
147
148<p>These extensions are explained in the next few paragraphs.</p>
149
150<h3>Filename Globbing</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]151<p>In Unix shells, certain characters such as the asterisk (<code>*</code>) and question mark (<code>?</code>) automagically cause lists of filenames to be generated based on pattern matches. This feature is known as globbing. ImageMagick supports filename globbing for systems, such as Windows, that does not natively support it. For example, suppose you want to convert <code>1.jpg</code>, <code>2.jpg</code>, <code>3.jpg</code>, <code>4.jpg</code>, and <code>5.jpg</code> in your current directory to a GIF animation. You can conveniently refer to all of the JPEG files with this command:
152</p>
153
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]154<pre>
155convert *.jpg images.gif
156</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]157
158<h3>Explicit Image Format</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]159<p>Images are stored in a myriad of image formats including
160the better known JPEG, PNG, TIFF and others. ImageMagick must know the format
161of the image before it can be read and processed. Most formats have a
162signature within the image that uniquely identifies the format. Failing
163that, ImageMagick leverages the filename extension to determine the format.
164For example, <code>image.jpg</code> or <code>image.JPG</code> tells ImageMagick
165it is reading an image in the JPEG format. </p>
166
167 <p>In some cases the image may not contain a signature
168and/or the filename does not identify the image format. In these cases an
169explicit image format must be specified. For example, suppose our image
170is named <code>image</code> and contains raw red, green, and blue intensity
171values. ImageMagick has no way to automagically determine the image format
172so we explicitly set one:
173</p>
174
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]175<pre>
176convert -size 640x480 -depth 8 rgb:image image.png
177</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]178
179<h3>Built-in Images and Patterns</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]180
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]181<p>ImageMagick has a number of built-in <a href="formats.html#builtin-images">images</a> and <a href="formats.html#builtin-patterns">patterns</a>. To utilize the checkerboard pattern, for example, use:
182</p>
183
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]184<pre>
185convert -size 640x480 pattern:checkerboard checkerboard.png
186</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]187
188<h3>STDIN, STDOUT, and file descriptors</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]189<p>Unix and Windows permit the output of one command to be piped to the input of another. ImageMagick permits image data to be read and written from the <a href="http://en.wikipedia.org/wiki/Standard_streams">standard streams</a> STDIN (<var>standard in</var>) and STDOUT (<var>standard out</var>), respectively, using a pseudo-filename of <code>-</code>. In this example we pipe the output of
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]190 <a href="convert.html">convert</a> to the <a href="display.html">display</a> program:
191</p>
192
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]193<pre>
194convert logo: gif:- | display gif:-
195</pre>
196
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]197<p>The second explicit format "<code>gif:</code>" is optional in the preceding example. The GIF image format has a unique signature within the image so ImageMagick's <a href="display.html">display</a> command can readily recognize the format as GIF. The <a href="convert.html">convert</a> program also accepts STDIN as input in this way:
198</p>
199
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]200<pre>
201convert rose: gif:- | convert - -resize "200%" bigrose.jpg'
202</pre>
203
204<p>Other pipes can be accessed via their <var>file descriptors</var> (as of version 6.4.9-3). The file descriptors 0, 1, and 2 are reserved for the standard streams STDIN, STDOUT, and STDERR, respectively, but a pipe associated with a file descriptor number <var>N</var>&gt;2 can be accessed using the pseudonym <code>fd:</code><var>N</var>. (The pseudonyms <code>fd:0</code> and <code>fd:1</code> can be used for STDIN and STDOUT.) The next example shows how to append image data piped from files with descriptors 3 and 4 and direct the result to the file with descriptor number 5.
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]205</p>
206
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]207<pre>
208convert fd:3 fd:4 -append fd:5
209</pre>
210
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]211<p>When needed, explicit image formats can be given as mentioned earlier, as in the following.
212</p>
213
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]214<pre>
215convert gif:fd:3 jpg:fd:4 -append tif:fd:5
216</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]217
218<h3>Selecting Frames</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]219<p>Some images formats contain more than one image frame. Perhaps you only want the first image, or the last, or some number of images in-between. You can specify which image frames to read by appending the image filename with the frame range enclosed in brackets. Here our image (an animated GIF) contains more than one frame but we only want the first:
220</p>
221
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]222<pre>
223convert 'images.gif[0]' image.png
224</pre>
225
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]226<p class="warn">[Unix shells generally interpret brackets so we enclosed the filename in quotes above.
227In a Windows command shell the brackets are not interpreted but using quotes doesn't hurt. However, in most cases the roles of single-quotes and double-quotes are reversed with respect to Unix and Windows, so Windows users should usually try double-quotes where we display single-quotes, and vice versa.]
228</p>
229
230<p>You can read more than one image from a sequence with a frame range. For example, you can extract the first four frames of an image sequence:
231</p>
232
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]233<pre>
234convert 'images.gif[0-3]' images.mng
235</pre>
236
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]237<p>Finally, you can read more than one image from a sequence, out-of-order. The next command gets the third image in the sequence, followed by the second, and then the fourth:
238</p>
239
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]240<pre>
241convert 'images.gif[3,2,4]' images.mng
242</pre>
243
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]244<p>Notice that in the last two commands, a single image is written. The output in this case, where the image type is MNG, is a multi-frame file because the MNG format supports multiple frames. Had the output format been JPG, which only supports single frames, the output would have consisted of separate frames. More about that below, in the section about the <a href="command-line-processing.html#output">Output Filename</a>.
245</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]246
247<h3>Selecting an Image Region</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]248<p>Raw images are a sequence of color intensities without additional meta information such as width, height, or image signature. With raw image formats, you must specify the image width and height but you can also specify a region of the image to read. In our example, the image is in the raw 8-bit RGB format and is 6000 pixels wide and 4000 pixels high. However, we only want a region of 600 by 400 near the center of the image:
249</p>
250
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]251<pre>
252convert -size 6000x4000 -depth 8 \
253 'rgb:image[600x400+1900+2900]' image.jpg
254</pre>
255
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]256<p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]257 You can get the same results with the <a href="command-line-options.html#extract">‑extract</a> option:
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]258</p>
259
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]260<pre>
261convert -size 6000x4000 -depth 8 \
262 -extract 600x400+1900+2900 rgb:image image.jpg
263</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]264
265<h3>Inline Image Resize</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]266<p>It is sometimes convenient to resize an image as they are read. Suppose you have hundreds of large JPEG images you want to convert to a sequence of PNG thumbails:
267</p>
268
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]269<pre>
270convert '*.jpg' -resize 120x120 thumbnail%03d.png
271</pre>
272
273<p>Here <var>all</var> the images are read and subsequently
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]274resized. It is faster and less resource intensive to resize each image it
275is read:
276</p>
277
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]278<pre>
279convert '*.jpg[120x120]' thumbnail%03d.png
280</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]281
282<h3>Inline Image Crop</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]283<p>It is sometimes convenient to crop an image as they are read. Suppose you have hundreds of large JPEG images you want to convert to a sequence of PNG thumbails:
284</p>
285
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]286<pre>
287convert '*.jpg' -crop 120x120+10+5 thumbnail%03d.png
288</pre>
289
290<p>Here <var>all</var> the images are read and subsequently cropped. It is faster and less resource-intensive to crop each image as it is read:
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]291</p>
292
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]293<pre>
294convert '*.jpg[120x120+10+5]' thumbnail%03d.png
295</pre>
296
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]297
298<h3>Filename References</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]299
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]300<p>There are two methods to use a filename to reference other image filenames.
301The first is with '<code>@</code>' which reads image filenames separated by white space from the specified file. Assume the file <code>myimages.txt</code> consists of a list of filenames, like so:
302</p>
303
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]304<pre>
305frame001.jpg
306frame002.jpg
307frame003.jpg
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]308</pre>
309
310<p>We then expect this command:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]311
312<pre>
313convert @myimages.txt mymovie.gif
314</pre>
315
316<p>to read the images <code>frame001.jpg</code>, <code>frame002.jpg</code>, and <code>frame003.jpg</code> and convert them to a GIF image sequence. </p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]317<p>If the image path includes one or more spaces, enclose the path in quotes:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]318<pre>
319'my title.jpg'
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]320</pre>
321
322
323 <p>Some ImageMagick command-line options may exceed the capabilities of
324your command line processor. Windows, for example, limits command lines
325to 8192 characters. If, for example, you have a draw option with polygon
326points that exceed the command-line length limit, put the draw option instead
327in a file and reference the file with
328the <code>@</code> (e.g. <code>@mypoly.txt</code>).</p>
329
330<p>Another method of referring to other image files is by
331embedding a formatting character in the filename with a scene range. Consider
332the filename <code>image-%d.jpg[1-5]</code>. The command</p>
333
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]334<pre>
335convert image-%d.jpg[1-5]
336</pre>
337
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]338<p>causes ImageMagick to attempt to read images with these filenames:
339</p>
340
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]341<pre>
342image-1.jpg
343image-2.jpg
344image-3.jpg
345image-4.jpg
346image-5.jpg
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]347</pre>
348
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]349<h3>Stream Buffering</h3>
350<p>By default, the input stream is buffered. To ensure information on the source file or terminal is read as soon as its available, set the buffer size to 0:</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]351
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]352<pre>
353convert logo: gif:- | display -define stream:buffer-size=0 gif:-
354</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]355
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]356<h2 class="magick-header"><a id="setting"></a>Image Setting</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]357
358<p>An image setting persists as it appears on the command line and may affect
359subsequent processing such as reading an image, an image operator, or when
360writing an image as appropriate. An image setting stays in effect until it
361is reset or the command line terminates. The image settings include:</p>
362
363<p class="options">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]364<a href="command-line-options.html#adjoin">‑adjoin</a> <span class="bull"> • </span> <a href="command-line-options.html#affine">‑affine</a> <span class="bull"> • </span> <a href="command-line-options.html#alpha">‑alpha</a> <span class="bull"> • </span> <a href="command-line-options.html#antialias">‑antialias</a> <span class="bull"> • </span> <a href="command-line-options.html#authenticate">‑authenticate</a> <span class="bull"> • </span> <a href="command-line-options.html#background">‑background</a> <span class="bull"> • </span> <a href="command-line-options.html#bias">‑bias</a> <span class="bull"> • </span> <a href="command-line-options.html#black-point-compensation">‑black‑point‑compensation</a> <span class="bull"> • </span> <a href="command-line-options.html#blue-primary">‑blue‑primary</a> <span class="bull"> • </span> <a href="command-line-options.html#bordercolor">‑bordercolor</a> <span class="bull"> • </span> <a href="command-line-options.html#caption">‑caption</a> <span class="bull"> • </span> <a href="command-line-options.html#channel">‑channel</a> <span class="bull"> • </span> <a href="command-line-options.html#comment">‑comment</a> <span class="bull"> • </span> <a href="command-line-options.html#compress">‑compress</a> <span class="bull"> • </span> <a href="command-line-options.html#debug">‑debug</a> <span class="bull"> • </span> <a href="command-line-options.html#define">‑define</a> <span class="bull"> • </span> <a href="command-line-options.html#delay">‑delay</a> <span class="bull"> • </span> <a href="command-line-options.html#density">‑density</a> <span class="bull"> • </span> <a href="command-line-options.html#depth">‑depth</a> <span class="bull"> • </span> <a href="command-line-options.html#direction">‑direction</a> <span class="bull"> • </span> <a href="command-line-options.html#display">‑display</a> <span class="bull"> • </span> <a href="command-line-options.html#dispose">‑dispose</a> <span class="bull"> • </span> <a href="command-line-options.html#dither">‑dither</a> <span class="bull"> • </span> <a href="command-line-options.html#encoding">‑encoding</a> <span class="bull"> • </span> <a href="command-line-options.html#endian">‑endian</a> <span class="bull"> • </span> <a href="command-line-options.html#extract">‑extract</a> <span class="bull"> • </span> <a href="command-line-options.html#family">‑family</a> <span class="bull"> • </span> <a href="command-line-options.html#fill">‑fill</a> <span class="bull"> • </span> <a href="command-line-options.html#filter">‑filter</a> <span class="bull"> • </span> <a href="command-line-options.html#font">‑font</a> <span class="bull"> • </span> <a href="command-line-options.html#format">‑format</a> <span class="bull"> • </span> <a href="command-line-options.html#fuzz">‑fuzz</a> <span class="bull"> • </span> <a href="command-line-options.html#geometry">‑geometry</a> <span class="bull"> • </span> <a href="command-line-options.html#gravity">‑gravity</a> <span class="bull"> • </span> <a href="command-line-options.html#green-primary">‑green‑primary</a> <span class="bull"> • </span> <a href="command-line-options.html#interlace">‑interlace</a> <span class="bull"> • </span> <a href="command-line-options.html#intent">‑intent</a> <span class="bull"> • </span> <a href="command-line-options.html#interpolate">‑interpolate</a> <span class="bull"> • </span> <a href="command-line-options.html#label">‑label</a> <span class="bull"> • </span> <a href="command-line-options.html#limit">‑limit</a> <span class="bull"> • </span> <a href="command-line-options.html#linewidth">‑linewidth</a> <span class="bull"> • </span> <a href="command-line-options.html#log">‑log</a> <span class="bull"> • </span> <a href="command-line-options.html#loop">‑loop</a> <span class="bull"> • </span> <a href="command-line-options.html#mask">‑mask</a> <span class="bull"> • </span> <a href="command-line-options.html#mattecolor">‑mattecolor</a> <span class="bull"> • </span> <a href="command-line-options.html#monitor">‑monitor</a> <span class="bull"> • </span> <a href="command-line-options.html#orient">‑orient</a> <span class="bull"> • </span> <a href="command-line-options.html#page">‑page</a> <span class="bull"> • </span> <a href="command-line-options.html#pointsize">‑pointsize</a> <span class="bull"> • </span> <a href="command-line-options.html#preview">‑preview</a> <span class="bull"> • </span> <a href="command-line-options.html#quality">‑quality</a> <span class="bull"> • </span> <a href="command-line-options.html#quiet">‑quiet</a> <span class="bull"> • </span> <a href="command-line-options.html#red-primary">‑red‑primary</a> <span class="bull"> • </span> <a href="command-line-options.html#region">‑region</a> <span class="bull"> • </span> <a href="command-line-options.html#render">‑render</a> <span class="bull"> • </span> <a href="command-line-options.html#repage">‑repage</a> <span class="bull"> • </span> <a href="command-line-options.html#sampling-factor">‑sampling‑factor</a> <span class="bull"> • </span> <a href="command-line-options.html#scene">‑scene</a> <span class="bull"> • </span> <a href="command-line-options.html#seed">‑seed</a> <span class="bull"> • </span> <a href="command-line-options.html#size">‑size</a> <span class="bull"> • </span> <a href="command-line-options.html#stretch">‑stretch</a> <span class="bull"> • </span> <a href="command-line-options.html#stroke">‑stroke</a> <span class="bull"> • </span> <a href="command-line-options.html#strokewidth">‑strokewidth</a> <span class="bull"> • </span> <a href="command-line-options.html#style">‑style</a> <span class="bull"> • </span> <a href="command-line-options.html#texture">‑texture</a> <span class="bull"> • </span> <a href="command-line-options.html#tile">‑tile</a> <span class="bull"> • </span> <a href="command-line-options.html#transparent-color">‑transparent‑color</a> <span class="bull"> • </span> <a href="command-line-options.html#treedepth">‑treedepth</a> <span class="bull"> • </span> <a href="command-line-options.html#type">‑type</a> <span class="bull"> • </span> <a href="command-line-options.html#undercolor">‑undercolor</a> <span class="bull"> • </span> <a href="command-line-options.html#units">‑units</a> <span class="bull"> • </span> <a href="command-line-options.html#verbose">‑verbose</a> <span class="bull"> • </span> <a href="command-line-options.html#virtual-pixel">‑virtual‑pixel</a> <span class="bull"> • </span> <a href="command-line-options.html#weight">‑weight</a> </p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]365
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]366<p>In this example, <var>-channel</var> applies to each of the images, since, as we mentioned, settings persist:
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]367</p>
368
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]369<pre>
370convert -channel RGB wand.png wizard.png images.png
371</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]372
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]373<h2 class="magick-header"><a id="operator"></a>Image Operator</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]374
375<p>An image operator differs from a setting in that it affects the image
376immediately as it appears on the command line. An operator is
377any <a href="command-line-options.html">command line option</a>
378not listed as a <a href="command-line-processing.html#setting">image setting</a>
379or <a href="command-line-processing.html#sequence">image sequence operator</a>. Unlike an
380image setting, which persists until the command line terminates,
381an operator is applied to an image and forgotten. The image operators
382include:</p>
383
384<p class="options">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]385<a href="command-line-options.html#annotate">‑annotate</a> <span class="bull"> • </span> <a href="command-line-options.html#black-threshold">‑black‑threshold</a> <span class="bull"> • </span> <a href="command-line-options.html#blur">‑blur</a> <span class="bull"> • </span> <a href="command-line-options.html#border">‑border</a> <span class="bull"> • </span> <a href="command-line-options.html#charcoal">‑charcoal</a> <span class="bull"> • </span> <a href="command-line-options.html#chop">‑chop</a> <span class="bull"> • </span> <a href="command-line-options.html#clip">‑clip</a> <span class="bull"> • </span> <a href="command-line-options.html#clip-path">‑clip‑path</a> <span class="bull"> • </span> <a href="command-line-options.html#clip-mask">‑clip‑mask</a> <span class="bull"> • </span> <a href="command-line-options.html#colors">‑colors</a> <span class="bull"> • </span> <a href="command-line-options.html#colorize">‑colorize</a> <span class="bull"> • </span> <a href="command-line-options.html#colorspace">‑colorspace</a> <span class="bull"> • </span> <a href="command-line-options.html#compose">‑compose</a> <span class="bull"> • </span> <a href="command-line-options.html#contrast">‑contrast</a> <span class="bull"> • </span> <a href="command-line-options.html#convolve">‑convolve</a> <span class="bull"> • </span> <a href="command-line-options.html#crop">‑crop</a> <span class="bull"> • </span> <a href="command-line-options.html#cycle">‑cycle</a> <span class="bull"> • </span> <a href="command-line-options.html#despeckle">‑despeckle</a> <span class="bull"> • </span> <a href="command-line-options.html#draw">‑draw</a> <span class="bull"> • </span> <a href="command-line-options.html#edge">‑edge</a> <span class="bull"> • </span> <a href="command-line-options.html#emboss">‑emboss</a> <span class="bull"> • </span> <a href="command-line-options.html#enhance">‑enhance</a> <span class="bull"> • </span> <a href="command-line-options.html#equalize">‑equalize</a> <span class="bull"> • </span> <a href="command-line-options.html#evaluate">‑evaluate</a> <span class="bull"> • </span> <a href="command-line-options.html#extent">‑extent</a> <span class="bull"> • </span> <a href="command-line-options.html#flip">‑flip</a> <span class="bull"> • </span> <a href="command-line-options.html#flop">‑flop</a> <span class="bull"> • </span> <a href="command-line-options.html#floodfill">‑floodfill</a> <span class="bull"> • </span> <a href="command-line-options.html#frame">‑frame</a> <span class="bull"> • </span> <a href="command-line-options.html#gamma">‑gamma</a> <span class="bull"> • </span> <a href="command-line-options.html#gaussian-blur">‑gaussian‑blur</a> <span class="bull"> • </span> <a href="command-line-options.html#implode">‑implode</a> <span class="bull"> • </span> <a href="command-line-options.html#lat">‑lat</a> <span class="bull"> • </span> <a href="command-line-options.html#level">‑level</a> <span class="bull"> • </span> <a href="command-line-options.html#map">‑map</a> <span class="bull"> • </span> <a href="command-line-options.html#median">‑median</a> <span class="bull"> • </span> <a href="command-line-options.html#modulate">‑modulate</a> <span class="bull"> • </span> <a href="command-line-options.html#monochrome">‑monochrome</a> <span class="bull"> • </span> <a href="command-line-options.html#negate">‑negate</a> <span class="bull"> • </span> <a href="command-line-options.html#noise">‑noise</a> <span class="bull"> • </span> <a href="command-line-options.html#normalize">‑normalize</a> <span class="bull"> • </span> <a href="command-line-options.html#opaque">‑opaque</a> <span class="bull"> • </span> <a href="command-line-options.html#ordered-dither">‑ordered‑dither</a> <span class="bull"> • </span> <a href="command-line-options.html#paint">‑paint</a> <span class="bull"> • </span> <a href="command-line-options.html#posterize">‑posterize</a> <span class="bull"> • </span> <a href="command-line-options.html#raise">‑raise</a> <span class="bull"> • </span> <a href="command-line-options.html#profile">‑profile</a> <span class="bull"> • </span> <a href="command-line-options.html#radial-blur">‑radial‑blur</a> <span class="bull"> • </span> <a href="command-line-options.html#raise">‑raise</a> <span class="bull"> • </span> <a href="command-line-options.html#random-threshold">‑random‑threshold</a> <span class="bull"> • </span> <a href="command-line-options.html#resample">‑resample</a> <span class="bull"> • </span> <a href="command-line-options.html#resize">‑resize</a> <span class="bull"> • </span> <a href="command-line-options.html#roll">‑roll</a> <span class="bull"> • </span> <a href="command-line-options.html#rotate">‑rotate</a> <span class="bull"> • </span> <a href="command-line-options.html#sample">‑sample</a> <span class="bull"> • </span> <a href="command-line-options.html#scale">‑scale</a> <span class="bull"> • </span> <a href="command-line-options.html#sepia-tone">‑sepia‑tone</a> <span class="bull"> • </span> <a href="command-line-options.html#segment">‑segment</a> <span class="bull"> • </span> <a href="command-line-options.html#shade">‑shade</a> <span class="bull"> • </span> <a href="command-line-options.html#shadow">‑shadow</a> <span class="bull"> • </span> <a href="command-line-options.html#sharpen">‑sharpen</a> <span class="bull"> • </span> <a href="command-line-options.html#shave">‑shave</a> <span class="bull"> • </span> <a href="command-line-options.html#shear">‑shear</a> <span class="bull"> • </span> <a href="command-line-options.html#sigmoidal-contrast">‑sigmoidal‑contrast</a> <span class="bull"> • </span> <a href="command-line-options.html#solarize">‑solarize</a> <span class="bull"> • </span> <a href="command-line-options.html#splice">‑splice</a> <span class="bull"> • </span> <a href="command-line-options.html#spread">‑spread</a> <span class="bull"> • </span> <a href="command-line-options.html#strip">‑strip</a> <span class="bull"> • </span> <a href="command-line-options.html#swirl">‑swirl</a> <span class="bull"> • </span> <a href="command-line-options.html#threshold">‑threshold</a> <span class="bull"> • </span> <a href="command-line-options.html#transparent">‑transparent</a> <span class="bull"> • </span> <a href="command-line-options.html#thumbnail">‑thumbnail</a> <span class="bull"> • </span> <a href="command-line-options.html#tint">‑tint</a> <span class="bull"> • </span> <a href="command-line-options.html#transform">‑transform</a> <span class="bull"> • </span> <a href="command-line-options.html#trim">‑trim</a> <span class="bull"> • </span> <a href="command-line-options.html#unsharp">‑unsharp</a> <span class="bull"> • </span> <a href="command-line-options.html#version">‑version</a> <span class="bull"> • </span> <a href="command-line-options.html#wave">‑wave</a> <span class="bull"> • </span> <a href="command-line-options.html#white-point">‑white‑point</a> <span class="bull"> • </span> <a href="command-line-options.html#white-threshold">‑white‑threshold</a> </p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]386
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]387<p>In this example, <var>-negate</var> negates the wand image but not the wizard:</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]388
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]389<pre>
390convert wand.png -negate wizard.png images.png
391</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]392
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]393<h2 class="magick-header"><a id="sequence"></a>Image Sequence Operator</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]394
395<p>An image sequence operator differs from a setting in that it affects an
396image sequence immediately as it appears on the command line. Choose from
397these image sequence operators:</p>
398
399<p class="options">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]400<a href="command-line-options.html#append">‑append</a> <span class="bull"> • </span> <a href="command-line-options.html#affinity">‑affinity</a> <span class="bull"> • </span> <a href="command-line-options.html#average">‑average</a> <span class="bull"> • </span> <a href="command-line-options.html#clut">‑clut</a> <span class="bull"> • </span> <a href="command-line-options.html#coalesce">‑coalesce</a> <span class="bull"> • </span> <a href="command-line-options.html#combine">‑combine</a> <span class="bull"> • </span> <a href="command-line-options.html#compare">‑compare</a> <span class="bull"> • </span> <a href="command-line-options.html#complex">‑complex</a> <span class="bull"> • </span> <a href="command-line-options.html#composite">‑composite</a> <span class="bull"> • </span> <a href="command-line-options.html#crop">‑crop</a> <span class="bull"> • </span> <a href="command-line-options.html#debug">‑debug</a> <span class="bull"> • </span> <a href="command-line-options.html#deconstruct">‑deconstruct</a> <span class="bull"> • </span> <a href="command-line-options.html#delete">‑delete</a> <span class="bull"> • </span> <a href="command-line-options.html#evaluate-sequence">‑evaluate‑sequence</a> <span class="bull"> • </span> <a href="command-line-options.html#fft">‑fft</a> <span class="bull"> • </span> <a href="command-line-options.html#flatten">‑flatten</a> <span class="bull"> • </span> <a href="command-line-options.html#fx">‑fx</a> <span class="bull"> • </span> <a href="command-line-options.html#hald-clut">‑hald‑clut</a> <span class="bull"> • </span> <a href="command-line-options.html#ift">‑ift</a> <span class="bull"> • </span> <a href="command-line-options.html#identify">‑identify</a> <span class="bull"> • </span> <a href="command-line-options.html#insert">‑insert</a> <span class="bull"> • </span> <a href="command-line-options.html#layers">‑layers</a> <span class="bull"> • </span> <a href="command-line-options.html#limit">‑limit</a> <span class="bull"> • </span> <a href="command-line-options.html#map">‑map</a> <span class="bull"> • </span> <a href="command-line-options.html#maximum">‑maximum</a> <span class="bull"> • </span> <a href="command-line-options.html#minimum">‑minimum</a> <span class="bull"> • </span> <a href="command-line-options.html#morph">‑morph</a> <span class="bull"> • </span> <a href="command-line-options.html#mosaic">‑mosaic</a> <span class="bull"> • </span> <a href="command-line-options.html#optimize">‑optimize</a> <span class="bull"> • </span> <a href="command-line-options.html#print">‑print</a> <span class="bull"> • </span> <a href="command-line-options.html#process">‑process</a> <span class="bull"> • </span> <a href="command-line-options.html#quiet">‑quiet</a> <span class="bull"> • </span> <a href="command-line-options.html#separate">‑separate</a> <span class="bull"> • </span> <a href="command-line-options.html#swap">‑swap</a> <span class="bull"> • </span> <a href="command-line-options.html#write">‑write</a> </p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]401
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]402<h2 class="magick-header"><a id="geometry"></a>Image Geometry</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]403
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]404<p>Many command-line options take a <var>geometry</var> argument
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]405to specify such things as the desired width and height of an image and other
406dimensional quantities. Because users want so many variations on the resulting
407dimensions, sizes, and positions of images (and because ImageMagick wants to
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]408provide them), the <var>geometry</var> argument can take many
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]409forms. We describe many of these in this section. </p>
410
411<p>The image options and settings that take some form of
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]412a <var>geometry</var> argument include the following.
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]413Keep in mind that some of these parse their arguments in slightly
414different ways. See the documentation for the individual option or
415setting for more specifics.</p>
416
417<p class="options" style="text-align:justify">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]418<a href="command-line-options.html#adaptive-resize">‑adaptive‑resize</a> <span class="bull"> • </span> <a href="command-line-options.html#border">‑border</a> <span class="bull"> • </span> <a href="command-line-options.html#borderwidth">‑borderwidth</a> <span class="bull"> • </span> <a href="command-line-options.html#chop">‑chop</a> <span class="bull"> • </span> <a href="command-line-options.html#crop">‑crop</a> <span class="bull"> • </span> <a href="command-line-options.html#density">‑density</a> <span class="bull"> • </span> <a href="command-line-options.html#extent">‑extent</a> <span class="bull"> • </span> <a href="command-line-options.html#extract">‑extract</a> <span class="bull"> • </span> <a href="command-line-options.html#frame">‑frame</a> <span class="bull"> • </span> <a href="command-line-options.html#geometry">‑geometry</a> <span class="bull"> • </span> <a href="command-line-options.html#iconGeometry">‑iconGeometry</a> <span class="bull"> • </span> <a href="command-line-options.html#liquid-rescale">‑liquid‑rescale</a> <span class="bull"> • </span> <a href="command-line-options.html#page">‑page</a> <span class="bull"> • </span> <a href="command-line-options.html#region">‑region</a> <span class="bull"> • </span> <a href="command-line-options.html#repage">‑repage</a> <span class="bull"> • </span> <a href="command-line-options.html#resize">‑resize</a> <span class="bull"> • </span> <a href="command-line-options.html#sample">‑sample</a> <span class="bull"> • </span> <a href="command-line-options.html#scale">‑scale</a> <span class="bull"> • </span> <a href="command-line-options.html#shave">‑shave</a> <span class="bull"> • </span> <a href="command-line-options.html#splice">‑splice</a> <span class="bull"> • </span> <a href="command-line-options.html#thumbnail">‑thumbnail</a> <span class="bull"> • </span> <a href="command-line-options.html#window">‑window</a> </p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]419
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]420<p>The <var>geometry</var> argument might take any of the forms listed in the table below. These will described in more detail in the subsections following the table. The usual form is <var>size</var>[<var>offset</var>], meaning <var>size</var> is required and <var>offset</var> is optional. Occasionally, [<var>size</var>]<var>offset</var> is possible. In no cases are spaces permitted within the <var>geometry</var> argument.</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]421
422
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]423<div class="table-responsive">
424<table class="table table-condensed table-striped">
425 <col width="20%"> <col width="80%">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]426 <thead>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]427 <tr>
428 <th style="text-align:center"><var>size</var></th>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]429 <th>General description (actual behavior can vary for different options and settings)</th>
430 </tr>
431 </thead>
432 <tbody>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]433 <tr>
434 <td><var>scale</var>%</td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]435 <td>Height and width both scaled by specified percentage.</td>
436 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]437 <tr>
438 <td><var>scale-x</var>%x<var>scale-y</var>%</td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]439 <td>Height and width individually scaled by specified percentages. (Only one % symbol needed.)</td>
440 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]441 <tr>
442 <td><var>width</var></td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]443 <td>Width given, height automagically selected to preserve aspect ratio.</td>
444 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]445 <tr>
446 <td>x<var>height</var></td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]447 <td>Height given, width automagically selected to preserve aspect ratio.</td>
448 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]449 <tr>
450 <td><var>width</var>x<var>height</var></td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]451 <td>Maximum values of height and width given, aspect ratio preserved.</td>
452 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]453 <tr>
454 <td><var>width</var>x<var>height</var>^</td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]455 <td>Minimum values of width and height given, aspect ratio preserved.</td>
456 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]457 <tr>
458 <td><var>width</var>x<var>height</var>!</td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]459 <td>Width and height emphatically given, original aspect ratio ignored.</td>
460 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]461 <tr>
462 <td><var>width</var>x<var>height</var>&gt;</td>
463 <td>Shrinks an image with dimension(s) <b>larger</b> than the corresponding <var>width</var> and/or <var>height</var> argument(s).</td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]464 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]465 <tr>
466 <td><var>width</var>x<var>height</var>&lt;</td>
467 <td>Enlarges an image with dimension(s) <b>smaller</b> than the corresponding <var>width</var> and/or <var>height</var> argument(s).</td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]468 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]469 <tr>
470 <td><var>area</var>@</td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]471 <td>Resize image to have specified area in pixels. Aspect ratio is preserved.</td>
472 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]473 <tr>
474 <td>{<var>size</var>}{<var>offset</var>}</td>
475 <td>Specifying the <var>offset</var> (default is <code>+0+0</code>). Below, {<var>size</var>} refers to any of the forms above.</td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]476 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]477 <tr>
478 <td>{<var>size</var>}{<var>+-</var>}<var>x</var>{<var>+-</var>}<var>y</var></td>
479 <td>Horizontal and vertical offsets <var>x</var> and <var>y</var>, specified in pixels. Signs are required for both. Offsets are affected by <a href="command-line-options.html#gravity">‑gravity</a> setting. Offsets are not affected by <code>%</code> or other <var>size</var> operators.</td>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]480 </tr>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]481 </tbody>
482</table></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]483
484
485<h3>Basic adjustments to width and height; the operators <code>%</code>, <code>^</code>, and <code>!</code> </h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]486<p>Here, just below, are a few simple examples of <var>geometry</var>, showing how it might be used as an argument to the <a href="command-line-options.html#resize">‑resize</a> option. We'll use the internal image <code>logo:</code> for our input image.
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]487<a href="../images/logo.png">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]488This fine image</a> is 640 pixels wide and 480 pixels high. We say its <var>dimensions</var> are 640x480. When we give dimensions of an image, the width (the horizontal dimension) always precedes the height (the vertical dimension). This will be true when we speak of coordinates or <var>offsets</var> into an image, which will always be <var>x</var>–value followed by <var>y</var>. Just think of your high school algebra classes and the <var>xy</var>–plane. (Well, almost: our <var>y</var>–axis will always go downward!)
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]489</p>
490
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]491<pre>
492convert logo: -resize '200%' bigWiz.png
493convert logo: -resize '200x50%' longShortWiz.png
494convert logo: -resize '100x200' notThinWiz.png
495convert logo: -resize '100x200^' biggerNotThinWiz.png
496convert logo: -resize '100x200!' dochThinWiz.png
497</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]498
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]499<p>The first of the four commands is simple—it stretches both the width and height of the input image by <code>200%</code> in each direction; it magnifies the whole thing by a factor of two. The second command specifies different percentages for each direction, stretching the width to <code>200</code>% and squashing the height to <code>50%</code>. The resulting image (in this example) has dimensions 1280x240. Notice that the percent symbol needn't be repeated; the following are equivalent: <code>200x50%</code>, <code>200%x50</code>, <code>200%x50%</code>.
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]500</p>
501
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]502<p>By default, the width and height given in a <var>geometry</var> argument are <var>maximum</var> values unless a percentage is specified. That is, the image is expanded or contracted to fit the specified width and height value while maintaining the <var>aspect ratio</var> (the ratio of its height to its width) of the image. For instance, the third command above "tries" to set the dimensions to <code>100x200</code>. Imagine gradually shrinking the original image (which is 640x480), keeping is aspect ratio constant, until it just fits into a 100x200 rectangle. Since the image is longer than it is tall, it will fit when its width shrinks to 100 pixels. To preserve the aspect ratio, the height will therefore have to be (480/640)×100 pixels=75 pixels, so the final dimensions will be 100x75.</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]503
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]504<p> Notice that in the previous example, at least one of the specified dimensions will be attained (in this case, the width, 100 pixels). The resulting image fits snugly within the original. One can do just the opposite of this by invoking the <code>^</code> operator, as in the fourth example above. In that case, when <code>100x200^</code> is given as the argument, again at least one of the dimensions will be attained, but in this case the resulting image can snugly contain the original. Here the <var>geometry</var> argument gives <var>minimum</var> values. In our example, the height will become 200 and the width will be scaled to preserve the aspect ratio, becoming (640/480)×200 pixels=267 pixels. With the <code>^</code> operator, one of those dimensions will match the requested size, but the image will likely overflow the dimensions requested to preserve its aspect ratio. (The <code>^</code> feature is new as of IM 6.3.8-2.)</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]505
506<p>We see that ImageMagick is very good about preserving aspect ratios of images, to prevent distortion of your favorite photos and images. But you might really want the dimensions to be <code>100x200</code>, thereby stretching the image. In this case just tell ImageMagick you really mean it (!) by appending an exclamation operator to the geometry. This will force the image size to exactly what you specify. So, for example, if you specify <code>100x200!</code> the dimensions will become exactly 100x200 (giving a small, vertically elongated wizard).</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]507
508<h3>Bounding the width, height, and area; the operators <code>&gt;</code>, <code>&lt;</code>, and <code>@</code> </h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]509<p>
510Here are a few more examples:
511</p>
512
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]513<pre>
514convert logo: -resize '100' wiz1.png
515convert logo: -resize 'x200' wiz2.png
516convert logo: -resize '100x200&gt;' wiz3.png
517convert logo: -resize '100x200&lt;' wiz4.png
518</pre>
519
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]520<p>If only one dimension is given it is taken to be the width. When only the width is specified, as in the first example above, the width is accepted as given and the height is chosen to maintain the aspect ratio of the input image. Similarly, if only the height is specified, as in the second example above, the height is accepted and the width is chosen to maintain the aspect ratio.</p>
521
522
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]523<p>Use <code>&gt;</code> to shrink an image <var>only</var> if its dimension(s) are <b>larger</b> than the corresponding <var>width</var> and/or <var>height</var> arguments. Use <code>&lt;</code> to enlarge an image <var>only</var> if its dimension(s) are <b>smaller</b> than the corresponding <var>width</var> and/or <var>height</var> arguments. In either case, if a change is made, the result is as if the <code>&gt;</code> or <code>&lt;</code> operator was not present. So, in the third example above, we specified <code>100x200&gt;</code> and the original image size is 640x480, so the image size is reduced as if we had specified <code>100x200</code>. However, in the fourth example above, there will be no change to its size.</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]524
cristyac1b4322013-07-28 13:58:06 +0000[diff] [blame]525<p>Finally, use <code>@</code> to specify the maximum area in pixels of an image, again while attempting to preserve aspect ratio. (Pixels take only integer values, so some approximation is always at work.) In the following example, an area of 10000 pixels is requested. The resulting file has dimensions 115x86, which has 9890 pixels. </p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]526
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]527<pre>
528convert logo: -resize '@10000' wiz10000.png
529</pre>
530
531<p class="warn">Another word about the quotation marks: In all the examples above and below, we have enclosed the <var>geometry</var> arguments within quotation marks. Doing so is optional in many cases, but not always. We <var>must</var> enclose the geometry specifications in quotation marks when using <code>&lt;</code> or <code>&gt;</code> to prevent these characters from being interpreted by the shell as <var>file redirection</var>. On Windows systems, the carat <code>^</code> needs to be within quotes, else it is ignored. To be safe, one should probably maintain a habit of enclosing all <var>geometry</var> arguments in quotes, as we have here.
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]532</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]533
534<h3>Offsets in geometry</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]535<p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]536Here are some examples to illustrate the use of <var>offsets</var> in <var>geometry</var> arguments. One typical use of offsets is in conjunction with the
537<a href="command-line-options.html#region">‑region</a> option. This option allows many other options to modify the pixels within a specified rectangular subregion of an image. As such, it needs to be given the width and height of that region, and also an <var>offset</var> into the image, which is a pair of coordinates that indicate the location of the region within the larger image. Below, in the first example, we specify a region of size <code>100x200</code> to be located at the <var>xy</var>–coordinates <var>x</var>=10, <var>y</var>=20. Let's use the usual algebraic notation (<var>x</var>,<var>y</var>)=(10,20), for convenience.
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]538</p>
539
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]540<pre>
541convert logo: -region '100x200+10+20' -negate wizNeg1.png
542convert logo: -region '100x200-10+20' -negate wizNeg2.png
543convert logo: -gravity center -region '100x200-10+20' \
544 -negate wizNeg3.png
545</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]546
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]547<p>Note that offsets always require +/− signs. The offset is not actually a true location within the image; its coordinates must be added to some other location. Let's refer to that as the <var>current location</var>. In the first two examples above, though, that location is the upper-left hand corner of the image, which has coordinates (0,0). (That is the default situation when there are no other directives given to change it.) The first example above puts the <code>100x200</code> rectangle's own upper-left corner at (10,20). </p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]548
549<p>A negative offset can make sense in many cases. In the second example above, the offset is (-10,20), specified by <code>-10+20</code>. In that case, only the portion of the (virtual) rectangle obtained that lies within the image can be negated; here it is equivalent to specifying the geometry as <code>90x200+0+20</code>.</p>
550
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]551<p>In the third example above, the <a href="command-line-options.html#gravity">‑gravity</a> setting precedes the others and sets the current location within the image at the very center of the image. In this case that is at pixel (320,240), since the size of the image is 640x480. This means that the offsets apply to that location, which thereby gets moved, in this case, to (320-10,240+20)=(310,260). But the <code>100x200</code> region itself is affected by the <a href="command-line-options.html#gravity">‑gravity</a> setting, so instead of affecting its upper-left corner, the region's own center (at (+50,+100) within it) is determined. Therefore the center of the <code>100x200</code> rectangle is moved to (310,260). The negated rectangle's upper-left corner is now at (310-50,260-100)=(260,160).
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]552</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]553
554
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]555<h2 class="magick-header"><a id="stack"></a>Image Stack</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]556
557<p>In school, your teacher probably permitted you to work on problems on a scrap of paper and then copy the results to your test paper. An image stack is similar. It permits you to work on an image or image sequence in isolation and subsequently introduce the results back into the command line. The image stack is delineated with parenthesis. Image operators only affect images in the current stack. For example, we can limit the image rotation to just the wizard image like this:</p>
558
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]559<pre>
560convert wand.gif \( wizard.gif -rotate 30 \) +append images.gif
561</pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]562
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]563
564<p class="warn">Notice again that the parentheses are <var>escaped</var> by preceding them with
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]565backslashes. This is required under Unix, where parentheses are special
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]566<var>shell</var> characters. The backslash tells the shell not to interpret
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]567these characters, but to pass them directly to the command being executed. Do
568not escape the parentheses under Windows. Each parenthesis (or escaped
569parenthesis) must have spaces on either side, as in the example shown
570above.</p>
571
572<p>In addition to the image operators already discussed, the following image operators are most useful when processing images in an image stack:</p>
573
574<p class="options">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]575<span class="bull"> • </span>
576<a href="command-line-options.html#clone">‑clone</a> <span class="bull"> • </span> <a href="command-line-options.html#delete">‑delete</a> <span class="bull"> • </span> <a href="command-line-options.html#insert">‑insert</a> <span class="bull"> • </span> <a href="command-line-options.html#swap">‑swap</a> <span class="bull"> • </span>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]577</p>
578
579<p>The arguments to these operators are indexes into the image sequence by number, starting with zero, for the first image, and so on. However if you give a negative index, the images are indexed from the end (last image added). That is, an index of -1 is the last image in the current image sequence, -2 gives the second-to-last, and so on.</p>
580
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]581<h2 class="magick-header"><a id="output"></a>Output Filename</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]582
583<p>ImageMagick extends the concept of an output filename to include:</p>
584
585<ol>
586<li>an explicit image format</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]587<li>write to <var>standard out</var></li>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]588<li>filename references</li>
589</ol>
590
591<p>Each of these extensions are explained in the next few paragraphs.</p>
592
593<h3>Explicit Image Format</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]594 <p>Images can be stored in a mryiad of image formats including the better known JPEG, PNG, TIFF and others. ImageMagick must know the desired format of the image before it is written. ImageMagick leverages the filename extension to determine the format. For example, <code>image.jpg</code> tells ImageMagick to write the image in the JPEG format. In some cases the filename does not identify the image format. In these cases, the image is written in the format it was originally read unless an explicit image format is specified. For example, suppose we want to write our image to a filename of <code>image</code> in the raw red, green, and blue intensity format:
595 </p>
596
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]597<pre>
598convert image.jpg rgb:image
599</pre>
600
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]601
602<h3>Standard Out</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]603 <p>Unix permits the output of one command to be piped to another. ImageMagick permits piping one command to another with a filename of <code>-</code>. In this example we pipe the output of <a href="convert.html">convert</a> to the <a href="display.html">display</a> program:
604 </p>
605
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]606<pre>
607convert logo: gif:- | display gif:-
608</pre>
609
610<p>Here the explicit format is optional. The GIF image format has a signature that uniquely identifies it so ImageMagick can readily recognize the format as GIF.</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]611
612<h3>Filename References</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]613<p>Optionally, use an embedded formatting character to write a sequential image list. Suppose our output filename is <code>image-%d.jpg</code> and our image list includes 3 images. You can expect these images files to be written:
614</p>
615
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]616<pre>
617image-0.jpg
618image-1.jpg
619image-2.jpg
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]620</pre>
621
622<p>Or retrieve image properties to modify the image filename. For example, the command
623</p>
624
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]625<pre>
626convert rose: -set filename:area '%wx%h' \
627 'rose-%[filename:area].png'
628</pre>
629
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]630<p>writes an image with this filename:
631</p>
632
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]633<pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]634 rose-70x46.png
635</pre>
636
637<p>Finally to convert multiple JPEG images to individual PDF pages, use:</p>
638
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]639<pre>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]640 convert *.jpg +adjoin page-%d.pdf
641</pre>
642
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]643<h3>Stream Buffering</h3>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]644
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]645<p>By default, the output stream is buffered. To ensure information appears on the destination file or terminal as soon as written, set the buffer size to 0:</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]646
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]647<pre>
648convert -define stream:buffer-size=0 logo: gif:- | display gif:-
649</pre>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]650</div>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]651 <footer class="magick-footer">
652 <div class="magick-nav-item navbar-left">
653 <a href="support.html">Donations</a>
654 </div>
655 <div class="magick-nav-item navbar-right">
656 <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a>
657 <noscript>
658 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
659 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
660 </noscript>
661 </div>
662 <p><a href="sitemap.html">Sitemap</a> •
663 <a href="links.html">Related</a> •
664 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
665 <a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
666 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
667</p>
668 <p><a href="command-line-processing.html#">Back to top</a> •
669 <a href="contact.html">Contact Us</a></p>
670 </footer>
671</div><!-- /.container -->
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]672
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame^]673 <script src="https://localhost/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
674 <script src="../js/bootstrap.min.js"></script>
675 <script type="text/javascript">
676 /* */
677 (function() {
678 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
679 s.type = 'text/javascript';
680 s.async = true;
681 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
682 t.parentNode.insertBefore(s, t);
683 })();
684 /* */
685 </script>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]686</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]687</body>
688</html>