grimshot - Man Page
a helper for screenshots within sway
Synopsis
grimshot [--notify] [--cursor] (copy|save) [TARGET] [FILE]
grimshot check
grimshot usage
Options
- --notify
Show notifications to the user that a screenshot has been taken.
- --cursor
Include cursors in the screenshot.
- save
Save the screenshot into a regular file. Grimshot will write image files to XDG_SCREENSHOTS_DIR if this is set (or defined in user-dirs.dir), or otherwise fall back to XDG_PICTURES_DIR. Set FILE to '-' to pipe the output to STDOUT.
- copy
Copy the screenshot data (as image/png) into the clipboard.
Description
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.
Examples
An example usage pattern is to add these bindings to your sway config:
# 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
Targets
grimshot can capture the following named targets:
- active
Captures the currently active window.
- screen
Captures the entire screen. This includes all visible outputs.
- area
Allows manually selecting a rectangular region, and captures that.
- window
Allows manually selecting a single window (by clicking on it), and captures it.
- output
Captures the currently active output.
Output
Grimshot will print the filename of the captured screenshot to stdout if called with the save subcommand.