sway/swaymsg/swaymsg.1.txt

87 lines
1.9 KiB
Plaintext
Raw Normal View History

2015-11-26 20:14:23 +00:00
/////
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.
2015-11-26 20:14:23 +00:00
*-q, \--quiet*::
Sends the IPC message but does not print the response from sway.
*-r, \--raw*::
Use raw output even if using a tty.
2015-11-26 20:14:23 +00:00
*-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.
*-v, \--version*::
Print the version (of swaymsg) and quit.
2015-11-26 20:14:23 +00:00
IPC Message Types
-----------------
*<command>*::
2015-11-26 20:14:23 +00:00
The message is a sway command (the same commands you can bind to keybindings
in your sway config file). It will be executed immediately.
+
See **sway**(5) for a list of commands.
2015-11-26 20:14:23 +00:00
*get_workspaces*::
Gets a JSON-encoded list of workspaces and their status.
2016-01-17 10:53:37 +00:00
*get_inputs*::
Gets a JSON-encoded list of current inputs.
2015-11-26 20:14:23 +00:00
*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.
2017-07-07 19:51:34 +00:00
*get_clipboard*::
Get JSON-encoded information about the clipboard.
Returns the current clipboard mime-types if called without
arguments, otherwise returns the clipboard data in the requested
formats. Encodes the data using base64 for non-text mime types.
2015-11-26 20:14:23 +00:00
Authors
-------
Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
source contributors. For more information about sway development, see
2017-10-06 03:13:42 +00:00
<https://github.com/swaywm/sway>.
2015-11-26 20:14:23 +00:00
See Also
--------
**sway**(5)