blob: 8d7f7852caef842ec18f4f7ff9d5e8c941bf7a39 [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
cristy7247bba2012-02-05 16:37:27 +00006\fBimport\fP [\fIoptions\fP] \fIoutput-file\fP
cristy3ed852e2009-09-05 21:47:34 +00007.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
Cristy47950f62015-12-18 18:31:40 -050010For more information about the import command, point your browser to file:///usr/local/share/doc/ImageMagick-7/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 \-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
cristye9252c22013-07-30 15:43:21 +000030 \-filter type use this filter when resizing an image
cristy3ed852e2009-09-05 21:47:34 +000031 \-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
cristyf46941c2013-10-06 22:25:41 +000041 \-pause seconds seconds delay between snapshots
cristy3ed852e2009-09-05 21:47:34 +000042 \-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
Cristy9c8659b2017-05-19 20:05:03 -040046 \-repage geometry size and location of an image canvas
cristye9252c22013-07-30 15:43:21 +000047 \-respect-parentheses settings remain in effect until parenthesis boundary
cristy3ed852e2009-09-05 21:47:34 +000048 \-sampling-factor geometry
49 horizontal and vertical sampling factor
50 \-scene value image scene number
51 \-screen select image from root window
52 \-seed value seed a new sequence of pseudo-random numbers
53 \-set property value set an image property
54 \-silent operate silently, i.e. don't ring any bells
55 \-snaps value number of screen snapshots
56 \-support factor resize support: > 1.0 is blurry, < 1.0 is sharp
cristyd9a29192010-10-16 16:49:53 +000057 \-synchronize synchronize image to storage device
58 \-taint declare the image as modified
cristy3ed852e2009-09-05 21:47:34 +000059 \-transparent-color color
60 transparent color
61 \-treedepth value color tree depth
62 \-verbose print detailed information about the image
63 \-virtual-pixel method
64 Constant, Edge, Mirror, or Tile
65 \-window id select window with this id or name
66
67Image Operators:
68 \-annotate geometry text
69 annotate the image with text
cristy3b8891e2014-11-11 15:51:46 +000070 \-channel mask set the image channel mask
cristy3ed852e2009-09-05 21:47:34 +000071 \-colors value preferred number of colors in the image
72 \-crop geometry preferred size and location of the cropped image
cristy901f09d2009-10-16 22:56:10 +000073 \-geometry geometry preferred size or location of the image
cristy3ed852e2009-09-05 21:47:34 +000074 \-help print program options
75 \-monochrome transform image to black and white
cristy2146a5f2010-02-01 01:28:35 +000076 \-negate replace each pixel with its complementary color
cristy3ed852e2009-09-05 21:47:34 +000077 \-quantize colorspace reduce colors in this colorspace
78 \-resize geometry resize the image
79 \-rotate degrees apply Paeth rotation to the image
80 \-strip strip image of all profiles and comments
81 \-thumbnail geometry create a thumbnail of the image
82 \-transparent color make this color transparent within the image
83 \-trim trim image edges
84 \-type type image type
85
86Miscellaneous Options:
87 \-debug events display copious debugging information
88 \-help print program options
89 \-log format format of debugging information
90 \-list type print a list of supported option arguments
91 \-version print version information
92
Cristy971aac42015-10-17 09:31:58 -040093By default, 'file' is written in the Postscript 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.
cristy3ed852e2009-09-05 21:47:34 +000094.SH SEE ALSO
95ImageMagick(1)
96
97.SH COPYRIGHT
98
Cristy5dd59b82017-03-11 13:01:43 -050099\fBCopyright (C) 1999-2017 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/local/share/doc/ImageMagick-7/www/license.html or http://www.imagemagick.org/script/license.php\fP