blob: afe9ac5329b47bc565cb92d7fdbfa824d2001e77 [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +00001.TH import 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
2.SH NAME
3import \- saves any visible window on an X server and outputs it as an image file. You can capture a single window, the entire screen, or any rectangular portion of the screen.
4.SH SYNOPSIS
5.TP
6\fBimport\fP [\fIoptions\fP] \fIinput-file\fP
7.SH OVERVIEW
8The \fBimport\fP program is a member of the ImageMagick(1) suite of tools. Use it to capture some or all of an X server screen and save the image to a file.
9
cristyb36feb22010-03-26 16:54:37 +000010For more information about the import command, point your browser to file:///usr/local/share/doc/ImageMagick-6.6.1/www/import.html or http://www.imagemagick.org/script/import.php.
cristy3ed852e2009-09-05 21:47:34 +000011.SH DESCRIPTION
12Image Settings:
13 \-adjoin join images into a single multi-image file
cristy8745c022010-03-03 18:22:05 +000014 \-border include window border in the output image
cristy3ed852e2009-09-05 21:47:34 +000015 \-channel type apply option to select image channels
16 \-colorspace type alternate image colorspace
17 \-comment string annotate image with comment
18 \-compress type type of pixel compression when writing the image
19 \-define format:option
20 define one or more image format options
21 \-density geometry horizontal and vertical density of the image
22 \-depth value image depth
23 \-descend obtain image by descending window hierarchy
24 \-display server X server to contact
25 \-dispose method layer disposal method
26 \-dither method apply error diffusion to image
27 \-delay value display the next image after pausing
28 \-encipher filename convert plain pixels to cipher pixels
29 \-endian type endianness (MSB or LSB) of the image
30 \-encoding type text encoding type
31 \-format "string" output formatted image characteristics
32 \-frame include window manager frame
33 \-gravity direction which direction to gravitate towards
34 \-identify identify the format and characteristics of the image
35 \-interlace type None, Line, Plane, or Partition
36 \-interpolate method pixel color interpolation method
37 \-label string assign a label to an image
38 \-limit type value Area, Disk, Map, or Memory resource limit
39 \-monitor monitor progress
40 \-page geometry size and location of an image canvas
41 \-pause value seconds delay between snapshots
42 \-pointsize value font point size
43 \-quality value JPEG/MIFF/PNG compression level
44 \-quiet suppress all warning messages
45 \-regard-warnings pay attention to warning messages
46 \-sampling-factor geometry
47 horizontal and vertical sampling factor
48 \-scene value image scene number
49 \-screen select image from root window
50 \-seed value seed a new sequence of pseudo-random numbers
51 \-set property value set an image property
52 \-silent operate silently, i.e. don't ring any bells
53 \-snaps value number of screen snapshots
54 \-support factor resize support: > 1.0 is blurry, < 1.0 is sharp
55 \-transparent-color color
56 transparent color
57 \-treedepth value color tree depth
58 \-verbose print detailed information about the image
59 \-virtual-pixel method
60 Constant, Edge, Mirror, or Tile
61 \-window id select window with this id or name
62
63Image Operators:
64 \-annotate geometry text
65 annotate the image with text
cristy3ed852e2009-09-05 21:47:34 +000066 \-colors value preferred number of colors in the image
67 \-crop geometry preferred size and location of the cropped image
cristy901f09d2009-10-16 22:56:10 +000068 \-geometry geometry preferred size or location of the image
cristy3ed852e2009-09-05 21:47:34 +000069 \-help print program options
70 \-monochrome transform image to black and white
cristy2146a5f2010-02-01 01:28:35 +000071 \-negate replace each pixel with its complementary color
cristy3ed852e2009-09-05 21:47:34 +000072 \-repage geometry size and location of an image canvas
73 \-quantize colorspace reduce colors in this colorspace
74 \-resize geometry resize the image
75 \-rotate degrees apply Paeth rotation to the image
76 \-strip strip image of all profiles and comments
77 \-thumbnail geometry create a thumbnail of the image
78 \-transparent color make this color transparent within the image
79 \-trim trim image edges
80 \-type type image type
81
82Miscellaneous Options:
83 \-debug events display copious debugging information
84 \-help print program options
85 \-log format format of debugging information
86 \-list type print a list of supported option arguments
87 \-version print version information
88
89By default, 'file' is written in the MIFF image format. To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps). Specify 'file' as '-' for standard input or output.
90.SH SEE ALSO
91ImageMagick(1)
92
93.SH COPYRIGHT
94
cristyb36feb22010-03-26 16:54:37 +000095\fBCopyright (C) 1999-2010 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/local/share/doc/ImageMagick-6.6.1/www/license.html or http://www.imagemagick.org/script/license.php\fP