twin/xmonad
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad.git synced 2025-08-03 21:51:53 -07:00
Code Issues Packages Projects Releases Wiki Activity

TUTORIAL: Fixes to ease inclusion into xmonad-web

Browse Source 
Also makes it easier to copy & paste.
This commit is contained in:
Tomas Janousek
2021-08-02 15:07:07 +01:00
parent 206fc918bb
commit ad7288030f
1 changed files with 374 additions and 374 deletions
Download Patch File Download Diff File Expand all files Collapse all files

296
TUTORIAL.md
View File

@@ -1,12 +1,3 @@
NOTE: `xmonad 0.16` and `xmonad-contrib 0.17` are obviously not released
yet. But don't worry, if you're reading this then you're already a beta
tester :) Since this guide is supposed to work on older versions of
xmonad as well this is no problem however; please report any
incompatibilities you notice and state the version of xmonad and
xmonad-contrib that you tried to use. If you use the git versions of
xmonad and xmonad-contrib, you should be able to follow everything just
fine.
# XMonad Configuration Tutorial # XMonad Configuration Tutorial
We're going to take you, step-by-step, through the process of We're going to take you, step-by-step, through the process of
@@ -29,6 +20,15 @@ the ability to magnify stack windows via [XMonad.Layout.Magnifier]:
So let's get started! So let's get started!
NOTE: `xmonad 0.17` and `xmonad-contrib 0.17` are obviously not released
yet. But don't worry, if you're reading this then you're already a beta
tester :) Since this guide is supposed to work on older versions of
xmonad as well this is no problem however; please report any
incompatibilities you notice and state the version of xmonad and
xmonad-contrib that you tried to use. If you use the git versions of
xmonad and xmonad-contrib, you should be able to follow everything just
fine.
## Preliminaries ## Preliminaries
First you'll want to install xmonad. You can either do this with your First you'll want to install xmonad. You can either do this with your
@@ -47,7 +47,7 @@ package manager, you will need to `xmonad --recompile` _every time_ a
Haskell dependency is updated—else xmonad may fail to start when you Haskell dependency is updated—else xmonad may fail to start when you
want to log in! want to log in!
We're going to assume xmonad version `0.16` and xmonad-contrib version We're going to assume xmonad version `0.17` and xmonad-contrib version
`0.17` here, though most of these steps should work with older versions `0.17` here, though most of these steps should work with older versions
as well. When we get to the relevant parts, will point you to as well. When we get to the relevant parts, will point you to
alternatives that work with at least xmonad version `0.15` and alternatives that work with at least xmonad version `0.15` and
@@ -70,8 +70,8 @@ commands for your system.
To install xmonad, as well as some utilities, via `apt` you can just run To install xmonad, as well as some utilities, via `apt` you can just run
``` shell ``` console
apt-get install xmonad libghc-xmonad-contrib-dev libghc-xmonad-dev suckless-tools $ apt-get install xmonad libghc-xmonad-contrib-dev libghc-xmonad-dev suckless-tools
``` ```
This installs xmonad itself, everything you need to configure it, and This installs xmonad itself, everything you need to configure it, and
@@ -114,10 +114,10 @@ file called `xmonad.hs`. We'll start off with importing some of the
utility modules we will use. At the very top of the file, write utility modules we will use. At the very top of the file, write
``` haskell ``` haskell
import XMonad import XMonad
import XMonad.Util.EZConfig import XMonad.Util.EZConfig
import XMonad.Util.Ungrab import XMonad.Util.Ungrab
``` ```
All of these imports are _unqualified_, meaning we are importing all of All of these imports are _unqualified_, meaning we are importing all of
@@ -127,7 +127,7 @@ you can do so by adding the necessary function to the `import` statement
in parentheses. For example in parentheses. For example
``` haskell ``` haskell
import XMonad.Util.EZConfig (additionalKeysP) import XMonad.Util.EZConfig (additionalKeysP)
``` ```
For the purposes of this tutorial, we will be importing everything For the purposes of this tutorial, we will be importing everything
@@ -137,8 +137,8 @@ Next, a basic configuration—which is the same as the default config—is
this: this:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad def main = xmonad def
``` ```
In case you're interested in what this default configuration actually In case you're interested in what this default configuration actually
@@ -163,8 +163,8 @@ Alt on most keyboards. We can do this by changing the above `main`
function in the following way: function in the following way:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad $ def main = xmonad $ def
{ modMask = mod4Mask -- Rebind Mod to the Super key { modMask = mod4Mask -- Rebind Mod to the Super key
} }
``` ```
@@ -184,8 +184,8 @@ use a dollar sign instead. For us this is particularly nice, because
now we don't have to awkwardly write now we don't have to awkwardly write
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad (def main = xmonad (def
{ modMask = mod4Mask -- Rebind Mod to the Super key { modMask = mod4Mask -- Rebind Mod to the Super key
}) })
``` ```
@@ -203,8 +203,8 @@ achieved with the `additionalKeysP` function from the
config file, starting with `main`, now looks like: config file, starting with `main`, now looks like:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad $ def main = xmonad $ def
{ modMask = mod4Mask -- Rebind Mod to the Super key { modMask = mod4Mask -- Rebind Mod to the Super key
} }
`additionalKeysP` `additionalKeysP`
@@ -226,8 +226,8 @@ release its keyboard grab before `scrot -s` tries to grab the keyboard
itself. The little `*>` operator essentially just sequences two itself. The little `*>` operator essentially just sequences two
functions, i.e. `f *> g` says functions, i.e. `f *> g` says
> first do `f` and then, discarding any result that `f` may have given > first do `f` and then, discarding any result that `f` may have given
> me, do `g`. > me, do `g`.
Do note that you may need to install `scrot` if you don't have it on Do note that you may need to install `scrot` if you don't have it on
your system already. your system already.
@@ -241,16 +241,16 @@ We start by visiting the documentation for [XMonad.Layout.ThreeColumns].
The very first sentence of the `Usage` section tells us exactly what we The very first sentence of the `Usage` section tells us exactly what we
want to start with: want to start with:
> You can use this module with the following in your `~/.xmonad/xmonad.hs`: > You can use this module with the following in your `~/.xmonad/xmonad.hs`:
> >
> `import XMonad.Layout.ThreeColumns` > `import XMonad.Layout.ThreeColumns`
Ignoring the part about where exactly our `xmonad.hs` is (we have opted Ignoring the part about where exactly our `xmonad.hs` is (we have opted
to put it into `~/.config/xmonad/xmonad.hs`, remember?) we can follow to put it into `~/.config/xmonad/xmonad.hs`, remember?) we can follow
that documentation word for word. Let's add that documentation word for word. Let's add
``` haskell ``` haskell
import XMonad.Layout.ThreeColumns import XMonad.Layout.ThreeColumns
``` ```
to the top of our configuration file. Most modules have a lot of to the top of our configuration file. Most modules have a lot of
@@ -263,7 +263,7 @@ layout. To do this, there is the `layoutHook`. Let's use the default
layout as a base: layout as a base:
``` haskell ``` haskell
myLayout = tiled ||| Mirror tiled ||| Full myLayout = tiled ||| Mirror tiled ||| Full
where where
tiled = Tall nmaster delta ratio tiled = Tall nmaster delta ratio
nmaster = 1 -- Default number of windows in the master pane nmaster = 1 -- Default number of windows in the master pane
@@ -276,7 +276,7 @@ that might clutter things up where they all declared at the top-level
like this like this
``` haskell ``` haskell
myLayout = Tall 1 (3/100) (1/2) ||| Mirror (Tall 1 (3/100) (1/2)) ||| Full myLayout = Tall 1 (3/100) (1/2) ||| Mirror (Tall 1 (3/100) (1/2)) ||| Full
``` ```
It also gives us the chance of documenting what the individual numbers It also gives us the chance of documenting what the individual numbers
@@ -290,7 +290,7 @@ worry; it'll come with time!
We can, for example, add the additional layout like this: We can, for example, add the additional layout like this:
``` haskell ``` haskell
myLayout = tiled ||| Mirror tiled ||| Full ||| ThreeColMid 1 (3/100) (1/2) myLayout = tiled ||| Mirror tiled ||| Full ||| ThreeColMid 1 (3/100) (1/2)
where where
tiled = Tall nmaster delta ratio tiled = Tall nmaster delta ratio
nmaster = 1 -- Default number of windows in the master pane nmaster = 1 -- Default number of windows in the master pane
@@ -301,7 +301,7 @@ We can, for example, add the additional layout like this:
or even, because the numbers happen to line up, like this: or even, because the numbers happen to line up, like this:
``` haskell ``` haskell
myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol
where where
threeCol = ThreeColMid nmaster delta ratio threeCol = ThreeColMid nmaster delta ratio
tiled = Tall nmaster delta ratio tiled = Tall nmaster delta ratio
@@ -315,8 +315,8 @@ Now we just need to tell xmonad that we want to use this modified
yourself by just looking at the documentation. Ready? Here we go: yourself by just looking at the documentation. Ready? Here we go:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad $ def main = xmonad $ def
{ modMask = mod4Mask -- Rebind Mod to the Super key { modMask = mod4Mask -- Rebind Mod to the Super key
, layoutHook = myLayout -- Use custom layouts , layoutHook = myLayout -- Use custom layouts
} }
@@ -335,7 +335,7 @@ modifier from the library; it magnifies a window by a given amount, but
only if it's a stack window. Add it to your three column layout thusly: only if it's a stack window. Add it to your three column layout thusly:
``` haskell ``` haskell
myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol
where where
threeCol = magnifiercz' 1.3 $ ThreeColMid nmaster delta ratio threeCol = magnifiercz' 1.3 $ ThreeColMid nmaster delta ratio
tiled = Tall nmaster delta ratio tiled = Tall nmaster delta ratio
@@ -351,7 +351,7 @@ from the dollar to the end of the line. If you don't like that you can
also write also write
``` haskell ``` haskell
threeCol = magnifiercz' 1.3 (ThreeColMid nmaster delta ratio) threeCol = magnifiercz' 1.3 (ThreeColMid nmaster delta ratio)
``` ```
instead. instead.
@@ -374,7 +374,7 @@ This functionality is to be found in the [XMonad.Hooks.EwmhDesktops]
module, so let's import it: module, so let's import it:
``` haskell ``` haskell
import XMonad.Hooks.EwmhDesktops import XMonad.Hooks.EwmhDesktops
``` ```
We might also consider using the `ewmhFullscreen` combinator. By We might also consider using the `ewmhFullscreen` combinator. By
@@ -398,8 +398,8 @@ To use the two combinators, we compose them with the `xmonad` function
in the following way: in the following way:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad $ ewmhFullscreen $ ewmh $ def main = xmonad $ ewmhFullscreen $ ewmh $ def
{ modMask = mod4Mask -- Rebind Mod to the Super key { modMask = mod4Mask -- Rebind Mod to the Super key
, layoutHook = myLayout -- Use custom layouts , layoutHook = myLayout -- Use custom layouts
} }
@@ -420,10 +420,10 @@ Let's call the config part `myConfig` for... obvious reasons. It would
look like this: look like this:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad $ ewmhFullscreen $ ewmh $ myConfig main = xmonad $ ewmhFullscreen $ ewmh $ myConfig
myConfig = def myConfig = def
{ modMask = mod4Mask -- Rebind Mod to the Super key { modMask = mod4Mask -- Rebind Mod to the Super key
, layoutHook = myLayout -- Use custom layouts , layoutHook = myLayout -- Use custom layouts
} }
@@ -442,9 +442,9 @@ Onto the main dish. First, we have to import the necessary modules.
Add the following to your list of imports: Add the following to your list of imports:
``` haskell ``` haskell
import XMonad.Hooks.DynamicLog import XMonad.Hooks.DynamicLog
import XMonad.Hooks.StatusBar import XMonad.Hooks.StatusBar
import XMonad.Hooks.StatusBar.PP import XMonad.Hooks.StatusBar.PP
``` ```
_IF YOU ARE ON A VERSION `< 0.17`_: The `XMonad.Hooks.StatusBar` and _IF YOU ARE ON A VERSION `< 0.17`_: The `XMonad.Hooks.StatusBar` and
@@ -455,8 +455,8 @@ _IF YOU ARE ON A VERSION `< 0.17`_: The `XMonad.Hooks.StatusBar` and
Replace your `main` function above with: Replace your `main` function above with:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad $ ewmhFullscreen $ ewmh $ xmobarProp $ myConfig main = xmonad $ ewmhFullscreen $ ewmh $ xmobarProp $ myConfig
``` ```
_IF YOU ARE ON A VERSION `< 0.17`_: The `xmobarProp` function does not _IF YOU ARE ON A VERSION `< 0.17`_: The `xmobarProp` function does not
@@ -468,20 +468,20 @@ _IF YOU ARE ON A VERSION `< 0.17`_: The `xmobarProp` function does not
As a quick side-note, we could have also written As a quick side-note, we could have also written
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad . ewmhFullscreen . ewmh . xmobarProp $ myConfig main = xmonad . ewmhFullscreen . ewmh . xmobarProp $ myConfig
``` ```
Notice how `$` became `.`! The dot operator `(.)` in Haskell means Notice how `$` became `.`! The dot operator `(.)` in Haskell means
function composition and is read from right to left. What this means in function composition and is read from right to left. What this means in
this specific case is essentially the following: this specific case is essentially the following:
> take the four functions `xmonad`, `ewmhFullscreen`, `ewmh`, and > take the four functions `xmonad`, `ewmhFullscreen`, `ewmh`, and
> `xmobarProp` and give me the big new function > `xmobarProp` and give me the big new function
> `xmonad . ewmhFullscreen . ewmh . xmobarProp` that first executes > `xmonad . ewmhFullscreen . ewmh . xmobarProp` that first executes
> `xmobarProp`, then `ewmh`, then `ewmhFullscreen`, and finally > `xmobarProp`, then `ewmh`, then `ewmhFullscreen`, and finally
> `xmonad`. Then give it `myConfig` as its argument so it can do its > `xmonad`. Then give it `myConfig` as its argument so it can do its
> thing. > thing.
This should strike you as nothing more than a syntactical quirk, at This should strike you as nothing more than a syntactical quirk, at
least in this case. And indeed, since `($)` is just function least in this case. And indeed, since `($)` is just function
@@ -490,19 +490,19 @@ This may be more obvious if we write everything with parentheses and
apply the `(.)` operator (because we do have an argument): apply the `(.)` operator (because we do have an argument):
``` haskell ``` haskell
-- ($) version -- ($) version
main = xmonad $ ewmhFullscreen $ ewmh $ xmobarProp $ myConfig main = xmonad $ ewmhFullscreen $ ewmh $ xmobarProp $ myConfig
-- ($) version with parentheses -- ($) version with parentheses
main = xmonad (ewmhFullscreen (ewmh (xmobarProp (myConfig)))) main = xmonad (ewmhFullscreen (ewmh (xmobarProp (myConfig))))
-- (.) version with parentheses -- (.) version with parentheses
main = (xmonad . ewmhFullscreen . ewmh . xmobarProp) (myConfig) main = (xmonad . ewmhFullscreen . ewmh . xmobarProp) (myConfig)
-- xmobarProp applied -- xmobarProp applied
main = (xmonad . ewmhFullscreen . ewmh) (xmobarProp (myConfig)) main = (xmonad . ewmhFullscreen . ewmh) (xmobarProp (myConfig))
-- ewmh applied -- ewmh applied
main = (xmonad . ewmhFullscreen) (ewmh (xmobarProp (myConfig))) main = (xmonad . ewmhFullscreen) (ewmh (xmobarProp (myConfig)))
-- xmonad and ewmhFullscreen applied -- xmonad and ewmhFullscreen applied
main = (xmonad (ewmhFullscreen (ewmh (xmobarProp (myConfig)))) main = (xmonad (ewmhFullscreen (ewmh (xmobarProp (myConfig))))
``` ```
It's the same! This is special to the interplay with `(.)` and `($)` It's the same! This is special to the interplay with `(.)` and `($)`
@@ -510,13 +510,13 @@ though; if you're on an older version of xmonad and xmonad-contrib and
use `xmobar` instead of `xmobarProp`, then you _have_ to write use `xmobar` instead of `xmobarProp`, then you _have_ to write
``` haskell ``` haskell
main = xmonad . ewmhFullscreen . ewmh =<< xmobar myConfig main = xmonad . ewmhFullscreen . ewmh =<< xmobar myConfig
``` ```
and this is _not_ equivalent to and this is _not_ equivalent to
``` haskell ``` haskell
main = xmonad (ewmhFullscreen (ewmh =<< xmobar myConfig)) main = xmonad (ewmhFullscreen (ewmh =<< xmobar myConfig))
``` ```
Consult a Haskell book of your choice for why this is the case. Consult a Haskell book of your choice for why this is the case.
@@ -564,7 +564,7 @@ do want to configure xmobar in Haskell there is a note about that at the
end of this section. end of this section.
``` haskell ``` haskell
Config { overrideRedirect = False Config { overrideRedirect = False
, font = "xft:iosevka-9" , font = "xft:iosevka-9"
, bgColor = "#5f5f5f" , bgColor = "#5f5f5f"
, fgColor = "#f8f8f2" , fgColor = "#f8f8f2"
@@ -649,7 +649,7 @@ top-level documentation of the module!) should give us some ideas for
how to proceed: how to proceed:
``` haskell ``` haskell
xmobarProp config = xmobarProp config =
withEasySB (statusBarProp "xmobar" (pure xmobarPP)) toggleStrutsKey config withEasySB (statusBarProp "xmobar" (pure xmobarPP)) toggleStrutsKey config
``` ```
@@ -661,8 +661,8 @@ what we want to modify!
Let's copy the implementation over into our main function: Let's copy the implementation over into our main function:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad main = xmonad
. ewmhFullscreen . ewmhFullscreen
. ewmh . ewmh
. withEasySB (statusBarProp "xmobar" (pure def)) defToggleStrutsKey . withEasySB (statusBarProp "xmobar" (pure def)) defToggleStrutsKey
@@ -674,24 +674,24 @@ _IF YOU ARE ON A VERSION `< 0.17`_: `xmobar` has a similar definition,
toggleStrutsKey`. Sadly, the `defToggleStrutsKey` function is not yet toggleStrutsKey`. Sadly, the `defToggleStrutsKey` function is not yet
exported, so you will have to define it yourself: exported, so you will have to define it yourself:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad main = xmonad
. ewmhFullscreen . ewmhFullscreen
. ewmh . ewmh
=<< statusBar "xmobar" def toggleStrutsKey myConfig =<< statusBar "xmobar" def toggleStrutsKey myConfig
where where
toggleStrutsKey :: XConfig Layout -> (KeyMask, KeySym) toggleStrutsKey :: XConfig Layout -> (KeyMask, KeySym)
toggleStrutsKey XConfig{ modMask = m } = (m, xK_b) toggleStrutsKey XConfig{ modMask = m } = (m, xK_b)
``` ```
The `defToggleStrutsKey` here is just the key with which you can toggle The `defToggleStrutsKey` here is just the key with which you can toggle
the bar; it is bound to `M-b`. If you want to change this, you can also the bar; it is bound to `M-b`. If you want to change this, you can also
define your own: define your own:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad main = xmonad
. ewmhFullscreen . ewmhFullscreen
. ewmh . ewmh
. withEasySB (statusBarProp "xmobar" (pure def)) toggleStrutsKey . withEasySB (statusBarProp "xmobar" (pure def)) toggleStrutsKey
@@ -709,8 +709,8 @@ If you want your xmobar configuration file to reside somewhere else than
positional argument! For example: positional argument! For example:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad main = xmonad
. ewmhFullscreen . ewmhFullscreen
. ewmh . ewmh
. withEasySB (statusBarProp "xmobar ~/.config/xmobar/xmobarrc" (pure def)) defToggleStrutsKey . withEasySB (statusBarProp "xmobar ~/.config/xmobar/xmobarrc" (pure def)) defToggleStrutsKey
@@ -724,15 +724,15 @@ this. To prepare, we can first create a new function `myXmobarPP` with
the default configuration: the default configuration:
``` haskell ``` haskell
myXmobarPP :: PP myXmobarPP :: PP
myXmobarPP = def myXmobarPP = def
``` ```
and then plug that into our main function: and then plug that into our main function:
``` haskell ``` haskell
main :: IO () main :: IO ()
main = xmonad main = xmonad
. ewmhFullscreen . ewmhFullscreen
. ewmh . ewmh
. withEasySB (statusBarProp "xmobar" (pure myXmobarPP)) defToggleStrutsKey . withEasySB (statusBarProp "xmobar" (pure myXmobarPP)) defToggleStrutsKey
@@ -744,7 +744,7 @@ find something that we like. First, for some functionality that we need
further down we need to import one more module: further down we need to import one more module:
``` haskell ``` haskell
import XMonad.Util.Loggers import XMonad.Util.Loggers
``` ```
Now we are finally ready to make things pretty. There are _a lot_ of Now we are finally ready to make things pretty. There are _a lot_ of
@@ -752,8 +752,8 @@ options for the [PP record]; I'd advise you to read through all of them
now, so you don't get lost! now, so you don't get lost!
``` haskell ``` haskell
myXmobarPP :: PP myXmobarPP :: PP
myXmobarPP = def myXmobarPP = def
{ ppSep = magenta " • " { ppSep = magenta " • "
, ppTitleSanitize = xmobarStrip , ppTitleSanitize = xmobarStrip
, ppCurrent = wrap " " "" . xmobarBorder "Top" "#8be9fd" 2 , ppCurrent = wrap " " "" . xmobarBorder "Top" "#8be9fd" 2
@@ -800,10 +800,10 @@ just how we like it.
An important thing to talk about may be `ppOrder`. Quoting from its An important thing to talk about may be `ppOrder`. Quoting from its
documentation: documentation:
> By default, this function receives a list with three formatted > By default, this function receives a list with three formatted
> strings, representing the workspaces, the layout, and the current > strings, representing the workspaces, the layout, and the current
> window title, respectively. If you have specified any extra loggers > window title, respectively. If you have specified any extra loggers
> in ppExtras, their output will also be appended to the list. > in ppExtras, their output will also be appended to the list.
So the first three argument of the list (`ws`, `l`, and `_` in our case, So the first three argument of the list (`ws`, `l`, and `_` in our case,
where the `_` just means we want to ignore that argument and not give it where the `_` just means we want to ignore that argument and not give it
@@ -813,7 +813,7 @@ title of the focused window. The last element—`wins`—is what we gave to
more items to the list, like this: more items to the list, like this:
``` haskell ``` haskell
ppOrder = \[ws, l, _, wins, more, more2] -> [ws, l, wins, more, more2] ppOrder = \[ws, l, _, wins, more, more2] -> [ws, l, wins, more, more2]
``` ```
However, many people want to show _all_ window titles on the currently However, many people want to show _all_ window titles on the currently
@@ -835,8 +835,8 @@ having to define it inside e.g. a `where` clause. The above could have
also be written as also be written as
``` haskell ``` haskell
myXmobarPP :: PP myXmobarPP :: PP
myXmobarPP = def myXmobarPP = def
{ -- stuff here { -- stuff here
, ppOrder = myOrder , ppOrder = myOrder
-- more stuff here -- more stuff here
@@ -850,7 +850,7 @@ If you're unsure of the number of elements that your `ppOrder` will
take, you can also specify the list like this: take, you can also specify the list like this:
``` haskell ``` haskell
ppOrder = \(ws : l : _ : wins : _) -> [ws, l, wins] ppOrder = \(ws : l : _ : wins : _) -> [ws, l, wins]
``` ```
This says that it is a list of _at least_ four elements (`ws`, `l`, the This says that it is a list of _at least_ four elements (`ws`, `l`, the
@@ -861,8 +861,8 @@ This config is really quite complicated. If this is too much for you,
you can also really just start with the blank you can also really just start with the blank
``` haskell ``` haskell
myXmobarPP :: PP myXmobarPP :: PP
myXmobarPP = def myXmobarPP = def
``` ```
then add something, reload xmonad, see how things change and whether you then add something, reload xmonad, see how things change and whether you
@@ -879,14 +879,14 @@ to set our desktop background, and the like.
For this, we will need a few pieces of software. For this, we will need a few pieces of software.
``` shell ``` shell
apt-get install trayer xscreensaver apt-get install trayer xscreensaver
``` ```
If you want a network applet, something to set your desktop background, If you want a network applet, something to set your desktop background,
and a power-manager: and a power-manager:
``` shell ``` shell
apt-get install nm-applet feh xfce4-power-manager apt-get install nm-applet feh xfce4-power-manager
``` ```
First, configure xscreensaver how you like it with the First, configure xscreensaver how you like it with the
@@ -899,31 +899,31 @@ for how to do this.
Your `~/.xinitrc` may wind up looking like this: Your `~/.xinitrc` may wind up looking like this:
``` shell ``` shell
#!/bin/sh #!/bin/sh
# [... default stuff that your distro may throw in here ...] # # [... default stuff that your distro may throw in here ...] #
# Set up an icon tray # Set up an icon tray
trayer --edge top --align right --SetDockType true --SetPartialStrut true \ trayer --edge top --align right --SetDockType true --SetPartialStrut true \
--expand true --width 10 --transparent true --tint 0x5f5f5f --height 18 & --expand true --width 10 --transparent true --tint 0x5f5f5f --height 18 &
# Set the default X cursor to the usual pointer # Set the default X cursor to the usual pointer
xsetroot -cursor_name left_ptr xsetroot -cursor_name left_ptr
# Set a nice background # Set a nice background
feh --bg-fill --no-fehbg ~/.wallpapers/haskell-red-noise.png feh --bg-fill --no-fehbg ~/.wallpapers/haskell-red-noise.png
# Fire up screensaver # Fire up screensaver
xscreensaver -no-splash & xscreensaver -no-splash &
# Power Management # Power Management
xfce4-power-manager & xfce4-power-manager &
if [ -x /usr/bin/nm-applet ] ; then if [ -x /usr/bin/nm-applet ] ; then
nm-applet --sm-disable & nm-applet --sm-disable &
fi fi
exec xmonad exec xmonad
``` ```
Notice the call to `trayer` above. The options tell it to go on the top Notice the call to `trayer` above. The options tell it to go on the top
@@ -959,7 +959,7 @@ Then click on the application that you would like to know the properties
of. In our case you should see (among other things) of. In our case you should see (among other things)
``` shell ``` shell
WM_CLASS(STRING) = "gimp", "Gimp" WM_CLASS(STRING) = "gimp", "Gimp"
``` ```
The second string in `WM_CLASS` is the class name, which we can access The second string in `WM_CLASS` is the class name, which we can access
@@ -971,7 +971,7 @@ Let's use the class name for now. We can tell all windows with that
class name to float by defining the following manageHook: class name to float by defining the following manageHook:
``` haskell ``` haskell
myManageHook = (className =? "Gimp" --> doFloat) myManageHook = (className =? "Gimp" --> doFloat)
``` ```
Say we also want to float all dialogs. This is easy with the `isDialog` Say we also want to float all dialogs. This is easy with the `isDialog`
@@ -979,8 +979,8 @@ function from [XMonad.Hooks.ManageHelpers] (which you should import) and
a little modification to the `myManageHook` function: a little modification to the `myManageHook` function:
``` haskell ``` haskell
myManageHook :: ManageHook myManageHook :: ManageHook
myManageHook = composeAll myManageHook = composeAll
[ className =? "Gimp" --> doFloat [ className =? "Gimp" --> doFloat
, isDialog --> doFloat , isDialog --> doFloat
] ]
@@ -991,7 +991,7 @@ as easy as overriding the `manageHook` field in `myConfig`. You can do
it like this: it like this:
``` haskell ``` haskell
myConfig = def myConfig = def
{ modMask = mod4Mask -- Rebind Mod to the Super key { modMask = mod4Mask -- Rebind Mod to the Super key
, layoutHook = myLayout -- Use custom layouts , layoutHook = myLayout -- Use custom layouts
, manageHook = myManageHook -- Match on certain windows , manageHook = myManageHook -- Match on certain windows
@@ -1009,32 +1009,32 @@ The full `~/.config/xmonad/xmonad.hs`, in all its glory, now looks like
this: this:
``` haskell ``` haskell
import XMonad import XMonad
import XMonad.Hooks.DynamicLog import XMonad.Hooks.DynamicLog
import XMonad.Hooks.ManageDocks import XMonad.Hooks.ManageDocks
import XMonad.Hooks.ManageHelpers import XMonad.Hooks.ManageHelpers
import XMonad.Hooks.StatusBar import XMonad.Hooks.StatusBar
import XMonad.Hooks.StatusBar.PP import XMonad.Hooks.StatusBar.PP
import XMonad.Util.EZConfig import XMonad.Util.EZConfig
import XMonad.Util.Loggers import XMonad.Util.Loggers
import XMonad.Util.Ungrab import XMonad.Util.Ungrab
import XMonad.Layout.Magnifier import XMonad.Layout.Magnifier
import XMonad.Layout.ThreeColumns import XMonad.Layout.ThreeColumns
import XMonad.Hooks.EwmhDesktops import XMonad.Hooks.EwmhDesktops
main :: IO () main :: IO ()
main = xmonad main = xmonad
. ewmhFullscreen . ewmhFullscreen
. ewmh . ewmh
. withEasySB (statusBarProp "xmobar" (pure myXmobarPP)) defToggleStrutsKey . withEasySB (statusBarProp "xmobar" (pure myXmobarPP)) defToggleStrutsKey
$ myConfig $ myConfig
myConfig = def myConfig = def
{ modMask = mod4Mask -- Rebind Mod to the Super key { modMask = mod4Mask -- Rebind Mod to the Super key
, layoutHook = myLayout -- Use custom layouts , layoutHook = myLayout -- Use custom layouts
, manageHook = myManageHook -- Match on certain windows , manageHook = myManageHook -- Match on certain windows
@@ -1045,13 +1045,13 @@ this:
, ("M-]" , spawn "firefox" ) , ("M-]" , spawn "firefox" )
] ]
myManageHook :: ManageHook myManageHook :: ManageHook
myManageHook = composeAll myManageHook = composeAll
[ className =? "Gimp" --> doFloat [ className =? "Gimp" --> doFloat
, isDialog --> doFloat , isDialog --> doFloat
] ]
myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol
where where
threeCol = magnifiercz' 1.3 $ ThreeColMid nmaster delta ratio threeCol = magnifiercz' 1.3 $ ThreeColMid nmaster delta ratio
tiled = Tall nmaster delta ratio tiled = Tall nmaster delta ratio
@@ -1059,8 +1059,8 @@ this:
ratio = 1/2 -- Default proportion of screen occupied by master pane ratio = 1/2 -- Default proportion of screen occupied by master pane
delta = 3/100 -- Percent of screen to increment by when resizing panes delta = 3/100 -- Percent of screen to increment by when resizing panes
myXmobarPP :: PP myXmobarPP :: PP
myXmobarPP = def myXmobarPP = def
{ ppSep = magenta " • " { ppSep = magenta " • "
, ppTitleSanitize = xmobarStrip , ppTitleSanitize = xmobarStrip
, ppCurrent = wrap " " "" . xmobarBorder "Top" "#8be9fd" 2 , ppCurrent = wrap " " "" . xmobarBorder "Top" "#8be9fd" 2
@@ -1107,7 +1107,7 @@ your Icons with `<fn>` tags and the respective index of the font
configuration above with this new functionality: configuration above with this new functionality:
``` haskell ``` haskell
Config { overrideRedirect = False Config { overrideRedirect = False
, font = "xft:iosevka-9" , font = "xft:iosevka-9"
, additionalFonts = ["xft:FontAwesome-9"] , additionalFonts = ["xft:FontAwesome-9"]
... ...
@@ -1148,7 +1148,7 @@ we again follow the documentation (try it yourself!)—import the module
and then change `myLayout` like this: and then change `myLayout` like this:
``` haskell ``` haskell
myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol
where where
threeCol threeCol
= renamed [Replace "ThreeCol"] = renamed [Replace "ThreeCol"]
@@ -1167,7 +1167,7 @@ breaks here are just cosmetic, by the way; if you want you can write
everything in one line: everything in one line:
``` haskell ``` haskell
threeCol = renamed [Replace "ThreeCol"] $ magnifiercz' 1.3 $ ThreeColMid nmaster delta ratio threeCol = renamed [Replace "ThreeCol"] $ magnifiercz' 1.3 $ ThreeColMid nmaster delta ratio
``` ```
## Get in Touch ## Get in Touch
@@ -1193,9 +1193,9 @@ you will have to set this up manually. For example, you could put
something like something like
``` shell ``` shell
if [[ ! $DISPLAY ]]; then if [[ ! $DISPLAY ]]; then
exec startx >& ~/.xsession-errors exec startx >& ~/.xsession-errors
fi fi
``` ```
into your `~/.profile` file to explicitly log everything into into your `~/.profile` file to explicitly log everything into
@@ -1246,7 +1246,7 @@ either :)
[Hacks]: https://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Util-Hacks.html [Hacks]: https://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Util-Hacks.html
[PP record]: https://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Hooks-DynamicLog.html#t:PP [PP record]: https://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Hooks-DynamicLog.html#t:PP
[INSTALL.md]: https://github.com/xmonad/xmonad/blob/master/INSTALL.md#stack [INSTALL.md]: INSTALL.md
[XMonad.Config]: https://github.com/xmonad/xmonad/blob/master/src/XMonad/Config.hs [XMonad.Config]: https://github.com/xmonad/xmonad/blob/master/src/XMonad/Config.hs
[XMonad.ManageHook]: https://hackage.haskell.org/package/xmonad/docs/XMonad-ManageHook.html [XMonad.ManageHook]: https://hackage.haskell.org/package/xmonad/docs/XMonad-ManageHook.html
[XMonad.Util.Loggers]: https://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Util-Loggers.html [XMonad.Util.Loggers]: https://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Util-Loggers.html