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
|
slurp(1)
# NAME
slurp - select a region in a Wayland compositor
# SYNOPSIS
*slurp* [options...]
# DESCRIPTION
slurp is a command-line utility to select a region from Wayland compositors
which support the layer-shell protocol. It lets the user hold the pointer to
select, or click to cancel the selection.
If the standard input is not a TTY or the -r option is used, slurp will read a
list of predefined rectangles for quick selection. Each line must be in the form
"<x>,<y> <width>x<height> [label]". The label is optional and can be any string
that doesn't contain newlines. It can be accessed using the "%l" sequence in a
format string.
If the _Esc_ key is pressed, selection is cancelled. If the _Space_ key is
held, the selection is moved instead of being resized.
# OPTIONS
*-h*
Show help message and quit.
*-d*
Display dimensions of selection.
*-b* _color_
Set background color. See *COLORS* for more detail.
*-c* _color_
Set border color. See *COLORS* for more detail.
*-s* _color_
Set selection color. See *COLORS* for more detail.
*-B* _color_
Set color for highlighting predefined rectangles from standard input when not
selected.
*-F* _font family_
Set the font family name when displaying the dimensions box. Only useful
when combined with the -d option. The available font family names guaranteed
to work are the standard generic CSS2 options: serif, sans-serif,
monospace, cursive and fantasy. It defaults to the sans-serif family name.
*-w* _weight_
Set border weight.
*-f* _format_
Set format. See *FORMAT* for more detail.
*-p*
Select a single pixel instead of a rectangle. This mode ignores any
predefined rectangles read from the standard input.
*-o*
Add predefined rectangles for all outputs, as if provided on standard input.
The label will be the name of the output.
*-r*
Require the user to select one of the predefined rectangles. These can come
from standard input, if *-o* is used, the rectangles of all display outputs.
This option conflicts with *-p*.
*-a* _width_:_height_
Force selections to have the given aspect ratio. This constraint is not
applied to the predefined rectangles specified using *-o*.
# COLORS
Colors may be specified in #RRGGBB or #RRGGBBAA format. The # is optional.
# FORMAT
Interpreted sequences are:
%x The x-coordinate of the selection
%y The y-coordinate of the selection
%w The width of the selection
%h The height of the selection
%X The x-coordinate of the selection with coordinates relative to the output
containing the top left corner.
%Y The y-coordinate of the selection with coordinates relative to the output
containing the top left corner.
%W The width of the selection cropped to the output containing the top left
corner.
%H The height of the selection cropped to the output containing the top left
corner.
%l Label included with region from stdin
%o The name of the output containing the top left corner, or "<unknown>" if
not known
The default format is "%x,%y %wx%h\\n".
# KEYBOARD CONTROLS
The following keyboard actions can be used during selection:
*Escape* Cancel the selection and exit slurp
*Space* If currently making a selection, while space is held down, move the
entire selection rather than change the selection's size as you move the
pointer.
*Shift* Experimental. If the *-a* option wasn't specified, then set the aspect
ratio to 1:1 while shift is held down, releasing it restores the un-constrained
aspect ratio. *Note:* This behavior may change in the future depending on
feedback.
# AUTHORS
Maintained by Simon Ser <contact@emersion.fr>, who is assisted by other
open-source contributors. For more information about slurp development, see
https://github.com/emersion/slurp.
|
