Personal tools

Xmonad/Using xmonad in KDE

From HaskellWiki

< Xmonad(Difference between revisions)
Jump to: navigation, search
(Fixed config, changed other sections to match it)
(Make xmonad your window manager in KDE)
 
(25 intermediate revisions by 6 users not shown)
Line 2: Line 2:
 
[[Category:XMonad]]
 
[[Category:XMonad]]
   
Below configuration is for xmonad 0.5, known to work on Kubuntu
+
Here's how to configure Xmonad to work with KDE.
   
 
[[Image:Screen-sjanssen-kde-kicker.png|200px|center]]
 
[[Image:Screen-sjanssen-kde-kicker.png|200px|center]]
Line 8: Line 8:
 
== Motivation ==
 
== Motivation ==
   
Easier system monitoring on laptops with networking widget.
+
You've heard about the wonders of Xmonad, and you want to try it out.
  +
But you're a [http://www.kde.org/ KDE] user, and you want to stay with KDE because of:
   
Ability to browse all programs and utitlities with desktop bar (kicker)
+
* Ability to browse all programs and utilities with desktop bar (kicker).
  +
* Easy integration of Xmonad on a system using kdm for logins.
  +
* Easier system monitoring on laptops with the KDE networking widget.
  +
* Best environment for running GUI applications developed with [http://trolltech.com/products/qt Qt].
  +
* Consistent user interface and shared system services for the vast collection of KDE applications.
  +
* You're just used to it.
   
Easy integration of Xmonad on a system using kdm for logins
+
Then this page is for you.
   
 
== Related reading ==
 
== Related reading ==
   
The [http://haskell.org/haskellwiki/Xmonad/Using_xmonad_in_Gnome GNOME/xmonad] page. Read this, really. Much of what is written there also applies to KDE,
+
Read the [http://haskell.org/haskellwiki/Xmonad/Using_xmonad_in_Gnome GNOME/xmonad] page, ''really''. Much of what is written there also applies to KDE and is not repeated here.
and is not repeated here.
+
  +
But if all you want is to get started quickly with Xmonad in KDE,
  +
read on.
  +
  +
== Versions ==
  +
  +
The following instructions are optimized and tested (so far) for
  +
xmonad 0.7 with KDE 3.5 and KDE 4.1
   
 
== Before you begin ==
 
== Before you begin ==
  +
  +
Make sure that xmonad and xmonad-contrib are installed.
  +
On most systems, you can just install the packages
  +
using [http://www.general.uwa.edu.au/u/toivo/kpackage/ KPackage], or your favorite package manager.
  +
For a list of systems with pre-built xmonad binaries, see
  +
the [http://xmonad.org/#ports ports and distributions list].
  +
Or you can [http://xmonad.org/intro.html build xmonad from source].
   
 
Make sure that KDE is not configured for multiple desktops.
 
Make sure that KDE is not configured for multiple desktops.
Line 25: Line 32:
 
'''Desktop''' > '''Multiple desktops''', and set the number
 
'''Desktop''' > '''Multiple desktops''', and set the number
 
of desktops to 1.
 
of desktops to 1.
  +
  +
Read the [http://xmonad.org/tour.html guided tour of xmonad],
  +
so that you'll know what to do once xmonad starts up.
  +
(Ignore the '''"Starting xmonad"''' section, though.
  +
These instructions replace that for KDE.)
  +
The [http://xmonad.org/manpage.html xmonad man page]
  +
has a nice summary of the default key bindings for xmonad.
   
 
== Sample xmonad configuration for KDE ==
 
== Sample xmonad configuration for KDE ==
Line 30: Line 44:
 
As usual, place xmonad configuration in <code>~/.xmonad/xmonad.hs</code>.
 
As usual, place xmonad configuration in <code>~/.xmonad/xmonad.hs</code>.
   
This sample configuration sets up xmonad to cooperate
+
The following sample configuration sets up xmonad to cooperate
with the KDE desktop and panel; for more details about
+
with the KDE desktop and panel; for more details about how this works, see the
how this works, see the Gnome page. This configuration also
+
[http://haskell.org/haskellwiki/Xmonad/Using_xmonad_in_Gnome Gnome page].
does the following:
+
  +
This configuration also does the following:
 
* uses the Windows key instead of the Alt key as "mod" for xmonad (freeing up Alt for common emacs-style key bindings in applications)
 
* uses the Windows key instead of the Alt key as "mod" for xmonad (freeing up Alt for common emacs-style key bindings in applications)
 
* causes certain applications to launch as floating windows
 
* causes certain applications to launch as floating windows
* automatically sends certain applications to other desktops when they launch.
+
* automatically sends certain applications to a specific desktop when they launch.
  +
  +
=== Using Config.Kde ===
  +
  +
For '''xmonad-0.8 and greater''', you can use the <code>XMonad.Config.Kde</code> module to start with good base defaults for xmonad in KDE (Note: KDE4 users with xmonad-0.9 or greater should replace kdeConfig with kde4Config in the following example. The Config.Kde module is found in the XMonadContrib repository, not in the xmonad repository. ) This base config
  +
* deals with docks and taskbars
  +
* sets the default terminal to konsole
  +
* sets mod-p to run popup
  +
* sets mod-shift-q to logout properly.
  +
  +
<haskell>
  +
import XMonad
  +
import XMonad.Config.Kde
  +
import qualified XMonad.StackSet as W -- to shift and float windows
  +
  +
main = xmonad kdeConfig
  +
{ modMask = mod4Mask -- use the Windows button as mod
  +
, manageHook = manageHook kdeConfig <+> myManageHook
  +
}
  +
  +
myManageHook = composeAll . concat $
  +
[ [ className =? c --> doFloat | c <- myFloats]
  +
, [ title =? t --> doFloat | t <- myOtherFloats]
  +
, [ className =? c --> doF (W.shift "2") | c <- webApps]
  +
, [ className =? c --> doF (W.shift "3") | c <- ircApps]
  +
]
  +
where myFloats = ["MPlayer", "Gimp"]
  +
myOtherFloats = ["alsamixer"]
  +
webApps = ["Firefox-bin", "Opera"] -- open on desktop 2
  +
ircApps = ["Ksirc"] -- open on desktop 3
  +
</haskell>
  +
  +
=== xmonad-0.7 and earlier ===
   
 
<haskell>
 
<haskell>
   
 
import XMonad
 
import XMonad
import XMonad.Hooks.ManageDocks
+
import XMonad.Hooks.ManageDocks
 
import XMonad.Hooks.EwmhDesktops
 
import XMonad.Hooks.EwmhDesktops
 
import qualified XMonad.StackSet as W
 
import qualified XMonad.StackSet as W
   
main = xmonad $ defaultConfig
+
main = xmonad defaultConfig
  +
{ manageHook = manageHook defaultConfig <+> myManageHook
  +
, logHook = ewmhDesktopsLogHook
  +
, layoutHook = avoidStruts $ layoutHook defaultConfig
  +
, modMask = mod4Mask -- use the Windows button as mod
  +
}
   
{ manageHook = manageHook defaultConfig <+> myManageHook
+
myManageHook = manageDocks <+> composeAll . concat $
, logHook = ewmhDesktopsLogHook
+
[ [ className =? c --> doFloat | c <- myFloats]
, layoutHook = avoidStruts $ layoutHook defaultConfig
 
, modMask = mod4Mask -- use the Windows button as mod
 
}
 
where
 
myManageHook = composeAll . concat $
 
[ [manageDocks]
 
, [ className =? c --> doFloat | c <- myFloats]
 
 
, [ title =? t --> doFloat | t <- myOtherFloats]
 
, [ title =? t --> doFloat | t <- myOtherFloats]
 
, [ className =? c --> doF (W.shift "2") | c <- webApps]
 
, [ className =? c --> doF (W.shift "2") | c <- webApps]
 
, [ className =? c --> doF (W.shift "3") | c <- ircApps]
 
, [ className =? c --> doF (W.shift "3") | c <- ircApps]
 
]
 
]
myFloats = ["MPlayer", "Gimp"]
+
where
myOtherFloats = ["alsamixer"]
+
myFloats = ["MPlayer", "Gimp"]
webApps = ["Firefox-bin", "Opera"]
+
myOtherFloats = ["alsamixer"]
ircApps = ["Ksirc"]
+
webApps = ["Firefox-bin", "Opera"] -- open on desktop 2
+
ircApps = ["Ksirc"] -- open on desktop 3
 
</haskell>
 
</haskell>
   
'''Note:''' To get the class name for an application:
+
'''Note:''' To get the class name or title of an application for use in the manageHook above:
 
# Open the application.
 
# Open the application.
 
# Enter the command <code>xprop | grep WM_CLASS</code> in a terminal window on the same desktop.
 
# Enter the command <code>xprop | grep WM_CLASS</code> in a terminal window on the same desktop.
 
# Click on the application window.
 
# Click on the application window.
# Read the class name in the terminal window.
+
# Read the class name in the terminal window. The class name is the second of the two quoted strings displayed, usually capitalized. The first one is resource, usually lower case.
   
Thanks to everyone on [http://haskell.org/haskellwiki/IRC_channel #xmonad]
+
(Use the command <code>xprop | grep WM_NAME</code> to get the title property.)
for all the help in putting together
+
this vastly improved sample xmonad configuration.
+
Thanks to everyone on [http://haskell.org/haskellwiki/IRC_channel #xmonad],
  +
especially sjanssen,
  +
for all the help in putting together this sample xmonad configuration
  +
for KDE.
  +
  +
For more tips on xonfiguring your xmonad, see: [http://haskell.org/haskellwiki/Xmonad/Frequently_asked_questions XMonad FAQ's], [http://haskell.org/haskellwiki/Xmonad/General_xmonad.hs_config_tips XMonad Configuration Tips].
   
 
== Make xmonad your window manager in KDE ==
 
== Make xmonad your window manager in KDE ==
   
 
Create the directory <code>~/.kde/env</code> if it does not
 
Create the directory <code>~/.kde/env</code> if it does not
already exist. Create a file there called <code>set_window_manager.sh</code>
+
already exist. (For KDE 4 use <code>~/.kde4/env</code>) Create a file there called <code>set_window_manager.sh</code>
 
containing only the following line of text:
 
containing only the following line of text:
   
 
<code>
 
<code>
KDEWM=/path/to/xmonad
+
export KDEWM=/path/to/xmonad
 
</code>
 
</code>
   
 
where "<code>/path/to/xmonad</code>" is the path to the xmonad
 
where "<code>/path/to/xmonad</code>" is the path to the xmonad
 
binary on your system. For example, on Debian systems this
 
binary on your system. For example, on Debian systems this
is <code>/usr/bin/xmonad</code>, and if you compiled xmonad
+
is <code>/usr/bin/xmonad</code>. If you compiled xmonad
by hand it may be something like <code>/home/$USER/bin/xmonad</code>.
+
from source, it may be something like <code>/home/$USER/bin/xmonad</code>.
  +
  +
You may also have to use <code>chmod</code> to ensure that
  +
<code>set_window_manager.sh</code> is executable.
   
 
== Restart your KDE session ==
 
== Restart your KDE session ==
Line 92: Line 106:
 
== Tips and issues ==
 
== Tips and issues ==
   
* As in Gnome, you currently cannot switch the focus to a window by clicking on it in the task bar. Use the xmonad keys.
+
* As in Gnome, it is '''very important''' not to use the xmonad <code>mod-shift-q</code> key to exit your session. Use the KDE menu or panel applet. ''This is dealt with in Config.Kde. It's ok to mod-shift-q to logout'' '''when using Config.Kde binding for mod-shift-q.'''
   
* Also as in Gnome, it is '''very important''' not to use the xmonad <code>mod-shift-q</code> key to exit your session. Use the KDE menu or panel applet. ''How do you bind an xmonad key to exit a KDE session?''
+
* Since KDE4's system tray is built around Plasma, whose widgets normally live on the desktop layer, it can be difficult to customize the Plasma tray's display for Xmonad. If you use a 3rd party system tray such as Trayer while running KDE, and some or all icons are missing or appear to conflict with the Plasma tray, the conflict might be worked around by disabling the kded status notifier manager. systemsettings -> Startup and Shutdown -> Service Manager -> uncheck "Status Notifier Manager". Additionally, such tray applications might not implement all of KDE's system tray functionality.
   
* The KDE screensaver does not work properly with xmonad. It can lock the screen, but the screen remains blank. Until someone figures out how to fix this, you can use xscreensaver:
+
'''''To do:''' In the sample configuration, show how to bind''
# Disable the KDE screensaver in the KDE Control Center.
+
<code>mod-shift-Q</code> ''to the command''
# Make sure that xscreensaver is installed.
+
<code>dcop kdesktop default logout</code>
# Create a symbolic link to xscreensaver in <code>~/.kde/Autostart</code>.
+
''to end the KDE session via a dialog, or to the command''
# Create a KDE button and/or xmonad key to run the command <code>xscreensaver-command -lock</code> or <code>xscreensaver-command -activate</code>.
+
<code>dcop ksmserver default logout 0 -1 -1</code>
  +
''to end the KDE session directly.''

Latest revision as of 23:18, 24 February 2012

Xmonad-logo-small.png

XMonad

Here's how to configure Xmonad to work with KDE.

Screen-sjanssen-kde-kicker.png

Contents

[edit] 1 Motivation

You've heard about the wonders of Xmonad, and you want to try it out. But you're a KDE user, and you want to stay with KDE because of:

  • Ability to browse all programs and utilities with desktop bar (kicker).
  • Easy integration of Xmonad on a system using kdm for logins.
  • Easier system monitoring on laptops with the KDE networking widget.
  • Best environment for running GUI applications developed with Qt.
  • Consistent user interface and shared system services for the vast collection of KDE applications.
  • You're just used to it.

Then this page is for you.

[edit] 2 Related reading

Read the GNOME/xmonad page, really. Much of what is written there also applies to KDE and is not repeated here.

But if all you want is to get started quickly with Xmonad in KDE, read on.

[edit] 3 Versions

The following instructions are optimized and tested (so far) for xmonad 0.7 with KDE 3.5 and KDE 4.1

[edit] 4 Before you begin

Make sure that xmonad and xmonad-contrib are installed. On most systems, you can just install the packages using KPackage, or your favorite package manager. For a list of systems with pre-built xmonad binaries, see the ports and distributions list. Or you can build xmonad from source.

Make sure that KDE is not configured for multiple desktops. To configure that, open the KDE Control Center, select Desktop > Multiple desktops, and set the number of desktops to 1.

Read the guided tour of xmonad, so that you'll know what to do once xmonad starts up. (Ignore the "Starting xmonad" section, though. These instructions replace that for KDE.) The xmonad man page has a nice summary of the default key bindings for xmonad.

[edit] 5 Sample xmonad configuration for KDE

As usual, place xmonad configuration in ~/.xmonad/xmonad.hs.

The following sample configuration sets up xmonad to cooperate with the KDE desktop and panel; for more details about how this works, see the Gnome page.

This configuration also does the following:

  • uses the Windows key instead of the Alt key as "mod" for xmonad (freeing up Alt for common emacs-style key bindings in applications)
  • causes certain applications to launch as floating windows
  • automatically sends certain applications to a specific desktop when they launch.

[edit] 5.1 Using Config.Kde

For xmonad-0.8 and greater, you can use the XMonad.Config.Kde module to start with good base defaults for xmonad in KDE (Note: KDE4 users with xmonad-0.9 or greater should replace kdeConfig with kde4Config in the following example. The Config.Kde module is found in the XMonadContrib repository, not in the xmonad repository. ) This base config

  • deals with docks and taskbars
  • sets the default terminal to konsole
  • sets mod-p to run popup
  • sets mod-shift-q to logout properly.
import XMonad
import XMonad.Config.Kde
import qualified XMonad.StackSet as W -- to shift and float windows
 
main = xmonad kdeConfig
    { modMask = mod4Mask -- use the Windows button as mod
    , manageHook = manageHook kdeConfig <+> myManageHook
    }
 
myManageHook = composeAll . concat $
    [ [ className   =? c --> doFloat           | c <- myFloats]
    , [ title       =? t --> doFloat           | t <- myOtherFloats]
    , [ className   =? c --> doF (W.shift "2") | c <- webApps]
    , [ className   =? c --> doF (W.shift "3") | c <- ircApps]
    ]
  where myFloats      = ["MPlayer", "Gimp"]
        myOtherFloats = ["alsamixer"]
        webApps       = ["Firefox-bin", "Opera"] -- open on desktop 2
        ircApps       = ["Ksirc"]                -- open on desktop 3

[edit] 5.2 xmonad-0.7 and earlier

import XMonad
import XMonad.Hooks.ManageDocks 
import XMonad.Hooks.EwmhDesktops
import qualified XMonad.StackSet as W
 
main = xmonad defaultConfig 
    { manageHook            = manageHook defaultConfig <+> myManageHook
    , logHook               = ewmhDesktopsLogHook
    , layoutHook            = avoidStruts $ layoutHook defaultConfig
    , modMask               = mod4Mask -- use the Windows button as mod
    }
 
myManageHook = manageDocks <+> composeAll . concat $
     [ [ className   =? c --> doFloat           | c <- myFloats]
     , [ title       =? t --> doFloat           | t <- myOtherFloats]
     , [ className   =? c --> doF (W.shift "2") | c <- webApps]
     , [ className   =? c --> doF (W.shift "3") | c <- ircApps]
     ]
  where
    myFloats      = ["MPlayer", "Gimp"]
    myOtherFloats = ["alsamixer"]
    webApps       = ["Firefox-bin", "Opera"] -- open on desktop 2
    ircApps       = ["Ksirc"]                -- open on desktop 3

Note: To get the class name or title of an application for use in the manageHook above:

  1. Open the application.
  2. Enter the command xprop | grep WM_CLASS in a terminal window on the same desktop.
  3. Click on the application window.
  4. Read the class name in the terminal window. The class name is the second of the two quoted strings displayed, usually capitalized. The first one is resource, usually lower case.
 (Use the command xprop | grep WM_NAME to get the title property.)

Thanks to everyone on #xmonad, especially sjanssen, for all the help in putting together this sample xmonad configuration for KDE.

For more tips on xonfiguring your xmonad, see: XMonad FAQ's, XMonad Configuration Tips.

[edit] 6 Make xmonad your window manager in KDE

Create the directory ~/.kde/env if it does not already exist. (For KDE 4 use ~/.kde4/env) Create a file there called set_window_manager.sh containing only the following line of text:

export KDEWM=/path/to/xmonad

where "/path/to/xmonad" is the path to the xmonad binary on your system. For example, on Debian systems this is /usr/bin/xmonad. If you compiled xmonad from source, it may be something like /home/$USER/bin/xmonad.

You may also have to use chmod to ensure that set_window_manager.sh is executable.

[edit] 7 Restart your KDE session

Now end your current KDE session and start a new one. Welcome to xmonad with KDE!

[edit] 8 Tips and issues

  • As in Gnome, it is very important not to use the xmonad mod-shift-q key to exit your session. Use the KDE menu or panel applet. This is dealt with in Config.Kde. It's ok to mod-shift-q to logout when using Config.Kde binding for mod-shift-q.
  • Since KDE4's system tray is built around Plasma, whose widgets normally live on the desktop layer, it can be difficult to customize the Plasma tray's display for Xmonad. If you use a 3rd party system tray such as Trayer while running KDE, and some or all icons are missing or appear to conflict with the Plasma tray, the conflict might be worked around by disabling the kded status notifier manager. systemsettings -> Startup and Shutdown -> Service Manager -> uncheck "Status Notifier Manager". Additionally, such tray applications might not implement all of KDE's system tray functionality.

To do: In the sample configuration, show how to bind mod-shift-Q to the command dcop kdesktop default logout to end the KDE session via a dialog, or to the command dcop ksmserver default logout 0 -1 -1 to end the KDE session directly.