swayfx/swaygrab.1.txt
Drew DeVault 2ef7cf9e97 Add ffmpeg capture to swaygrab (with limitations)
This needs to be multithreaded to have any sort of realistic expectation
of performance, due to issues with syncronous I/O.
2015-11-27 14:21:38 -05:00

61 lines
1.3 KiB
Plaintext

/////
vim:set ts=4 sw=4 tw=82 noet:
/////
:quotes.~:
swaygrab (1)
============
Name
----
swaygrab - Grab image data from the current sway session.
Synopsis
--------
'swaygrab' [options] [output] [file]
Grabs pixels from _output_ and writes them to _file_. The image will be passed to
ImageMagick convert for processing.
Options
-------
*-c, \--capture*::
Captures multiple frames as video and passes them into ffmpeg. Continues until
you send SIGTERM (ctrl+c) to swaygrab.
*-v, \--version*::
Print the version (of swaymsg) and quit.
*-s, --socket* <path>::
Use the specified socket path. Otherwise, swaymsg will ask sway where the
socket is (which is the value of $SWAYSOCK, then of $I3SOCK).
*-r, --rate* <rate>::
Specify a framerate (in frames per second). Used in combination with -c.
Default is 30. Must be an integer.
*--raw*::
Instead of invoking ImageMagick or ffmpeg, dump raw rgba data to stdout.
Examples
--------
swaygrab HDMI-A-1 output.png::
Grab the contents of HDMI-A-1 and write to output.png.
swaygrab -c HDMI-A-1 output.webm::
Capture a webm of HDMI-A-1.
Authors
-------
Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
source contributors. For more information about sway development, see
<https://github.com/SirCmpwn/sway>.
See Also
--------
**sway**(5)