add'l documentation

This commit is contained in:
Devin Mullins
2008-09-27 23:46:39 +00:00
parent 28c57a837a
commit 77657b65f9
3 changed files with 8 additions and 2 deletions

View File

@@ -340,7 +340,8 @@ io = liftIO
catchIO :: MonadIO m => IO () -> m ()
catchIO f = io (f `catch` \e -> hPrint stderr e >> hFlush stderr)
-- | spawn. Launch an external application
-- | spawn. Launch an external application. Specifically, it double-forks and
-- runs the 'String' you pass as a command to /bin/sh.
spawn :: MonadIO m => String -> m ()
spawn x = doubleFork $ executeFile "/bin/sh" False ["-c", x] Nothing

View File

@@ -51,7 +51,10 @@ instance LayoutClass Full a
-- | The builtin tiling mode of xmonad. Supports 'Shrink', 'Expand' and
-- 'IncMasterN'.
data Tall a = Tall !Int !Rational !Rational deriving (Show, Read)
data Tall a = Tall !Int -- ^ The default number of windows in the master pane (default: 1)
!Rational -- ^ Default proportion of screen occupied by master pane (default: 1/2)
!Rational -- ^ Percent of screen to increment by when resizing panes (default: 3/100)
deriving (Show, Read)
-- TODO should be capped [0..1] ..
-- a nice pure layout, lots of properties for the layout, and its messages, in Properties.hs

View File

@@ -36,5 +36,7 @@ xmonad
to your \fI~/.xinitrc\fR file
.SH CUSTOMIZATION
\fBxmonad\fR is customized in ~/.xmonad/xmonad.hs, and then restarting with mod-q.
.PP
You can find many extensions to the core feature set in the xmonad-contrib package, available through your package manager or from http://xmonad.org/.
.SH BUGS
Probably. If you find any, please report them: http://code.google.com/p/xmonad/issues/list