blob: dab474dae0a8ac3f4515b1a4516f1c8ed091aa0f [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +00001
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
cristy1f9e1ed2009-11-18 04:09:38 +00006 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
cristyf3bb4782009-09-08 13:10:04 +00007 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
8 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
9 <style type="text/css" media="screen,projection"><!--
10 @import url("../www/magick.css");
11 --></style>
cristy3ed852e2009-09-05 21:47:34 +000012 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
13 <title>ImageMagick: Command-line Tools: Import</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:, import, 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-2009 ImageMagick Studio LLC"/>
27 <meta name="Distribution" content="Global"/>
cristyf3bb4782009-09-08 13:10:04 +000028</head>
29
30<body id="www-imagemagick-org">
31<div class="titlebar">
32<a href="../index.html">
33 <img src="../images/script.png" alt="[ImageMagick]"
34 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
35<a href="http://www.networkredux.com">
36 <img src="../images/networkredux.png" alt="[sponsor]"
37 style="margin: 45px auto; border: 0px; float: left;" /></a>
38<a href="http://www.imagemagick.org/discourse-server/">
39 <img src="../images/logo.jpg" alt=""
40 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
41<a href="../index.html">
42 <img src="../images/sprite.jpg" alt=""
43 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
44</div>
45
46<div class="eastbar">
47
cristy3ed852e2009-09-05 21:47:34 +000048<div class="menu">
49 <a href="../index.html">About ImageMagick</a>
50</div>
cristyf3bb4782009-09-08 13:10:04 +000051<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000052<div class="menu">
53 <a href="../www/command-line-tools.html">Command-line Tools</a>
54</div>
55<div class="sub">
56 <a href="../www/command-line-processing.html">Processing</a>
57</div>
58<div class="sub">
59 <a href="../www/command-line-options.html">Options</a>
60</div>
61<div class="sub">
62 <a href="http://www.imagemagick.org/Usage/">Usage</a>
63</div>
64<div class="menu">
65 <a href="../www/api.html">Program Interfaces</a>
66</div>
67<div class="sub">
68 <a href="../www/magick-wand.html">MagickWand</a>
69</div>
70<div class="sub">
71 <a href="../www/magick-core.html">MagickCore</a>
72</div>
73<div class="sub">
74 <a href="../www/perl-magick.html">PerlMagick</a>
75</div>
76<div class="sub">
77 <a href="../Magick++/">Magick++</a>
78</div>
79<div class="menu">
80 <a href="../www/architecture.html">Architecture</a>
81</div>
cristyf3bb4782009-09-08 13:10:04 +000082<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000083<div class="menu">
84 <a href="../www/install-source.html">Install from Source</a>
85</div>
86<div class="sub">
87 <a href="../www/install-source.html#unix">Unix</a>
88</div>
89<div class="sub">
90 <a href="../www/install-source.html#windows">Windows</a>
91 </div>
92<div class="menu">
93 <a href="../www/binary-releases.html">Binary Releases</a>
94</div>
95<div class="sub">
96 <a href="../www/binary-releases.html#unix">Unix</a>
97</div>
98<div class="sub">
99 <a href="../www/binary-releases.html#macosx">Mac OS X</a>
100</div>
101<div class="sub">
102 <a href="../www/binary-releases.html#windows">Windows</a>
103</div>
104<div class="menu">
105 <a href="../www/resources.html">Resources</a>
106</div>
cristyf3bb4782009-09-08 13:10:04 +0000107<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000108<div class="menu">
109 <a href="../www/download.html">Download</a>
110</div>
cristyf3bb4782009-09-08 13:10:04 +0000111<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000112<div class="menu">
113 <a href="http://www.imagemagick.org/script/search.php">Search</a>
114</div>
cristyf3bb4782009-09-08 13:10:04 +0000115<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000116<div class="menu">
117 <a href="../www/sitemap.html">Site Map</a>
118</div>
119<div class="sub">
120 <a href="../www/links.html">Links</a>
121</div>
cristyf3bb4782009-09-08 13:10:04 +0000122<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000123<div class="menu">
124 <a href="../www/sponsors.html">Sponsors:</a>
125
126<div class="sponsbox">
127<div class="sponsor">
cristy5f2356f2009-11-16 00:40:46 +0000128 <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
129</div>
130<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000131 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
132</div>
133<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000134 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
cristyc1c61662009-09-30 14:04:37 +0000135</div>
136<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000137 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy916e1922009-10-01 12:52:47 +0000138</div>
139<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000140 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
141</div>
142<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000143 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
144</div>
145<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000146 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
147</div>
148<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000149 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
150</div>
cristy3ed852e2009-09-05 21:47:34 +0000151</div>
152</div>
cristyf3bb4782009-09-08 13:10:04 +0000153
154
155</div>
156
157<div class="main">
158
cristy3ed852e2009-09-05 21:47:34 +0000159<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
160
161<div class="doc-section">
162<p>Use the <kbd>import</kbd> program to capture some or all of an X server screen and save the image to a file. See <a href="../www/command-line-processing.html">Command Line Processing</a> for advice on how to structure your <kbd>import</kbd> command or see below for example usages of the command.</p>
163</div>
164
165<h2><a name="usage"></a>Example Usage</h2>
166<div class="doc-section">
167
168<p>We list a few examples of the <kbd>import</kbd> command here to illustrate its usefulness and ease of use. To get started, lets import an image in the JPEG format:</p>
169
170<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>import rose.jpg</span></p>
171<p>To capture the entire X server screen in the Postscript image format:</p>
172
173<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>import -window root screen.ps</span></p>
174<p>You can find additional examples of using <kbd>import</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>
175
176</div>
177
178<h2><a name="options"></a>Option Summary</h2>
179<div class="doc-section">
180
181<p>The <kbd>import</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
182
183<table class="doc">
184 <tbody>
185 <tr>
186 <th align="left">Option</th>
187 <th align="left">Description</th>
188 </tr>
189
190 <tr>
191 <td valign="top"><a href="../www/command-line-options.html#adjoin">-adjoin</a></td>
192 <td valign="top">join images into a single multi-image file</td>
193 </tr>
194
195 <tr>
196 <td valign="top"><a href="../www/command-line-options.html#annotate">-annotate <em class="option">geometry text</em></a></td>
197 <td valign="top">annotate the image with text</td>
198 </tr>
199
200 <tr>
201 <td valign="top"><a href="../www/command-line-options.html#border">-border</a></td>
202 <td valign="top">include image borders in the output image</td>
203 </tr>
204
205 <tr>
206 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
207 <td valign="top">apply option to select image channels</td>
208 </tr>
209
210 <tr>
211 <td valign="top"><a href="../www/command-line-options.html#colors">-colors <em class="option">value</em></a></td>
212 <td valign="top">preferred number of colors in the image</td>
213 </tr>
214
215 <tr>
216 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
217 <td valign="top">set image colorspace</td>
218 </tr>
219
220 <tr>
221 <td valign="top"><a href="../www/command-line-options.html#comment">-comment <em class="option">string</em></a></td>
222 <td valign="top">annotate image with comment</td>
223 </tr>
224
225 <tr>
226 <td valign="top"><a href="../www/command-line-options.html#compress">-compress <em class="option">type</em></a></td>
227 <td valign="top">image compression type</td>
228 </tr>
229
230 <tr>
231 <td valign="top"><a href="../www/command-line-options.html#contrast">-contrast</a></td>
232 <td valign="top">enhance or reduce the image contrast</td>
233 </tr>
234
235 <tr>
236 <td valign="top"><a href="../www/command-line-options.html#crop">-crop <em class="option">geometry</em></a></td>
237 <td valign="top">preferred size and location of the cropped image</td>
238 </tr>
239
240 <tr>
241 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
242 <td valign="top">import copious debugging information</td>
243 </tr>
244
245 <tr>
246 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
247 <td valign="top">define one or more image format options</td>
248 </tr>
249
250 <tr>
251 <td valign="top"><a href="../www/command-line-options.html#delay">-delay <em class="option">value</em></a></td>
252 <td valign="top">import the next image after pausing</td>
253 </tr>
254
255 <tr>
256 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
257 <td valign="top">horizontal and vertical density of the image</td>
258 </tr>
259
260 <tr>
261 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
262 <td valign="top">image depth</td>
263 </tr>
264
265 <tr>
266 <td valign="top"><a href="../www/command-line-options.html#despeckle">-descend</a></td>
267 <td valign="top">obtain image by descending window hierarchy</td>
268 </tr>
269
270 <tr>
271 <td valign="top"><a href="../www/command-line-options.html#display">-display <em class="option">server</em></a></td>
272 <td valign="top">get image or font from this X server</td>
273 </tr>
274
275 <tr>
276 <td valign="top"><a href="../www/command-line-options.html#dispose">-dispose <em class="option">method</em></a></td>
277 <td valign="top">layer disposal method</td>
278 </tr>
279
280 <tr>
281 <td valign="top"><a href="../www/command-line-options.html#dither">-dither <em class="option">method</em></a></td>
282 <td valign="top">apply error diffusion to image</td>
283 </tr>
284
285 <tr>
286 <td valign="top"><a href="../www/command-line-options.html#encipher">-encipher <em class="option">filename</em></a></td>
287 <td valign="top">convert plain pixels to cipher pixels</td>
288 </tr>
289
290 <tr>
291 <td valign="top"><a href="../www/command-line-options.html#encoding">-encoding <em class="option">type</em></a></td>
292 <td valign="top">text encoding type</td>
293 </tr>
294
295 <tr>
296 <td valign="top"><a href="../www/command-line-options.html#endian">-endian <em class="option">type</em></a></td>
297 <td valign="top">endianness (MSB or LSB) of the image</td>
298 </tr>
299
300 <tr>
301 <td valign="top"><a href="../www/command-line-options.html#filter">-filter <em class="option">type</em></a></td>
302 <td valign="top">use this filter when resizing an image</td>
303 </tr>
304
305 <tr>
306 <td valign="top"><a href="../www/command-line-options.html#frame">-frame</a></td>
307 <td valign="top">include window manager frame</td>
308 </tr>
309
310 <tr>
311 <td valign="top"><a href="../www/command-line-options.html#geometry">-geometry <em class="option">geometry</em></a></td>
312 <td valign="top">preferred size or location of the image</td>
313 </tr>
314
315 <tr>
316 <td valign="top"><a href="../www/command-line-options.html#gravity">-gravity <em class="option">type</em></a></td>
317 <td valign="top">horizontal and vertical text placement</td>
318 </tr>
319
320 <tr>
321 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
322 <td valign="top">print program options</td>
323 </tr>
324
325 <tr>
326 <td valign="top"><a href="../www/command-line-options.html#identify">-identify</a></td>
327 <td valign="top">identify the format and characteristics of the image</td>
328 </tr>
329
330 <tr>
331 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
332 <td valign="top">type of image interlacing scheme</td>
333 </tr>
334
335 <tr>
336 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
337 <td valign="top">pixel color interpolation method</td>
338 </tr>
339
340 <tr>
341 <td valign="top"><a href="../www/command-line-options.html#label">-label <em class="option">name</em></a></td>
342 <td valign="top">assign a label to an image</td>
343 </tr>
344
345 <tr>
346 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
347 <td valign="top">pixel cache resource limit</td>
348 </tr>
349
350 <tr>
351 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
352 <td valign="top">format of debugging information</td>
353 </tr>
354
355 <tr>
356 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
357 <td valign="top">monitor progress</td>
358 </tr>
359
360 <tr>
361 <td valign="top"><a href="../www/command-line-options.html#monochrome">-monochrome</a></td>
362 <td valign="top">transform image to black and white</td>
363 </tr>
364
365 <tr>
366 <td valign="top"><a href="../www/command-line-options.html#negate">-negate</a></td>
367 <td valign="top">replace every pixel with its complementary color </td>
368 </tr>
369
370 <tr>
371 <td valign="top"><a href="../www/command-line-options.html#page">-page <em class="option">geometry</em></a></td>
372 <td valign="top">size and location of an image canvas (setting)</td>
373 </tr>
374
375 <tr>
376 <td valign="top"><a href="../www/command-line-options.html#quality">-quality <em class="option">value</em></a></td>
377 <td valign="top">JPEG/MIFF/PNG compression level</td>
378 </tr>
379
380 <tr>
381 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
382 <td valign="top">reduce image colors in this colorspace</td>
383 </tr>
384
385 <tr>
386 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
387 <td valign="top">suppress all warning messages</td>
388 </tr>
389
390 <tr>
391 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
392 <td valign="top">suppress all warning messages</td>
393 </tr>
394
395 <tr>
396 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
397 <td valign="top">pay attention to warning messages.</td>
398 </tr>
399
400 <tr>
401 <td valign="top"><a href="../www/command-line-options.html#repage">-repage <em class="option">geometry</em></a></td>
402 <td valign="top">size and location of an image canvas</td>
403 </tr>
404
405 <tr>
406 <td valign="top"><a href="../www/command-line-options.html#resize">-resize <em class="option">geometry</em></a></td>
407 <td valign="top">resize the image</td>
408 </tr>
409
410 <tr>
411 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
412 <td valign="top">settings remain in effect until parenthesis boundary.</td>
413 </tr>
414
415 <tr>
416 <td valign="top"><a href="../www/command-line-options.html#rotate">-rotate <em class="option">degrees</em></a></td>
417 <td valign="top">apply Paeth rotation to the image</td>
418 </tr>
419
420 <tr>
421 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
422 <td valign="top">horizontal and vertical sampling factor</td>
423 </tr>
424
425 <tr>
426 <td valign="top"><a href="../www/command-line-options.html#scene">-scene <em class="option">value</em></a></td>
427 <td valign="top">image scene number</td>
428 </tr>
429
430 <tr>
431 <td valign="top"><a href="../www/command-line-options.html#screen">-screen</a></td>
432 <td valign="top">select image from root window</td>
433 </tr>
434
435 <tr>
436 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
437 <td valign="top">seed a new sequence of pseudo-random numbers</td>
438 </tr>
439
440 <tr>
441 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
442 <td valign="top">set an image attribute</td>
443 </tr>
444
445 <tr>
446 <td valign="top"><a href="../www/command-line-options.html#sharpen">-silent</a></td>
447 <td valign="top">operate silently, i.e. don't ring any bells</td>
448 </tr>
449
450 <tr>
451 <td valign="top"><a href="../www/command-line-options.html#strip">-strip</a></td>
452 <td valign="top">strip image of all profiles and comments</td>
453 </tr>
454
455 <tr>
456 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
457 <td valign="top">transparent color</td>
458 </tr>
459
460 <tr>
461 <td valign="top"><a href="../www/command-line-options.html#trim">-trim</a></td>
462 <td valign="top">trim image edges</td>
463 </tr>
464
465 <tr>
466 <td valign="top"><a href="../www/command-line-options.html#update">-type <em class="option">type</em></a></td>
467 <td valign="top">image type</td>
468 </tr>
469
470 <tr>
471 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
472 <td valign="top">print detailed information about the image</td>
473 </tr>
474
475 <tr>
476 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
477 <td valign="top">print version information</td>
478 </tr>
479
480 <tr>
481 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
482 <td valign="top">access method for pixels outside the boundaries of the image</td>
483 </tr>
484
485 <tr>
486 <td valign="top"><a href="../www/command-line-options.html#write">-window <em class="option">id</em></a></td>
487 <td valign="top">select window with this id or name</td>
488 </tr>
489
490 </tbody>
491</table>
492
493</div>
cristyf3bb4782009-09-08 13:10:04 +0000494
495</div>
496
497<div id="linkbar">
498 <!-- <span id="linkbar-west">&nbsp;</span> -->
499 <span id="linkbar-center">
500 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
501 <a href="../www/mailing-list.html">Mailing Lists</a> &bull;
cristy1f9e1ed2009-11-18 04:09:38 +0000502 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000503 </span>
504 <span id="linkbar-east">&nbsp;</span>
505 </div>
506 <div class="footer">
507 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
508 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
509 </div>
510 <div style="clear: both; margin: 0; width: 100%; "></div>
511</body>
512</html>