blob: 854630e6438d1b432f332b110c91581e3af2d9cc [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
10For more information about the import command, point your browser to file://@DOCUMENTATION_PATH@/www/import.html or http://www.imagemagick.org/script/import.php.
11.SH DESCRIPTION
12Image Settings:
13 \-adjoin join images into a single multi-image file
14 \-channel type apply option to select image channels
15 \-colorspace type alternate image colorspace
16 \-comment string annotate image with comment
17 \-compress type type of pixel compression when writing the image
18 \-define format:option
19 define one or more image format options
20 \-density geometry horizontal and vertical density of the image
21 \-depth value image depth
22 \-descend obtain image by descending window hierarchy
23 \-display server X server to contact
24 \-dispose method layer disposal method
25 \-dither method apply error diffusion to image
26 \-delay value display the next image after pausing
27 \-encipher filename convert plain pixels to cipher pixels
28 \-endian type endianness (MSB or LSB) of the image
29 \-encoding type text encoding type
30 \-format "string" output formatted image characteristics
31 \-frame include window manager frame
32 \-gravity direction which direction to gravitate towards
33 \-identify identify the format and characteristics of the image
34 \-interlace type None, Line, Plane, or Partition
35 \-interpolate method pixel color interpolation method
36 \-label string assign a label to an image
37 \-limit type value Area, Disk, Map, or Memory resource limit
38 \-monitor monitor progress
39 \-page geometry size and location of an image canvas
40 \-pause value seconds delay between snapshots
41 \-pointsize value font point size
42 \-quality value JPEG/MIFF/PNG compression level
43 \-quiet suppress all warning messages
44 \-regard-warnings pay attention to warning messages
45 \-sampling-factor geometry
46 horizontal and vertical sampling factor
47 \-scene value image scene number
48 \-screen select image from root window
49 \-seed value seed a new sequence of pseudo-random numbers
50 \-set property value set an image property
51 \-silent operate silently, i.e. don't ring any bells
52 \-snaps value number of screen snapshots
53 \-support factor resize support: > 1.0 is blurry, < 1.0 is sharp
54 \-transparent-color color
55 transparent color
56 \-treedepth value color tree depth
57 \-verbose print detailed information about the image
58 \-virtual-pixel method
59 Constant, Edge, Mirror, or Tile
60 \-window id select window with this id or name
61
62Image Operators:
63 \-annotate geometry text
64 annotate the image with text
65 \-border include image borders in the output image
66 \-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
71 \-negate replace every pixel with its complementary color
72 \-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
95\fBCopyright (C) 1999-2009 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file://@DOCUMENTATION_PATH@/www/license.html or http://www.imagemagick.org/script/license.php\fP