<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>XMonad/Doc.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-2"></a><span class='hs-comment'>-- |</span>
<a name="line-3"></a><span class='hs-comment'>-- Module : XMonad.Doc</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (C) 2007 Andrea Rossato</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD3</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : andrea.rossato@unibz.it</span>
<a name="line-8"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-9"></a><span class='hs-comment'>-- Portability : portable</span>
<a name="line-10"></a><span class='hs-comment'>--</span>
<a name="line-11"></a><span class='hs-comment'>-- This is the main documentation module for the xmonad-contrib</span>
<a name="line-12"></a><span class='hs-comment'>-- library. It provides a brief overview of xmonad and a link to</span>
<a name="line-13"></a><span class='hs-comment'>-- documentation for configuring and extending xmonad.</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>-- A link to documentation describing xmonad internals is also provided.</span>
<a name="line-16"></a><span class='hs-comment'>-- This module is mainly intended for those wanting to contribute code,</span>
<a name="line-17"></a><span class='hs-comment'>-- or for those who are curious to know what's going on behind the scenes.</span>
<a name="line-18"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-19"></a>
<a name="line-20"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Doc</span>
<a name="line-21"></a> <span class='hs-layout'>(</span>
<a name="line-22"></a> <span class='hs-comment'>-- * Overview</span>
<a name="line-23"></a> <span class='hs-comment'>-- $overview</span>
<a name="line-24"></a>
<a name="line-25"></a> <span class='hs-comment'>-- * Configuring xmonad</span>
<a name="line-26"></a> <span class='hs-comment'>-- $configuring</span>
<a name="line-27"></a>
<a name="line-28"></a> <span class='hs-comment'>-- * Extending xmonad with the xmonad-contrib library</span>
<a name="line-29"></a> <span class='hs-comment'>-- $extending</span>
<a name="line-30"></a>
<a name="line-31"></a> <span class='hs-comment'>-- * Developing xmonad: a brief code commentary</span>
<a name="line-32"></a> <span class='hs-comment'>-- $developing</span>
<a name="line-33"></a>
<a name="line-34"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-35"></a>
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Doc</span><span class='hs-varop'>.</span><span class='hs-conid'>Configuring</span> <span class='hs-conid'>()</span>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Doc</span><span class='hs-varop'>.</span><span class='hs-conid'>Extending</span> <span class='hs-conid'>()</span>
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Doc</span><span class='hs-varop'>.</span><span class='hs-conid'>Developing</span> <span class='hs-conid'>()</span>
<a name="line-39"></a>
<a name="line-40"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-41"></a><span class='hs-comment'>--</span>
<a name="line-42"></a><span class='hs-comment'>-- Overview</span>
<a name="line-43"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-45"></a>
<a name="line-46"></a><span class='hs-comment'>{- $overview
<a name="line-47"></a>#Overview#
<a name="line-48"></a>
<a name="line-49"></a>xmonad is a tiling window manager for X. The xmonad-contrib library
<a name="line-50"></a>collects third party tiling algorithms, hooks, configurations,
<a name="line-51"></a>scripts, and other extensions to xmonad. The source for this library
<a name="line-52"></a>is available from <<a href="http://code.haskell.org/XMonadContrib">http://code.haskell.org/XMonadContrib</a>> via darcs:
<a name="line-53"></a>
<a name="line-54"></a>> darcs get <a href="http://code.haskell.org/XMonadContrib">http://code.haskell.org/XMonadContrib</a>
<a name="line-55"></a>
<a name="line-56"></a>Each stable release of xmonad is accompanied by a stable release of
<a name="line-57"></a>the contrib library, which you should use if (and only if) you're
<a name="line-58"></a>using a stable release of xmonad. You can find the most recent
<a name="line-59"></a>tarball here:
<a name="line-60"></a><<a href="http://hackage.haskell.org/cgi-bin/hackage-scripts/package/xmonad-contrib">http://hackage.haskell.org/cgi-bin/hackage-scripts/package/xmonad-contrib</a>>
<a name="line-61"></a>
<a name="line-62"></a>-}</span>
<a name="line-63"></a>
<a name="line-64"></a><span class='hs-comment'>{- $configuring
<a name="line-65"></a>
<a name="line-66"></a>"XMonad.Doc.Configuring" documents the process of configuring
<a name="line-67"></a>xmonad. A brief tutorial will guide you through the basic
<a name="line-68"></a>configuration steps.
<a name="line-69"></a>
<a name="line-70"></a>-}</span>
<a name="line-71"></a>
<a name="line-72"></a><span class='hs-comment'>{- $extending
<a name="line-73"></a>
<a name="line-74"></a>"XMonad.Doc.Extending" is dedicated to the xmonad-contrib library
<a name="line-75"></a>itself. You will find an overview of extensions available in the
<a name="line-76"></a>library and instructions for using them.
<a name="line-77"></a>
<a name="line-78"></a>-}</span>
<a name="line-79"></a>
<a name="line-80"></a><span class='hs-comment'>{- $developing
<a name="line-81"></a>
<a name="line-82"></a>"XMonad.Doc.Developing" consists of a brief description of the xmonad
<a name="line-83"></a>internals. It is mainly intended for contributors and provides a
<a name="line-84"></a>brief code commentary with links to the source documentation.
<a name="line-85"></a>
<a name="line-86"></a>-}</span>
</pre></body>
</html>
