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, jpg, bmp or webp image of it. By default it
14 outputs the 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`, `jpg`, `bmp`, and `webp`.
31 -i, --window=WINDOW
33 By default, maim captures the root window. This parameter over‐
34 rides this and sets the desired window to capture. Allows for an
35 integer, hex, or `root` for input.
36 -g, --geometry=GEOMETRY
38 Sets the region to capture, uses local coordinates from the
39 given window. So -g 10x30-5+0 would represent the rectangle
40 wxh+x+y where w=10, h=30, x=-5, and y=0. x and y are the upper
41 left location of this rectangle.
42 -w, --parent=WINDOW
44 By default, maim assumes the --geometry values are in respect to
45 the provided --window (or root if not provided). This parameter
46 overrides this behavior by making the geometry be in respect to
47 whatever window you provide to --parent. Allows for an integer,
48 hex, or `root` for input.
49 -B, --capturebackground
51 By default, when capturing a window, maim will ignore anything
52 beneath the specified window. This parameter overrides this and
53 also captures elements underneath the window.
54 -d, --delay=FLOAT
56 Sets the time in seconds to wait before taking a screenshot.
57 Prints a simple message to show how many seconds are left before
58 a screenshot is taken. See --quiet for muting this message.
59 -u, --hidecursor
61 By default maim super-imposes the cursor onto the image, you can
62 disable that behavior with this flag.
63 -m, --quality
65 An integer from 1 to 10 that determines the compression quality.
66 For lossy formats (jpg and webp), lower settings will produce
67 smaller files with lower quality, while higher settings will in‐
68 crease quality at the cost of higher file size. A quality of 10
69 is lossless for webp. For png, lower settings will compress
70 faster and produce larger files, while higher settings will com‐
71 press slower, but produce smaller files. No effect on bmp im‐
72 ages.
73 -s, --select
75 Enables an interactive selection mode where you may select the
76 desired region or window before a screenshot is captured. Uses
77 the settings below to determine the visuals and settings of
78 slop.
79
81 -b, --bordersize=FLOAT
82 Sets the selection rectangle's thickness.
83 -p, --padding=FLOAT
85 Sets the padding size for the selection, this can be negative.
86 -t, --tolerance=FLOAT
88 How far in pixels the mouse can move after clicking, and still
89 be detected as a normal click instead of a click-and-drag. Set‐
90 ting this to 0 will disable window selections. Alternatively
91 setting it to 9999999 would force a window selection.
92 -c, --color=FLOAT,FLOAT,FLOAT,FLOAT
94 Sets the selection rectangle's color. Supports RGB or RGBA in‐
95 put. Depending on the system's window manager/OpenGL support,
96 the opacity may be ignored.
97 -r, --shader=STRING
99 This sets the vertex shader, and fragment shader combo to use
100 when drawing the final framebuffer to the screen. This obviously
101 only works when OpenGL is enabled. The shaders are loaded from
102 ~/.config/maim. See https://github.com/naelstrof/slop for more
103 information on how to create your own shaders.
104 -n, --nodecorations=INT
106 Sets the level of aggressiveness when trying to remove window
107 decorations. `0' is off, `1' will try lightly to remove decora‐
108 tions, and `2' will recursively descend into the root tree until
109 it gets the deepest available visible child under the mouse. De‐
110 faults to `0'.
111 -l, --highlight
113 Instead of outlining a selection, maim will highlight it in‐
114 stead. This is particularly useful if the color is set to an
115 opacity lower than 1.
116 -D, --nodrag
118 Allows you to click twice to indicate a selection, rather than
119 click-dragging.
120 -q, --quiet
122 Disable any unnecessary cerr output. Any warnings or info simply
123 won't print.
124 -k, --nokeyboard
126 Disables the ability to cancel selections with the keyboard.
127 -o, --noopengl
129 Disables graphics hardware acceleration.
130
132 Screenshot the active window and save it to the clipboard for quick
133 pasting.
134 maim -i $(xdotool getactivewindow) | xclip -selection clipboard -t image/png
136 Save a desktop screenshot with a unique ordered timestamp in the Pic‐
138 tures folder.
139 maim ~/Pictures/$(date +%s).png
141 Save screenshot to the Pictures folder and add it to the clipboard at
143 the same time.
144 maim | tee ~/Pictures/$(date +%s).png | xclip -selection clipboard -t image/png
146 Prompt for a region to screenshot. Add a fancy shadow to it, then save
148 it to shadow.png.
149 maim -s | convert - \( +clone -background black -shadow 80x3+5+5 \) +swap -background none -layers merge +repage shadow.png
151
153 slop(1)
154
156 No known bugs.
157
159 Dalton Nell (naelstrof@gmail.com)
160Linux 2017-03-21 maim(1)