summaryrefslogtreecommitdiff
path: root/utilities/import.1.in
blob: d2e37690d12d90fc5a52260c73557e335f19f5aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
.TH import 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
.SH NAME
import \- 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. The window to capture is selected by clicking the desired window or a program option.
.SH SYNOPSIS
.TP
\fBimport\fP [\fIoptions\fP] \fIoutput-file\fP
.SH OVERVIEW
The \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.

For more information about the import command, point your browser to file://@DOCUMENTATION_PATH@/www/import.html or http://imagemagick.org/script/import.php.
.SH DESCRIPTION
Image Settings:
  \-adjoin              join images into a single multi-image file
  \-border              include window border in the output image
  \-colorspace type     alternate image colorspace
  \-comment string      annotate image with comment
  \-compress type       type of pixel compression when writing the image
  \-define format:option
                       define one or more image format options
  \-density geometry    horizontal and vertical density of the image
  \-depth value         image depth
  \-descend             obtain image by descending window hierarchy
  \-display server      X server to contact
  \-dispose method      layer disposal method
  \-dither method       apply error diffusion to image
  \-delay value         display the next image after pausing
  \-encipher filename   convert plain pixels to cipher pixels
  \-endian type         endianness (MSB or LSB) of the image
  \-encoding type       text encoding type
  \-filter type         use this filter when resizing an image
  \-format "string"     output formatted image characteristics
  \-frame               include window manager frame
  \-gravity direction   which direction to gravitate towards
  \-identify            identify the format and characteristics of the image
  \-interlace type      None, Line, Plane, or Partition
  \-interpolate method  pixel color interpolation method
  \-label string        assign a label to an image
  \-limit type value    Area, Disk, Map, or Memory resource limit
  \-monitor             monitor progress
  \-page geometry       size and location of an image canvas
  \-pause seconds       seconds delay between snapshots
  \-pointsize value     font point size
  \-quality value       JPEG/MIFF/PNG compression level
  \-quiet               suppress all warning messages
  \-regard-warnings     pay attention to warning messages
  \-repage geometry     size and location of an image canvas
  \-respect-parentheses settings remain in effect until parenthesis boundary
  \-sampling-factor geometry
                       horizontal and vertical sampling factor
  \-scene value         image scene number
  \-screen              select image from root window
  \-seed value          seed a new sequence of pseudo-random numbers
  \-set property value  set an image property
  \-silent              operate silently, i.e. don't ring any bells 
  \-snaps value         number of screen snapshots
  \-support factor      resize support: > 1.0 is blurry, < 1.0 is sharp
  \-synchronize         synchronize image to storage device
  \-taint               declare the image as modified
  \-transparent-color color
                       transparent color
  \-treedepth value     color tree depth
  \-verbose             print detailed information about the image
  \-virtual-pixel method
                       Constant, Edge, Mirror, or Tile
  \-window id           select window with this id or name
                        root selects the whole screen

Image Operators:
  \-annotate geometry text
                       annotate the image with text
  \-channel mask        set the image channel mask
  \-colors value        preferred number of colors in the image
  \-crop geometry       preferred size and location of the cropped image
  \-geometry geometry   preferred size or location of the image
  \-help                print program options
  \-monochrome          transform image to black and white
  \-negate              replace each pixel with its complementary color 
  \-quantize colorspace reduce colors in this colorspace
  \-resize geometry     resize the image
  \-rotate degrees      apply Paeth rotation to the image
  \-strip               strip image of all profiles and comments
  \-thumbnail geometry  create a thumbnail of the image
  \-transparent color   make this color transparent within the image
  \-trim                trim image edges
  \-type type           image type

Miscellaneous Options:
  \-debug events        display copious debugging information
  \-help                print program options
  \-log format          format of debugging information
  \-list type           print a list of supported option arguments
  \-version             print version information

By 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.
.SH SEE ALSO
ImageMagick(1)

.SH COPYRIGHT

\fBCopyright (C) 1999-2018 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file://@DOCUMENTATION_PATH@/www/license.html or http://imagemagick.org/script/license.php\fP