1 files changed, 96 insertions, 0 deletions
diff --git a/contrib/grimshot.1 b/contrib/grimshot.1
new file mode 100644
index 00000000..6e764007
--- /dev/null
+++ b/contrib/grimshot.1
@@ -0,0 +1,96 @@
+.\" Generated by scdoc 1.10.1
+.\" Complete documentation for this program is not available as a GNU info page
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.nh
+.ad l
+.\" Begin generated content:
+.TH "grimshot" "1" "2020-05-05"
+.P
+.SH NAME
+.P
+grimshot - a helper for screenshots within sway
+.P
+.SH DESCRIPTION
+.P
+grimshot [--notify] (copy|save) [TARGET] [FILE]
+grimshot check
+grimshot usage
+.P
+\fB--notify\fR
+.RS 4
+Show notifications to the user that a screenshot has been taken.
+.P
+.RE
+\fBsave\fR
+.RS 4
+Save the screenshot into a regular file. Grimshot will write images
+files to \fB$XDG_SCREENSHOTS_DIR\fR if this is set (or defined
+in `user-dirs.dir`), or otherwise fall back to `$XDG_PICTURES_DIR`
+.P
+.RE
+\fBcopy\fR
+.RS 4
+Copy the screenshot data (as image/png) into the clipboard.
+.P
+.RE
+.SH SYNOPSIS
+.P
+Grimshot is an easy to use screenshot tool for sway. It relies on grim, slurp
+and jq to do the heavy lifting, and mostly provides an easy to use interface.
+.P
+A recommended usage pattern is to just bind this to Super+P via sway:
+.P
+.nf
+.RS 4
+# Screenshots:
+# Cmd+P: Current window
+# Cmd+Shift+p: Select region
+# Cmd+Alt+p Current output
+# Cmd+Ctrl+p Select a window
+bindsym Mod4+p       exec grimshot active
+bindsym Mod4+Shift+p exec grimshot region
+bindsym Mod4+Mod1+p  exec grimshot output
+bindsym Mod4+Ctrl+p  exec grimshot window
+.fi
+.RE
+.P
+.SH TARGETS
+.P
+grimshot can capture the following named targets:
+.P
+\fIactive\fR
+.RS 4
+Captures the currently active window.
+.P
+.RE
+\fIscreen\fR
+.RS 4
+Captures the entire screen. This includes all visible outputs.
+.P
+.RE
+\fIregion\fR
+.RS 4
+Allows manually selecting a rectangular region, and captures that.
+.P
+.RE
+\fIwindow\fR
+.RS 4
+Allows manually selecting a single window (by clicking on it), and
+captures it.
+.P
+.RE
+\fIoutput\fR
+.RS 4
+Captures the currently active output.
+.P
+.RE
+.SH OUTPUT
+.P
+Grimshot will always print the filename of the captured screenshot to
+stdout.
+.P
+.SH SEE ALSO
+.P
+\fBgrim\fR(1)

diff --git a/contrib/grimshot.1 b/contrib/grimshot.1 new file mode 100644 index 00000000..6e764007 --- /dev/null +++ b/contrib/grimshot.1
@@ -0,0 +1,96 @@
	1	.\" Generated by scdoc 1.10.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-05-05"
	9	.P
	10	.SH NAME
	11	.P
	12	grimshot - a helper for screenshots within sway
	13	.P
	14	.SH DESCRIPTION
	15	.P
	16	grimshot [--notify] (copy\|save) [TARGET] [FILE]
	17	grimshot check
	18	grimshot usage
	19	.P
	20	\fB--notify\fR
	21	.RS 4
	22	Show notifications to the user that a screenshot has been taken.
	23	.P
	24	.RE
	25	\fBsave\fR
	26	.RS 4
	27	Save the screenshot into a regular file. Grimshot will write images
	28	files to \fB$XDG_SCREENSHOTS_DIR\fR if this is set (or defined
	29	in `user-dirs.dir`), or otherwise fall back to `$XDG_PICTURES_DIR`
	30	.P
	31	.RE
	32	\fBcopy\fR
	33	.RS 4
	34	Copy the screenshot data (as image/png) into the clipboard.
	35	.P
	36	.RE
	37	.SH SYNOPSIS
	38	.P
	39	Grimshot is an easy to use screenshot tool for sway. It relies on grim, slurp
	40	and jq to do the heavy lifting, and mostly provides an easy to use interface.
	41	.P
	42	A recommended usage pattern is to just bind this to Super+P via sway:
	43	.P
	44	.nf
	45	.RS 4
	46	# Screenshots:
	47	# Cmd+P: Current window
	48	# Cmd+Shift+p: Select region
	49	# Cmd+Alt+p Current output
	50	# Cmd+Ctrl+p Select a window
	51
	52	bindsym Mod4+p exec grimshot active
	53	bindsym Mod4+Shift+p exec grimshot region
	54	bindsym Mod4+Mod1+p exec grimshot output
	55	bindsym Mod4+Ctrl+p exec grimshot window
	56	.fi
	57	.RE
	58	.P
	59	.SH TARGETS
	60	.P
	61	grimshot can capture the following named targets:
	62	.P
	63	\fIactive\fR
	64	.RS 4
	65	Captures the currently active window.
	66	.P
	67	.RE
	68	\fIscreen\fR
	69	.RS 4
	70	Captures the entire screen. This includes all visible outputs.
	71	.P
	72	.RE
	73	\fIregion\fR
	74	.RS 4
	75	Allows manually selecting a rectangular region, and captures that.
	76	.P
	77	.RE
	78	\fIwindow\fR
	79	.RS 4
	80	Allows manually selecting a single window (by clicking on it), and
	81	captures it.
	82	.P
	83	.RE
	84	\fIoutput\fR
	85	.RS 4
	86	Captures the currently active output.
	87	.P
	88	.RE
	89	.SH OUTPUT
	90	.P
	91	Grimshot will always print the filename of the captured screenshot to
	92	stdout.
	93	.P
	94	.SH SEE ALSO
	95	.P
	96	\fBgrim\fR(1)