aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-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