slurp - Man Page
select a region in a Wayland compositor
Description
slurp [options...]
Synopsis
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.
- -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.
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
%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".
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.