aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/grimshot.1.scd
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/grimshot.1.scd
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/grimshot.1.scd')
-rw-r--r--contrib/grimshot.1.scd37
1 files changed, 21 insertions, 16 deletions
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