1maim(1) maim man page maim(1)
2
6 maim - make image
7
9 maim [OPTIONS] [FILEPATH]
10
12 maim (make image) is an utility that takes a screenshot of your desk‐
13 top, and encodes a png or jpg image of it. By default it outputs the
14 encoded image data directly to standard output.
15
17 -h, --help
18 Print help and exit.
19 -v, --version
21 Print version and exit.
22 -x, --xdisplay=hostname:number.screen_number
24 Sets the xdisplay to use.
25 -f, --format=STRING
27 Sets the desired output format, by default maim will attempt to
28 determine the desired output format automatically from the out‐
29 put file. If that fails it defaults to a lossless png format.
30 Currently only supports `png` or `jpg`.
31 -i, --window=WINDOW
33 Sets the desired window to capture, defaults to the root window.
34 Allows for an integer, hex, or `root` for input.
35 -g, --geometry=GEOMETRY
37 Sets the region to capture, uses local coordinates from the
38 given window. So -g 10x30-5+0 would represent the rectangle
39 wxh+x+y where w=10, h=30, x=-5, and y=0. x and y are the upper
40 left location of this rectangle.
41 -w, --parent=WINDOW
43 By default, maim assumes the --geometry values are in respect to
44 the provided --window (or root if not provided). This parameter
45 overrides this behavior by making the geometry be in respect to
46 whatever window you provide to --parent. Allows for an integer,
47 hex, or `root` for input.
48 -B, --capturebackground
50 By default, when capturing a window, maim will ignore anything
51 beneath the specified window. This parameter overrides this and
52 also captures elements underneath the window.
53 -d, --delay=FLOAT
55 Sets the time in seconds to wait before taking a screenshot.
56 Prints a simple message to show how many seconds are left before
57 a screenshot is taken. See --quiet for muting this message.
58 -u, --hidecursor
60 By default maim super-imposes the cursor onto the image, you can
61 disable that behavior with this flag.
62 -m, --quality
64 An integer from 1 to 10 that determines the compression quality.
65 1 is the highest (and lossiest) compression available for the
66 provided format. For example a setting of `1` with png (a loss‐
67 less format) would increase filesize and decrease decoding time.
68 While a setting of `1` on a jpeg would create a pixel mush.
69 -s, --select
71 Enables an interactive selection mode where you may select the
72 desired region or window before a screenshot is captured. Uses
73 the settings below to determine the visuals and settings of
74 slop.
75
77 -b, --bordersize=FLOAT
78 Sets the selection rectangle's thickness.
79 -p, --padding=FLOAT
81 Sets the padding size for the selection, this can be negative.
82 -t, --tolerance=FLOAT
84 How far in pixels the mouse can move after clicking, and still
85 be detected as a normal click instead of a click-and-drag. Set‐
86 ting this to 0 will disable window selections. Alternatively
87 setting it to 9999999 would force a window selection.
88 -c, --color=FLOAT,FLOAT,FLOAT,FLOAT
90 Sets the selection rectangle's color. Supports RGB or RGBA in‐
91 put. Depending on the system's window manager/OpenGL support,
92 the opacity may be ignored.
93 -r, --shader=STRING
95 This sets the vertex shader, and fragment shader combo to use
96 when drawing the final framebuffer to the screen. This obviously
97 only works when OpenGL is enabled. The shaders are loaded from
98 ~/.config/maim. See https://github.com/naelstrof/slop for more
99 information on how to create your own shaders.
100 -n, --nodecorations=INT
102 Sets the level of aggressiveness when trying to remove window
103 decorations. `0' is off, `1' will try lightly to remove decora‐
104 tions, and `2' will recursively descend into the root tree until
105 it gets the deepest available visible child under the mouse. De‐
106 faults to `0'.
107 -l, --highlight
109 Instead of outlining a selection, maim will highlight it in‐
110 stead. This is particularly useful if the color is set to an
111 opacity lower than 1.
112 -D, --nodrag
114 Allows you to click twice to indicate a selection, rather than
115 click-dragging.
116 -q, --quiet
118 Disable any unnecessary cerr output. Any warnings or info simply
119 won't print.
120 -k, --nokeyboard
122 Disables the ability to cancel selections with the keyboard.
123 -o, --noopengl
125 Disables graphics hardware acceleration.
126
128 Screenshot the active window and save it to the clipboard for quick
129 pasting.
130 maim -i $(xdotool getactivewindow) | xclip -selection clipboard -t image/png
132 Save a desktop screenshot with a unique ordered timestamp in the Pic‐
134 tures folder.
135 maim ~/Pictures/$(date +%s).png
137 Save screenshot to the Pictures folder and add it to the clipboard at
139 the same time.
140 maim | tee ~/Pictures/$(date +%s).png | xclip -selection clipboard -t image/png
142 Prompt for a region to screenshot. Add a fancy shadow to it, then save
144 it to shadow.png.
145 maim -s | convert - \( +clone -background black -shadow 80x3+5+5 \) +swap -background none -layers merge +repage shadow.png
147
149 slop(1)
150
152 No known bugs.
153
155 Dalton Nell (naelstrof@gmail.com)
156Linux 2017-03-21 maim(1)