grimshot(1)

1grimshot(1)                 General Commands Manual                grimshot(1)
2
3
4

NAME

6       grimshot - a helper for screenshots within sway
7

SYNOPSIS

9       grimshot [--notify] (copy|save) [TARGET] [FILE]
10       grimshot check
11       grimshot usage
12

OPTIONS

14       --notify
15           Show notifications to the user that a screenshot has been taken.
16
17       save
18           Save the screenshot into a regular file. Grimshot will write images
19           files to XDG_SCREENSHOTS_DIR if this is set (or defined in user-
20           dirs.dir), or otherwise fall back to XDG_PICTURES_DIR. Set FILE to
21           '-' to pipe the output to STDOUT.
22
23       copy
24           Copy the screenshot data (as image/png) into the clipboard.
25

DESCRIPTION

27       Grimshot is an easy-to-use screenshot utility for sway. It provides a
28       convenient interface over grim, slurp and jq, and supports storing the
29       screenshot either directly to the clipboard using wl-copy or to a file.
30

EXAMPLES

32       An example usage pattern is to add these bindings to your sway config:
33
34           # Screenshots:
35           # Super+P: Current window
36           # Super+Shift+p: Select area
37           # Super+Alt+p Current output
38           # Super+Ctrl+p Select a window
39
40           bindsym Mod4+p       exec grimshot save active
41           bindsym Mod4+Shift+p exec grimshot save area
42           bindsym Mod4+Mod1+p  exec grimshot save output
43           bindsym Mod4+Ctrl+p  exec grimshot save window
44

TARGETS

46       grimshot can capture the following named targets:
47
48       active
49           Captures the currently active window.
50
51       screen
52           Captures the entire screen. This includes all visible outputs.
53
54       area
55           Allows manually selecting a rectangular region, and captures that.
56
57       window
58           Allows manually selecting a single window (by clicking on it), and
59           captures it.
60
61       output
62           Captures the currently active output.
63

OUTPUT

65       Grimshot will print the filename of the captured screenshot to stdout
66       if called with the save subcommand.
67