aboutsummaryrefslogtreecommitdiffstats
path: root/contrib
diff options
context:
space:
mode:
authorLibravatar William Culhane <sxroka@gmail.com>2020-12-20 00:33:32 -0600
committerLibravatar Simon Ser <contact@emersion.fr>2020-12-26 17:37:41 +0100
commit7c9706de7186f32159f719e3f15fcdc017a13f35 (patch)
tree4eaac358e67a4565882af35851dfd1a7b61b5347 /contrib
parentcontainer: set fullscreen mode before attempting focus (diff)
downloadsway-7c9706de7186f32159f719e3f15fcdc017a13f35.tar.gz
sway-7c9706de7186f32159f719e3f15fcdc017a13f35.tar.zst
sway-7c9706de7186f32159f719e3f15fcdc017a13f35.zip
grimshot: Fix man page issues
This fixes a few formatting errors in SYNOPSIS, moves the command options out of SYNOPSIS, swaps the labels on the SYNOPSIS and DESCRIPTION sections, creates an EXAMPLES section and slightly rewords parts of the OPTIONS, DESCRIPTION, EXAMPLES, and OUTPUT sections.
Diffstat (limited to 'contrib')
-rw-r--r--contrib/grimshot.159
-rw-r--r--contrib/grimshot.1.scd37
2 files changed, 54 insertions, 42 deletions
diff --git a/contrib/grimshot.1 b/contrib/grimshot.1
index a51f3d4d..f6c8a377 100644
--- a/contrib/grimshot.1
+++ b/contrib/grimshot.1
@@ -1,53 +1,60 @@
1.\" Generated by scdoc 1.10.1 1.\" Generated by scdoc 1.11.1
2.\" Complete documentation for this program is not available as a GNU info page 2.\" Complete documentation for this program is not available as a GNU info page
3.ie \n(.g .ds Aq \(aq 3.ie \n(.g .ds Aq \(aq
4.el .ds Aq ' 4.el .ds Aq '
5.nh 5.nh
6.ad l 6.ad l
7.\" Begin generated content: 7.\" Begin generated content:
8.TH "grimshot" "1" "2020-05-08" 8.TH "grimshot" "1" "2020-12-20"
9.P 9.P
10.SH NAME 10.SH NAME
11.P 11.P
12grimshot - a helper for screenshots within sway 12grimshot - a helper for screenshots within sway
13.P 13.P
14.SH DESCRIPTION 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
15.P 21.P
16grimshot [--notify] (copy|save) [TARGET] [FILE] 22.SH OPTIONS
17grimshot check
18grimshot usage
19.P 23.P
20\fB--notify\fR 24\fB--notify\fR
21.RS 4 25.RS 4
22Show notifications to the user that a screenshot has been taken. 26Show notifications to the user that a screenshot has been taken.\&
23.P 27.P
24.RE 28.RE
25\fBsave\fR 29\fBsave\fR
26.RS 4 30.RS 4
27Save the screenshot into a regular file. Grimshot will write images 31Save the screenshot into a regular file.\& Grimshot will write images
28files to \fB$XDG_SCREENSHOTS_DIR\fR if this is set (or defined 32files to \fBXDG_SCREENSHOTS_DIR\fR if this is set (or defined
29in `user-dirs.dir`), or otherwise fall back to `$XDG_PICTURES_DIR` 33in \fBuser-dirs.\&dir\fR), or otherwise fall back to \fBXDG_PICTURES_DIR\fR.\&
30.P 34.P
31.RE 35.RE
32\fBcopy\fR 36\fBcopy\fR
33.RS 4 37.RS 4
34Copy the screenshot data (as image/png) into the clipboard. 38Copy the screenshot data (as image/png) into the clipboard.\&
35.P 39.P
36.RE 40.RE
37.SH SYNOPSIS 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.\&
38.P 46.P
39Grimshot is an easy to use screenshot tool for sway. It relies on grim, slurp 47.SH EXAMPLES
40and jq to do the heavy lifting, and mostly provides an easy to use interface.
41.P 48.P
42A recommended usage pattern is to just bind this to Super+P via sway: 49An example usage pattern is to add these bindings to your sway config:
43.P 50.P
44.nf 51.nf
45.RS 4 52.RS 4
46# Screenshots: 53# Screenshots:
47# Cmd+P: Current window 54# Super+P: Current window
48# Cmd+Shift+p: Select area 55# Super+Shift+p: Select area
49# Cmd+Alt+p Current output 56# Super+Alt+p Current output
50# Cmd+Ctrl+p Select a window 57# Super+Ctrl+p Select a window
51 58
52bindsym Mod4+p exec grimshot save active 59bindsym Mod4+p exec grimshot save active
53bindsym Mod4+Shift+p exec grimshot save area 60bindsym Mod4+Shift+p exec grimshot save area
@@ -62,34 +69,34 @@ grimshot can capture the following named targets:
62.P 69.P
63\fIactive\fR 70\fIactive\fR
64.RS 4 71.RS 4
65Captures the currently active window. 72Captures the currently active window.\&
66.P 73.P
67.RE 74.RE
68\fIscreen\fR 75\fIscreen\fR
69.RS 4 76.RS 4
70Captures the entire screen. This includes all visible outputs. 77Captures the entire screen.\& This includes all visible outputs.\&
71.P 78.P
72.RE 79.RE
73\fIarea\fR 80\fIarea\fR
74.RS 4 81.RS 4
75Allows manually selecting a rectangular region, and captures that. 82Allows manually selecting a rectangular region, and captures that.\&
76.P 83.P
77.RE 84.RE
78\fIwindow\fR 85\fIwindow\fR
79.RS 4 86.RS 4
80Allows manually selecting a single window (by clicking on it), and 87Allows manually selecting a single window (by clicking on it), and
81captures it. 88captures it.\&
82.P 89.P
83.RE 90.RE
84\fIoutput\fR 91\fIoutput\fR
85.RS 4 92.RS 4
86Captures the currently active output. 93Captures the currently active output.\&
87.P 94.P
88.RE 95.RE
89.SH OUTPUT 96.SH OUTPUT
90.P 97.P
91Grimshot will always print the filename of the captured screenshot to 98Grimshot will print the filename of the captured screenshot to stdout if called
92stdout. 99with the \fIsave\fR subcommand.\&
93.P 100.P
94.SH SEE ALSO 101.SH SEE ALSO
95.P 102.P
diff --git a/contrib/grimshot.1.scd b/contrib/grimshot.1.scd
index b2877976..4ab58532 100644
--- a/contrib/grimshot.1.scd
+++ b/contrib/grimshot.1.scd
@@ -4,36 +4,41 @@ grimshot(1)
4 4
5grimshot - a helper for screenshots within sway 5grimshot - a helper for screenshots within sway
6 6
7# DESCRIPTION 7# SYNOPSIS
8
9*grimshot* [--notify] (copy|save) [TARGET] [FILE]++
10*grimshot* check++
11*grimshot* usage
8 12
9grimshot [--notify] (copy|save) [TARGET] [FILE] 13# OPTIONS
10grimshot check
11grimshot usage
12 14
13*--notify* 15*--notify*
14 Show notifications to the user that a screenshot has been taken. 16 Show notifications to the user that a screenshot has been taken.
15 17
16*save* 18*save*
17 Save the screenshot into a regular file. Grimshot will write images 19 Save the screenshot into a regular file. Grimshot will write images
18 files to *$XDG_SCREENSHOTS_DIR* if this is set (or defined 20 files to *XDG_SCREENSHOTS_DIR* if this is set (or defined
19 in `user-dirs.dir`), or otherwise fall back to `$XDG_PICTURES_DIR` 21 in *user-dirs.dir*), or otherwise fall back to *XDG_PICTURES_DIR*.
20 22
21*copy* 23*copy*
22 Copy the screenshot data (as image/png) into the clipboard. 24 Copy the screenshot data (as image/png) into the clipboard.
23 25
24# SYNOPSIS 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.
25 31
26Grimshot is an easy to use screenshot tool for sway. It relies on grim, slurp 32# EXAMPLES
27and jq to do the heavy lifting, and mostly provides an easy to use interface.
28 33
29A recommended usage pattern is to just bind this to Super+P via sway: 34An example usage pattern is to add these bindings to your sway config:
30 35
31``` 36```
32# Screenshots: 37# Screenshots:
33# Cmd+P: Current window 38# Super+P: Current window
34# Cmd+Shift+p: Select area 39# Super+Shift+p: Select area
35# Cmd+Alt+p Current output 40# Super+Alt+p Current output
36# Cmd+Ctrl+p Select a window 41# Super+Ctrl+p Select a window
37 42
38bindsym Mod4+p exec grimshot save active 43bindsym Mod4+p exec grimshot save active
39bindsym Mod4+Shift+p exec grimshot save area 44bindsym Mod4+Shift+p exec grimshot save area
@@ -63,8 +68,8 @@ _output_
63 68
64# OUTPUT 69# OUTPUT
65 70
66Grimshot will always print the filename of the captured screenshot to 71Grimshot will print the filename of the captured screenshot to stdout if called
67stdout. 72with the _save_ subcommand.
68 73
69# SEE ALSO 74# SEE ALSO
70 75