Sway: Difference between revisions

From Alpine Linux
m (Add swaybg as wallpaper daemon to the optional dependencies)
(pipewire-launcher)
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[http://swaywm.org Sway] is a tiling [[Wayland]] compositor. It's a drop-in replacement for the i3 window manager.
[http://swaywm.org Sway] is a tiling [[Wayland]] compositor. It's a drop-in replacement for the i3 window manager.


== Prerequisites ==
== Installation ==


First, install & configure eudev:
eudev:


<pre>
<pre>
# apk add eudev
# apk add eudev
# setup-udev
# setup-devd udev
</pre>
 
Then install graphics drivers appropriate to your system:
 
<pre>
# apk add mesa-dri-gallium  # gallium
# apk add mesa-dri-classic  # or classic
# apk add mesa-dri-nouveau  # for nvidia users
</pre>
</pre>


The following links contain guides for setting up the video stack.
Graphics drivers:


* [[Intel Video]]
* [[Intel Video]]
* [[Radeon Video]]
* [[Radeon Video]]
 
* [[Nvidia Video]]
Add yourself to the input and video groups:
Add user to the input and video groups:


<pre>
<pre>
Line 30: Line 22:
</pre>
</pre>


You have to log out and back in for this to take effect.


Install some TTF fonts:
Install some TTF fonts:
Line 38: Line 29:
</pre>
</pre>


Since sway 1.6.1 (more specifically, since wlroots 0.14), you need to set up libseat backend if you wish to run sway directly (without nesting it in another wayland compositor). To do that, [[Enable Community Repository|enable the community repository]] and choose one of the following methods:
seatd daemon:


<dl>
<dt>Option 1: seatd daemon (recommended)</dt>
<dd>
<pre>
<pre>
# apk add seatd
# apk add seatd
Line 51: Line 38:
</pre>
</pre>


If you are already logged in as a $USER, you will need to relogin.
[[elogind]], optional for suspend on lid close support.
</dd>
 
Install sway:


<dt>Option 2: seatd-launch</dt>
<dd>
<pre>
<pre>
# apk add seatd-launch
# apk add sway sway-doc
# apk add                \ # Install optional dependencies:
    xwayland            \ # recommended for compatibility reasons
    foot                \ # default terminal emulator
    bemenu              \ # wayland menu
    swaylock swaylockd  \ # lockscreen tool
    swaybg              \ # wallpaper daemon
    swayidle              # idle management (DPMS) daemon
</pre>
</pre>


When starting sway, you will need to prefix invocation with <code>seatd-launch</code>.   
Configure XDG_RUNTIME_DIRAdd the following to shell init scripts, for the default ash shell it is ~/.profile:
Note: <code>seatd-launch</code> is a suid binary, so it might be wise to use one of the other methods from a security perspective.
</dd>
 
<dt>Option 3: elogind daemon</dt>
<dd>


<pre>
<pre>
# apk add elogind polkit-elogind
if test -z "${XDG_RUNTIME_DIR}"; then
# rc-update add elogind
  export XDG_RUNTIME_DIR=/tmp/$(id -u)-runtime-dir
# rc-service elogind start
  if ! test -d "${XDG_RUNTIME_DIR}"; then
    mkdir "${XDG_RUNTIME_DIR}"
    chmod 0700 "${XDG_RUNTIME_DIR}"
  fi
fi
</pre>
</pre>


Using <code>elogind</code> will automatically set the necessary permissions, so you can skip adding groups like <code>seat</code> and <code>video</code>
</dd>


</dl>
For inter-program communication and functionality such as screensharing, install and enable dbus and PipeWire, see [[PipeWire]].


== Installation ==
Re-login or reboot to allow above modifications to take effect.


We can now install sway:
Launch Sway with dbus support:


<pre>
<pre>
# apk add sway sway-doc
dbus-run-session -- sway
# apk add                \ # Install optional dependencies:
    xwayland            \ # recommended for compatibility reasons
    foot                \ # default terminal emulator
    dmenu                \ # default application launcher
    swaylock            \ # lockscreen tool
    swaybg              \ # wallpaper daemon
    swayidle              # idle management (DPMS) daemon
</pre>
</pre>


== Running Sway ==
== Configuration ==
 
An example config is provided at <code>/etc/sway/config</code>. Copy it to <code>~/.config/sway/config</code> and read through it to learn the default keybindings.
 
For additional information, start at <code>man 5 sway</code> and read the [https://github.com/swaywm/sway/wiki upstream wiki].


To run sway, first set XDG_RUNTIME_DIR to a suitable location (e.g. create a .run folder in your home directory and set it to ~/.run). Then run sway from the Linux console (dbus-launch is used because pipewire needs it, it is included in dbus-x11 and you may omit it):
=== Firefox screensharing ===


For some programs, additional configuration is needed to launch them natively under Wayland and to support special features such as screen sharing.
To launch Firefox natively under Wayland and to enable support for screensharing, you need:
* Install and configure [[PipeWire]]
* Install xdg-desktop-portal and xdg-desktop-portal-wlr package
* Install wofi for screen selection
* Launch support programs on sway startup:
<pre>
<pre>
$ XDG_RUNTIME_DIR=~/.run dbus-launch sway
exec /usr/libexec/pipewire-launcher #pipewire must be launched first
exec /usr/libexec/xdg-desktop-portal-wlr
</pre>
</pre>
* Export the following variables:


(if you run sway with seatd-launch, you will need to use <code>$ XDG_RUNTIME_DIR=~/.run dbus-launch seatd-launch sway</code>)
You can also create a simple alias in your shell rc file (e.g. .zshrc), like:
<pre>
<pre>
alias swayinit="XDG_RUNTIME_DIR=~/.run dbus-launch seatd-launch sway"
export MOZ_ENABLE_WAYLAND="1"
export XDG_CURRENT_DESKTOP=sway
export XDG_SESSION_TYPE=wayland
export QT_QPA_PLATFORM="wayland-egl"
</pre>
</pre>


See the [https://wiki.alpinelinux.org/wiki/Wayland Wayland] page for a permanent configuration
=== Scaling for high resolution screens ===
 
Without further configuration, program interfaces might be too small to use on high resolution screens.
 
==== Via sway ====


{{Note|
Sway supports the per-display configuration of
swaylock needs to be able to read your <code>/etc/shadow</code> file to be able to validate your password
}}


== Configuration and Usage ==
* fractional (e.g., 1.5x), and
* integer scaling (e.g., 2x)


An example config is provided at <code>/etc/sway/config</code>. Copy it to <code>~/.config/sway/config</code> and read through it to learn the default keybindings.
However, fractional scaling is discouraged due to both the performance impact and the blurry output it produces. In this case, where 1x scaling is too small and 2x scaling is too large, program-specific GTK/QT based scaling is recommended.  See below.
 
To enable Sway scaling, the user can first preview different scaling factors with <code>wdisplays</code> package.  Note the output name (eDP-1, LVDS-1) and try apply scaling factors such as 1 and 2. To make changes permanent, add


You might want to have gaps between windows, in which case add:
<pre>
<pre>
inner_gaps 20
output <name> scale <factor>
outer_gaps 20
</pre>
</pre>
(replace 20 with the amount of pixels you want to be used for gaps) in your sway config.


You might have two monitors, and you might want to set their position, so here's an example of how to do it:
to ~/.config/sway/config.
 
==== Via GTK/Qt ====
 
<pre>
<pre>
output eDP-1 mode 1920x1080@60Hz
# for GTK-based programs such as firefox and emacs:
output eDP-1 position 1920,0
export GDK_DPI_SCALE=2
output DP-1 position 0,0
 
output DP-1 mode 1920x1080@120Hz
# for QT-based programs
export QT_WAYLAND_FORCE_DPI="physical"
# or if still too small, use a custom DPI
export QT_WAYLAND_FORCE_DPI=192 # 2x scaling
export QT_QPA_PLATFORM="wayland-egl"
</pre>
</pre>
In this case, eDP-1 is the internal laptop monitor running at 60Hz and DP-1 is the external monitor running at 120Hz. The position of the laptop monitor is where the external monitor's width ends, so if the display is 1920 pixels wide and it is on the left, the laptop's monitor would be on the right, so it's width would start at the end of the second monitor's width, so at 1920. Replace the eDP-1 and DP-1 outputs with your own ones, and to change resolution and refresh rate, change the mode according to your parameters.


For additional information, start at <code>man 5 sway</code> and read the [https://github.com/swaywm/sway/wiki upstream FAQ].
=== Make clipboard content persistent ===
By default the clipboard content does not persist after terminating the program: you copy some text from Firefox and then exit Firefox, the copied text is also lost.
 
Install clipman from test repo and add the following to sway config:
 
<pre>
exec wl-paste --type text/plain --watch clipman store --histpath="~/.local/state/clipman-primary.json"
bindsym $mod+h exec clipman pick --tool wofi --histpath="~/.local/state/clipman-primary.json"
</pre>


[[Category:Desktop]]
[[Category:Desktop]]

Revision as of 19:40, 11 September 2022

Sway is a tiling Wayland compositor. It's a drop-in replacement for the i3 window manager.

Installation

eudev:

# apk add eudev
# setup-devd udev

Graphics drivers:

Add user to the input and video groups:

# adduser $USER input
# adduser $USER video


Install some TTF fonts:

# apk add ttf-dejavu

seatd daemon:

# apk add seatd
# rc-update add seatd
# rc-service seatd start
# adduser $USER seat

elogind, optional for suspend on lid close support.

Install sway:

# apk add sway sway-doc
# apk add                \ # Install optional dependencies:
    xwayland             \ # recommended for compatibility reasons
    foot                 \ # default terminal emulator
    bemenu               \ # wayland menu
    swaylock swaylockd   \ # lockscreen tool
    swaybg               \ # wallpaper daemon
    swayidle               # idle management (DPMS) daemon

Configure XDG_RUNTIME_DIR. Add the following to shell init scripts, for the default ash shell it is ~/.profile:

if test -z "${XDG_RUNTIME_DIR}"; then
  export XDG_RUNTIME_DIR=/tmp/$(id -u)-runtime-dir
  if ! test -d "${XDG_RUNTIME_DIR}"; then
    mkdir "${XDG_RUNTIME_DIR}"
    chmod 0700 "${XDG_RUNTIME_DIR}"
  fi
fi


For inter-program communication and functionality such as screensharing, install and enable dbus and PipeWire, see PipeWire.

Re-login or reboot to allow above modifications to take effect.

Launch Sway with dbus support:

dbus-run-session -- sway

Configuration

An example config is provided at /etc/sway/config. Copy it to ~/.config/sway/config and read through it to learn the default keybindings.

For additional information, start at man 5 sway and read the upstream wiki.

Firefox screensharing

For some programs, additional configuration is needed to launch them natively under Wayland and to support special features such as screen sharing.

To launch Firefox natively under Wayland and to enable support for screensharing, you need:

  • Install and configure PipeWire
  • Install xdg-desktop-portal and xdg-desktop-portal-wlr package
  • Install wofi for screen selection
  • Launch support programs on sway startup:
exec /usr/libexec/pipewire-launcher #pipewire must be launched first
exec /usr/libexec/xdg-desktop-portal-wlr
  • Export the following variables:
export MOZ_ENABLE_WAYLAND="1"
export XDG_CURRENT_DESKTOP=sway
export XDG_SESSION_TYPE=wayland
export QT_QPA_PLATFORM="wayland-egl"

Scaling for high resolution screens

Without further configuration, program interfaces might be too small to use on high resolution screens.

Via sway

Sway supports the per-display configuration of

  • fractional (e.g., 1.5x), and
  • integer scaling (e.g., 2x)

However, fractional scaling is discouraged due to both the performance impact and the blurry output it produces. In this case, where 1x scaling is too small and 2x scaling is too large, program-specific GTK/QT based scaling is recommended. See below.

To enable Sway scaling, the user can first preview different scaling factors with wdisplays package. Note the output name (eDP-1, LVDS-1) and try apply scaling factors such as 1 and 2. To make changes permanent, add

output <name> scale <factor>

to ~/.config/sway/config.

Via GTK/Qt

# for GTK-based programs such as firefox and emacs:
export GDK_DPI_SCALE=2

# for QT-based programs
export QT_WAYLAND_FORCE_DPI="physical"
# or if still too small, use a custom DPI
export QT_WAYLAND_FORCE_DPI=192 # 2x scaling
export QT_QPA_PLATFORM="wayland-egl"

Make clipboard content persistent

By default the clipboard content does not persist after terminating the program: you copy some text from Firefox and then exit Firefox, the copied text is also lost.

Install clipman from test repo and add the following to sway config:

exec wl-paste --type text/plain --watch clipman store --histpath="~/.local/state/clipman-primary.json"
bindsym $mod+h exec clipman pick --tool wofi --histpath="~/.local/state/clipman-primary.json"