You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Xaver Hugl 1746af4b02 gesture: use the global direction enums 2 years ago
LICENSES Remove unused license file 2 years ago
autotests gesture: use the global direction enums 2 years ago
cmake/modules Fix some tests not building with Qt 6 2 years ago
data Run clang-tidy with -checks=readability-braces-around-statements fixit 3 years ago
doc kcms/kwindecoration: add link to aurorae tutorial in docbook 2 years ago
kconf_update kconf_update: replace cascaded by zero-cornered placement 2 years ago
po GIT_SILENT Sync po/docbooks with svn 2 years ago
src gesture: use the global direction enums 2 years ago
tests build: Add -Wno-unused-parameter compiler option 2 years ago
.clang-format Run clang-format 3 years ago
.gitignore Run clang-format 3 years ago
.gitlab-ci.yml Add Qt 6 FreeBSD CI 2 years ago
.kde-ci.yml ci: Sort dependencies in alphabetical order 2 years ago
CMakeLists.txt Update version number for 5.27.80 2 years ago
CONTRIBUTING.md add more debugging information to CONTRIBUTING.md 2 years ago
KWinDBusInterfaceConfig.cmake.in Expose org.kde.kwin.ColorCorrect.xml dbus file 3 years ago
Mainpage.dox
README.md doc: modernise HACKING -> CONTRIBUTING guidelines and information 3 years ago
logo.png
plasma-kwin_wayland.service.in Re-enable systemd managed kwin 3 years ago
plasma-kwin_x11.service.in [systemd] Fix X11 service file 3 years ago

README.md

KWin

KWin is an easy to use, but flexible, composited Window Manager for Xorg windowing systems (Wayland, X11) on Linux. Its primary usage is in conjunction with a Desktop Shell (e.g. KDE Plasma Desktop). KWin is designed to go out of the way; users should not notice that they use a window manager at all. Nevertheless KWin provides a steep learning curve for advanced features, which are available, if they do not conflict with the primary mission. KWin does not have a dedicated targeted user group, but follows the targeted user group of the Desktop Shell using KWin as it's window manager.

KWin is not...

  • a standalone window manager (c.f. openbox, i3) and does not provide any functionality belonging to a Desktop Shell.
  • a replacement for window managers designed for use with a specific Desktop Shell (e.g. GNOME Shell)
  • a minimalistic window manager
  • designed for use without compositing or for X11 network transparency, though both are possible.

Contributing to KWin

Please refer to the contributing document for everything you need to know to get started contributing to KWin.

Contacting KWin development team

  • mailing list: kwin@kde.org
  • IRC: #kde-kwin on irc.libera.chat

Support

Application Developer

If you are an application developer having questions regarding windowing systems (either X11 or Wayland) please do not hesitate to contact us. Preferable through our mailing list. Ideally subscribe to the mailing list, so that your mail doesn't get stuck in the moderation queue.

End user

Please contact the support channels of your Linux distribution for user support. The KWin development team does not provide end user support.

Reporting bugs

Please use KDE's bugtracker and report for product KWin.

Guidelines for new features

A new Feature can only be added to KWin if:

  • it does not violate the primary missions as stated at the start of this document
  • it does not introduce instabilities
  • it is maintained, that is bugs are fixed in a timely manner (second next minor release) if it is not a corner case.
  • it works together with all existing features
  • it supports both single and multi screen (xrandr)
  • it adds a significant advantage
  • it is feature complete, that is supports at least all useful features from competitive implementations
  • it is not a special case for a small user group
  • it does not increase code complexity significantly
  • it does not affect KWin's license (GPLv2+)

All new added features are under probation, that is if any of the non-functional requirements as listed above do not hold true in the next two feature releases, the added feature will be removed again.

The same non functional requirements hold true for any kind of plugins (effects, scripts, etc.). It is suggested to use scripted plugins and distribute them separately.