.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "sway" "1" "2023-12-23"
.P
.SH NAME
.P
sway - An i3-compatible Wayland compositor
.P
.SH SYNOPSIS
.P
\fBsway\fR [options.\&.\&.\&] [command]
.P
.SH OPTIONS
.P
\fB-h, --help\fR
.RS 4
Show help message and quit.\&
.P
.RE
\fB-c, --config\fR <config>
.RS 4
Specifies a config file.\&
.P
.RE
\fB-C, --validate\fR
.RS 4
Check the validity of the config file, then exit.\&
.P
.RE
\fB-d, --debug\fR
.RS 4
Enables full logging, including debug information.\&
.P
.RE
\fB-v, --version\fR
.RS 4
Show the version number and quit.\&
.P
.RE
\fB-V, --verbose\fR
.RS 4
Enables more verbose logging.\&
.P
.RE
\fB--get-socketpath\fR
.RS 4
Gets the IPC socket path and prints it, then exits.\&
.P
.RE
.SH DESCRIPTION
.P
sway was created to fill the need of an i3-like window manager for Wayland.\& The
upstream i3 developers have no intention of porting i3 to Wayland, and projects
proposed by others ended up as vaporware.\& Many thanks to the i3 folks for
providing such a great piece of software, so good that your users would rather
write an entirely new window manager from scratch that behaved \fIexactly\fR like i3
rather than switch to something else.\&
.P
You can run sway directly from a tty, or via a Wayland-compatible login manager.\&
.P
.SH CONFIGURATION
.P
sway searches for a config file in the following locations, in this order:
.P
.RS 4
.ie n \{\
\h'-04'1.\h'+03'\c
.\}
.el \{\
.IP 1. 4
.\}
~/.\&sway/config
.RE
.RS 4
.ie n \{\
\h'-04'2.\h'+03'\c
.\}
.el \{\
.IP 2. 4
.\}
$XDG_CONFIG_HOME/sway/config (suggested location)
.RE
.RS 4
.ie n \{\
\h'-04'3.\h'+03'\c
.\}
.el \{\
.IP 3. 4
.\}
~/.\&i3/config
.RE
.RS 4
.ie n \{\
\h'-04'4.\h'+03'\c
.\}
.el \{\
.IP 4. 4
.\}
$XDG_CONFIG_HOME/i3/config
.RE
.RS 4
.ie n \{\
\h'-04'5.\h'+03'\c
.\}
.el \{\
.IP 5. 4
.\}
/etc/sway/config
.RE
.RS 4
.ie n \{\
\h'-04'6.\h'+03'\c
.\}
.el \{\
.IP 6. 4
.\}
/etc/i3/config

.RE
.P
If unset, $XDG_CONFIG_HOME defaults to \fB~/.\&config\fR.\&
.P
An error is raised when no config file is found.\& The recommended default
configuration is usually installed to \fB/etc/sway/config\fR; you are encouraged to
copy this to \fB~/.\&config/sway/config\fR and edit it from there.\&
.P
For information on the config file format, see \fBsway\fR(5).\&
.P
.SH IPC COMMANDS
.P
Though \fBswaymsg\fR(1) is generally preferred, you may run \fBsway\fR \fIcommand\fR to
send \fIcommand\fR to the running instance of sway.\& You can also issue commands
with \fBi3-msg\fR(1) or even with \fBi3\fR(1).\&
.P
.SH ENVIRONMENT
.P
The following environment variables have an effect on sway:
.P
\fISWAYSOCK\fR
.RS 4
Specifies the path to the sway IPC socket.\&
.P
.RE
\fIXKB_DEFAULT_RULES\fR, \fIXKB_DEFAULT_MODEL\fR, \fIXKB_DEFAULT_LAYOUT\fR,
\fIXKB_DEFAULT_VARIANT\fR, \fIXKB_DEFAULT_OPTIONS\fR
.RS 4
Configures the xkb keyboard settings.\& See \fBxkeyboard-config\fR(7).\& The
preferred way to configure the keyboard is via the configuration file, see
\fBsway-input\fR(5).\&
.P
.RE
The following environment variables are set by sway:
.P
\fIDISPLAY\fR
.RS 4
If compiled with Xwayland support and Xwayland is not disabled by the
config, this will be set to the name of the X display used for Xwayland.\&
.P
.RE
\fII3SOCK\fR
.RS 4
For compatibility with i3, specifies the path to the sway IPC socket.\&
.P
.RE
\fISWAYSOCK\fR
.RS 4
Specifies the path to the sway IPC socket.\&
.P
.RE
\fIWAYLAND_DISPLAY\fR
.RS 4
Specifies the name of the Wayland display that sway is running on.\&
.P
.RE
\fIXCURSOR_SIZE\fR
.RS 4
Specifies the configured cursor size.\&
.P
.RE
\fIXCURSOR_THEME\fR
.RS 4
Specifies the configured cursor theme.\&
.P
.RE
.SH AUTHORS
.P
Maintained by Simon Ser <contact@emersion.\&fr>, who is assisted by other open
source contributors.\& For more information about sway development, see
<https://github.\&com/swaywm/sway>.\&
.P
.SH SEE ALSO
.P
\fBsway\fR(5) \fBswaymsg\fR(1) \fBsway-input\fR(5) \fBsway-output\fR(5) \fBsway-bar\fR(5)
\fBsway-ipc\fR(7)