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