diff options
Diffstat (limited to 'contrib/grimshot.1')
-rw-r--r-- | contrib/grimshot.1 | 104 |
1 files changed, 0 insertions, 104 deletions
diff --git a/contrib/grimshot.1 b/contrib/grimshot.1 deleted file mode 100644 index e4baccfd..00000000 --- a/contrib/grimshot.1 +++ /dev/null | |||
@@ -1,104 +0,0 @@ | |||
1 | .\" Generated by scdoc 1.11.1 | ||
2 | .\" Complete documentation for this program is not available as a GNU info page | ||
3 | .ie \n(.g .ds Aq \(aq | ||
4 | .el .ds Aq ' | ||
5 | .nh | ||
6 | .ad l | ||
7 | .\" Begin generated content: | ||
8 | .TH "grimshot" "1" "2021-02-23" | ||
9 | .P | ||
10 | .SH NAME | ||
11 | .P | ||
12 | grimshot - a helper for screenshots within sway | ||
13 | .P | ||
14 | .SH SYNOPSIS | ||
15 | .P | ||
16 | \fBgrimshot\fR [--notify] (copy|save) [TARGET] [FILE] | ||
17 | .br | ||
18 | \fBgrimshot\fR check | ||
19 | .br | ||
20 | \fBgrimshot\fR usage | ||
21 | .P | ||
22 | .SH OPTIONS | ||
23 | .P | ||
24 | \fB--notify\fR | ||
25 | .RS 4 | ||
26 | Show notifications to the user that a screenshot has been taken.\& | ||
27 | .P | ||
28 | .RE | ||
29 | \fBsave\fR | ||
30 | .RS 4 | ||
31 | Save the screenshot into a regular file.\& Grimshot will write images | ||
32 | files to \fBXDG_SCREENSHOTS_DIR\fR if this is set (or defined | ||
33 | in \fBuser-dirs.\&dir\fR), or otherwise fall back to \fBXDG_PICTURES_DIR\fR.\& | ||
34 | Set FILE to '-' to pipe the output to STDOUT.\& | ||
35 | .P | ||
36 | .RE | ||
37 | \fBcopy\fR | ||
38 | .RS 4 | ||
39 | Copy the screenshot data (as image/png) into the clipboard.\& | ||
40 | .P | ||
41 | .RE | ||
42 | .SH DESCRIPTION | ||
43 | .P | ||
44 | Grimshot is an easy-to-use screenshot utility for sway.\& It provides a | ||
45 | convenient interface over grim, slurp and jq, and supports storing the | ||
46 | screenshot either directly to the clipboard using wl-copy or to a file.\& | ||
47 | .P | ||
48 | .SH EXAMPLES | ||
49 | .P | ||
50 | An example usage pattern is to add these bindings to your sway config: | ||
51 | .P | ||
52 | .nf | ||
53 | .RS 4 | ||
54 | # Screenshots: | ||
55 | # Super+P: Current window | ||
56 | # Super+Shift+p: Select area | ||
57 | # Super+Alt+p Current output | ||
58 | # Super+Ctrl+p Select a window | ||
59 | |||
60 | bindsym Mod4+p exec grimshot save active | ||
61 | bindsym Mod4+Shift+p exec grimshot save area | ||
62 | bindsym Mod4+Mod1+p exec grimshot save output | ||
63 | bindsym Mod4+Ctrl+p exec grimshot save window | ||
64 | .fi | ||
65 | .RE | ||
66 | .P | ||
67 | .SH TARGETS | ||
68 | .P | ||
69 | grimshot can capture the following named targets: | ||
70 | .P | ||
71 | \fIactive\fR | ||
72 | .RS 4 | ||
73 | Captures the currently active window.\& | ||
74 | .P | ||
75 | .RE | ||
76 | \fIscreen\fR | ||
77 | .RS 4 | ||
78 | Captures the entire screen.\& This includes all visible outputs.\& | ||
79 | .P | ||
80 | .RE | ||
81 | \fIarea\fR | ||
82 | .RS 4 | ||
83 | Allows manually selecting a rectangular region, and captures that.\& | ||
84 | .P | ||
85 | .RE | ||
86 | \fIwindow\fR | ||
87 | .RS 4 | ||
88 | Allows manually selecting a single window (by clicking on it), and | ||
89 | captures it.\& | ||
90 | .P | ||
91 | .RE | ||
92 | \fIoutput\fR | ||
93 | .RS 4 | ||
94 | Captures the currently active output.\& | ||
95 | .P | ||
96 | .RE | ||
97 | .SH OUTPUT | ||
98 | .P | ||
99 | Grimshot will print the filename of the captured screenshot to stdout if called | ||
100 | with the \fIsave\fR subcommand.\& | ||
101 | .P | ||
102 | .SH SEE ALSO | ||
103 | .P | ||
104 | \fBgrim\fR(1) | ||