.\" Generated by scdoc 1.11.3
.\" 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 "grimshot" "1" "2024-04-26"
.PP
.SH NAME
.PP
grimshot - a helper for screenshots within sway
.PP
.SH SYNOPSIS
.PP
\fBgrimshot\fR [--notify] [--cursor] [--wait N] (copy|save) [TARGET] [FILE]
.br
\fBgrimshot\fR check
.br
\fBgrimshot\fR usage
.PP
.SH OPTIONS
.PP
\fB--notify\fR
.RS 4
Show notifications to the user that a screenshot has been taken.\&
.PP
.RE
\fB--cursor\fR
.RS 4
Include cursors in the screenshot.\&
.PP
.RE
\fB--wait N\fR
.RS 4
Wait for N seconds before taking a screenshot.\& Waits after any
manual selection is made.\& Recommended to combine with --notify in
order to know when the screenshot has been taken.\&
.PP
.RE
\fBsave\fR
.RS 4
Save the screenshot into a regular file.\& Grimshot will write image
files to \fBXDG_SCREENSHOTS_DIR\fR if this is set (or defined
in \fBuser-dirs.\&dir\fR), or otherwise fall back to \fBXDG_PICTURES_DIR\fR.\&
Set FILE to '\&-'\& to pipe the output to STDOUT.\&
.PP
.RE
\fBcopy\fR
.RS 4
Copy the screenshot data (as image/png) into the clipboard.\&
.PP
.RE
\fB\fRsavecopy\fB\fR
.RS 4
Save the screenshot into a regular file (see \fIsave\fR documentation) and
copy the screenshot data into the clipboard (see \fIcopy\fR documentation).\&
.PP
.RE
.SH DESCRIPTION
.PP
Grimshot is an easy-to-use screenshot utility for sway.\& It provides a
convenient interface over grim, slurp and jq, and supports storing the
screenshot either directly to the clipboard using wl-copy or to a file.\&
.PP
.SH EXAMPLES
.PP
An example usage pattern is to add these bindings to your sway config:
.PP
.nf
.RS 4
# Screenshots:
# Super+P: Current window
# Super+Shift+p: Select area
# Super+Alt+p Current output
# Super+Ctrl+p Select a window

bindsym Mod4+p       exec grimshot save active
bindsym Mod4+Shift+p exec grimshot save area
bindsym Mod4+Mod1+p  exec grimshot save output
bindsym Mod4+Ctrl+p  exec grimshot save window
.fi
.RE
.PP
.SH TARGETS
.PP
grimshot can capture the following named targets:
.PP
\fIactive\fR
.RS 4
Captures the currently active window.\&
.PP
.RE
\fIscreen\fR
.RS 4
Captures the entire screen.\& This includes all visible outputs.\&
.PP
.RE
\fIarea\fR
.RS 4
Allows manually selecting a rectangular region, and captures that.\&
.PP
.RE
\fIwindow\fR
.RS 4
Allows manually selecting a single window (by clicking on it), and
captures it.\&
.PP
.RE
\fIoutput\fR
.RS 4
Captures the currently active output.\&
.PP
.RE
\fIanything\fR
.RS 4
Allows manually selecting a single window (by clicking on it), an output (by
clicking outside of all windows, e.\&g.\& on the status bar), or an area (by
using click and drag).\&
.PP
.RE
.SH OUTPUT
.PP
Grimshot will print the filename of the captured screenshot to stdout if called
with the \fIsave\fR or \fIsavecopy\fR subcommands.\&
.PP
.SH SEE ALSO
.PP
\fBgrim\fR(1)