diff options
Diffstat (limited to 'contrib/grimshot.1.scd')
-rw-r--r-- | contrib/grimshot.1.scd | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/contrib/grimshot.1.scd b/contrib/grimshot.1.scd new file mode 100644 index 00000000..afc6362e --- /dev/null +++ b/contrib/grimshot.1.scd | |||
@@ -0,0 +1,71 @@ | |||
1 | grimshot(1) | ||
2 | |||
3 | # NAME | ||
4 | |||
5 | grimshot - a helper for screenshots within sway | ||
6 | |||
7 | # DESCRIPTION | ||
8 | |||
9 | grimshot [--notify] (copy|save) [TARGET] [FILE] | ||
10 | grimshot check | ||
11 | grimshot usage | ||
12 | |||
13 | *--notify* | ||
14 | Show notifications to the user that a screenshot has been taken. | ||
15 | |||
16 | *save* | ||
17 | Save the screenshot into a regular file. Grimshot will write images | ||
18 | files to *$XDG_SCREENSHOTS_DIR* if this is set (or defined | ||
19 | in `user-dirs.dir`), or otherwise fall back to `$XDG_PICTURES_DIR` | ||
20 | |||
21 | *copy* | ||
22 | Copy the screenshot data (as image/png) into the clipboard. | ||
23 | |||
24 | # SYNOPSIS | ||
25 | |||
26 | Grimshot is an easy to use screenshot tool for sway. It relies on grim, slurp | ||
27 | and jq to do the heavy lifting, and mostly provides an easy to use interface. | ||
28 | |||
29 | A recommended usage pattern is to just bind this to Super+P via sway: | ||
30 | |||
31 | ``` | ||
32 | # Screenshots: | ||
33 | # Cmd+P: Current window | ||
34 | # Cmd+Shift+p: Select region | ||
35 | # Cmd+Alt+p Current output | ||
36 | # Cmd+Ctrl+p Select a window | ||
37 | |||
38 | bindsym Mod4+p exec grimshot active | ||
39 | bindsym Mod4+Shift+p exec grimshot region | ||
40 | bindsym Mod4+Mod1+p exec grimshot output | ||
41 | bindsym Mod4+Ctrl+p exec grimshot window | ||
42 | ``` | ||
43 | |||
44 | # TARGETS | ||
45 | |||
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 | _region_ | ||
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 | |||
64 | # OUTPUT | ||
65 | |||
66 | Grimshot will always print the filename of the captured screenshot to | ||
67 | stdout. | ||
68 | |||
69 | # SEE ALSO | ||
70 | |||
71 | *grim*(1) | ||