aboutsummaryrefslogtreecommitdiffstats
path: root/XMonad/Layout/LayoutHints.hs
diff options
context:
space:
mode:
authorAndrea Rossato <andrea.rossato@unibz.it>2007-11-23 15:28:59 +0100
committerAndrea Rossato <andrea.rossato@unibz.it>2007-11-23 15:28:59 +0100
commit08cb6caca1db58abd5e0c08f639cf276ba8078c8 (patch)
treeed2fc8979d98068dd797e88fc57d33cb434508b7 /XMonad/Layout/LayoutHints.hs
parent43e3cc02dbbe9e3402fbf117d4a8412b843ce35e (diff)
downloadXMonadContrib-08cb6caca1db58abd5e0c08f639cf276ba8078c8.tar.gz
XMonadContrib-08cb6caca1db58abd5e0c08f639cf276ba8078c8.tar.xz
XMonadContrib-08cb6caca1db58abd5e0c08f639cf276ba8078c8.zip
LayoutHints: haddock fixes
darcs-hash:20071123142859-32816-0cd84e2523c5f43dd9bd0dd83f0c1e745ef86fd4.gz
Diffstat (limited to '')
-rw-r--r--XMonad/Layout/LayoutHints.hs17
1 files changed, 12 insertions, 5 deletions
diff --git a/XMonad/Layout/LayoutHints.hs b/XMonad/Layout/LayoutHints.hs
index 0bc9a3f..71d2241 100644
--- a/XMonad/Layout/LayoutHints.hs
+++ b/XMonad/Layout/LayoutHints.hs
@@ -27,12 +27,19 @@ import XMonad.Layout.LayoutModifier
import Control.Monad.Reader ( asks )
-- $usage
+-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
+--
-- > import XMonad.Layout.LayoutHints
--- > layouts = [ layoutHints tiled , layoutHints $ Mirror tiled ]
-
--- %import XMonad.Layout.LayoutHints
--- %layout , layoutHints $ tiled
--- %layout , layoutHints $ Mirror tiled
+--
+-- Then edit your @layoutHook@ by adding the LayoutHints layout modifier
+-- to some layout:
+--
+-- > myLayouts = layoutHints (Tall 1 (3/100) (1/2)) ||| Full ||| etc..
+-- > main = xmonad dafaultConfig { layoutHook = myLayouts }
+--
+-- For more detailed instructions on editing the layoutHook see:
+--
+-- "XMonad.Doc.Extending#Editing_the_layout_hook"
layoutHints :: (LayoutClass l a) => l a -> ModifiedLayout LayoutHints l a
layoutHints = ModifiedLayout LayoutHints