commit 4e7dccf631bdf1f9b676b44e18331c6b55880c6b
parent a1018f32801320bab67261828394c76dd0fe0c45
Author: Drew DeVault <sir@cmpwn.com>
Date: Thu, 26 Nov 2015 15:14:23 -0500
Add swaymsg(1) man page
Diffstat:
2 files changed, 70 insertions(+), 0 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -109,6 +109,7 @@ endfunction ()
add_manpage(sway 1)
add_manpage(sway 5)
+add_manpage(swaymsg 1)
install(
FILES "${CMAKE_CURRENT_SOURCE_DIR}/sway.desktop"
diff --git a/swaymsg.1.txt b/swaymsg.1.txt
@@ -0,0 +1,69 @@
+/////
+vim:set ts=4 sw=4 tw=82 noet:
+/////
+:quotes.~:
+
+swaymsg (1)
+===========
+
+Name
+----
+swaymsg - Send messages to a running instance of sway over the IPC socket.
+
+Synopsis
+--------
+'swaymsg' [options] [message]
+
+Options
+-------
+
+*-q, \--quiet*::
+ Sends the IPC message but does not print the response from sway.
+
+*-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).
+
+*-t, \--type* <type>::
+ Specify the type of IPC message. See below.
+
+IPC Message Types
+-----------------
+
+*command*::
+ The message is a sway command (the same commands you can bind to keybindings
+ in your sway config file). It will be executed immediately.
+
+*get_workspaces*::
+ Gets a JSON-encoded list of workspaces and their status.
+
+*get_outputs*::
+ Gets a JSON-encoded list of current outputs.
+
+*get_tree*::
+ Gets a JSON-encoded layout tree of all open windows, containers, outputs,
+ workspaces, and so on.
+
+*get_marks*::
+ Get a JSON-encoded list of marks.
+
+*get_bar_config*::
+ Get a JSON-encoded configuration for swaybar.
+
+*get_version*::
+ Get JSON-encoded version information for the running instance of sway.
+
+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)
