diff options
author | Drew DeVault <sir@cmpwn.com> | 2018-05-12 09:27:24 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-05-12 09:27:24 -0400 |
commit | 867190e0828a139fa4529cde60d033a9389df42c (patch) | |
tree | c986cca12ecdb3e3ac4d94d38205028788315889 /swaymsg | |
parent | 51b0b25587d69593eb77e3337e3fa459c1024f5c (diff) | |
parent | 2da685e913432716f55cd537fd3d64f3fb3cc09a (diff) |
Merge pull request #1958 from swaywm/scdoc
Port man pages to scdoc
Diffstat (limited to 'swaymsg')
-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 @@ +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. |