aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/grimshot.1
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/grimshot.1')
-rw-r--r--contrib/grimshot.1103
1 files changed, 0 insertions, 103 deletions
diff --git a/contrib/grimshot.1 b/contrib/grimshot.1
deleted file mode 100644
index f6c8a377..00000000
--- a/contrib/grimshot.1
+++ /dev/null
@@ -1,103 +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" "2020-12-20"
9.P
10.SH NAME
11.P
12grimshot - 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
26Show notifications to the user that a screenshot has been taken.\&
27.P
28.RE
29\fBsave\fR
30.RS 4
31Save the screenshot into a regular file.\& Grimshot will write images
32files to \fBXDG_SCREENSHOTS_DIR\fR if this is set (or defined
33in \fBuser-dirs.\&dir\fR), or otherwise fall back to \fBXDG_PICTURES_DIR\fR.\&
34.P
35.RE
36\fBcopy\fR
37.RS 4
38Copy the screenshot data (as image/png) into the clipboard.\&
39.P
40.RE
41.SH DESCRIPTION
42.P
43Grimshot is an easy-to-use screenshot utility for sway.\& It provides a
44convenient interface over grim, slurp and jq, and supports storing the
45screenshot either directly to the clipboard using wl-copy or to a file.\&
46.P
47.SH EXAMPLES
48.P
49An example usage pattern is to add these bindings to your sway config:
50.P
51.nf
52.RS 4
53# Screenshots:
54# Super+P: Current window
55# Super+Shift+p: Select area
56# Super+Alt+p Current output
57# Super+Ctrl+p Select a window
58
59bindsym Mod4+p exec grimshot save active
60bindsym Mod4+Shift+p exec grimshot save area
61bindsym Mod4+Mod1+p exec grimshot save output
62bindsym Mod4+Ctrl+p exec grimshot save window
63.fi
64.RE
65.P
66.SH TARGETS
67.P
68grimshot can capture the following named targets:
69.P
70\fIactive\fR
71.RS 4
72Captures the currently active window.\&
73.P
74.RE
75\fIscreen\fR
76.RS 4
77Captures the entire screen.\& This includes all visible outputs.\&
78.P
79.RE
80\fIarea\fR
81.RS 4
82Allows manually selecting a rectangular region, and captures that.\&
83.P
84.RE
85\fIwindow\fR
86.RS 4
87Allows manually selecting a single window (by clicking on it), and
88captures it.\&
89.P
90.RE
91\fIoutput\fR
92.RS 4
93Captures the currently active output.\&
94.P
95.RE
96.SH OUTPUT
97.P
98Grimshot will print the filename of the captured screenshot to stdout if called
99with the \fIsave\fR subcommand.\&
100.P
101.SH SEE ALSO
102.P
103\fBgrim\fR(1)