summaryrefslogtreecommitdiff
path: root/man-src/maim.1
blob: 10cfe7b8dddbcd4bd1c2e0029906dc3fc07db088 (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "MAIM" "1" "December 2014" "" ""
.
.SH "NAME"
\fBmaim\fR \- Takes screenshots
.
.SH "SYNOPSIS"
\fBmaim\fR [options] [file]
.
.SH "DESCRIPTION"
maim (MAke IMage) is a utility that takes screenshots of your desktop using imlib2\. It\'s meant to overcome shortcomings of scrot and performs better than scrot in several ways\.
.
.SH "OPTIONS"
.
.TP
\fB\-\-help\fR
Print help and exit
.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version and exit
.
.SS "Options"
.
.TP
\fB\-\-xdisplay=hostname:number\.screen_number\fR
Sets the x display\.
.
.TP
\fB\-s\fR, \fB\-\-select\fR
Enables user region selection\. Requires slop to be installed\. (default=off)
.
.TP
\fB\-x\fR, \fB\-\-x=INT\fR
Sets the x coordinate for taking an image
.
.TP
\fB\-y\fR, \fB\-\-y=INT\fR
Sets the y coordinate for taking an image
.
.TP
\fB\-w\fR, \fB\-\-w=INT\fR
Sets the width for taking an image
.
.TP
\fB\-h\fR, \fB\-\-h=INT\fR
Sets the height for taking an image
.
.TP
\fB\-g\fR, \fB\-\-geometry=WxH+X+Y\fR
Set the region to capture
.
.TP
\fB\-d\fR, \fB\-\-delay=FLOAT\fR
Set the amount of time to wait before taking an image\. (default=`0\.0\')
.
.TP
\fB\-i\fR, \fB\-\-windowid=INT\fR
Set the window to capture\. Defaults to the root window id\.
.
.TP
\fB\-\-localize\fR
Localizes given geometry to the given window\. So \fBmaim \-i $ID \-g 100x100+0+0 \-\-localize\fR would screenshot the top\-left 100x100 pixels of the given window, rather than the top\-left 100x100 pixels of the root window\. (default=off)
.
.TP
\fB\-\-hidecursor\fR
Prevents the system cursor from showing up in screenshots\. (default=off)
.
.TP
\fB\-m\fR, \fB\-\-mask=STRING\fR
Masks off\-screen pixels so they don\'t show up in screenshots\. (possible values="auto", "off", "on" default=`auto\')
.
.SS "SLOP OPTIONS"
.
.TP
\fB\-\-nokeyboard\fR
Disables the ability to cancel selections with the keyboard\. (default=off)
.
.TP
\fB\-b\fR, \fB\-\-bordersize=INT\fR
Set the selection rectangle\'s thickness\. Does nothing when \fB\-\-highlight\fR is enabled\. (default=`5\')
.
.TP
\fB\-p\fR, \fB\-\-padding=INT\fR
Set the padding size of the selection\. Can be negative\. (default=`0\')
.
.TP
\fB\-t\fR, \fB\-\-tolerance=INT\fR
How far in pixels the mouse can move after clicking and still be detected as a normal click instead of a click and drag\. Setting this to 0 will disable window selections\. (default=`2\')
.
.TP
\fB\-\-gracetime=FLOAT\fR
Set the amount of time before slop will check for keyboard cancellations in seconds\. (default=`0\.4\')
.
.TP
\fB\-c\fR, \fB\-\-color=FLOAT,FLOAT,FLOAT,FLOAT\fR
Set the selection rectangle\'s color\. Supports RGB or RGBA values\. (default=`0\.5,0\.5,0\.5,1\')
.
.TP
\fB\-n\fR, \fB\-\-nodecorations\fR
Attempt to select child windows in order to avoid window decorations\. (default=off)
.
.TP
\fB\-\-min=INT\fR
Set the minimum output of width or height values\. This is useful to avoid outputting 0\. Setting min and max to the same value disables drag selections\. (default=`0\')
.
.TP
\fB\-\-max=INT\fR
Set the maximum output of width or height values\. Setting min and max to the same value disables drag selections\. (default=`0\')
.
.TP
\fB\-l\fR, \fB\-\-highlight\fR
Instead of outlining selections, slop highlights it\. This is only useful when \fB\-\-color\fR is set to a transparent color\. (default=off)
.
.SH "EXAMPLES"
Screenshot the active window
.
.IP "" 4
.
.nf

$ maim \-i $(xdotool getactivewindow)
.
.fi
.
.IP "" 0
.
.P
Prompt a transparent red selection to screenshot\.
.
.IP "" 4
.
.nf

$ maim \-s \-c 1,0,0,0\.6
.
.fi
.
.IP "" 0
.
.P
Save a dated screenshot\.
.
.IP "" 4
.
.nf

$ maim ~/$(date +%F\-%T)\.png
.
.fi
.
.IP "" 0
.
.SH "COPYRIGHT"
Copyright (C) 2014 Dalton Nell \fB<naelstrof@gmail\.com>\fR, Maim Contributors \fB<http://github\.com/naelstrof/maim/graphs/contributors>\fR\.