aboutsummaryrefslogtreecommitdiffstats
path: root/XMonad/Util/EZConfig.hs
diff options
context:
space:
mode:
authorDevin Mullins <me@twifkak.com>2007-11-14 13:04:42 +0100
committerDevin Mullins <me@twifkak.com>2007-11-14 13:04:42 +0100
commitb8c7d4b7c456038f45d410530596b82a121c9cec (patch)
treea4c18560130787aaad976722ff793c4f3bbb5356 /XMonad/Util/EZConfig.hs
parent1913f1f205ee631bd2c77dc90609e2b24e103bc6 (diff)
downloadXMonadContrib-b8c7d4b7c456038f45d410530596b82a121c9cec.tar.gz
XMonadContrib-b8c7d4b7c456038f45d410530596b82a121c9cec.tar.xz
XMonadContrib-b8c7d4b7c456038f45d410530596b82a121c9cec.zip
fix EZConfig documentation
darcs-hash:20071114120442-78224-5c569e0a5f76a8527223d8ced1d18670077ef73e.gz
Diffstat (limited to 'XMonad/Util/EZConfig.hs')
-rw-r--r--XMonad/Util/EZConfig.hs8
1 files changed, 6 insertions, 2 deletions
diff --git a/XMonad/Util/EZConfig.hs b/XMonad/Util/EZConfig.hs
index 32f087b..3690f98 100644
--- a/XMonad/Util/EZConfig.hs
+++ b/XMonad/Util/EZConfig.hs
@@ -8,6 +8,8 @@
--
-- Useful helper functions for amending the defaultConfig.
--
+-- (See also "XMonad.Config.CustomKeys" in xmonad-contrib.)
+--
--------------------------------------------------------------------
module XMonad.Util.EZConfig (
@@ -21,6 +23,7 @@ import XMonad
import qualified Data.Map as M
import Graphics.X11.Xlib
+-- |
-- Add or override keybindings from the existing set. Example use:
-- > main = xmonad $ defaultConfig { terminal = "urxvt" }
-- > `additionalKeys`
@@ -36,6 +39,7 @@ additionalKeys :: XConfig a -> [((ButtonMask, KeySym), X ())] -> XConfig a
additionalKeys conf keysList =
conf { keys = \cnf -> M.union (M.fromList keysList) (keys conf cnf) }
+-- |
-- Remove standard keybidings you're not using. Example use:
-- > main = xmonad $ defaultConfig { terminal = "urxvt" }
-- > `removeKeys` [(mod1Mask .|. shiftMask, n) | n <- [xK_1 .. xK_9]]
@@ -43,12 +47,12 @@ removeKeys :: XConfig a -> [(ButtonMask, KeySym)] -> XConfig a
removeKeys conf keyList =
conf { keys = \cnf -> keys conf cnf `M.difference` M.fromList (zip keyList $ return ()) }
--- Like additionalKeys, but for mouseBindings.
+-- | Like additionalKeys, but for mouseBindings.
additionalMouseBindings :: XConfig a -> [((ButtonMask, Button), Window -> X ())] -> XConfig a
additionalMouseBindings conf mouseBindingsList =
conf { mouseBindings = \cnf -> M.union (M.fromList mouseBindingsList) (mouseBindings conf cnf) }
--- Like removeKeys, but for mouseBindings.
+-- | Like removeKeys, but for mouseBindings.
removeMouseBindings :: XConfig a -> [(ButtonMask, Button)] -> XConfig a
removeMouseBindings conf mouseBindingList =
conf { mouseBindings = \cnf -> mouseBindings conf cnf `M.difference`