summaryrefslogtreecommitdiffstats
path: root/swaygrab/swaygrab.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'swaygrab/swaygrab.1.txt')
-rw-r--r--swaygrab/swaygrab.1.txt76
1 files changed, 0 insertions, 76 deletions
diff --git a/swaygrab/swaygrab.1.txt b/swaygrab/swaygrab.1.txt
deleted file mode 100644
index 8faf43f5..00000000
--- a/swaygrab/swaygrab.1.txt
+++ /dev/null
@@ -1,76 +0,0 @@
1/////
2vim:set ts=4 sw=4 tw=82 noet:
3/////
4:quotes.~:
5
6swaygrab (1)
7============
8
9Name
10----
11swaygrab - Grab image data from the current sway session.
12
13Synopsis
14--------
15'swaygrab' [options] [file]
16
17Grabs pixels from an output and writes them to _file_. The image will be passed to
18ImageMagick convert for processing.
19
20Options
21-------
22
23*-h, --help*::
24 Show help message and quit.
25
26*-c, \--capture*::
27 Captures multiple frames as video and passes them into ffmpeg. Continues until
28 you send SIGTERM (ctrl+c) to swaygrab.
29
30*-o, \--output* <output>::
31 Use the specified _output_. If no output is defined the currently focused
32 output in sway will be used.
33
34*-v, \--version*::
35 Print the version (of swaymsg) and quit.
36
37*-s, --socket* <path>::
38 Use the specified socket path. Otherwise, swaymsg will ask sway where the
39 socket is (which is the value of $SWAYSOCK, then of $I3SOCK).
40
41*-R, --rate* <rate>::
42 Specify a framerate (in frames per second). Used in combination with -c.
43 Default is 30. Must be an integer.
44
45*-r, --raw*::
46 Instead of invoking ImageMagick or ffmpeg, dump raw rgba data to stdout.
47
48*-f, --focused*::
49 Capture only the currently focused container.
50
51Environment Variables
52---------------------
53swaygrab reads the following environment variables.
54
55*SWAYGRAB_FFMPEG_OPTS*::
56 Pass additional arguments to FFmpeg when starting a capture.
57
58Examples
59--------
60
61swaygrab output.png::
62 Grab the contents of currently focused output and write to output.png.
63
64swaygrab -c -o HDMI-A-1 output.webm::
65 Capture a webm of HDMI-A-1.
66
67SWAYGRAB_FFMPEG_OPTS="-f alsa -i pulse" swaygrab -c::
68 Capture the focused output and encode audio from the default recording
69 device.
70
71Authors
72-------
73
74Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
75source contributors. For more information about sway development, see
76<https://github.com/swaywm/sway>.