From 25a48e25941bc5064e391b44ce373d0561010e80 Mon Sep 17 00:00:00 2001 From: Brent Yorgey Date: Thu, 31 Jan 2008 02:27:28 +0100 Subject: Extending.hs: documentation update darcs-hash:20080131012728-bd4d7-37532b163af1144c2a6cfdd87a6b69360ded3f32.gz --- XMonad/Doc/Configuring.hs | 26 +++++++++++++------------- XMonad/Doc/Extending.hs | 3 +++ 2 files changed, 16 insertions(+), 13 deletions(-) (limited to 'XMonad/Doc') diff --git a/XMonad/Doc/Configuring.hs b/XMonad/Doc/Configuring.hs index 0e43ff5..4af629e 100644 --- a/XMonad/Doc/Configuring.hs +++ b/XMonad/Doc/Configuring.hs @@ -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, configuring xmonad required editing an xmonad source file called Config.hs, recompiling xmonad, and then restarting. From version 0.5 -onwards, however, all you have to do is edit xmonad.hs and restart -with @mod-q@; xmonad does the recompiling itself. The format of the -configuration file has also changed; it is now simpler and much -shorter, only requiring you to list those settings which are different -from the defaults. +onwards, however, you should NOT edit this file. All you have to do +is edit xmonad.hs and restart with @mod-q@; xmonad does the +recompiling itself. The format of the configuration file has also +changed; it is now simpler and much shorter, only requiring you to +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 describe values that differ from the defaults. -An alternative is to inline the entire default config file from -xmonad, and edit values you wish to change. This is requires more -work, but some users may find this easier. You can find the defaults -in the "XMonad.Config" module of the core xmonad library. - -However, note that (unlike previous versions of xmonad) you should not -edit Config.hs itself. +As an alternative, you can copy the template @xmonad.hs@ file (found +either in the @man@ directory, if you have the xmonad source, or on +the xmonad wiki at +@http:\/\/haskell.org\/haskellwiki\/Xmonad\/Config_archive\/Template_Config.hs@) +into your @~\/.xmonad\/@ directory. This template file contains all +the default settings spelled out, and you should be able to simply +change the ones you would like to change. To see what fields can be customized beyond the ones in the example 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: > $ 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. > Ok, modules loaded: Main. > diff --git a/XMonad/Doc/Extending.hs b/XMonad/Doc/Extending.hs index 12e7591..7ca338e 100644 --- a/XMonad/Doc/Extending.hs +++ b/XMonad/Doc/Extending.hs @@ -439,6 +439,9 @@ This particular definition also requires importing "Graphics.X11.Xlib" > import Graphics.X11.Xlib > import ... -- and so on +For a list of the names of particular keys (such as xK_F12, and so on), see +. + Usually, rather than completely redefining the key bindings, as we did above, we want to simply add some new bindings and\/or remove existing ones. -- cgit v1.2.3