swayfx/swaygrab/swaygrab.1.txt

77 lines
1.8 KiB
Plaintext
Raw Normal View History

2015-11-28 02:06:24 +11:00
/////
vim:set ts=4 sw=4 tw=82 noet:
/////
:quotes.~:
swaygrab (1)
============
Name
----
swaygrab - Grab image data from the current sway session.
Synopsis
--------
2015-12-18 02:47:18 +11:00
'swaygrab' [options] [file]
2015-11-28 02:06:24 +11:00
2015-12-18 02:47:18 +11:00
Grabs pixels from an output and writes them to _file_. The image will be passed to
2015-11-28 02:06:24 +11:00
ImageMagick convert for processing.
Options
-------
*-h, --help*::
Show help message and quit.
2015-11-28 02:06:24 +11:00
*-c, \--capture*::
Captures multiple frames as video and passes them into ffmpeg. Continues until
you send SIGTERM (ctrl+c) to swaygrab.
2015-12-18 02:47:18 +11:00
*-o, \--output* <output>::
Use the specified _output_. If no output is defined the currently focused
output in sway will be used.
2015-11-28 02:06:24 +11:00
*-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).
2016-03-30 05:32:21 +11:00
*-R, --rate* <rate>::
Specify a framerate (in frames per second). Used in combination with -c.
Default is 30. Must be an integer.
2017-02-13 11:22:48 +11:00
*-r, --raw*::
Instead of invoking ImageMagick or ffmpeg, dump raw rgba data to stdout.
2017-02-13 11:22:48 +11:00
*-f, --focused*::
Capture only the currently focused container.
2017-06-18 10:41:09 +10:00
Environment Variables
---------------------
swaygrab reads the following environment variables.
*SWAYGRAB_FFMPEG_OPTS*::
Pass additional arguments to FFmpeg when starting a capture.
2015-11-28 02:39:18 +11:00
Examples
--------
2015-12-18 02:47:18 +11:00
swaygrab output.png::
Grab the contents of currently focused output and write to output.png.
2015-11-28 02:39:18 +11:00
2015-12-18 02:47:18 +11:00
swaygrab -c -o HDMI-A-1 output.webm::
2015-11-28 02:39:18 +11:00
Capture a webm of HDMI-A-1.
2017-06-18 10:41:09 +10:00
SWAYGRAB_FFMPEG_OPTS="-f alsa -i pulse" swaygrab -c::
Capture the focused output and encode audio from the default recording
device.
2015-11-28 02:06:24 +11:00
Authors
-------
Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
source contributors. For more information about sway development, see
2017-10-06 14:13:42 +11:00
<https://github.com/swaywm/sway>.