.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "slurp" "1" "2023-12-16"
.P
.SH NAME
.P
slurp - select a region in a Wayland compositor
.P
.SH SYNOPSIS
.P
\fBslurp\fR [options.\&.\&.\&]
.P
.SH DESCRIPTION
.P
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.\&
.P
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.\&
.P
If the \fIEsc\fR key is pressed, selection is cancelled.\& If the \fISpace\fR key is
held, the selection is moved instead of being resized.\&
.P
.SH OPTIONS
.P
\fB-h\fR
.RS 4
Show help message and quit.\&
.P
.RE
\fB-d\fR
.RS 4
Display dimensions of selection.\&
.P
.RE
\fB-b\fR \fIcolor\fR
.RS 4
Set background color.\& See \fBCOLORS\fR for more detail.\&
.P
.RE
\fB-c\fR \fIcolor\fR
.RS 4
Set border color.\& See \fBCOLORS\fR for more detail.\&
.P
.RE
\fB-s\fR \fIcolor\fR
.RS 4
Set selection color.\& See \fBCOLORS\fR for more detail.\&
.P
.RE
\fB-B\fR \fIcolor\fR
.RS 4
Set color for highlighting predefined rectangles from standard input when not
selected.\&
.P
.RE
\fB-F\fR \fIfont family\fR
.RS 4
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.\&
.P
.RE
\fB-w\fR \fIweight\fR
.RS 4
Set border weight.\&
.P
.RE
\fB-f\fR \fIformat\fR
.RS 4
Set format.\& See \fBFORMAT\fR for more detail.\&
.P
.RE
\fB-p\fR
.RS 4
Select a single pixel instead of a rectangle.\& This mode ignores any
predefined rectangles read from the standard input.\&
.P
.RE
\fB-o\fR
.RS 4
Add predefined rectangles for all outputs, as if provided on standard input.\&
The label will be the name of the output.\&
.P
.RE
\fB-r\fR
.RS 4
Require the user to select one of the predefined rectangles.\& These can come
from standard input, if \fB-o\fR is used, the rectangles of all display outputs.\&
This option conflicts with \fB-p\fR.\&
.P
.RE
\fB-a\fR \fIwidth\fR:\fIheight\fR
.RS 4
Force selections to have the given aspect ratio.\& This constraint is not
applied to the predefined rectangles specified using \fB-o\fR.\&
.P
.RE
.SH COLORS
.P
Colors may be specified in #RRGGBB or #RRGGBBAA format.\& The # is optional.\&
.P
.SH FORMAT
.P
Interpreted sequences are:
.P
%x	The x-coordinate of the selection
.P
%y	The y-coordinate of the selection
.P
%w	The width of the selection
.P
%h	The height of the selection
.P
%X	The x-coordinate of the selection with coordinates relative to the output
.RS 4
containing the top left corner.\&
.P
.RE
%Y	The y-coordinate of the selection with coordinates relative to the output
.RS 4
containing the top left corner.\&
.P
.RE
%W	The width of the selection cropped to the output containing the top left
.RS 4
corner.\&
.P
.RE
%H	The height of the selection cropped to the output containing the top left
.RS 4
corner.\&
.P
.RE
%l	Label included with region from stdin
.P
%o	The name of the output containing the top left corner, or "<unknown>" if
.RS 4
not known
.P
.RE
The default format is "%x,%y %wx%h\\n".\&
.P
.SH KEYBOARD CONTROLS
.P
The following keyboard actions can be used during selection:
.P
\fBEscape\fR	Cancel the selection and exit slurp
.P
\fBSpace\fR	 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.\&
.P
\fBShift\fR	Experimental.\& If the \fB-a\fR 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.\& \fBNote:\fR This behavior may change in the future depending on
feedback.\&
.P
.P
.SH AUTHORS
.P
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.\&