aboutsummaryrefslogtreecommitdiff
path: root/swaymsg/swaymsg.1.txt
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2015-12-05 18:16:45 -0500
committerDrew DeVault <sir@cmpwn.com>2015-12-05 18:16:45 -0500
commit762a78be3ca22767b94adf5bba4668047aa80e4e (patch)
tree53cf05c4a723991b1da13f835297a2d1fb420d5e /swaymsg/swaymsg.1.txt
parente39f846247c639ed1194ffeaa460acf6b7900c2c (diff)
parent99af7e7c9cf3fbf6e3b626fa7b8e20f173bd6295 (diff)
Merge pull request #292 from christophgysin/man
move manpages to subfolders
Diffstat (limited to 'swaymsg/swaymsg.1.txt')
-rw-r--r--swaymsg/swaymsg.1.txt72
1 files changed, 72 insertions, 0 deletions
diff --git a/swaymsg/swaymsg.1.txt b/swaymsg/swaymsg.1.txt
new file mode 100644
index 00000000..984780fa
--- /dev/null
+++ b/swaymsg/swaymsg.1.txt
@@ -0,0 +1,72 @@
+/////
+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
+-------
+
+*-h, --help*::
+ Show help message and quit.
+
+*-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)