diff options
| author | William Culhane <[email protected]> | 2020-12-20 00:33:32 -0600 |
|---|---|---|
| committer | Simon Ser <[email protected]> | 2020-12-26 17:37:41 +0100 |
| commit | 7c9706de7186f32159f719e3f15fcdc017a13f35 (patch) | |
| tree | 4eaac358e67a4565882af35851dfd1a7b61b5347 /contrib/grimshot.1.scd | |
| parent | d1c4ed18671bca0cabf07bd5514d58d3060a5e1c (diff) | |
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.scd | 37 |
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) grimshot - a helper for screenshots within sway -# DESCRIPTION +# SYNOPSIS + +*grimshot* [--notify] (copy|save) [TARGET] [FILE]++ +*grimshot* check++ +*grimshot* usage -grimshot [--notify] (copy|save) [TARGET] [FILE] -grimshot check -grimshot usage +# OPTIONS *--notify* Show notifications to the user that a screenshot has been taken. *save* Save the screenshot into a regular file. Grimshot will write images - files to *$XDG_SCREENSHOTS_DIR* if this is set (or defined - in `user-dirs.dir`), or otherwise fall back to `$XDG_PICTURES_DIR` + files to *XDG_SCREENSHOTS_DIR* if this is set (or defined + in *user-dirs.dir*), or otherwise fall back to *XDG_PICTURES_DIR*. *copy* Copy the screenshot data (as image/png) into the clipboard. -# SYNOPSIS +# DESCRIPTION + +Grimshot is an easy-to-use screenshot utility for sway. It provides a +convenient interface over grim, slurp and jq, and supports storing the +screenshot either directly to the clipboard using wl-copy or to a file. -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. +# EXAMPLES -A recommended usage pattern is to just bind this to Super+P via sway: +An example usage pattern is to add these bindings to your sway config: ``` # Screenshots: -# Cmd+P: Current window -# Cmd+Shift+p: Select area -# Cmd+Alt+p Current output -# Cmd+Ctrl+p Select a window +# Super+P: Current window +# Super+Shift+p: Select area +# Super+Alt+p Current output +# Super+Ctrl+p Select a window bindsym Mod4+p exec grimshot save active bindsym Mod4+Shift+p exec grimshot save area @@ -63,8 +68,8 @@ _output_ # OUTPUT -Grimshot will always print the filename of the captured screenshot to -stdout. +Grimshot will print the filename of the captured screenshot to stdout if called +with the _save_ subcommand. # SEE ALSO |