aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Drew DeVault <sir@cmpwn.com>2015-11-26 15:14:23 -0500
committerLibravatar Drew DeVault <sir@cmpwn.com>2015-11-26 15:14:23 -0500
commit4e7dccf631bdf1f9b676b44e18331c6b55880c6b (patch)
tree0922916d1f0a80e7b415e79f23c5bbf87aef8d88
parentImplement swaymsg IPC behavior (diff)
downloadsway-4e7dccf631bdf1f9b676b44e18331c6b55880c6b.tar.gz
sway-4e7dccf631bdf1f9b676b44e18331c6b55880c6b.tar.zst
sway-4e7dccf631bdf1f9b676b44e18331c6b55880c6b.zip
Add swaymsg(1) man page
-rw-r--r--CMakeLists.txt1
-rw-r--r--swaymsg.1.txt69
2 files changed, 70 insertions, 0 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index bf94ca88..55d2cde8 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -109,6 +109,7 @@ endfunction ()
109 109
110add_manpage(sway 1) 110add_manpage(sway 1)
111add_manpage(sway 5) 111add_manpage(sway 5)
112add_manpage(swaymsg 1)
112 113
113install( 114install(
114 FILES "${CMAKE_CURRENT_SOURCE_DIR}/sway.desktop" 115 FILES "${CMAKE_CURRENT_SOURCE_DIR}/sway.desktop"
diff --git a/swaymsg.1.txt b/swaymsg.1.txt
new file mode 100644
index 00000000..d832dd17
--- /dev/null
+++ b/swaymsg.1.txt
@@ -0,0 +1,69 @@
1/////
2vim:set ts=4 sw=4 tw=82 noet:
3/////
4:quotes.~:
5
6swaymsg (1)
7===========
8
9Name
10----
11swaymsg - Send messages to a running instance of sway over the IPC socket.
12
13Synopsis
14--------
15'swaymsg' [options] [message]
16
17Options
18-------
19
20*-q, \--quiet*::
21 Sends the IPC message but does not print the response from sway.
22
23*-v, \--version*::
24 Print the version (of swaymsg) and quit.
25
26*-s, --socket* <path>::
27 Use the specified socket path. Otherwise, swaymsg will ask sway where the
28 socket is (which is the value of $SWAYSOCK, then of $I3SOCK).
29
30*-t, \--type* <type>::
31 Specify the type of IPC message. See below.
32
33IPC Message Types
34-----------------
35
36*command*::
37 The message is a sway command (the same commands you can bind to keybindings
38 in your sway config file). It will be executed immediately.
39
40*get_workspaces*::
41 Gets a JSON-encoded list of workspaces and their status.
42
43*get_outputs*::
44 Gets a JSON-encoded list of current outputs.
45
46*get_tree*::
47 Gets a JSON-encoded layout tree of all open windows, containers, outputs,
48 workspaces, and so on.
49
50*get_marks*::
51 Get a JSON-encoded list of marks.
52
53*get_bar_config*::
54 Get a JSON-encoded configuration for swaybar.
55
56*get_version*::
57 Get JSON-encoded version information for the running instance of sway.
58
59Authors
60-------
61
62Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
63source contributors. For more information about sway development, see
64<https://github.com/SirCmpwn/sway>.
65
66See Also
67--------
68
69**sway**(5)