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] [--cursor] (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       --cursor
18           Include cursors in the screenshot.
19
20       save
21           Save the screenshot into a regular file. Grimshot will write image
22           files to XDG_SCREENSHOTS_DIR if this is set (or defined in user-
23           dirs.dir), or otherwise fall back to XDG_PICTURES_DIR. Set FILE to
24           '-' to pipe the output to STDOUT.
25
26       copy
27           Copy the screenshot data (as image/png) into the clipboard.
28

DESCRIPTION

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

EXAMPLES

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

TARGETS

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

OUTPUT

68       Grimshot will print the filename of the captured screenshot to stdout
69       if called with the save subcommand.
70