diff options
author | 2015-12-05 18:16:45 -0500 | |
---|---|---|
committer | 2015-12-05 18:16:45 -0500 | |
commit | 762a78be3ca22767b94adf5bba4668047aa80e4e (patch) | |
tree | 53cf05c4a723991b1da13f835297a2d1fb420d5e /swaygrab | |
parent | Free outputs on registry teardown (diff) | |
parent | move manpages to subfolders (diff) | |
download | sway-762a78be3ca22767b94adf5bba4668047aa80e4e.tar.gz sway-762a78be3ca22767b94adf5bba4668047aa80e4e.tar.zst sway-762a78be3ca22767b94adf5bba4668047aa80e4e.zip |
Merge pull request #292 from christophgysin/man
move manpages to subfolders
Diffstat (limited to 'swaygrab')
-rw-r--r-- | swaygrab/CMakeLists.txt | 2 | ||||
-rw-r--r-- | swaygrab/swaygrab.1.txt | 58 |
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 | |||
17 | add_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 | ///// | ||
2 | vim:set ts=4 sw=4 tw=82 noet: | ||
3 | ///// | ||
4 | :quotes.~: | ||
5 | |||
6 | swaygrab (1) | ||
7 | ============ | ||
8 | |||
9 | Name | ||
10 | ---- | ||
11 | swaygrab - Grab image data from the current sway session. | ||
12 | |||
13 | Synopsis | ||
14 | -------- | ||
15 | 'swaygrab' [options] [output] [file] | ||
16 | |||
17 | Grabs pixels from _output_ and writes them to _file_. The image will be passed to | ||
18 | ImageMagick convert for processing. | ||
19 | |||
20 | Options | ||
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 | |||
44 | Examples | ||
45 | -------- | ||
46 | |||
47 | swaygrab HDMI-A-1 output.png:: | ||
48 | Grab the contents of HDMI-A-1 and write to output.png. | ||
49 | |||
50 | swaygrab -c HDMI-A-1 output.webm:: | ||
51 | Capture a webm of HDMI-A-1. | ||
52 | |||
53 | Authors | ||
54 | ------- | ||
55 | |||
56 | Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open | ||
57 | source contributors. For more information about sway development, see | ||
58 | <https://github.com/SirCmpwn/sway>. | ||