twin/xmonad-contrib
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad-contrib.git synced 2025-07-26 09:41:52 -07:00
Code Issues Packages Projects Releases Wiki Activity

Extending.hs: documentation update

Browse Source
This commit is contained in:
Brent Yorgey
2008-01-31 01:27:28 +00:00
parent 1826f43e85
commit adf747b666
2 changed files with 16 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
XMonad/Doc/Configuring.hs
View File

@@ -53,11 +53,11 @@ NOTE for users of previous versions (< 0.5) of xmonad: this is a major
change in the way xmonad is configured. Prior to version 0.5, change in the way xmonad is configured. Prior to version 0.5,
configuring xmonad required editing an xmonad source file called configuring xmonad required editing an xmonad source file called
Config.hs, recompiling xmonad, and then restarting. From version 0.5 Config.hs, recompiling xmonad, and then restarting. From version 0.5
onwards, however, all you have to do is edit xmonad.hs and restart onwards, however, you should NOT edit this file. All you have to do
with @mod-q@; xmonad does the recompiling itself. The format of the is edit xmonad.hs and restart with @mod-q@; xmonad does the
configuration file has also changed; it is now simpler and much recompiling itself. The format of the configuration file has also
shorter, only requiring you to list those settings which are different changed; it is now simpler and much shorter, only requiring you to
from the defaults. list those settings which are different from the defaults.
-} -}
@@ -88,13 +88,13 @@ Overriding default settings like this (using \"record update
syntax\"), will yield the shortest config file, as you only have to syntax\"), will yield the shortest config file, as you only have to
describe values that differ from the defaults. describe values that differ from the defaults.
An alternative is to inline the entire default config file from As an alternative, you can copy the template @xmonad.hs@ file (found
xmonad, and edit values you wish to change. This is requires more either in the @man@ directory, if you have the xmonad source, or on
work, but some users may find this easier. You can find the defaults the xmonad wiki at
in the "XMonad.Config" module of the core xmonad library. @http:\/\/haskell.org\/haskellwiki\/Xmonad\/Config_archive\/Template_Config.hs@)
into your @~\/.xmonad\/@ directory. This template file contains all
However, note that (unlike previous versions of xmonad) you should not the default settings spelled out, and you should be able to simply
edit Config.hs itself. change the ones you would like to change.
To see what fields can be customized beyond the ones in the example To see what fields can be customized beyond the ones in the example
above, the definition of the 'XMonad.Core.XConfig' data structure can above, the definition of the 'XMonad.Core.XConfig' data structure can
@@ -110,7 +110,7 @@ is syntactically and type correct. You can do this easily by loading
your configuration file in the Haskell interpreter: your configuration file in the Haskell interpreter:
> $ ghci ~/.xmonad/xmonad.hs > $ ghci ~/.xmonad/xmonad.hs
> GHCi, version 6.8.1: http://www.haskell.org/ghc/ :? for help > GHCi, version 6.8.2: http://www.haskell.org/ghc/ :? for help
> Loading package base ... linking ... done. > Loading package base ... linking ... done.
> Ok, modules loaded: Main. > Ok, modules loaded: Main.
> >

3
XMonad/Doc/Extending.hs
View File

@@ -439,6 +439,9 @@ This particular definition also requires importing "Graphics.X11.Xlib"
> import Graphics.X11.Xlib > import Graphics.X11.Xlib
> import ... -- and so on > import ... -- and so on
For a list of the names of particular keys (such as xK_F12, and so on), see
<http://hackage.haskell.org/packages/archive/X11/1.4.1/doc/html/Graphics-X11-Types.html>.
Usually, rather than completely redefining the key bindings, as we did Usually, rather than completely redefining the key bindings, as we did
above, we want to simply add some new bindings and\/or remove existing above, we want to simply add some new bindings and\/or remove existing
ones. ones.