1slurp(1)                    General Commands Manual                   slurp(1)
2
3
4

NAME

6       slurp - select a region in a Wayland compositor
7

SYNOPSIS

9       slurp [options...]
10

DESCRIPTION

12       slurp is a command-line utility to select a region from Wayland compos‐
13       itors which support the layer-shell protocol. It lets the user hold the
14       pointer to select, or click to cancel the selection.
15
16       If the standard input is not a TTY or the -r option is used, slurp will
17       read a list of predefined rectangles for quick selection. Each line
18       must be in the form "<x>,<y> <width>x<height> [label]". The label is
19       optional and can be any string that doesn't contain newlines. It can be
20       accessed using the "%l" sequence in a format string.
21
22       If the Esc key is pressed, selection is cancelled. If the Space key is
23       held, the selection is moved instead of being resized.
24

OPTIONS

26       -h
27           Show help message and quit.
28
29       -d
30           Display dimensions of selection.
31
32       -b color
33           Set background color. See COLORS for more detail.
34
35       -c color
36           Set border color. See COLORS for more detail.
37
38       -s color
39           Set selection color. See COLORS for more detail.
40
41       -B color
42           Set color for highlighting predefined rectangles from standard in‐
43           put when not selected.
44
45       -F font family
46           Set the font family name when displaying the dimensions box. Only
47           useful when combined with the -d option. The available font family
48           names guaranteed to work are the standard generic CSS2 options:
49           serif, sans-serif, monospace, cursive and fantasy. It defaults to
50           the sans-serif family name.
51
52       -w weight
53           Set border weight.
54
55       -f format
56           Set format. See FORMAT for more detail.
57
58       -p
59           Select a single pixel instead of a rectangle. This mode ignores any
60           predefined rectangles read from the standard input.
61
62       -o
63           Add predefined rectangles for all outputs, as if provided on stan‐
64           dard input. The label will be the name of the output.
65
66       -r
67           Require the user to select one of the predefined rectangles. These
68           can come from standard input, if -o is used, the rectangles of all
69           display outputs. This option conflicts with -p.
70
71       -a width:height
72           Force selections to have the given aspect ratio. This constraint is
73           not applied to the predefined rectangles specified using -o.
74

COLORS

76       Colors may be specified in #RRGGBB or #RRGGBBAA format. The # is op‐
77       tional.
78

FORMAT

80       Interpreted sequences are:
81
82       %x   The x-coordinate of the selection
83
84       %y   The y-coordinate of the selection
85
86       %w   The width of the selection
87
88       %h   The height of the selection
89
90       %X   The x-coordinate of the selection with coordinates relative to the
91       output
92           containing the top left corner.
93
94       %Y   The y-coordinate of the selection with coordinates relative to the
95       output
96           containing the top left corner.
97
98       %W   The width of the selection cropped to the output containing the
99       top left
100           corner.
101
102       %H   The height of the selection cropped to the output containing the
103       top left
104           corner.
105
106       %l   Label included with region from stdin
107
108       %o   The name of the output containing the top left corner, or "<un‐
109       known>" if
110           not known
111
112       The default format is "%x,%y %wx%h\n".
113

KEYBOARD CONTROLS

115       The following keyboard actions can be used during selection:
116
117       Escape    Cancel the selection and exit slurp
118
119       Space      If currently making a selection, while space is held down,
120       move the entire selection rather than change the selection's size as
121       you move the pointer.
122
123       Shift     Experimental. If the -a option wasn't specified, then set the
124       aspect ratio to 1:1 while shift is held down, releasing it restores the
125       un-constrained aspect ratio. Note: This behavior may change in the fu‐
126       ture depending on feedback.
127

AUTHORS

129       Maintained by Simon Ser <contact@emersion.fr>, who is assisted by other
130       open-source contributors. For more information about slurp development,
131       see https://github.com/emersion/slurp.
132
133
134
135                                  2022-12-10                          slurp(1)
Impressum