Difference between revisions of "Xmonad/Config archive/Template xmonad.hs (darcs)"

From HaskellWiki
Jump to: navigation, search
(Update with handleEventHook)
(correct field name)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<haskell>
 
  +
If you want a good configuration to start from, it's quite simple.
--
 
-- xmonad example config file.
 
--
 
-- A template showing all available configuration hooks,
 
-- and how to override the defaults in your own xmonad.hs conf file.
 
--
 
-- Normally, you'd only override those defaults you care about.
 
--
 
   
  +
A very basic configuration, which will work for things like simple terminals but not so well for many modern applications such as web browsers:
  +
  +
<pre>
 
import XMonad
 
import XMonad
import System.Exit
 
   
import qualified XMonad.StackSet as W
 
  +
main = xmonad defaultConfig
import qualified Data.Map as M
 
  +
</pre>
   
-- The preferred terminal program, which is used in a binding below and by
 
  +
A more modern and more easily customized, yet still minimal, configuration (requires xmonad-contrib). '''Use this config if you plan to run Chromium; recent versions do ''not'' work correctly if you do not have desktop support enabled!'''
-- certain contrib modules.
 
--
 
myTerminal = "xterm"
 
   
-- Whether focus follows the mouse pointer.
 
  +
<pre>
myFocusFollowsMouse :: Bool
 
  +
import XMonad
myFocusFollowsMouse = True
 
  +
import XMonad.Config.Desktop
   
-- Width of the window border in pixels.
 
  +
baseConfig = desktopConfig
--
 
myBorderWidth = 1
 
   
-- modMask lets you specify which modkey you want to use. The default
 
  +
main = xmonad baseConfig
-- is mod1Mask ("left alt"). You may also consider using mod3Mask
 
  +
</pre>
-- ("right alt"), which does not conflict with emacs keybindings. The
 
-- "windows key" is usually mod4Mask.
 
--
 
myModMask = mod1Mask
 
   
-- The mask for the numlock key. Numlock status is "masked" from the
 
  +
