commit 59e97c27884a0dc82eb45f3269368bb684044aa2
parent 7c04cd4fc849f01aaf3c5e8b09bee0a8af39276e
Author: Drew DeVault <sir@cmpwn.com>
Date: Fri, 27 Nov 2015 10:06:24 -0500
Add swaygrab(1) man page
Diffstat:
2 files changed, 45 insertions(+), 0 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -111,6 +111,7 @@ endfunction ()
add_manpage(sway 1)
add_manpage(sway 5)
add_manpage(swaymsg 1)
+add_manpage(swaygrab 1)
install(
FILES "${CMAKE_CURRENT_SOURCE_DIR}/sway.desktop"
diff --git a/swaygrab.1.txt b/swaygrab.1.txt
@@ -0,0 +1,44 @@
+/////
+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
+-------
+
+*-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).
+
+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>.
+
+See Also
+--------
+
+**sway**(5)
