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

NAME

6       slurp - select a region in a Wayland compositor
7

DESCRIPTION

9       slurp [options...]
10

SYNOPSIS

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       -w weight
46           Set border weight.
47
48       -f format
49           Set format. See FORMAT for more detail.
50
51       -p
52           Select a single pixel instead of a rectangle. This mode ignores any
53           predefined rectangles read from the standard input.
54
55       -o
56           Add predefined rectangles for all outputs, as if provided on stan‐
57           dard input. The label will be the name of the output.
58
59       -r
60           Require the user to select one of the predefined rectangles. These
61           can come from standard input, if -o is used, the rectangles of all
62           display outputs. This option conflicts with -p.
63

COLORS

65       Colors may be specified in #RRGGBB or #RRGGBBAA format. The # is op‐
66       tional.
67

FORMAT

69       Interpreted sequences are:
70
71       %x   The x-coordinate of the selection
72
73       %y   The y-coordinate of the selection
74
75       %w   The width of the selection
76
77       %h   The height of the selection
78
79       %l   Label included with region from stdin
80
81       %o   The name of the output containing the top left corner, or "<un‐
82       known>" if
83           not known
84
85       The default format is "%x,%y %wx%h\n".
86

AUTHORS

88       Maintained by Simon Ser <contact@emersion.fr>, who is assisted by other
89       open-source contributors. For more information about slurp development,
90       see https://github.com/emersion/slurp.
91
92
93
94                                  2022-01-22                          slurp(1)
Impressum