diff options
Diffstat (limited to 'swaymsg/swaymsg.1.scd')
-rw-r--r-- | swaymsg/swaymsg.1.scd | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/swaymsg/swaymsg.1.scd b/swaymsg/swaymsg.1.scd index b69013b5..abee1bb9 100644 --- a/swaymsg/swaymsg.1.scd +++ b/swaymsg/swaymsg.1.scd | |||
@@ -21,12 +21,13 @@ _swaymsg_ [options...] [message] | |||
21 | 21 | ||
22 | *-p, --pretty* | 22 | *-p, --pretty* |
23 | Use pretty output even when not using a tty. | 23 | Use pretty output even when not using a tty. |
24 | Not available for all message types. | ||
24 | 25 | ||
25 | *-q, --quiet* | 26 | *-q, --quiet* |
26 | Sends the IPC message but does not print the response from sway. | 27 | Sends the IPC message but does not print the response from sway. |
27 | 28 | ||
28 | *-r, --raw* | 29 | *-r, --raw* |
29 | Use raw output even if using a tty. | 30 | Use raw JSON output even if using a tty. |
30 | 31 | ||
31 | *-s, --socket* <path> | 32 | *-s, --socket* <path> |
32 | Use the specified socket path. Otherwise, swaymsg will ask sway where the | 33 | Use the specified socket path. Otherwise, swaymsg will ask sway where the |
@@ -46,6 +47,11 @@ _swaymsg_ [options...] [message] | |||
46 | 47 | ||
47 | See *sway*(5) for a list of commands. | 48 | See *sway*(5) for a list of commands. |
48 | 49 | ||
50 | _swaymsg_ can return pretty printed (standalone-default) or JSON-formatted | ||
51 | (*--raw*) output. For detailed documentation on the returned JSON-data of | ||
52 | each message type listed below, refer to *sway-ipc*(7). The JSON-format can | ||
53 | contain more information than the pretty print. | ||
54 | |||
49 | Tips: | 55 | Tips: |
50 | - Command expansion is performed twice: once by swaymsg, and again by sway. | 56 | - Command expansion is performed twice: once by swaymsg, and again by sway. |
51 | If you have quoted multi-word strings in your command, enclose the entire | 57 | If you have quoted multi-word strings in your command, enclose the entire |
@@ -60,20 +66,20 @@ _swaymsg_ [options...] [message] | |||
60 | _swaymsg -- mark --add test_ instead of _swaymsg mark --add test_. | 66 | _swaymsg -- mark --add test_ instead of _swaymsg mark --add test_. |
61 | 67 | ||
62 | *get\_workspaces* | 68 | *get\_workspaces* |
63 | Gets a JSON-encoded list of workspaces and their status. | 69 | Gets a list of workspaces and their status. |
64 | 70 | ||
65 | *get\_inputs* | 71 | *get\_inputs* |
66 | Gets a JSON-encoded list of current inputs. | 72 | Gets a list of current inputs. |
67 | 73 | ||
68 | *get\_outputs* | 74 | *get\_outputs* |
69 | Gets a JSON-encoded list of current outputs. | 75 | Gets a list of current outputs. |
70 | 76 | ||
71 | *get\_tree* | 77 | *get\_tree* |
72 | Gets a JSON-encoded layout tree of all open windows, containers, outputs, | 78 | Gets a JSON-encoded layout tree of all open windows, containers, outputs, |
73 | workspaces, and so on. | 79 | workspaces, and so on. |
74 | 80 | ||
75 | *get\_seats* | 81 | *get\_seats* |
76 | Gets a JSON-encoded list of all seats, | 82 | Gets a list of all seats, |
77 | its properties and all assigned devices. | 83 | its properties and all assigned devices. |
78 | 84 | ||
79 | *get\_marks* | 85 | *get\_marks* |
@@ -83,7 +89,7 @@ _swaymsg_ [options...] [message] | |||
83 | Get a JSON-encoded configuration for swaybar. | 89 | Get a JSON-encoded configuration for swaybar. |
84 | 90 | ||
85 | *get\_version* | 91 | *get\_version* |
86 | Get JSON-encoded version information for the running instance of sway. | 92 | Get version information for the running instance of sway. |
87 | 93 | ||
88 | *get\_binding\_modes* | 94 | *get\_binding\_modes* |
89 | Gets a JSON-encoded list of currently configured binding modes. | 95 | Gets a JSON-encoded list of currently configured binding modes. |
@@ -92,7 +98,7 @@ _swaymsg_ [options...] [message] | |||
92 | Gets JSON-encoded info about the current binding state. | 98 | Gets JSON-encoded info about the current binding state. |
93 | 99 | ||
94 | *get\_config* | 100 | *get\_config* |
95 | Gets a JSON-encoded copy of the current configuration. | 101 | Gets a copy of the current configuration. Doesn't expand includes. |
96 | 102 | ||
97 | *send\_tick* | 103 | *send\_tick* |
98 | Sends a tick event to all subscribed clients. | 104 | Sends a tick event to all subscribed clients. |
@@ -101,6 +107,8 @@ _swaymsg_ [options...] [message] | |||
101 | Subscribe to a list of event types. The argument for this type should be | 107 | Subscribe to a list of event types. The argument for this type should be |
102 | provided in the form of a valid JSON array. If any of the types are invalid | 108 | provided in the form of a valid JSON array. If any of the types are invalid |
103 | or if a valid JSON array is not provided, this will result in a failure. | 109 | or if a valid JSON array is not provided, this will result in a failure. |
110 | For a list of valid event types and the data returned with them refer to | ||
111 | *sway-ipc*(7). | ||
104 | 112 | ||
105 | # RETURN CODES | 113 | # RETURN CODES |
106 | 114 | ||