summaryrefslogtreecommitdiffstats
path: root/swaymsg/swaymsg.1.txt
blob: abc517c87b2f3d4b7573faf053d1bb874cad7d71 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/////
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.

*-r, \--raw*::
	Use raw output even if using a tty.

*-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.

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.
	+
	See **sway**(5) for a list of commands.

*get_workspaces*::
	Gets a JSON-encoded list of workspaces and their status.

*get_inputs*::
	Gets a JSON-encoded list of current inputs.

*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.

*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.

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/swaywm/sway>.

See Also
--------

**sway**(5)