diff options
Diffstat (limited to 'contrib/grimshot.1.scd')
| -rw-r--r-- | contrib/grimshot.1.scd | 80 |
1 files changed, 0 insertions, 80 deletions
diff --git a/contrib/grimshot.1.scd b/contrib/grimshot.1.scd deleted file mode 100644 index e356f99d..00000000 --- a/contrib/grimshot.1.scd +++ /dev/null | |||
| @@ -1,80 +0,0 @@ | |||
| 1 | grimshot(1) | ||
| 2 | |||
| 3 | # NAME | ||
| 4 | |||
| 5 | grimshot - a helper for screenshots within sway | ||
| 6 | |||
| 7 | # SYNOPSIS | ||
| 8 | |||
| 9 | *grimshot* [--notify] [--cursor] (copy|save) [TARGET] [FILE]++ | ||
| 10 | *grimshot* check++ | ||
| 11 | *grimshot* usage | ||
| 12 | |||
| 13 | # OPTIONS | ||
| 14 | |||
| 15 | *--notify* | ||
| 16 | Show notifications to the user that a screenshot has been taken. | ||
| 17 | |||
| 18 | *--cursor* | ||
| 19 | Include cursors in the screenshot. | ||
| 20 | |||
| 21 | *save* | ||
| 22 | Save the screenshot into a regular file. Grimshot will write image | ||
| 23 | files to *XDG_SCREENSHOTS_DIR* if this is set (or defined | ||
| 24 | in *user-dirs.dir*), or otherwise fall back to *XDG_PICTURES_DIR*. | ||
| 25 | Set FILE to '-' to pipe the output to STDOUT. | ||
| 26 | |||
| 27 | *copy* | ||
| 28 | Copy the screenshot data (as image/png) into the clipboard. | ||
| 29 | |||
| 30 | # DESCRIPTION | ||
| 31 | |||
| 32 | Grimshot is an easy-to-use screenshot utility for sway. It provides a | ||
| 33 | convenient interface over grim, slurp and jq, and supports storing the | ||
| 34 | screenshot either directly to the clipboard using wl-copy or to a file. | ||
| 35 | |||
| 36 | # EXAMPLES | ||
| 37 | |||
| 38 | An example usage pattern is to add these bindings to your sway config: | ||
| 39 | |||
| 40 | ``` | ||
| 41 | # Screenshots: | ||
| 42 | # Super+P: Current window | ||
| 43 | # Super+Shift+p: Select area | ||
| 44 | # Super+Alt+p Current output | ||
| 45 | # Super+Ctrl+p Select a window | ||
| 46 | |||
| 47 | bindsym Mod4+p exec grimshot save active | ||
| 48 | bindsym Mod4+Shift+p exec grimshot save area | ||
| 49 | bindsym Mod4+Mod1+p exec grimshot save output | ||
| 50 | bindsym Mod4+Ctrl+p exec grimshot save window | ||
| 51 | ``` | ||
| 52 | |||
| 53 | # TARGETS | ||
| 54 | |||
| 55 | grimshot can capture the following named targets: | ||
| 56 | |||
| 57 | _active_ | ||
| 58 | Captures the currently active window. | ||
| 59 | |||
| 60 | _screen_ | ||
| 61 | Captures the entire screen. This includes all visible outputs. | ||
| 62 | |||
| 63 | _area_ | ||
| 64 | Allows manually selecting a rectangular region, and captures that. | ||
| 65 | |||
| 66 | _window_ | ||
| 67 | Allows manually selecting a single window (by clicking on it), and | ||
| 68 | captures it. | ||
| 69 | |||
| 70 | _output_ | ||
| 71 | Captures the currently active output. | ||
| 72 | |||
| 73 | # OUTPUT | ||
| 74 | |||
| 75 | Grimshot will print the filename of the captured screenshot to stdout if called | ||
| 76 | with the _save_ subcommand. | ||
| 77 | |||
| 78 | # SEE ALSO | ||
| 79 | |||
| 80 | *grim*(1) | ||