docs(man): update man page

This commit is contained in:
Jeremy Attali 2020-01-04 15:33:37 -05:00
parent 6d00c3a0f2
commit c81d8982ff

View File

@ -10,12 +10,32 @@ swappy - grab and edit on the fly snapshots of a Wayland compositor
# SYNOPSIS
swappy is a command-line utility to take and edit screenshots of Wayland desktops. For now
it requires support for the screencopy protocol to work.
swappy is a command-line utility to take and edit screenshots of Wayland
desktops. It can also work on regular X11 desktops if using the *-f* option.
swappy will save the swappshot images to a timestamped file name in
*$XDG_DESKTOP_DIR*. If this variable is not set, it will revert to: *$XDG_CONFIG_HOME/Desktop*.
If *$XDG_CONFIG_HOME* is not set, it will revert to: *$HOME/Desktop*.
*$XDG_DESKTOP_DIR*. If this variable is not set, it will revert to:
*$XDG_CONFIG_HOME/Desktop*. If *$XDG_CONFIG_HOME* is not set, it will revert
to: *$HOME/Desktop*.
Can be used in two ways, either as the output of grim (recommended) or by
grabbing the geometry (if the compositor supports the screencopy protocol).
# OPTIONS
*-h*
Show help message and quit.
*-g* "<x>,<y> <width>x<height>"
Set the region to capture, in layout coordinates. This is slurp friendly.
Requires a Wayland compositor that supports screencopy protocol.
*-f* <file>
A PNG file to load for editing.
If set to *-*, read the file from standard input instead. This is grim
friendly.
# KEY BINDINGS
@ -48,16 +68,6 @@ If *$XDG_CONFIG_HOME* is not set, it will revert to: *$HOME/Desktop*.
- *Ctrl+c*: Copy to clipboard
- *Escape* or *q*: Quit swappy
# OPTIONS
*-h*
Show help message and quit.
*-g* "<x>,<y> <width>x<height>"
Set the region to capture, in layout coordinates.
This is slurp friendly.
# AUTHORS
Written and maintained by jtheoof <contact@jtheoof.me>. See