aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/grimshot.1.scd
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/grimshot.1.scd')
-rw-r--r--contrib/grimshot.1.scd76
1 files changed, 0 insertions, 76 deletions
diff --git a/contrib/grimshot.1.scd b/contrib/grimshot.1.scd
deleted file mode 100644
index 4ab58532..00000000
--- a/contrib/grimshot.1.scd
+++ /dev/null
@@ -1,76 +0,0 @@
1grimshot(1)
2
3# NAME
4
5grimshot - a helper for screenshots within sway
6
7# SYNOPSIS
8
9*grimshot* [--notify] (copy|save) [TARGET] [FILE]++
10*grimshot* check++
11*grimshot* usage
12
13# OPTIONS
14
15*--notify*
16 Show notifications to the user that a screenshot has been taken.
17
18*save*
19 Save the screenshot into a regular file. Grimshot will write images
20 files to *XDG_SCREENSHOTS_DIR* if this is set (or defined
21 in *user-dirs.dir*), or otherwise fall back to *XDG_PICTURES_DIR*.
22
23*copy*
24 Copy the screenshot data (as image/png) into the clipboard.
25
26# DESCRIPTION
27
28Grimshot is an easy-to-use screenshot utility for sway. It provides a
29convenient interface over grim, slurp and jq, and supports storing the
30screenshot either directly to the clipboard using wl-copy or to a file.
31
32# EXAMPLES
33
34An example usage pattern is to add these bindings to your sway config:
35
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
43bindsym Mod4+p exec grimshot save active
44bindsym Mod4+Shift+p exec grimshot save area
45bindsym Mod4+Mod1+p exec grimshot save output
46bindsym Mod4+Ctrl+p exec grimshot save window
47```
48
49# TARGETS
50
51grimshot can capture the following named targets:
52
53_active_
54 Captures the currently active window.
55
56_screen_
57 Captures the entire screen. This includes all visible outputs.
58
59_area_
60 Allows manually selecting a rectangular region, and captures that.
61
62_window_
63 Allows manually selecting a single window (by clicking on it), and
64 captures it.
65
66_output_
67 Captures the currently active output.
68
69# OUTPUT
70
71Grimshot will print the filename of the captured screenshot to stdout if called
72with the _save_ subcommand.
73
74# SEE ALSO
75
76*grim*(1)