From 81bb12f8e71706501982d38e8682cdffbd3021da Mon Sep 17 00:00:00 2001 From: Wirt Wolff Date: Fri, 23 Oct 2009 20:49:05 +0200 Subject: Doc namespace minor updates Ignore-this: b3fd7de477f0a9ba6af1d8c78eb47754 Most signifigant changes are use unversioned links to external html, fix a couple of key binding examples, and double quotes that should have been single. darcs-hash:20091023184905-18562-289dca9ef6140e899ff6820bc8d2940cea2488bf.gz --- XMonad/Doc/Configuring.hs | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) (limited to 'XMonad/Doc/Configuring.hs') diff --git a/XMonad/Doc/Configuring.hs b/XMonad/Doc/Configuring.hs index c80219e..4e3486d 100644 --- a/XMonad/Doc/Configuring.hs +++ b/XMonad/Doc/Configuring.hs @@ -49,16 +49,25 @@ if it does exist, xmonad will use whatever settings you specify. Note that this file can contain arbitrary Haskell code, which means that you have quite a lot of flexibility in configuring xmonad. -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, 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. - +HISTORICAL NOTE regarding upgrading from versions (< 0.5) of xmonad +or using old documentation: + +xmonad-0.5 delivered a major change in the way xmonad is configured. Prior +to version 0.5, configuring xmonad required editing a source file called +Config.hs, manually recompiling xmonad, and then restarting. From +version 0.5 onwards, however, you should NOT edit this file or manually +compile with ghc --make. 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 also changed with version 0.5; enabling simpler and +much shorter xmonad.hs files that only require listing those settings which +are different from the defaults. + +While the complicated template.hs (man/xmonad.hs) files listing all default +settings are still provided for reference, once you wish to make substantial +changes to your configuration, the template.hs style configuration is not +recommended. It is fine to use top-level definitions to organize your +xmonad.hs, but wherever possible it is better to leave out settings that +simply duplicate defaults. -} {- $example @@ -90,8 +99,8 @@ describe values that differ from the defaults. 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_xmonad.hs@) +the xmonad wiki config archive at +) 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. @@ -135,7 +144,8 @@ all your windows, layouts, etc. intact. (If you change anything related to your layouts, you may need to hit @mod-shift-space@ after restarting to see the changes take effect.) If something goes wrong, the previous (default) settings will be used. Note this requires that -GHC and xmonad are in your @$PATH@. +GHC and xmonad are in the @$PATH@ in the environment from which xmonad +is started. -} -- cgit v1.2.3