mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2024-11-17 21:49:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
sway/swaymsg/swaymsg.1.scd

110 lines
2.8 KiB
Plaintext
Raw Normal View History

Add swaylock(1) and swaymsg(1)
2018-05-12 01:39:47 +00:00
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.
Implement support for swaymsg -t SUBSCRIBE [-m] In `i3 4.16`, `i3-msg` can be used with the message type `subscribe` and has the ability to monitor for responses until killed. This adds support for both to swaymsg. If the JSON array of event types is malformed or contains an invalid event, sway will send a response with `success` set to `false`. If swaymsg sees this, it will not display the failure and exit. If the `subscribe` event is successful, swaymsg will wait for the first response and display that instead of the success message. If `-m/--monitor` is given, swaymsg will continue monitor for responses until killed or a malformed response is received. For the `subscribe` event, the responses will always be printed as JSON. If `-r/--raw` is given, the JSON will not be pretty printed, which may be preferred when monitoring due to there being multiple responses. Example: `swaymsg -t SUBSCRIBE -m "['window']"`
2018-11-28 16:19:18 +00:00
*-m, --monitor*
Monitor for responses until killed instead of exiting after the first
response. This can only be used with the IPC message type _subscribe_. If
there is a malformed response or an invalid event type was requested,
swaymsg will stop monitoring and exit.
Add -p/--pretty option to swaymsg This new option forces pretty (non-raw/non-JSON) output. By default, when not using a tty, swaymsg outputs using the "raw" format. This makes it impossible to, for example, pipe the pretty output to a pager such as `less` since piping does not use a tty. The new -p/--pretty option gives the user explicit control over the output format while retaining the default tty-dependent behavior. Signed-off-by: Peter Grayson <pete@jpgrayson.net>
2019-03-08 17:43:04 +00:00
*-p, --pretty*
Use raw output even when not using a tty.
Add swaylock(1) and swaymsg(1)
2018-05-12 01:39:47 +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.
*-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.
swaymsg.1: add tip about two hyphens for commands This adds a tip to the command section about using two hyphens before a command to signal that no swaymsg options will follow to allow for sway commands with leading hyphens.
2019-08-13 02:23:29 +00:00
Tip: If you are proving a command that contains a leading hyphen (_-_),
insert two hyphens (_--_) before the command to signal to swaymsg not to
parse anything beyond that point as an option. For example, use
_swaymsg -- mark --add test_ instead of _swaymsg mark --add test_
Add swaylock(1) and swaymsg(1)
2018-05-12 01:39:47 +00:00
*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.
document swaymessage type for get_seats
2018-11-04 21:49:44 +00:00
*get\_seats*
Gets a JSON-encoded list of all seats,
its properties and all assigned devices.
Add swaylock(1) and swaymsg(1)
2018-05-12 01:39:47 +00:00
*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.
Add get_binding_modes message type to ipc
2018-07-08 19:32:42 +00:00
*get\_binding\_modes*
Gets a JSON-encoded list of currently configured binding modes.
Add get_config message type to ipc
2018-07-08 19:34:47 +00:00
*get\_config*
Gets a JSON-encoded copy of the current configuration.
ipc: add tick event
2018-07-18 11:30:39 +00:00
*send\_tick*
Sends a tick event to all subscribed clients.
Implement support for swaymsg -t SUBSCRIBE [-m] In `i3 4.16`, `i3-msg` can be used with the message type `subscribe` and has the ability to monitor for responses until killed. This adds support for both to swaymsg. If the JSON array of event types is malformed or contains an invalid event, sway will send a response with `success` set to `false`. If swaymsg sees this, it will not display the failure and exit. If the `subscribe` event is successful, swaymsg will wait for the first response and display that instead of the success message. If `-m/--monitor` is given, swaymsg will continue monitor for responses until killed or a malformed response is received. For the `subscribe` event, the responses will always be printed as JSON. If `-r/--raw` is given, the JSON will not be pretty printed, which may be preferred when monitoring due to there being multiple responses. Example: `swaymsg -t SUBSCRIBE -m "['window']"`
2018-11-28 16:19:18 +00:00
*subscribe*
Subscribe to a list of event types. The argument for this type should be
provided in the form of a valid JSON array. If any of the types are invalid
or if an valid JSON array is not provided, this will result in an failure.
Add sway-ipc.7.scd to document IPC protocol This add `sway-ipc.7.scd` that documents the IPC protocol. This also increased the minimum scdoc version from 1.8.1 to 1.9.0 to allow for table cells to be continued on the following line
2019-02-27 18:23:10 +00:00
swaymsg: return 2 for sway errors This mirrors a change in i3 4.17 that returns 2 for errors from sway, including invalid command, command failed, and invalid subscription requests
2019-08-04 06:02:13 +00:00
# RETURN CODES
*0*
Success
*1*
swaymsg errors such as invalid syntax, unable to connect to the ipc socket
or unable to parse sway's reply
*2*
Sway returned an error when processing the command (ex. invalid command,
command failed, and invalid subscription request)
Add sway-ipc.7.scd to document IPC protocol This add `sway-ipc.7.scd` that documents the IPC protocol. This also increased the minimum scdoc version from 1.8.1 to 1.9.0 to allow for table cells to be continued on the following line
2019-02-27 18:23:10 +00:00
# SEE ALSO
*sway*(5) *sway-bar*(5) *sway-input*(5) *sway-output*(5) *sway-ipc*(7)
Reference in a new issue Copy permalink