mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2024-11-04 23:43:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
sway/contrib/grimshot.1.scd

77 lines
1.7 KiB
Plaintext
Raw Normal View History

grimshot: Add a man page
2020-05-01 09:57:48 +00:00
grimshot(1)
# NAME
grimshot - a helper for screenshots within sway
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.
2020-12-20 06:33:32 +00:00
# SYNOPSIS
*grimshot* [--notify] (copy|save) [TARGET] [FILE]++
*grimshot* check++
*grimshot* usage
grimshot: Add a man page
2020-05-01 09:57:48 +00:00
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.
2020-12-20 06:33:32 +00:00
# OPTIONS
grimshot: Add a man page
2020-05-01 09:57:48 +00:00
*--notify*
Show notifications to the user that a screenshot has been taken.
*save*
Save the screenshot into a regular file. Grimshot will write images
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.
2020-12-20 06:33:32 +00:00
files to *XDG_SCREENSHOTS_DIR* if this is set (or defined
in *user-dirs.dir*), or otherwise fall back to *XDG_PICTURES_DIR*.
grimshot: Add a man page
2020-05-01 09:57:48 +00:00
*copy*
Copy the screenshot data (as image/png) into the clipboard.
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.
2020-12-20 06:33:32 +00:00
# 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: Add a man page
2020-05-01 09:57:48 +00:00
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.
2020-12-20 06:33:32 +00:00
# EXAMPLES
grimshot: Add a man page
2020-05-01 09:57:48 +00:00
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.
2020-12-20 06:33:32 +00:00
An example usage pattern is to add these bindings to your sway config:
grimshot: Add a man page
2020-05-01 09:57:48 +00:00
```
# Screenshots:
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.
2020-12-20 06:33:32 +00:00
# Super+P: Current window
# Super+Shift+p: Select area
# Super+Alt+p Current output
# Super+Ctrl+p Select a window
grimshot: Add a man page
2020-05-01 09:57:48 +00:00
Fix some mistakes in grimshot docs
2020-05-08 02:56:25 +00:00
bindsym Mod4+p exec grimshot save active
bindsym Mod4+Shift+p exec grimshot save area
bindsym Mod4+Mod1+p exec grimshot save output
bindsym Mod4+Ctrl+p exec grimshot save window
grimshot: Add a man page
2020-05-01 09:57:48 +00:00
```
# TARGETS
grimshot can capture the following named targets:
_active_
Captures the currently active window.
_screen_
Captures the entire screen. This includes all visible outputs.
Fix some mistakes in grimshot docs
2020-05-08 02:56:25 +00:00
_area_
grimshot: Add a man page
2020-05-01 09:57:48 +00:00
Allows manually selecting a rectangular region, and captures that.
_window_
Allows manually selecting a single window (by clicking on it), and
captures it.
_output_
Captures the currently active output.
# OUTPUT
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.
2020-12-20 06:33:32 +00:00
Grimshot will print the filename of the captured screenshot to stdout if called
with the _save_ subcommand.
grimshot: Add a man page
2020-05-01 09:57:48 +00:00
# SEE ALSO
*grim*(1)
Reference in a new issue Copy permalink