Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / c1c6166d512ecb270db88b2aacf650c86ddfda08 / . / www / import.html
blob: 8240e8ccb1f600ec14f4ba1f4282f5abdf0bf9eb [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]1
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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]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
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
48 <a href="../index.html">About ImageMagick</a>
49</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
108 <a href="../www/download.html">Download</a>
109</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
112 <a href="http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
123 <a href="../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame^]127 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
128</div>
129<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]130 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
131</div>
132<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]133 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
134</div>
135<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
137</div>
138<div class="sponsor">
139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
140</div>
141<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
143</div>
144<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]145 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
147</div>
148</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<p class="navigation-index">[<a href="#usage">Example Usage</a> &bull; <a href="#options">Option Summary</a>]</p>
156
157<div class="doc-section">
158<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>
159</div>
160
161<h2><a name="usage"></a>Example Usage</h2>
162<div class="doc-section">
163
164<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>
165
166<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>import rose.jpg</span></p>
167<p>To capture the entire X server screen in the Postscript image format:</p>
168
169<p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>import -window root screen.ps</span></p>
170<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>
171
172</div>
173
174<h2><a name="options"></a>Option Summary</h2>
175<div class="doc-section">
176
177<p>The <kbd>import</kbd> command recognizes these options. Click on an option to get more details about how that option works.</p>
178
179<table class="doc">
180 <tbody>
181 <tr>
182 <th align="left">Option</th>
183 <th align="left">Description</th>
184 </tr>
185
186 <tr>
187 <td valign="top"><a href="../www/command-line-options.html#adjoin">-adjoin</a></td>
188 <td valign="top">join images into a single multi-image file</td>
189 </tr>
190
191 <tr>
192 <td valign="top"><a href="../www/command-line-options.html#annotate">-annotate <em class="option">geometry text</em></a></td>
193 <td valign="top">annotate the image with text</td>
194 </tr>
195
196 <tr>
197 <td valign="top"><a href="../www/command-line-options.html#border">-border</a></td>
198 <td valign="top">include image borders in the output image</td>
199 </tr>
200
201 <tr>
202 <td valign="top"><a href="../www/command-line-options.html#channel">-channel <em class="option">type</em></a></td>
203 <td valign="top">apply option to select image channels</td>
204 </tr>
205
206 <tr>
207 <td valign="top"><a href="../www/command-line-options.html#colors">-colors <em class="option">value</em></a></td>
208 <td valign="top">preferred number of colors in the image</td>
209 </tr>
210
211 <tr>
212 <td valign="top"><a href="../www/command-line-options.html#colorspace">-colorspace <em class="option">type</em></a></td>
213 <td valign="top">set image colorspace</td>
214 </tr>
215
216 <tr>
217 <td valign="top"><a href="../www/command-line-options.html#comment">-comment <em class="option">string</em></a></td>
218 <td valign="top">annotate image with comment</td>
219 </tr>
220
221 <tr>
222 <td valign="top"><a href="../www/command-line-options.html#compress">-compress <em class="option">type</em></a></td>
223 <td valign="top">image compression type</td>
224 </tr>
225
226 <tr>
227 <td valign="top"><a href="../www/command-line-options.html#contrast">-contrast</a></td>
228 <td valign="top">enhance or reduce the image contrast</td>
229 </tr>
230
231 <tr>
232 <td valign="top"><a href="../www/command-line-options.html#crop">-crop <em class="option">geometry</em></a></td>
233 <td valign="top">preferred size and location of the cropped image</td>
234 </tr>
235
236 <tr>
237 <td valign="top"><a href="../www/command-line-options.html#debug">-debug <em class="option">events</em></a></td>
238 <td valign="top">import copious debugging information</td>
239 </tr>
240
241 <tr>
242 <td valign="top"><a href="../www/command-line-options.html#define">-define <em class="option">format:option</em></a></td>
243 <td valign="top">define one or more image format options</td>
244 </tr>
245
246 <tr>
247 <td valign="top"><a href="../www/command-line-options.html#delay">-delay <em class="option">value</em></a></td>
248 <td valign="top">import the next image after pausing</td>
249 </tr>
250
251 <tr>
252 <td valign="top"><a href="../www/command-line-options.html#density">-density <em class="option">geometry</em></a></td>
253 <td valign="top">horizontal and vertical density of the image</td>
254 </tr>
255
256 <tr>
257 <td valign="top"><a href="../www/command-line-options.html#depth">-depth <em class="option">value</em></a></td>
258 <td valign="top">image depth</td>
259 </tr>
260
261 <tr>
262 <td valign="top"><a href="../www/command-line-options.html#despeckle">-descend</a></td>
263 <td valign="top">obtain image by descending window hierarchy</td>
264 </tr>
265
266 <tr>
267 <td valign="top"><a href="../www/command-line-options.html#display">-display <em class="option">server</em></a></td>
268 <td valign="top">get image or font from this X server</td>
269 </tr>
270
271 <tr>
272 <td valign="top"><a href="../www/command-line-options.html#dispose">-dispose <em class="option">method</em></a></td>
273 <td valign="top">layer disposal method</td>
274 </tr>
275
276 <tr>
277 <td valign="top"><a href="../www/command-line-options.html#dither">-dither <em class="option">method</em></a></td>
278 <td valign="top">apply error diffusion to image</td>
279 </tr>
280
281 <tr>
282 <td valign="top"><a href="../www/command-line-options.html#encipher">-encipher <em class="option">filename</em></a></td>
283 <td valign="top">convert plain pixels to cipher pixels</td>
284 </tr>
285
286 <tr>
287 <td valign="top"><a href="../www/command-line-options.html#encoding">-encoding <em class="option">type</em></a></td>
288 <td valign="top">text encoding type</td>
289 </tr>
290
291 <tr>
292 <td valign="top"><a href="../www/command-line-options.html#endian">-endian <em class="option">type</em></a></td>
293 <td valign="top">endianness (MSB or LSB) of the image</td>
294 </tr>
295
296 <tr>
297 <td valign="top"><a href="../www/command-line-options.html#filter">-filter <em class="option">type</em></a></td>
298 <td valign="top">use this filter when resizing an image</td>
299 </tr>
300
301 <tr>
302 <td valign="top"><a href="../www/command-line-options.html#frame">-frame</a></td>
303 <td valign="top">include window manager frame</td>
304 </tr>
305
306 <tr>
307 <td valign="top"><a href="../www/command-line-options.html#geometry">-geometry <em class="option">geometry</em></a></td>
308 <td valign="top">preferred size or location of the image</td>
309 </tr>
310
311 <tr>
312 <td valign="top"><a href="../www/command-line-options.html#gravity">-gravity <em class="option">type</em></a></td>
313 <td valign="top">horizontal and vertical text placement</td>
314 </tr>
315
316 <tr>
317 <td valign="top"><a href="../www/command-line-options.html#help">-help</a></td>
318 <td valign="top">print program options</td>
319 </tr>
320
321 <tr>
322 <td valign="top"><a href="../www/command-line-options.html#identify">-identify</a></td>
323 <td valign="top">identify the format and characteristics of the image</td>
324 </tr>
325
326 <tr>
327 <td valign="top"><a href="../www/command-line-options.html#interlace">-interlace <em class="option">type</em></a></td>
328 <td valign="top">type of image interlacing scheme</td>
329 </tr>
330
331 <tr>
332 <td valign="top"><a href="../www/command-line-options.html#interpolate">-interpolate <em class="option">method</em></a></td>
333 <td valign="top">pixel color interpolation method</td>
334 </tr>
335
336 <tr>
337 <td valign="top"><a href="../www/command-line-options.html#label">-label <em class="option">name</em></a></td>
338 <td valign="top">assign a label to an image</td>
339 </tr>
340
341 <tr>
342 <td valign="top"><a href="../www/command-line-options.html#limit">-limit <em class="option">type value</em></a></td>
343 <td valign="top">pixel cache resource limit</td>
344 </tr>
345
346 <tr>
347 <td valign="top"><a href="../www/command-line-options.html#log">-log <em class="option">format</em></a></td>
348 <td valign="top">format of debugging information</td>
349 </tr>
350
351 <tr>
352 <td valign="top"><a href="../www/command-line-options.html#monitor">-monitor</a></td>
353 <td valign="top">monitor progress</td>
354 </tr>
355
356 <tr>
357 <td valign="top"><a href="../www/command-line-options.html#monochrome">-monochrome</a></td>
358 <td valign="top">transform image to black and white</td>
359 </tr>
360
361 <tr>
362 <td valign="top"><a href="../www/command-line-options.html#negate">-negate</a></td>
363 <td valign="top">replace every pixel with its complementary color </td>
364 </tr>
365
366 <tr>
367 <td valign="top"><a href="../www/command-line-options.html#page">-page <em class="option">geometry</em></a></td>
368 <td valign="top">size and location of an image canvas (setting)</td>
369 </tr>
370
371 <tr>
372 <td valign="top"><a href="../www/command-line-options.html#quality">-quality <em class="option">value</em></a></td>
373 <td valign="top">JPEG/MIFF/PNG compression level</td>
374 </tr>
375
376 <tr>
377 <td valign="top"><a href="../www/command-line-options.html#quantize">-quantize <em class="option">colorspace</em></a></td>
378 <td valign="top">reduce image colors in this colorspace</td>
379 </tr>
380
381 <tr>
382 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
383 <td valign="top">suppress all warning messages</td>
384 </tr>
385
386 <tr>
387 <td valign="top"><a href="../www/command-line-options.html#quiet">-quiet</a></td>
388 <td valign="top">suppress all warning messages</td>
389 </tr>
390
391 <tr>
392 <td valign="top"><a href="../www/command-line-options.html#regard-warnings">-regard-warnings</a></td>
393 <td valign="top">pay attention to warning messages.</td>
394 </tr>
395
396 <tr>
397 <td valign="top"><a href="../www/command-line-options.html#repage">-repage <em class="option">geometry</em></a></td>
398 <td valign="top">size and location of an image canvas</td>
399 </tr>
400
401 <tr>
402 <td valign="top"><a href="../www/command-line-options.html#resize">-resize <em class="option">geometry</em></a></td>
403 <td valign="top">resize the image</td>
404 </tr>
405
406 <tr>
407 <td valign="top"><a href="../www/command-line-options.html#respect-parentheses">-respect-parentheses</a></td>
408 <td valign="top">settings remain in effect until parenthesis boundary.</td>
409 </tr>
410
411 <tr>
412 <td valign="top"><a href="../www/command-line-options.html#rotate">-rotate <em class="option">degrees</em></a></td>
413 <td valign="top">apply Paeth rotation to the image</td>
414 </tr>
415
416 <tr>
417 <td valign="top"><a href="../www/command-line-options.html#sampling-factor">-sampling-factor <em class="option">geometry</em></a></td>
418 <td valign="top">horizontal and vertical sampling factor</td>
419 </tr>
420
421 <tr>
422 <td valign="top"><a href="../www/command-line-options.html#scene">-scene <em class="option">value</em></a></td>
423 <td valign="top">image scene number</td>
424 </tr>
425
426 <tr>
427 <td valign="top"><a href="../www/command-line-options.html#screen">-screen</a></td>
428 <td valign="top">select image from root window</td>
429 </tr>
430
431 <tr>
432 <td valign="top"><a href="../www/command-line-options.html#seed">-seed <em class="option">value</em></a></td>
433 <td valign="top">seed a new sequence of pseudo-random numbers</td>
434 </tr>
435
436 <tr>
437 <td valign="top"><a href="../www/command-line-options.html#set">-set <em class="option">attribute value</em></a></td>
438 <td valign="top">set an image attribute</td>
439 </tr>
440
441 <tr>
442 <td valign="top"><a href="../www/command-line-options.html#sharpen">-silent</a></td>
443 <td valign="top">operate silently, i.e. don't ring any bells</td>
444 </tr>
445
446 <tr>
447 <td valign="top"><a href="../www/command-line-options.html#strip">-strip</a></td>
448 <td valign="top">strip image of all profiles and comments</td>
449 </tr>
450
451 <tr>
452 <td valign="top"><a href="../www/command-line-options.html#transparent-color">-transparent-color <em class="option">color</em></a></td>
453 <td valign="top">transparent color</td>
454 </tr>
455
456 <tr>
457 <td valign="top"><a href="../www/command-line-options.html#trim">-trim</a></td>
458 <td valign="top">trim image edges</td>
459 </tr>
460
461 <tr>
462 <td valign="top"><a href="../www/command-line-options.html#update">-type <em class="option">type</em></a></td>
463 <td valign="top">image type</td>
464 </tr>
465
466 <tr>
467 <td valign="top"><a href="../www/command-line-options.html#verbose">-verbose</a></td>
468 <td valign="top">print detailed information about the image</td>
469 </tr>
470
471 <tr>
472 <td valign="top"><a href="../www/command-line-options.html#version">-version</a></td>
473 <td valign="top">print version information</td>
474 </tr>
475
476 <tr>
477 <td valign="top"><a href="../www/command-line-options.html#virtual-pixel">-virtual-pixel <em class="option">method</em></a></td>
478 <td valign="top">access method for pixels outside the boundaries of the image</td>
479 </tr>
480
481 <tr>
482 <td valign="top"><a href="../www/command-line-options.html#write">-window <em class="option">id</em></a></td>
483 <td valign="top">select window with this id or name</td>
484 </tr>
485
486 </tbody>
487</table>
488
489</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]490
491</div>
492
493<div id="linkbar">
494 <!-- <span id="linkbar-west">&nbsp;</span> -->
495 <span id="linkbar-center">
496 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
497 <a href="../www/mailing-list.html">Mailing Lists</a> &bull;
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame^]498 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]499 </span>
500 <span id="linkbar-east">&nbsp;</span>
501 </div>
502 <div class="footer">
503 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
504 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
505 </div>
506 <div style="clear: both; margin: 0; width: 100%; "></div>
507</body>
508</html>