sway(1) - f31

1sway(1)                     General Commands Manual                    sway(1)
2
3
4

NAME

6       sway - An i3-compatible Wayland compositor
7

SYNOPSIS

9       sway [options...] [command]
10

OPTIONS

12       -h, --help
13           Show help message and quit.
14
15       -c, --config <config>
16           Specifies a config file.
17
18       -C, --validate
19           Check the validity of the config file, then exit.
20
21       -d, --debug
22           Enables full logging, including debug information.
23
24       -v, --version
25           Show the version number and quit.
26
27       -V, --verbose
28           Enables more verbose logging.
29
30       --get-socketpath
31           Gets the IPC socket path and prints it, then exits.
32

DESCRIPTION

34       sway was created to fill the need of an i3-like window manager for Way‐
35       land. The upstream i3 developers have no intention of porting i3 to
36       Wayland, and projects proposed by others ended up as vaporware. Many
37       thanks to the i3 folks for providing such a great piece of software, so
38       good that your users would rather write an entirely new window manager
39       from scratch that behaved exactly like i3 rather than switch to some‐
40       thing else.
41
42       You can run sway directly from a tty, or via a Wayland-compatible login
43       manager.
44

CONFIGURATION

46       sway searches for a config file in the following locations, in this
47       order:
48
49       1.   ~/.sway/config
50       2.   $XDG_CONFIG_HOME/sway/config (suggested location)
51       3.   ~/.i3/config
52       4.   $XDG_CONFIG_HOME/i3/config
53       5.   /etc/sway/config
54       6.   /etc/i3/config
55
56
57       If unset, $XDG_CONFIG_HOME defaults to ~/.config.
58
59       An error is raised when no config file is found. The recommended
60       default configuration is usually installed to /etc/sway/config; you are
61       encouraged to copy this to ~/.config/sway/config and edit it from
62       there.
63
64       For information on the config file format, see sway(5).
65

IPC COMMANDS

67       Though swaymsg(1) is generally preferred, you may run sway command to
68       send command to the running instance of sway. You can also issue com‐
69       mands with i3-msg(1) or even with i3(1).
70

ENVIRONMENT

72       The following environment variables have an effect on sway:
73
74       SWAYSOCK
75           Specifies the path to the sway IPC socket.
76
77       XKB_DEFAULT_RULES, XKB_DEFAULT_MODEL, XKB_DEFAULT_LAYOUT,
78       XKB_DEFAULT_VARIANT, XKB_DEFAULT_OPTIONS
79           Configures the xkb keyboard settings. See xkeyboard-config(7). The
80           preferred way to configure the keyboard is via the configuration
81           file, see sway-input(5).
82
83       The following environment variables are set by sway:
84
85       DISPLAY
86           If compiled with Xwayland support and Xwayland is not disabled by
87           the config, this will be set to the name of the X display used for
88           Xwayland
89
90       I3SOCK
91           For compatibility with i3, specifies the path to the sway IPC
92           socket
93
94       SWAYSOCK
95           Specifies the path to the sway IPC socket
96
97       WAYLAND_DISPLAY
98           Specifies the name of the Wayland display that sway is running on
99
100       XCURSOR_SIZE
101           Specifies the configured cursor size
102
103       XCURSOR_THEME
104           Specifies the configured cursor theme
105

AUTHORS

107       Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other
108       open source contributors. For more information about sway development,
109       see <https://github.com/swaywm/sway>.
110