diff options
Diffstat (limited to 'swaymsg/swaymsg.1.scd')
-rw-r--r-- | swaymsg/swaymsg.1.scd | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/swaymsg/swaymsg.1.scd b/swaymsg/swaymsg.1.scd new file mode 100644 index 00000000..1aa6a1b0 --- /dev/null +++ b/swaymsg/swaymsg.1.scd | |||
@@ -0,0 +1,66 @@ | |||
1 | swaymsg(1) | ||
2 | |||
3 | # NAME | ||
4 | |||
5 | swaymsg - Send messages to a running instance of sway over the IPC socket. | ||
6 | |||
7 | # SYNOPSIS | ||
8 | |||
9 | _swaymsg_ [options...] [message] | ||
10 | |||
11 | # OPTIONS | ||
12 | |||
13 | *-h, --help* | ||
14 | Show help message and quit. | ||
15 | |||
16 | *-q, --quiet* | ||
17 | Sends the IPC message but does not print the response from sway. | ||
18 | |||
19 | *-r, --raw* | ||
20 | Use raw output even if using a tty. | ||
21 | |||
22 | *-s, --socket* <path> | ||
23 | Use the specified socket path. Otherwise, swaymsg will ask sway where the | ||
24 | socket is (which is the value of $SWAYSOCK, then of $I3SOCK). | ||
25 | |||
26 | *-t, --type* <type> | ||
27 | Specify the type of IPC message. See below. | ||
28 | |||
29 | *-v, --version* | ||
30 | Print the version (of swaymsg) and quit. | ||
31 | |||
32 | # IPC MESSAGE TYPES | ||
33 | |||
34 | *<command>* | ||
35 | The message is a sway command (the same commands you can bind to keybindings | ||
36 | in your sway config file). It will be executed immediately. | ||
37 | |||
38 | See **sway**(5) for a list of commands. | ||
39 | |||
40 | *get\_workspaces* | ||
41 | Gets a JSON-encoded list of workspaces and their status. | ||
42 | |||
43 | *get\_inputs* | ||
44 | Gets a JSON-encoded list of current inputs. | ||
45 | |||
46 | *get\_outputs* | ||
47 | Gets a JSON-encoded list of current outputs. | ||
48 | |||
49 | *get\_tree* | ||
50 | Gets a JSON-encoded layout tree of all open windows, containers, outputs, | ||
51 | workspaces, and so on. | ||
52 | |||
53 | *get\_marks* | ||
54 | Get a JSON-encoded list of marks. | ||
55 | |||
56 | *get\_bar\_config* | ||
57 | Get a JSON-encoded configuration for swaybar. | ||
58 | |||
59 | *get\_version* | ||
60 | Get JSON-encoded version information for the running instance of sway. | ||
61 | |||
62 | *get\_clipboard* | ||
63 | Get JSON-encoded information about the clipboard. | ||
64 | Returns the current clipboard mime-types if called without | ||
65 | arguments, otherwise returns the clipboard data in the requested | ||
66 | formats. Encodes the data using base64 for non-text mime types. | ||