Tutorials/Using Other Window Managers with Plasma: Difference between revisions

From KDE Wiki Sandbox
(add some i3 config improvement and add categories)
(Marked this version for translation)
 
(42 intermediate revisions by 12 users not shown)
Line 1: Line 1:
<languages />
<languages />
<translate>
<translate>
{{Construction}}


==Introduction==
==Introduction== <!--T:2-->


KWin is the default window manager (WM) in Plasma and has lot of features, but only support floating windows. Plasma let you use another window manager for example i3, bspwm or [https://wiki.archlinux.org/index.php/Window_managers any other tilling window manager].
<!--T:3-->
KWin is the default window manager (WM) in Plasma and has lot of features, but it only supports floating windows. Plasma lets you use another window manager, such as i3, bspwm or [https://wiki.archlinux.org/index.php/Window_managers any other tilling window manager].


{{Warning|Other window managers are only available when using X.org. These changes can not be made for Wayland sessions.}}
<!--T:54-->
[[File:Plasma_i3.png|500px|thumb|center|Plasma using i3 as window manager]]


<!--T:4-->
{{Warning|Other window managers are only available when using X.org. These changes cannot be made for Wayland sessions yet. With Wayland maturing and Wayland extensions being standardized, this feature could be implemented in Wayland<ref>https://drewdevault.com/2018/04/28/KDE-Sprint-retrospective.html</ref> }}
<!--T:5-->
Most window managers require few, if any, changes to their configuration files.
Most window managers require few, if any, changes to their configuration files.


<!--T:6-->
Some considerations to be aware of when using another window manager:
Some considerations to be aware of when using another window manager:


*Tiling window managers may have problems with components like panels. For some configuration options will help alleviate issues
<!--T:7-->
* Tiling window managers may have problems with components like panels. For some configurations, certain options will help alleviate issues
 
<!--T:8-->
* Most window managers do not have their own compositors, and therefore lack features like animations and transparency. If such effects are desired, a compositor is required - refer to [https://wiki.archlinux.org/index.php/Xorg#Composite Arch Wiki] for options.</translate>
<translate>
<!--T:58-->
** Compositors can also help with screen tearing, however check first if you can resolve it with your video drivers, as this will be a more performant solution in most cases.
 
==Set-up == <!--T:9-->
 
<!--T:78-->
To use a different window manager with Plasma, replace the systemd service for KWin with a new user unit for your preferred WM. A tutorial can be found in the [https://wiki.archlinux.org/title/KDE#Use_a_different_window_manager ArchWiki].
 
==Configuration== <!--T:27-->
 
<!--T:79-->
To make a non-standard WM work well with Plasma, some additional configuration may be required.
 
===i3=== <!--T:80-->
 
====Installation==== <!--T:28-->
 
<!--T:29-->
Before starting the configuration, you should make sure i3 or i3-gaps are installed on your system. If they are not, use your package manager or [[Special:myLanguage/Discover|Discover]] to install one of these two packages.


* Most window managers do not have their own compositors, and therefore lack such features as animations and transparency. If such effects are desired, a compositor, such as '''compton''', is required
====Configure i3==== <!--T:30-->


==Using Another Window Manager with Plasma ==
<!--T:35-->
===Single User: Using System Settings===
When you first start i3, its default global configuration (at <code>/etc/i3/config</code>) will start i3-config-wizard, which will provide a dialog for Mod key selection and generate the user local configuration at <code>~/.i3/config</code>.


This is the simplest method, but only affects the user for which it is added
<!--T:59-->
If you wish to maintain the same configuration across users (they can still override it with their own local config), remove the wizard invocation from the global configuration file and use it directly.


[[Image:kde-i3-integration.png]]


*Create a shell script (kde-i3.sh as an example), containing the following{{Input|1=<nowiki>
<!--T:60-->
#!/bin/sh
The following i3 window rules will help you with notifications and some other plasma windows:
export KDEWM=/usr/bin/i3
{{Input|1=<nowiki>for_window [title="Desktop — Plasma"] kill, floating enable, border none
for_window [class="plasmashell"] floating enable
for_window [class="Plasma"] floating enable, border none
for_window [title="plasma-desktop"] floating enable, border none
for_window [title="win7"] floating enable, border none
for_window [class="krunner"] floating enable, border none
for_window [class="Kmix"] floating enable, border none
for_window [class="Klipper"] floating enable, border none
for_window [class="Plasmoidviewer"] floating enable, border none
for_window [class="(?i)*nextcloud*"] floating disable
for_window [class="plasmashell" window_type="notification"] floating enable, border none, move right 700px, move down 450px
no_focus [class="plasmashell" window_type="notification"]
</nowiki>}}
</nowiki>}}
Replace /usr/bin/i3 with the path to the window manager desired.


* Start '''System Settings'''
<!--T:55-->
If you are using a non-English installation of Plasma, you need to find out what the exact window title of the Desktop is. One way is to do this is with <code>wmctrl -l</code>.


* Select '''Startup and Shutdown'''
<!--T:56-->
Instead of adding
{{Input|1=<nowiki>for_window [title="Desktop — Plasma"] kill; floating enable; border none
</nowiki>}}


* Select '''Autostart'''
<!--T:57-->
add the name of the window to the i3 config. This example uses the German Plasma installation.
{{Input|1=<nowiki>for_window [title="Arbeitsfläche — Plasma"] kill; floating enable; border none
</nowiki>}}


* Click the '''Add script''' button below the list
<!--T:74-->
Notification positioning can be tricky, since not all notifications have the same size depending on their content. You can also use coordinates positioning, knowing your screen resolution. For example, for a 1920x1080 screen and notifications in the top-right corner we can use:{{Input|1=<nowiki>
for_window [class="plasmashell" window_type="notification"] floating enable, border none, move position 1450px 20px
</nowiki>}}


* Enter the location of the script created earlier, or use the folder icon to use a dialog to find it. Click '''OK''', the script will be added to the list
<!--T:77-->
If you want to unlock KWallet automatically on login, configure PAM and then add the following line to your i3 configuration file:
{{Input|1=<nowiki>exec --no-startup-id /usr/lib/pam_kwallet_init
</nowiki>}}
 
====Configure Plasma==== <!--T:61-->
 
<!--T:62-->
You may get into issues related with the "Activities" feature - activating it via keyboard shortcuts (some of which are also used by i3, like "Meta + Q") seems to make i3 unresponsive. Removing Activity related global shortcuts seems to resolve this.


* In the '''Run On''' column, select '''Before Session Startup''' from the drop down list
<!--T:63-->
To get the Plasma provided pager display desktops as i3bar, set '''Pager Settings''' > '''General''' > '''Text display''' to "Desktop name"


* The chosen window manager will be used the next time you log in
===Bspwm=== <!--T:36-->


=== System Wide: Adding an XSession===
<!--T:37-->
For the most part, bspwm requires little additional configuration.


If superuser (root) access is available, a new session file for X.org can be created.
<!--T:38-->
* A single Plasma panel, in most cases, is detected properly and bspwm will not place windows in its space. If the panel ends up presenting a problem, or when using multiple panels, the following may be added to '''.bspwmrc'''{{Input|1=<nowiki>bspc config top_padding size</nowiki>}}where '''size''' is the size of the panel in pixels. Also valid are bottom_padding, left_padding, and right_padding. As many of these directives may be used as necessary for multiple panels.


This has several advantages: the alternate session is available to all users of the system, and changing back to KWin is as simple as logging out and then back in
==Hints and Tips== <!--T:43-->


To add a session for an alternate window manager, as the superuser
===DBus=== <!--T:64-->


* Copy the existing Plasma session flie{{Input|1=<nowiki>cp plasma.desktop plasma-i3.desktop</nowiki>}}
<!--T:45-->
Since Meta key handling is in part performed by KWin, you will have to handle these shortcuts manually when you switch to a different window manager.


* Using a text editor, open the file and change the Exec line, and optionally the Description{{Input|1=<nowiki>[Desktop Entry]
<!--T:65-->
Type=XSession
You can open some Plasma components with DBus commands. You can use this to map corresponding keybindings to DBus commands. To find a specific DBus command, you can look at <code>dbus-monitor</code> or <code>qdbusviewer</code> while you invoke the component in a standard Plasma set-up.
Exec=env KDEWM=/usr/bin/i3
 
DesktopNames=KDE
<!--T:66-->
Name=Plasma (i3)
More info on meta key handling:
Comment=Plasma by KDE w/i3
 
X-KDE-PluginInfo-Version=5.14.4
<!--T:67-->
</nowiki>}}
* [https://www.reddit.com/r/kde/comments/6wn5lk/bind_meta_key_alone_to_do_something/ Reddit post describing the ''Meta key - KWin'' relation]
 
<!--T:68-->
* [https://zren.github.io/2019/03/04/activate-any-widget-with-meta-key Blog post describing the ''DBus - Component'' relation]


* The display manager must be restarted, most easily by rebooting


==I3 configuration==
<!--T:46-->
Some examples:


===Installation===
<!--T:47-->
* Open Application Launcher {{Input|1=<nowiki>qdbus org.kde.plasmashell /PlasmaShell org.kde.PlasmaShell.activateLauncherMenu</nowiki>}}


Before starting the configuration, you should make sure i3 or i3-gaps are installed on your system. If not use your packet manager or [[Special:myLanguage/Discover|Discover]] to install one of this two packages. You should also install a compositor, because unlike KWin, i3 don't ship with an integrated compositor. I recommend the use of compton.  
<!--T:69-->
* Open Krunner {{Input|1=<nowiki>qdbus org.kde.kglobalaccel /component/krunner org.kde.kglobalaccel.Component.invokeShortcut 'run command'</nowiki>}}


===Create a default i3 configuration===
<!--T:70-->
* Open logout confirmation screen {{Input|1=<nowiki>qdbus org.kde.ksmserver /KSMServer org.kde.KSMServerInterface.logout -1 -1 -1</nowiki>}}


{{Note|If you already have an i3 configuration file (usually at <code>.i3/config</code> or <code>.config/i3/config</code>), you can skip this step.}}
<!--T:48-->
For i3, you can map a keybinding with the '''bindsym''' command. Use <code>--no-startup-id</code> to prevent the command from generating "i3" entries in the task manager.


[[Special:myLanguage/Tutorials/Open a console|Open a console]] and type <code>i3-config-wizard</code>. This command open a small windows that will help you create a configuration file.
<!--T:49-->
Example:
{{Input|1=<nowiki>bindsym $mod+Shift+e exec --no-startup-id <command></nowiki>}}


[[File:i3-wizard.png|500px]]
<!--T:71-->
If you want to map the modifier key itself, use the '''bindcode''' command - you have to specify the keycode generated by the key, which you can get via the <code>xev</code> utility.


Some i3 keybinding can be used to provide better integration with Plasma.
<!--T:72-->
{{Input|1=<nowiki># Open logout confirmation screen with $mod+e
Example for the Meta key:
bindsym $mod+Shift+e exec qdbus org.kde.ksmserver /KSMServer org.kde.KSMServerInterface.logout -1 -1 -1
{{Input|1=<nowiki>bindcode 133 --release exec --no-startup-id <command></nowiki>}}
# Open krunner with $mod+d
bindsym $mod+d exec qdbus org.kde.kglobalaccel /component/krunner org.kde.kglobalaccel.Component.invokeShortcut 'run command'
</nowiki>}}


Some i3 window rules help you to have notification and some other plasma windows as floating windows:
<!--T:50-->
{{Input|1=<nowiki>for_window [title="Desktop — Plasma"] kill; floating enable; border none
For Bspwn, you need to use the <code>bspc</code> program. See [https://wiki.archlinux.org/index.php/Bspwm#Keyboard Arch Linux wiki] for more information.
for_window [class="plasmashell"] floating enable;
for_window [class="Plasma"] floating enable; border none
for_window [title="plasma-desktop"] floating enable; border none
for_window [title="win7"] floating enable; border none
for_window [class="krunner"] floating enable; border none
for_window [class="Kmix"] floating enable; border none
for_window [class="Klipper"] floating enable; border none
for_window [class="Plasmoidviewer"] floating enable; border none
for_window [class="(?i)*nextcloud*"] floating disable
</nowiki>}}


==bspwm==
==More Information== <!--T:51-->


For the most part, bspwm requires little additional configuration.
<!--T:52-->
* [https://en.wikipedia.org/wiki/X_window_manager Window managers] (Wikipedia)
* [https://wiki.archlinux.org/index.php/Window_managers Window managers] (Arch Linux wiki)
* [https://en.wikipedia.org/wiki/Desktop_environment Desktop environment] (Wikipedia)
* [https://wiki.archlinux.org/index.php/Desktop_environment Desktop environment] (Arch Linux wiki)


* A single Plasma panel, in most cases, is detected properly and bspwm will not place windows in its space. If the panel does present a problem, or when using multiple panels, the following may be added to '''.bspwmrc'''{{Input|1=<nowiki>bspc config top_padding size</nowiki>}}where '''size''' is the size in pixels of the panel. Also valid are bottom_padding, left_padding, and right_padding. As many of these directive may be used as necessary for multiple panels.
==References== <!--T:53-->


<!--T:39-->
[[Category:Tutorials]]
[[Category:Tutorials]]
[[Category:Advanced Users]]
[[Category:Advanced Users]]

Latest revision as of 12:09, 2 January 2023

Other languages:

Introduction

KWin is the default window manager (WM) in Plasma and has lot of features, but it only supports floating windows. Plasma lets you use another window manager, such as i3, bspwm or any other tilling window manager.

Plasma using i3 as window manager
Warning
Other window managers are only available when using X.org. These changes cannot be made for Wayland sessions yet. With Wayland maturing and Wayland extensions being standardized, this feature could be implemented in Wayland[1]


Most window managers require few, if any, changes to their configuration files.

Some considerations to be aware of when using another window manager:

  • Tiling window managers may have problems with components like panels. For some configurations, certain options will help alleviate issues
  • Most window managers do not have their own compositors, and therefore lack features like animations and transparency. If such effects are desired, a compositor is required - refer to Arch Wiki for options.
    • Compositors can also help with screen tearing, however check first if you can resolve it with your video drivers, as this will be a more performant solution in most cases.

Set-up

To use a different window manager with Plasma, replace the systemd service for KWin with a new user unit for your preferred WM. A tutorial can be found in the ArchWiki.

Configuration

To make a non-standard WM work well with Plasma, some additional configuration may be required.

i3

Installation

Before starting the configuration, you should make sure i3 or i3-gaps are installed on your system. If they are not, use your package manager or Discover to install one of these two packages.

Configure i3

When you first start i3, its default global configuration (at /etc/i3/config) will start i3-config-wizard, which will provide a dialog for Mod key selection and generate the user local configuration at ~/.i3/config.

If you wish to maintain the same configuration across users (they can still override it with their own local config), remove the wizard invocation from the global configuration file and use it directly.


The following i3 window rules will help you with notifications and some other plasma windows: 

for_window [title="Desktop — Plasma"] kill, floating enable, border none
for_window [class="plasmashell"] floating enable
for_window [class="Plasma"] floating enable, border none
for_window [title="plasma-desktop"] floating enable, border none
for_window [title="win7"] floating enable, border none
for_window [class="krunner"] floating enable, border none
for_window [class="Kmix"] floating enable, border none
for_window [class="Klipper"] floating enable, border none
for_window [class="Plasmoidviewer"] floating enable, border none
for_window [class="(?i)*nextcloud*"] floating disable
for_window [class="plasmashell" window_type="notification"] floating enable, border none, move right 700px, move down 450px
no_focus [class="plasmashell" window_type="notification"]

If you are using a non-English installation of Plasma, you need to find out what the exact window title of the Desktop is. One way is to do this is with wmctrl -l.

Instead of adding 

for_window [title="Desktop — Plasma"] kill; floating enable; border none

add the name of the window to the i3 config. This example uses the German Plasma installation. 

for_window [title="Arbeitsfläche — Plasma"] kill; floating enable; border none

Notification positioning can be tricky, since not all notifications have the same size depending on their content. You can also use coordinates positioning, knowing your screen resolution. For example, for a 1920x1080 screen and notifications in the top-right corner we can use:

for_window [class="plasmashell" window_type="notification"] floating enable, border none, move position 1450px 20px

If you want to unlock KWallet automatically on login, configure PAM and then add the following line to your i3 configuration file: 

exec --no-startup-id /usr/lib/pam_kwallet_init

Configure Plasma

You may get into issues related with the "Activities" feature - activating it via keyboard shortcuts (some of which are also used by i3, like "Meta + Q") seems to make i3 unresponsive. Removing Activity related global shortcuts seems to resolve this.

To get the Plasma provided pager display desktops as i3bar, set Pager Settings > General > Text display to "Desktop name"

Bspwm

For the most part, bspwm requires little additional configuration.

  • A single Plasma panel, in most cases, is detected properly and bspwm will not place windows in its space. If the panel ends up presenting a problem, or when using multiple panels, the following may be added to .bspwmrc
    bspc config top_padding size
    where size is the size of the panel in pixels. Also valid are bottom_padding, left_padding, and right_padding. As many of these directives may be used as necessary for multiple panels.

Hints and Tips

DBus

Since Meta key handling is in part performed by KWin, you will have to handle these shortcuts manually when you switch to a different window manager.

You can open some Plasma components with DBus commands. You can use this to map corresponding keybindings to DBus commands. To find a specific DBus command, you can look at dbus-monitor or qdbusviewer while you invoke the component in a standard Plasma set-up.

More info on meta key handling:


Some examples:

  • Open Application Launcher 
    qdbus org.kde.plasmashell /PlasmaShell org.kde.PlasmaShell.activateLauncherMenu
  • Open Krunner 
    qdbus org.kde.kglobalaccel /component/krunner org.kde.kglobalaccel.Component.invokeShortcut 'run command'
  • Open logout confirmation screen 
    qdbus org.kde.ksmserver /KSMServer org.kde.KSMServerInterface.logout -1 -1 -1

For i3, you can map a keybinding with the bindsym command. Use --no-startup-id to prevent the command from generating "i3" entries in the task manager.

Example: 

bindsym $mod+Shift+e exec --no-startup-id <command>

If you want to map the modifier key itself, use the bindcode command - you have to specify the keycode generated by the key, which you can get via the xev utility.

Example for the Meta key: 

bindcode 133 --release exec --no-startup-id <command>

For Bspwn, you need to use the bspc program. See Arch Linux wiki for more information.

More Information

References

  1. ↑ https://drewdevault.com/2018/04/28/KDE-Sprint-retrospective.html
Retrieved from "https://wikisandbox.kde.org/index.php?title=Tutorials/Using_Other_Window_Managers_with_Plasma&oldid=476178"