aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--XMonad/Layout/Named.hs14
1 files changed, 11 insertions, 3 deletions
diff --git a/XMonad/Layout/Named.hs b/XMonad/Layout/Named.hs
index 54ef89b..265f39c 100644
--- a/XMonad/Layout/Named.hs
+++ b/XMonad/Layout/Named.hs
@@ -10,6 +10,8 @@
-- Stability : unstable
-- Portability : unportable
--
+-- A module for assigning a name to a given layout.
+--
-----------------------------------------------------------------------------
module XMonad.Layout.Named (
@@ -21,13 +23,19 @@ module XMonad.Layout.Named (
import XMonad
-- $usage
--- You can use this module with the following in your Config.hs file:
+-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
--
-- > import XMonad.Layout.Named
--
--- and change the name of a given layout by
+-- Then edit your @layoutHook@ by adding the Named layout modifier
+-- to some layout:
+--
+-- > myLayouts = Named "real big" Full ||| etc..
+-- > main = xmonad dafaultConfig { layoutHook = myLayouts }
+--
+-- For more detailed instructions on editing the layoutHook see:
--
--- > layout = Named "real big" Full ||| ...
+-- "XMonad.Doc.Extending#Editing_the_layout_hook"
data Named l a = Named String (l a) deriving ( Read, Show )