aboutsummaryrefslogtreecommitdiffstats
path: root/swaygrab
diff options
context:
space:
mode:
authorLibravatar Christoph Gysin <christoph.gysin@gmail.com>2015-12-02 12:47:34 +0200
committerLibravatar Christoph Gysin <christoph.gysin@gmail.com>2015-12-02 12:49:01 +0200
commit99af7e7c9cf3fbf6e3b626fa7b8e20f173bd6295 (patch)
tree2064357a24faf45ec40ef38475d6a81f13f5eb3f /swaygrab
parentMerge pull request #291 from christophgysin/libs (diff)
downloadsway-99af7e7c9cf3fbf6e3b626fa7b8e20f173bd6295.tar.gz
sway-99af7e7c9cf3fbf6e3b626fa7b8e20f173bd6295.tar.zst
sway-99af7e7c9cf3fbf6e3b626fa7b8e20f173bd6295.zip
move manpages to subfolders
Diffstat (limited to 'swaygrab')
-rw-r--r--swaygrab/CMakeLists.txt2
-rw-r--r--swaygrab/swaygrab.1.txt58
2 files changed, 60 insertions, 0 deletions
diff --git a/swaygrab/CMakeLists.txt b/swaygrab/CMakeLists.txt
index d5468cda..f664c01d 100644
--- a/swaygrab/CMakeLists.txt
+++ b/swaygrab/CMakeLists.txt
@@ -13,3 +13,5 @@ install(
13 DESTINATION bin 13 DESTINATION bin
14 COMPONENT runtime 14 COMPONENT runtime
15) 15)
16
17add_manpage(swaygrab 1)
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 @@
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] [output] [file]
16
17Grabs pixels from _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*-v, \--version*::
31 Print the version (of swaymsg) and quit.
32
33*-s, --socket* <path>::
34 Use the specified socket path. Otherwise, swaymsg will ask sway where the
35 socket is (which is the value of $SWAYSOCK, then of $I3SOCK).
36
37*-r, --rate* <rate>::
38 Specify a framerate (in frames per second). Used in combination with -c.
39 Default is 30. Must be an integer.
40
41*--raw*::
42 Instead of invoking ImageMagick or ffmpeg, dump raw rgba data to stdout.
43
44Examples
45--------
46
47swaygrab HDMI-A-1 output.png::
48 Grab the contents of HDMI-A-1 and write to output.png.
49
50swaygrab -c HDMI-A-1 output.webm::
51 Capture a webm of HDMI-A-1.
52
53Authors
54-------
55
56Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
57source contributors. For more information about sway development, see
58<https://github.com/SirCmpwn/sway>.