docs(man): update man page

This commit is contained in:
Jeremy Attali 2019-12-28 20:59:32 -05:00
parent 9b8ea64307
commit fc6f15d9fc

View File

@ -2,7 +2,7 @@ swappy(1)
# NAME
swappy - grab and edit on the fly snapshots of a Wayland compositor, inspired by Snappy on macOS
swappy - grab and edit on the fly snapshots of a Wayland compositor
# DESCRIPTION
@ -11,13 +11,42 @@ swappy - grab and edit on the fly snapshots of a Wayland compositor, inspired by
# 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. Support for the
xdg-output protocol is optional, but improves fractional scaling support.
it requires support for the screencopy protocol to work.
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*.
# KEY BINDINGS
## LAYOUT
- *Ctrl+b*: Toggle Paint Panel
## PAINT MODE
- *b*: Switch to Brush
- *t*: Switch to Text
- *r*: Switch to Rectangle
- *o*: Switch to Ellipse
- *a*: Switch to Arrow
- *R*: Use Red Color
- *G*: Use Green Color
- *B*: Use Blue Color
- *C*: Use Custom Color
- *Minus*: Reduce Stroke Size
- *Plus*: Increase Stroke Size
- *Equal*: Reset Stroke Size
- *k*: Clear Paints (cannot be undone)
## HEADER BAR
- *Ctrl+z*: Undo
- *Ctrl+Shift+z* or *Ctrl+y*: Redo
- *Ctrl+s*: Save to file (see man page).
- *Ctrl+c*: Copy to clipboard
# OPTIONS
*-h*
@ -30,5 +59,5 @@ If *$XDG_CONFIG_HOME* is not set, it will revert to: *$HOME/Desktop*.
# AUTHORS
Written and maintained by Jeremy Attali <jeremy.attali@gmail.com>. See
Written and maintained by jtheoof <contact@jtheoof.me>. See
https://github.com/jtheoof/swappy.