diff options
Diffstat (limited to 'swaygrab/swaygrab.1.txt')
| -rw-r--r-- | swaygrab/swaygrab.1.txt | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/swaygrab/swaygrab.1.txt b/swaygrab/swaygrab.1.txt new file mode 100644 index 00000000..cd4b8bd2 --- /dev/null +++ b/swaygrab/swaygrab.1.txt @@ -0,0 +1,58 @@ +///// +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 +------- + +*-h, --help*:: + Show help message and quit. + +*-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>. |