|
|
|
|
.\" 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 "grimshot" "1" "2022-03-31"
|
|
|
|
|
.P
|
|
|
|
|
.SH NAME
|
|
|
|
|
.P
|
|
|
|
|
grimshot - a helper for screenshots within sway
|
|
|
|
|
.P
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.P
|
|
|
|
|
\fBgrimshot\fR [--notify] [--cursor] (copy|save) [TARGET] [FILE]
|
|
|
|
|
.br
|
|
|
|
|
\fBgrimshot\fR check
|
|
|
|
|
.br
|
|
|
|
|
\fBgrimshot\fR usage
|
|
|
|
|
.P
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.P
|
|
|
|
|
\fB--notify\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Show notifications to the user that a screenshot has been taken.\&
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
|
|
|
|
\fB--cursor\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Include cursors in the screenshot.\&
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
|
|
|
|
\fBsave\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Save the screenshot into a regular file.\& Grimshot will write images
|
|
|
|
|
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.\&
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
|
|
|
|
\fBcopy\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Copy the screenshot data (as image/png) into the clipboard.\&
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.P
|
|
|
|
|
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.\&
|
|
|
|
|
.P
|
|
|
|
|
.SH EXAMPLES
|
|
|
|
|
.P
|
|
|
|
|
An example usage pattern is to add these bindings to your sway config:
|
|
|
|
|
.P
|
|
|
|
|
.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
|
|
|
|
|
.P
|
|
|
|
|
.SH TARGETS
|
|
|
|
|
.P
|
|
|
|
|
grimshot can capture the following named targets:
|
|
|
|
|
.P
|
|
|
|
|
\fIactive\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Captures the currently active window.\&
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
|
|
|
|
\fIscreen\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Captures the entire screen.\& This includes all visible outputs.\&
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
|
|
|
|
\fIarea\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Allows manually selecting a rectangular region, and captures that.\&
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
|
|
|
|
\fIwindow\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Allows manually selecting a single window (by clicking on it), and
|
|
|
|
|
captures it.\&
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
|
|
|
|
\fIoutput\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Captures the currently active output.\&
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
|
|
|
|
.SH OUTPUT
|
|
|
|
|
.P
|
|
|
|
|
Grimshot will print the filename of the captured screenshot to stdout if called
|
|
|
|
|
with the \fIsave\fR subcommand.\&
|
|
|
|
|
.P
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.P
|
|
|
|
|
\fBgrim\fR(1)
|
