aboutsummaryrefslogtreecommitdiffstats
path: root/XMonad/Prompt/XMonad.hs
diff options
context:
space:
mode:
authorAndrea Rossato <andrea.rossato@unibz.it>2007-11-21 15:27:15 +0100
committerAndrea Rossato <andrea.rossato@unibz.it>2007-11-21 15:27:15 +0100
commit649c4e081e27bdfa220c3b3e83f151a63da944d2 (patch)
tree574830456b2d4c73205e6cb3addb8db7499e75c5 /XMonad/Prompt/XMonad.hs
parentc0b830251f688598c2bee2bf1b63ffcd70220a2d (diff)
downloadXMonadContrib-649c4e081e27bdfa220c3b3e83f151a63da944d2.tar.gz
XMonadContrib-649c4e081e27bdfa220c3b3e83f151a63da944d2.tar.xz
XMonadContrib-649c4e081e27bdfa220c3b3e83f151a63da944d2.zip
Updated documentation of all prompts in XMonad.Prompt
darcs-hash:20071121142715-32816-d7bc698f2a035139bf7a512af20804c872b6d467.gz
Diffstat (limited to 'XMonad/Prompt/XMonad.hs')
-rw-r--r--XMonad/Prompt/XMonad.hs13
1 files changed, 5 insertions, 8 deletions
diff --git a/XMonad/Prompt/XMonad.hs b/XMonad/Prompt/XMonad.hs
index fde7b8c..992c011 100644
--- a/XMonad/Prompt/XMonad.hs
+++ b/XMonad/Prompt/XMonad.hs
@@ -3,7 +3,7 @@
-- Module : XMonad.Prompt.XMonad
-- Copyright : (C) 2007 Andrea Rossato
-- License : BSD3
---
+--
-- Maintainer : andrea.rossato@unibz.it
-- Stability : unstable
-- Portability : unportable
@@ -24,8 +24,7 @@ import XMonad.Prompt
import XMonad.Actions.Commands (defaultCommands, runCommand')
-- $usage
---
--- in Config.hs add:
+-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
--
-- > import XMonad.Prompt
-- > import XMonad.Prompt.XMonad
@@ -34,10 +33,8 @@ import XMonad.Actions.Commands (defaultCommands, runCommand')
--
-- > , ((modMask x .|. controlMask, xK_x), xmonadPrompt defaultXPConfig)
--
-
--- %import XMonad.Prompt
--- %import XMonad.Prompt.XMonad
--- %keybind , ((modMask x .|. controlMask, xK_x), xmonadPrompt defaultXPConfig)
+-- For detailed instruction on editing the key binding see
+-- "XMonad.Doc.Extending#Editing_key_bindings".
data XMonad = XMonad
@@ -49,6 +46,6 @@ xmonadPrompt c = do
cmds <- defaultCommands
mkXPrompt XMonad c (mkComplFunFromList (map fst cmds)) runCommand'
--- xmonad prompt with custom command list
+-- | An xmonad prompt with a custom command list
xmonadPromptC :: [(String, X ())] -> XPConfig -> X ()
xmonadPromptC commands c = mkXPrompt XMonad c (mkComplFunFromList (map fst commands)) runCommand'