WorkspaceDir.hs: info and documentation

darcs-hash:20070614144443-32816-3783f2a1a77aacf8e13f10624692d97ea71de953.gz

1 files changed, 37 insertions, 10 deletions

diff --git a/WorkspaceDir.hs b/WorkspaceDir.hs
index 4b04ff0..cd84263 100644
--- a/WorkspaceDir.hs
+++ b/WorkspaceDir.hs
@@ -1,14 +1,29 @@
 {-# OPTIONS -fglasgow-exts #-}
-module XMonadContrib.WorkspaceDir ( workspaceDir, changeDir ) where
-
--- to use:
-
--- import XMonadContrib.WorkspaceDir
-
--- defaultLayouts = map (workspaceDir "~") [ tiled, ... ]
-
--- In keybindings:
---  , ((modMask .|. shiftMask, xK_x     ), changeDir ["~","/tmp"])
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.WorkspaceDir
+-- Copyright   :  (c) 2007  David Roundy <droundy@darcs.net>
+-- License     :  BSD3-style (see LICENSE)
+-- 
+-- Maintainer  :  David Roundy <droundy@darcs.net>
+-- Stability   :  unstable
+-- Portability :  unportable
+--
+-- WorkspaceDir is an exstension to set the current directory in a workspace.
+--
+-- Actually, it sets the current directory in a layout, since there's no way I
+-- know of to attach a behavior to a workspace.  This means that any terminals
+-- (or other programs) pulled up in that workspace (with that layout) will
+-- execute in that working directory.  Sort of handy, I think.
+--
+-----------------------------------------------------------------------------
+
+module XMonadContrib.WorkspaceDir ( 
+                                   -- * Usage
+                                   -- $usage
+                                   workspaceDir, 
+                                   changeDir
+                                  ) where
 
 import System.Directory ( setCurrentDirectory, getCurrentDirectory )
 import Data.List ( nub )
@@ -17,6 +32,18 @@ import XMonad
 import Operations ( sendMessage )
 import XMonadContrib.Dmenu ( dmenu, runProcessWithInput )
 
+-- $usage
+-- You can use this module with the following in your Config.hs file:
+--
+-- > import XMonadContrib.WorkspaceDir
+-- >
+-- > defaultLayouts = map (workspaceDir "~") [ tiled, ... ]
+--
+-- In keybindings:
+--
+-- >  , ((modMask .|. shiftMask, xK_x     ), changeDir ["~","/tmp"])
+
+
 data Chdir = Chdir String deriving ( Typeable )
 instance Message Chdir