Dmenu.hs: info and documentation

darcs-hash:20070614143753-32816-5a7b0c05a7081b1fa8c07f75f24b94e0e8acfea1.gz

1 files changed, 27 insertions, 3 deletions

diff --git a/Dmenu.hs b/Dmenu.hs
index ce27029..c38bd1d 100644
--- a/Dmenu.hs
+++ b/Dmenu.hs
@@ -1,4 +1,23 @@
-module XMonadContrib.Dmenu (dmenu, dmenuXinerama, runProcessWithInput) where
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.Dmenu
+-- Copyright   :  (c) Spencer Janssen <sjanssen@cse.unl.edu>
+-- License     :  BSD-style (see LICENSE)
+-- 
+-- Maintainer  :  Spencer Janssen <sjanssen@cse.unl.edu>
+-- Stability   :  unstable
+-- Portability :  unportable
+--
+-- A convenient binding to dmenu.
+--
+-----------------------------------------------------------------------------
+
+module XMonadContrib.Dmenu (
+                            -- * Usage
+                            -- $usage 
+                            dmenu, dmenuXinerama, 
+                            runProcessWithInput
+                           ) where
 
 import XMonad
 import qualified StackSet as W
@@ -6,6 +25,11 @@ import System.Process
 import System.IO
 import Control.Monad.State
 
+-- $usage
+-- You can use this module with the following in your Config.hs file:
+--
+-- > import XMonadContrib.Dmenu
+
 runProcessWithInput :: FilePath -> [String] -> String -> IO String
 runProcessWithInput cmd args input = do
     (pin, pout, perr, ph) <- runInteractiveProcess cmd args Nothing Nothing
@@ -18,8 +42,8 @@ runProcessWithInput cmd args input = do
     waitForProcess ph
     return output
     
--- Starts dmenu on the current screen. Requires this patch to dmenu:
--- http://www.jcreigh.com/dmenu/dmenu-2.8-xinerama.patch
+-- | Starts dmenu on the current screen. Requires this patch to dmenu:
+-- http:\/\/www.jcreigh.com\/dmenu\/dmenu-2.8-xinerama.patch
 dmenuXinerama :: [String] -> X String
 dmenuXinerama opts = do
     curscreen <- (fromIntegral . W.screen . W.current) `liftM` gets windowset :: X Int