aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrent Yorgey <byorgey@gmail.com>2007-11-23 21:22:04 +0100
committerBrent Yorgey <byorgey@gmail.com>2007-11-23 21:22:04 +0100
commit51aca78ec6aa3fd00a32442862c339e8cb34d984 (patch)
tree45d4e939d35c28c94b212ab76061cfd467a56e92
parent8a72ef15151bfb2a812449dd6a19df41f9f2930c (diff)
downloadXMonadContrib-51aca78ec6aa3fd00a32442862c339e8cb34d984.tar.gz
XMonadContrib-51aca78ec6aa3fd00a32442862c339e8cb34d984.tar.xz
XMonadContrib-51aca78ec6aa3fd00a32442862c339e8cb34d984.zip
DwmPromote: haddock updates
darcs-hash:20071123202204-bd4d7-040391c80a219ae077bbcb954b71be155259edc0.gz
-rw-r--r--XMonad/Actions/DwmPromote.hs17
1 files changed, 10 insertions, 7 deletions
diff --git a/XMonad/Actions/DwmPromote.hs b/XMonad/Actions/DwmPromote.hs
index dfe7cc6..3a7020c 100644
--- a/XMonad/Actions/DwmPromote.hs
+++ b/XMonad/Actions/DwmPromote.hs
@@ -9,7 +9,7 @@
-- Portability : unportable
--
-- Dwm-like swap function for xmonad.
---
+--
-- Swaps focused window with the master window. If focus is in the
-- master, swap it with the next window in the stack. Focus stays in the
-- master.
@@ -18,7 +18,7 @@
module XMonad.Actions.DwmPromote (
-- * Usage
- -- $usage
+ -- $usage
dwmpromote
) where
@@ -28,17 +28,20 @@ import XMonad.StackSet
-- $usage
--
--- To use, modify your Config.hs to:
+-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
--
-- > import XMonad.Actions.DwmPromote
--
--- and add a keybinding or substitute promote with dwmpromote:
+-- then add a keybinding or substitute 'dwmpromote' in place of promote:
--
-- > , ((modMask, xK_Return), dwmpromote)
+--
+-- For detailed instructions on editing your key bindings, see
+-- "XMonad.Doc.Extending#Editing_key_bindings".
--- %import XMonad.Actions.DwmPromote
--- %keybind , ((modMask, xK_Return), dwmpromote)
-
+-- | Swap the focused window with the master window. If focus is in
+-- the master, swap it with the next window in the stack. Focus
+-- stays in the master.
dwmpromote :: X ()
dwmpromote = windows $ modify' $
\c -> case c of