DeManage: haddock updates

This commit is contained in:
Brent Yorgey 2007-11-23 20:17:02 +00:00
parent 52df6deb52
commit 518cb7432f

View File

@ -8,17 +8,19 @@
-- Stability : unstable -- Stability : unstable
-- Portability : unportable -- Portability : unportable
-- --
-- This module provides a method to cease management of a window, without -- This module provides a method to cease management of a window
-- unmapping it. This is especially useful for applications like kicker and -- without unmapping it. This is especially useful for applications
-- gnome-panel. -- like kicker and gnome-panel.
-- --
-- To make a panel display correctly with xmonad: -- To make a panel display correctly with xmonad:
-- --
-- * Determine the pixel size of the panel, add that value to defaultGaps -- * Determine the pixel size of the panel, add that value to
-- 'XMonad.Core.XConfig.defaultGaps'
-- --
-- * Launch the panel -- * Launch the panel
-- --
-- * Give the panel window focus, then press mod-d -- * Give the panel window focus, then press @mod-d@ (or whatever key
-- you have bound 'demanage' to)
-- --
-- * Convince the panel to move\/resize to the correct location. Changing the -- * Convince the panel to move\/resize to the correct location. Changing the
-- panel's position setting several times seems to work. -- panel's position setting several times seems to work.
@ -38,19 +40,18 @@ import Control.Monad.State
import Graphics.X11 (Window) import Graphics.X11 (Window)
-- $usage -- $usage
-- To use demanage, add this import: -- To use demanage, add this import to your @~\/.xmonad\/xmonad.hs@:
-- --
-- > import XMonad.Actions.DeManage -- > import XMonad.Actions.DeManage
-- --
-- And add a keybinding to it: -- And add a keybinding, such as:
-- --
-- > , ((modMask, xK_d ), withFocused demanage) -- > , ((modMask, xK_d ), withFocused demanage)
-- --
-- For detailed instructions on editing your key bindings, see
-- "XMonad.Doc.Extending#Editing_key_bindings".
-- %import XMonad.Actions.DeManage -- | Stop managing the currently focused window.
-- %keybind , ((modMask, xK_d ), withFocused demanage)
-- | Stop managing the current focused window.
demanage :: Window -> X () demanage :: Window -> X ()
demanage w = do demanage w = do
-- use modify to defeat automatic 'unmanage' calls. -- use modify to defeat automatic 'unmanage' calls.