In this one, if you want to add things to various hooks (anything that ends with <code>Hook</code>, except <code>layoutHook</code> which is handled specially), you should prepend <code>hookName baseConfig <+></code> to the new value. (You may also make it the first item in a <code>composeAll</code> for the <code>manageHook</code>, or use Haskell's <code>do</code> notation for most other hooks.)
-- current modifier status, so the keybindings will work with numlock on or
 
-- off. You may need to change this on some systems.
 
--
 
-- You can find the numlock modifier by running "xmodmap" and looking for a
 
-- modifier with Num_Lock bound to it:
 
--
 
-- > $ xmodmap | grep Num
 
-- > mod2 Num_Lock (0x4d)
 
--
 
-- Set numlockMask = 0 if you don't have a numlock key, or want to treat
 
-- numlock status separately.
 
--
 
myNumlockMask = mod2Mask
 
   
-- The default number of workspaces (virtual screens) and their names.
 
  +
<pre>
-- By default we use numeric strings, but any string may be used as a
 
  +
import XMonad
-- workspace name. The number of workspaces is determined by the length
 
  +
import XMonad.Config.Desktop
-- of this list.
 
  +
import XMonad.Util.SpawnOnce
--
 
-- A tagging example:
 
--
 
-- > workspaces = ["web", "irc", "code" ] ++ map show [4..9]
 
--
 
myWorkspaces = ["1","2","3","4","5","6","7","8","9"]
 
   
-- Border colors for unfocused and focused windows, respectively.
 
  +
baseConfig = desktopConfig
--
 
myNormalBorderColor = "#dddddd"
 
myFocusedBorderColor = "#ff0000"
 
   
------------------------------------------------------------------------
 
  +
main = xmonad baseConfig {
-- Key bindings. Add, modify or remove key bindings here.
 
  +
focusedBorderColor = "#ff2037" -- not a hook
--
 
  +
,startupHook = startupHook baseConfig <+> spawnOnce "urxvt"
myKeys conf@(XConfig {XMonad.modMask = modMask}) = M.fromList $
 
  +
}
  +
</pre>
   
-- launch a terminal
 
  +
This ensures that you don't skip any hooks needed by the base configuration. If you want to do this with <code>layoutHook</code>, use <code>(|||)</code> instead:
[ ((modMask .|. shiftMask, xK_Return), spawn $ XMonad.terminal conf)
 
   
-- launch dmenu
 
  +
<pre>
, ((modMask, xK_p ), spawn "exe=`dmenu_path | dmenu` && eval \"exec $exe\"")
 
  +
layoutHook = myTall ||| layoutHook baseConfig
  +
</pre>
   
-- launch gmrun
 
  +
The consistent use of <code>baseConfig</code> means you only need to change the definition of <code>baseConfig</code> in order to switch to a different base, e.g. <code>defaultConfig</code> for basic ICCCM compliance or <code>xfceConfig</code> to integrate with an existing XFCE session.
, ((modMask .|. shiftMask, xK_p ), spawn "gmrun")
 
   
-- close focused window
 
  +
If you plan to use <code>XMonad.Util.EZConfig.additionalKeys</code>, or define your own hooks or commands, you may wish to put non-hooks in the definition of <code>baseConfig</code> so that you can refer to your <code>modMask</code> etc. later:
, ((modMask .|. shiftMask, xK_c ), kill)
 
   
-- Rotate through the available layout algorithms
 
  +
<pre>
, ((modMask, xK_space ), sendMessage NextLayout)
 
  +
import XMonad
 
  +
import XMonad.Config.Desktop
-- Reset the layouts on the current workspace to default
 
  +
import XMonad.Util.EZConfig
, ((modMask .|. shiftMask, xK_space ), setLayout $ XMonad.layoutHook conf)
 
 
-- Resize viewed windows to the correct size
 
, ((modMask, xK_n ), refresh)
 
 
-- Move focus to the next window
 
, ((modMask, xK_Tab ), windows W.focusDown)
 
 
-- Move focus to the next window
 
, ((modMask, xK_j ), windows W.focusDown)
 
 
-- Move focus to the previous window
 
, ((modMask, xK_k ), windows W.focusUp )
 
 
-- Move focus to the master window
 
, ((modMask, xK_m ), windows W.focusMaster )
 
 
-- Swap the focused window and the master window
 
, ((modMask, xK_Return), windows W.swapMaster)
 
 
-- Swap the focused window with the next window
 
, ((modMask .|. shiftMask, xK_j ), windows W.swapDown )
 
 
-- Swap the focused window with the previous window
 
, ((modMask .|. shiftMask, xK_k ), windows W.swapUp )
 
 
-- Shrink the master area
 
, ((modMask, xK_h ), sendMessage Shrink)
 
 
-- Expand the master area
 
, ((modMask, xK_l ), sendMessage Expand)
 
 
-- Push window back into tiling
 
, ((modMask, xK_t ), withFocused $ windows . W.sink)
 
 
-- Increment the number of windows in the master area
 
, ((modMask , xK_comma ), sendMessage (IncMasterN 1))
 
 
-- Deincrement the number of windows in the master area
 
, ((modMask , xK_period), sendMessage (IncMasterN (-1)))
 
 
-- toggle the status bar gap
 
-- TODO, update this binding with avoidStruts , ((modMask , xK_b ),
 
 
-- Quit xmonad
 
, ((modMask .|. shiftMask, xK_q ), io (exitWith ExitSuccess))
 
 
-- Restart xmonad
 
, ((modMask , xK_q ), restart "xmonad" True)
 
]
 
++
 
 
--
 
-- mod-[1..9], Switch to workspace N
 
-- mod-shift-[1..9], Move client to workspace N
 
--
 
[((m .|. modMask, k), windows $ f i)
 
| (i, k) <- zip (XMonad.workspaces conf) [xK_1 .. xK_9]
 
, (f, m) <- [(W.greedyView, 0), (W.shift, shiftMask)]]
 
++
 
 
--
 
-- mod-{w,e,r}, Switch to physical/Xinerama screens 1, 2, or 3
 
-- mod-shift-{w,e,r}, Move client to screen 1, 2, or 3
 
--
 
[((m .|. modMask, key), screenWorkspace sc >>= flip whenJust (windows . f))
 
| (key, sc) <- zip [xK_w, xK_e, xK_r] [0..]
 
, (f, m) <- [(W.view, 0), (W.shift, shiftMask)]]
 
 
 
------------------------------------------------------------------------
 
-- Mouse bindings: default actions bound to mouse events
 
--
 
myMouseBindings (XConfig {XMonad.modMask = modMask}) = M.fromList $
 
 
-- mod-button1, Set the window to floating mode and move by dragging
 
[ ((modMask, button1), (\w -> focus w >> mouseMoveWindow w
 
>> windows W.shiftMaster))
 
 
-- mod-button2, Raise the window to the top of the stack
 
, ((modMask, button2), (\w -> focus w >> windows W.shiftMaster))
 
 
-- mod-button3, Set the window to floating mode and resize by dragging
 
, ((modMask, button3), (\w -> focus w >> mouseResizeWindow w
 
>> windows W.shiftMaster))
 
 
-- you may also bind events to the mouse scroll wheel (button4 and button5)
 
]
 
 
------------------------------------------------------------------------
 
-- Layouts:
 
 
-- You can specify and transform your layouts by modifying these values.
 
-- If you change layout bindings be sure to use 'mod-shift-space' after
 
-- restarting (with 'mod-q') to reset your layout state to the new
 
-- defaults, as xmonad preserves your old layout settings by default.
 
--
 
-- The available layouts. Note that each layout is separated by |||,
 
-- which denotes layout choice.
 
--
 
myLayout = tiled ||| Mirror tiled ||| Full
 
where
 
-- default tiling algorithm partitions the screen into two panes
 
tiled = Tall nmaster delta ratio
 
 
-- The default number of windows in the master pane
 
nmaster = 1
 
 
-- Default proportion of screen occupied by master pane
 
ratio = 1/2
 
 
-- Percent of screen to increment by when resizing panes
 
delta = 3/100
 
 
------------------------------------------------------------------------
 
-- Window rules:
 
 
-- Execute arbitrary actions and WindowSet manipulations when managing
 
-- a new window. You can use this to, for example, always float a
 
-- particular program, or have a client always appear on a particular
 
-- workspace.
 
--
 
-- To find the property name associated with a program, use
 
-- > xprop | grep WM_CLASS
 
-- and click on the client you're interested in.
 
--
 
-- To match on the WM_NAME, you can use 'title' in the same way that
 
-- 'className' and 'resource' are used below.
 
--
 
myManageHook = composeAll
 
[ className =? "MPlayer" --> doFloat
 
, className =? "Gimp" --> doFloat
 
, resource =? "desktop_window" --> doIgnore
 
, resource =? "kdesktop" --> doIgnore ]
 
 
------------------------------------------------------------------------
 
-- Event handling:
 
 
-- * EwmhDesktops users should change this to ewmhDesktopsEventHook
 
--
 
-- Defines a custom handler function for X Events. The function should
 
-- return True if the default handler is to be run afterwards. To
 
-- combine Event Hooks use mappend or mconcat from Data.Monoid.
 
--
 
myEventHook = handleEventHook
 
 
------------------------------------------------------------------------
 
-- Status bars and logging
 
 
-- Perform an arbitrary action on each internal state change or X event.
 
-- See the 'DynamicLog' extension for examples.
 
--
 
-- To emulate dwm's status bar
 
--
 
-- > logHook = dynamicLogDzen
 
--
 
myLogHook = return ()
 
 
------------------------------------------------------------------------
 
-- Startup hook
 
 
-- Perform an arbitrary action each time xmonad starts or is restarted
 
-- with mod-q. Used by, e.g., XMonad.Layout.PerWorkspace to initialize
 
-- per-workspace layout choices.
 
--
 
-- By default, do nothing.
 
myStartupHook = return ()
 
 
------------------------------------------------------------------------
 
-- Now run xmonad with all the defaults we set up.
 
   
-- Run xmonad with the settings you specify. No need to modify this.
 
  +
baseConfig = desktopConfig {
--
 
  +
modMask = mod4Mask
main = xmonad defaults
 
  +
, focusedBorderColor = "#ff2037"
  +
}
   
-- A structure containing your configuration settings, overriding
 
  +
main = xmonad $ baseConfig {
-- fields in the default config. Any you don't override, will
 
  +
startupHook = startupHook baseConfig <+> myHook
-- use the defaults defined in xmonad/XMonad/Config.hs
 
  +
}
--
 
  +
`additionalKeys`
-- No need to modify this.
 
  +
[((modMask baseConfig,xK_F1), spawn "firefox"))
--
 
  +
]
defaults = defaultConfig {
 
-- simple stuff
 
terminal = myTerminal,
 
focusFollowsMouse = myFocusFollowsMouse,
 
borderWidth = myBorderWidth,
 
modMask = myModMask,
 
numlockMask = myNumlockMask,
 
workspaces = myWorkspaces,
 
normalBorderColor = myNormalBorderColor,
 
focusedBorderColor = myFocusedBorderColor,
 
   
-- key bindings
 
  +
myHook = {- ... -}
keys = myKeys,
 
  +
</pre>
mouseBindings = myMouseBindings,
 
   
-- hooks, layouts
 
  +
See [http://xmonad.org/xmonad-docs/xmonad-contrib/XMonad-Doc-Configuring.html XMonad.Doc.Configuring] for more information on customizing an xmonad configuration.
layoutHook = myLayout,
 
manageHook = myManageHook,
 
handleEventHook = myEventHook,
 
logHook = myLogHook,
 
startupHook = myStartupHook
 
}
 
</haskell>
 

Latest revision as of 17:06, 11 January 2018

If you want a good configuration to start from, it's quite simple.

A very basic configuration, which will work for things like simple terminals but not so well for many modern applications such as web browsers:

import XMonad

main = xmonad defaultConfig

A more modern and more easily customized, yet still minimal, configuration (requires xmonad-contrib). Use this config if you plan to run Chromium; recent versions do not work correctly if you do not have desktop support enabled!

import XMonad
import XMonad.Config.Desktop

baseConfig = desktopConfig

main = xmonad baseConfig

In this one, if you want to add things to various hooks (anything that ends with Hook, except layoutHook which is handled specially), you should prepend hookName baseConfig <+> to the new value. (You may also make it the first item in a composeAll for the manageHook, or use Haskell's do notation for most other hooks.)

import XMonad
import XMonad.Config.Desktop
import XMonad.Util.SpawnOnce

baseConfig = desktopConfig

main = xmonad baseConfig {
   focusedBorderColor = "#ff2037" -- not a hook
  ,startupHook = startupHook baseConfig <+> spawnOnce "urxvt"
}

This ensures that you don't skip any hooks needed by the base configuration. If you want to do this with layoutHook, use (|||) instead:

    layoutHook = myTall ||| layoutHook baseConfig

The consistent use of baseConfig means you only need to change the definition of baseConfig in order to switch to a different base, e.g. defaultConfig for basic ICCCM compliance or xfceConfig to integrate with an existing XFCE session.

If you plan to use XMonad.Util.EZConfig.additionalKeys, or define your own hooks or commands, you may wish to put non-hooks in the definition of baseConfig so that you can refer to your modMask etc. later:

import XMonad
import XMonad.Config.Desktop
import XMonad.Util.EZConfig

baseConfig = desktopConfig {
               modMask = mod4Mask
             , focusedBorderColor = "#ff2037"
             }

main = xmonad $ baseConfig {
                  startupHook = startupHook baseConfig <+> myHook
                }
                `additionalKeys`
                [((modMask baseConfig,xK_F1), spawn "firefox"))
                ]

myHook = {- ... -}

See XMonad.Doc.Configuring for more information on customizing an xmonad configuration.