mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2024-12-01 19:06:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
sway/swaymsg/swaymsg.1.txt

85 lines
1.9 KiB
Plaintext
Raw Permalink Normal View History

Add swaymsg(1) man page
2015-11-26 20:14:23 +00:00
/////
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
-------
swaymsg: Add --help option that prints usage
2015-11-28 14:18:46 +00:00
*-h, --help*::
Show help message and quit.
Add swaymsg(1) man page
2015-11-26 20:14:23 +00:00
*-q, \--quiet*::
Sends the IPC message but does not print the response from sway.
Add pretty printing to swaymsg If stdout is a tty, it will pretty print unless -r (--raw) is given. Sample outputs: ``` ~/s/s/build > ./bin/swaymsg fullscreen toggle Error: Permission denied for fullscreen toggle via IPC ~/s/s/build > ./bin/swaymsg -t get_workspaces Workspace 3:三 Output: DVI-I-1 Layout: splith Workspace 1:一 (off-screen) Output: HDMI-A-1 Layout: splith Workspace 5:五 (focused) Output: HDMI-A-1 Layout: splith ~/s/s/build > ./bin/swaymsg -t get_inputs Input device Metadot - Das Keyboard Das Keyboard Type: Keyboard Sway ID: 9456:320:Metadot_-_Das_Keyboard_Das_Keyb Input device Wacom Intuos S 2 Pen Type: Tablet tool Sway ID: 1386:827:Wacom_Intuos_S_2 Input device Wacom Intuos S 2 Pad Type: Tablet pad Sway ID: 1386:827:Wacom_Intuos_S_2 Input device Logitech Gaming Mouse G502 Type: Keyboard, Mouse Sway ID: 1133:49277:Logitech_Gaming_Mous ~/s/s/build > ./bin/swaymsg -t get_outputs Output DVI-I-1 Geometry: 1920x1080 @ 3840,0 Scale factor: 1x Workspace: 3:三 Output DVI-D-1 Geometry: 1920x1080 @ 0,0 Scale factor: 1x Workspace: 4:四 Output HDMI-A-1 Geometry: 1920x1080 @ 1920,0 Scale factor: 1x Workspace: 5:五 ```
2017-04-03 11:27:25 +00:00
*-r, \--raw*::
Use raw output even if using a tty.
Add swaymsg(1) man page
2015-11-26 20:14:23 +00:00
*-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.
Add pretty printing to swaymsg If stdout is a tty, it will pretty print unless -r (--raw) is given. Sample outputs: ``` ~/s/s/build > ./bin/swaymsg fullscreen toggle Error: Permission denied for fullscreen toggle via IPC ~/s/s/build > ./bin/swaymsg -t get_workspaces Workspace 3:三 Output: DVI-I-1 Layout: splith Workspace 1:一 (off-screen) Output: HDMI-A-1 Layout: splith Workspace 5:五 (focused) Output: HDMI-A-1 Layout: splith ~/s/s/build > ./bin/swaymsg -t get_inputs Input device Metadot - Das Keyboard Das Keyboard Type: Keyboard Sway ID: 9456:320:Metadot_-_Das_Keyboard_Das_Keyb Input device Wacom Intuos S 2 Pen Type: Tablet tool Sway ID: 1386:827:Wacom_Intuos_S_2 Input device Wacom Intuos S 2 Pad Type: Tablet pad Sway ID: 1386:827:Wacom_Intuos_S_2 Input device Logitech Gaming Mouse G502 Type: Keyboard, Mouse Sway ID: 1133:49277:Logitech_Gaming_Mous ~/s/s/build > ./bin/swaymsg -t get_outputs Output DVI-I-1 Geometry: 1920x1080 @ 3840,0 Scale factor: 1x Workspace: 3:三 Output DVI-D-1 Geometry: 1920x1080 @ 0,0 Scale factor: 1x Workspace: 4:四 Output HDMI-A-1 Geometry: 1920x1080 @ 1920,0 Scale factor: 1x Workspace: 5:五 ```
2017-04-03 11:27:25 +00:00
*-v, \--version*::
Print the version (of swaymsg) and quit.
Add swaymsg(1) man page
2015-11-26 20:14:23 +00:00
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.
*get_workspaces*::
Gets a JSON-encoded list of workspaces and their status.
libinput
2016-01-17 10:53:37 +00:00
*get_inputs*::
Gets a JSON-encoded list of current inputs.
Add swaymsg(1) man page
2015-11-26 20:14:23 +00:00
*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.
Rework get_clipboard implementation
2017-07-07 19:51:34 +00:00
*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.
Add swaymsg(1) man page
2015-11-26 20:14:23 +00:00
Authors
-------
Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
source contributors. For more information about sway development, see
Fix github links in doc
2017-10-06 03:13:42 +00:00
<https://github.com/swaywm/sway>.
Add swaymsg(1) man page
2015-11-26 20:14:23 +00:00
See Also
--------
**sway**(5)
Reference in a new issue Copy permalink