blob: 0d43b0bc6e9b89ceff3a980f4c6e29f6685464cf [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +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>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../www/magick.css");
10 --></style>
11 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: Command-line Tools: Import</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <meta name="Keywords" content="command-line, tools:, import, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../index.html">
32 <img src="../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../index.html">
41 <img src="../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
47<div class="menu">
48 <a href="../index.html">About ImageMagick</a>
49</div>
50<div class="sep"></div>
51<div class="menu">
52 <a href="../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../www/architecture.html">Architecture</a>
80</div>
81<div class="sep"></div>
82<div class="menu">
83 <a href="../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../www/resources.html">Resources</a>
105</div>
106<div class="sep"></div>
107<div class="menu">
108 <a href="../www/download.html">Download</a>
109</div>
110<div class="sep"></div>
111<div class="menu">
112 <a href="http://www.imagemagick.org/script/search.php">Search</a>
113</div>
114<div class="sep"></div>
115<div class="menu">
116 <a href="../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../www/links.html">Links</a>
120</div>
121<div class="sep"></div>
122<div class="menu">
123 <a href="../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
127 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
128</div>
129<div class="sponsor">
130 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
131</div>
132<div class="sponsor">
133 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
134</div>
135<div class="sponsor">
136 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
137</div>
138<div class="sponsor">
139 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
140</div>
141</div>
142</div>
143
144
145</div>
146
147<div class="main">
148
149<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
150
151<div class="doc-section">
152<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>
153</div>
154
155<h2><a name="usage"></a>Example Usage</h2>
156<div class="doc-section">
157
158<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>
159
160<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>import rose.jpg</span></p>
161<p>To capture the entire X server screen in the Postscript image format:</p>
162
163<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>import -window root screen.ps</span></p>
164<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>
165
166</div>
167
168<h2><a name="options"></a>Option Summary</h2>
169<div class="doc-section">
170
171<p>The <kbd>import</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
172
173<table class="doc">
174 <tbody>
175 <tr>
176 <th align="left">Option</th>
177 <th align="left">Description</th>
178 </tr>
179
180 <tr>
181 <td valign="top"><a href="../www/command-line-options.html#adjoin">-adjoin</a></td>
182 <td valign="top">join images into a single multi-image file</td>
183 </tr>
184
185 <tr>
186 <td valign="top"><a href="../www/command-line-options.html#annotate">-annotate <em class="option">geometry text</em></a></td>
187 <td valign="top">annotate the image with text</td>
188 </tr>
189
190 <tr>
191 <td valign="top"><a href="../www/command-line-options.html#border">-border</a></td>
192 <td valign="top">include image borders in the output image</td>
193 </tr>
194
195 <tr>
196 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
197 <td valign="top">apply option to select image channels</td>
198 </tr>
199
200 <tr>
201 <td valign="top"><a href="../www/command-line-options.html#colors">-colors <em class="option">value</em></a></td>
202 <td valign="top">preferred number of colors in the image</td>
203 </tr>
204
205 <tr>
206 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
207 <td valign="top">set image colorspace</td>
208 </tr>
209
210 <tr>
211 <td valign="top"><a href="../www/command-line-options.html#comment">-comment <em class="option">string</em></a></td>
212 <td valign="top">annotate image with comment</td>
213 </tr>
214
215 <tr>
216 <td valign="top"><a href="../www/command-line-options.html#compress">-compress <em class="option">type</em></a></td>
217 <td valign="top">image compression type</td>
218 </tr>
219
220 <tr>
221 <td valign="top"><a href="../www/command-line-options.html#contrast">-contrast</a></td>
222 <td valign="top">enhance or reduce the image contrast</td>
223 </tr>
224
225 <tr>
226 <td valign="top"><a href="../www/command-line-options.html#crop">-crop <em class="option">geometry</em></a></td>
227 <td valign="top">preferred size and location of the cropped image</td>
228 </tr>
229
230 <tr>
231 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
232 <td valign="top">import copious debugging information</td>
233 </tr>
234
235 <tr>
236 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
237 <td valign="top">define one or more image format options</td>
238 </tr>
239
240 <tr>
241 <td valign="top"><a href="../www/command-line-options.html#delay">-delay <em class="option">value</em></a></td>
242 <td valign="top">import the next image after pausing</td>
243 </tr>
244
245 <tr>
246 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
247 <td valign="top">horizontal and vertical density of the image</td>
248 </tr>
249
250 <tr>
251 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
252 <td valign="top">image depth</td>
253 </tr>
254
255 <tr>
256 <td valign="top"><a href="../www/command-line-options.html#despeckle">-descend</a></td>
257 <td valign="top">obtain image by descending window hierarchy</td>
258 </tr>
259
260 <tr>
261 <td valign="top"><a href="../www/command-line-options.html#display">-display <em class="option">server</em></a></td>
262 <td valign="top">get image or font from this X server</td>
263 </tr>
264
265 <tr>
266 <td valign="top"><a href="../www/command-line-options.html#dispose">-dispose <em class="option">method</em></a></td>
267 <td valign="top">layer disposal method</td>
268 </tr>
269
270 <tr>
271 <td valign="top"><a href="../www/command-line-options.html#dither">-dither <em class="option">method</em></a></td>
272 <td valign="top">apply error diffusion to image</td>
273 </tr>
274
275 <tr>
276 <td valign="top"><a href="../www/command-line-options.html#encipher">-encipher <em class="option">filename</em></a></td>
277 <td valign="top">convert plain pixels to cipher pixels</td>
278 </tr>
279
280 <tr>
281 <td valign="top"><a href="../www/command-line-options.html#encoding">-encoding <em class="option">type</em></a></td>
282 <td valign="top">text encoding type</td>
283 </tr>
284
285 <tr>
286 <td valign="top"><a href="../www/command-line-options.html#endian">-endian <em class="option">type</em></a></td>
287 <td valign="top">endianness (MSB or LSB) of the image</td>
288 </tr>
289
290 <tr>
291 <td valign="top"><a href="../www/command-line-options.html#filter">-filter <em class="option">type</em></a></td>
292 <td valign="top">use this filter when resizing an image</td>
293 </tr>
294
295 <tr>
296 <td valign="top"><a href="../www/command-line-options.html#frame">-frame</a></td>
297 <td valign="top">include window manager frame</td>
298 </tr>
299
300 <tr>
301 <td valign="top"><a href="../www/command-line-options.html#geometry">-geometry <em class="option">geometry</em></a></td>
302 <td valign="top">preferred size or location of the image</td>
303 </tr>
304
305 <tr>
306 <td valign="top"><a href="../www/command-line-options.html#gravity">-gravity <em class="option">type</em></a></td>
307 <td valign="top">horizontal and vertical text placement</td>
308 </tr>
309
310 <tr>
311 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
312 <td valign="top">print program options</td>
313 </tr>
314
315 <tr>
316 <td valign="top"><a href="../www/command-line-options.html#identify">-identify</a></td>
317 <td valign="top">identify the format and characteristics of the image</td>
318 </tr>
319
320 <tr>
321 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
322 <td valign="top">type of image interlacing scheme</td>
323 </tr>
324
325 <tr>
326 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
327 <td valign="top">pixel color interpolation method</td>
328 </tr>
329
330 <tr>
331 <td valign="top"><a href="../www/command-line-options.html#label">-label <em class="option">name</em></a></td>
332 <td valign="top">assign a label to an image</td>
333 </tr>
334
335 <tr>
336 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
337 <td valign="top">pixel cache resource limit</td>
338 </tr>
339
340 <tr>
341 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
342 <td valign="top">format of debugging information</td>
343 </tr>
344
345 <tr>
346 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
347 <td valign="top">monitor progress</td>
348 </tr>
349
350 <tr>
351 <td valign="top"><a href="../www/command-line-options.html#monochrome">-monochrome</a></td>
352 <td valign="top">transform image to black and white</td>
353 </tr>
354
355 <tr>
356 <td valign="top"><a href="../www/command-line-options.html#negate">-negate</a></td>
357 <td valign="top">replace every pixel with its complementary color </td>
358 </tr>
359
360 <tr>
361 <td valign="top"><a href="../www/command-line-options.html#page">-page <em class="option">geometry</em></a></td>
362 <td valign="top">size and location of an image canvas (setting)</td>
363 </tr>
364
365 <tr>
366 <td valign="top"><a href="../www/command-line-options.html#quality">-quality <em class="option">value</em></a></td>
367 <td valign="top">JPEG/MIFF/PNG compression level</td>
368 </tr>
369
370 <tr>
371 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
372 <td valign="top">reduce image colors in this colorspace</td>
373 </tr>
374
375 <tr>
376 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
377 <td valign="top">suppress all warning messages</td>
378 </tr>
379
380 <tr>
381 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
382 <td valign="top">suppress all warning messages</td>
383 </tr>
384
385 <tr>
386 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
387 <td valign="top">pay attention to warning messages.</td>
388 </tr>
389
390 <tr>
391 <td valign="top"><a href="../www/command-line-options.html#repage">-repage <em class="option">geometry</em></a></td>
392 <td valign="top">size and location of an image canvas</td>
393 </tr>
394
395 <tr>
396 <td valign="top"><a href="../www/command-line-options.html#resize">-resize <em class="option">geometry</em></a></td>
397 <td valign="top">resize the image</td>
398 </tr>
399
400 <tr>
401 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
402 <td valign="top">settings remain in effect until parenthesis boundary.</td>
403 </tr>
404
405 <tr>
406 <td valign="top"><a href="../www/command-line-options.html#rotate">-rotate <em class="option">degrees</em></a></td>
407 <td valign="top">apply Paeth rotation to the image</td>
408 </tr>
409
410 <tr>
411 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
412 <td valign="top">horizontal and vertical sampling factor</td>
413 </tr>
414
415 <tr>
416 <td valign="top"><a href="../www/command-line-options.html#scene">-scene <em class="option">value</em></a></td>
417 <td valign="top">image scene number</td>
418 </tr>
419
420 <tr>
421 <td valign="top"><a href="../www/command-line-options.html#screen">-screen</a></td>
422 <td valign="top">select image from root window</td>
423 </tr>
424
425 <tr>
426 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
427 <td valign="top">seed a new sequence of pseudo-random numbers</td>
428 </tr>
429
430 <tr>
431 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
432 <td valign="top">set an image attribute</td>
433 </tr>
434
435 <tr>
436 <td valign="top"><a href="../www/command-line-options.html#sharpen">-silent</a></td>
437 <td valign="top">operate silently, i.e. don't ring any bells</td>
438 </tr>
439
440 <tr>
441 <td valign="top"><a href="../www/command-line-options.html#strip">-strip</a></td>
442 <td valign="top">strip image of all profiles and comments</td>
443 </tr>
444
445 <tr>
446 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
447 <td valign="top">transparent color</td>
448 </tr>
449
450 <tr>
451 <td valign="top"><a href="../www/command-line-options.html#trim">-trim</a></td>
452 <td valign="top">trim image edges</td>
453 </tr>
454
455 <tr>
456 <td valign="top"><a href="../www/command-line-options.html#update">-type <em class="option">type</em></a></td>
457 <td valign="top">image type</td>
458 </tr>
459
460 <tr>
461 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
462 <td valign="top">print detailed information about the image</td>
463 </tr>
464
465 <tr>
466 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
467 <td valign="top">print version information</td>
468 </tr>
469
470 <tr>
471 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
472 <td valign="top">access method for pixels outside the boundaries of the image</td>
473 </tr>
474
475 <tr>
476 <td valign="top"><a href="../www/command-line-options.html#write">-window <em class="option">id</em></a></td>
477 <td valign="top">select window with this id or name</td>
478 </tr>
479
480 </tbody>
481</table>
482
483</div>
484
485</div>
486
487<div id="linkbar">
488 <!-- <span id="linkbar-west">&nbsp;</span> -->
489 <span id="linkbar-center">
490 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
491 <a href="../www/mailing-list.html">Mailing Lists</a> &bull;
492 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
493 </span>
494 <span id="linkbar-east">&nbsp;</span>
495 </div>
496 <div class="footer">
497 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
498 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
499 </div>
500 <div style="clear: both; margin: 0; width: 100%; "></div>
501</body>
502</html>