XMonad.Util.RemoteWindows

xmonad-contrib-0.12: Third party extensions for xmonad

Copyright | (c) Anton Vorontsov <anton@enomsg.org> 2014
License | BSD-style (as xmonad)
Maintainer | Anton Vorontsov <anton@enomsg.org>
Stability | unstable
Portability | unportable
Safe Haskell | None
Language | Haskell98

XMonad.Util.RemoteWindows

Description

This module implements a proper way of finding out whether the window is remote or local.

Just checking for a hostname and WM_CLIENT_MACHINE being equal is often not enough because the hostname is a changing subject (without any established notification mechanisms), and thus WM_CLIENT_MACHINE and the hostname can diverge even for a local window.

This module solves the problem. As soon as there is a new window created, we check the hostname and WM_CLIENT_MACHINE, and then we cache the result into the XMONAD_REMOTE property.

Notice that XMonad itself does not know anything about hostnames, nor does it have any dependency on Network.* modules. For this module it is not a problem: you can provide a mean to get the hostname through your config file (see usage). Or, if you don't like the hassle of handling dynamic hostnames (suppose your hostname never changes), it is also fine: this module will fallback to using environment variables.

Synopsis

- isLocalWindow :: Window -> X Bool
- manageRemote :: String -> ManageHook
- manageRemoteG :: ManageHook

# Documentation

You can use this module with the following in your `~/.xmonad/xmonad.hs`:

    import XMonad
    import XMonad.Util.RemoteWindows
    import Network.BSD

    main = xmonad def
       { manageHook = manageRemote =<< io getHostName }

isLocalWindow :: Window -> X Bool #

Given a window, tell if it is a local or a remote process. Normally, it checks XMONAD_REMOTE property. If it does not exist (i.e. the manageRemote hook was not deployed in user's config), it falls back to checking environment variables and assuming that hostname never changes.

manageRemote :: String -> ManageHook #

Use this hook to let XMonad properly track remote/local windows. For example, `manageHook = manageRemote =<< io getHostName`.

manageRemoteG :: ManageHook #

Use this hook if you want to manage XMONAD_REMOTE properties, but don't want to use an external getHostName in your config. That way you are retreating to environment variables.