Official NixOS Wiki

XMonad: Difference between revisions

← Older edit
VisualWikitext
imported>Jooooscha
Add more information about xmonad contrib
Pigs (talk | contribs)
262 edits
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[https://xmonad.org/ xmonad] is a tiling [[window manager]] for X. Windows are arranged automatically to tile the screen without gaps or overlap, maximizing screen use. Window manager features are accessible from the keyboard: a mouse is optional.
[https://xmonad.org/ xmonad] is a tiling [https://wiki.archlinux.org/title/Window_manager window manager] for [[Xorg|X]]. Windows are arranged automatically to tile the screen without gaps or overlap, maximizing screen use. Window manager features are accessible from the keyboard: a mouse is optional.


xmonad is written, configured and extensible in [https://haskell.org/ Haskell]. Custom layout algorithms, key bindings and other extensions may be written by the user in configuration files.
xmonad is written, configured and extensible in [[Haskell]]. Custom layout algorithms, key bindings and other extensions may be written by the user in configuration files.


Layouts are applied dynamically, and different layouts may be used on each workspace. [[Wikipedia:Xinerama|Xinerama]] is fully supported, allowing windows to be tiled on several physical screens.
Layouts are applied dynamically, and different layouts may be used on each workspace. [[Wikipedia:Xinerama|Xinerama]] is fully supported, allowing windows to be tiled on several physical screens.
Line 9: Line 9:
The simplest way to install Xmonad is to activate the corresponding NixOS module.
The simplest way to install Xmonad is to activate the corresponding NixOS module.
You can do this by adding the following to your NixOS configuration.
You can do this by adding the following to your NixOS configuration.
You probably also want to activate the <core>enableContribAndExtras</code> option.
You probably also want to activate the <code>enableContribAndExtras</code> option.


{{file|/etc/nixos/configuration.nix|nix|
<nowiki>
   services.xserver.windowManager.xmonad = {
   services.xserver.windowManager.xmonad = {
     enable = true;
     enable = true;
     enableContribAndExtras = true;
     enableContribAndExtras = true;
   };
   };
</nowiki>
}}


The second options automatically adds the <code>xmonad-contrib</code> and <code>xmonad-extras</code> packages.
The second options automatically adds the <code>xmonad-contrib</code> and <code>xmonad-extras</code> packages.
They are required to use the [https://hackage.haskell.org/package/xmonad-contrib Xmonad Contrib] extensions.
They are required to use the [https://hackage.haskell.org/package/xmonad-contrib Xmonad Contrib] extensions.


== Configuration ==
=== Adding Haskell Modules ===


To configure Xmonad you give Nix your config file like this:
To add additional Haskell modules beyond xmonad-contrib and xmonad-extras, use the <code>extraPackages</code> option


services.xserver.windowManager.xmonad.config = builtins.readFile ../path/to/xmonad.hs;
{{file|/etc/nixos/configuration.nix|nix|
<nowiki>
  ...
  services.xserver.windowManager.xmonad = {
    ...
    extraPackages = haskellPackages: [
      haskellPackages.monad-logger
    ];
  };
</nowiki>
}}


More information on how to configure Xmonad can be found in the [https://wiki.archlinux.org/title/Xmonad Arch Wiki], and a list of starter configs can be found in the [https://wiki.haskell.org/Xmonad/Config_archive Xmonad Config Archive].
To add Haskell modules that are not in the Haskell Nix package set, you have to tell ghc where to find them.
For example, you can use the following to add the [https://github.com/Procrat/xmonad-contexts xmonad-contexts] module.


=== Configuring XMonad with IDE support ===
{{file|/etc/nixos/configuration.nix|nix|
<nowiki>
{ config, pkgs, ... }:
let
  xmonad-contexts = pkgs.fetchFromGitHub {
    owner = "Procrat";
    repo = "xmonad-contexts";
    rev = "SOME_COMMIT_HASH"; # replace with an actual commit for reproducibility
    sha256 = "sha256-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
  };
in {
  ...
  services.xserver.windowManager.xmonad = {
    ...
    ghcArgs = [
      "-hidir /tmp" # place interface files in /tmp, otherwise ghc tries to write them to the nix store
      "-odir /tmp" # place object files in /tmp, otherwise ghc tries to write them to the nix store
      "-i${xmonad-contexts}" # tell ghc to search in the respective nix store path for the module
    ];
  };
}
</nowiki>
}}


To edit XMonad configuration with IDE support, see https://www.srid.ca/xmonad-conf-ide
or if you are using Flakes


=== Another way to set up lsp support ===
{{file|/etc/nixos/configuration.nix|nix|
 
<nowiki>
Previous way to set up lsp support didn't work for me.
{ xmonad-contexts, ... }:
[https://discourse.nixos.org/t/haskell-language-server-support-for-xmonad/12348 This post] helped:
{
  ...
  services.xserver.windowManager.xmonad = {
    ...
    ghcArgs = [
      "-hidir /tmp" # place interface files in /tmp, otherwise ghc tries to write them to the nix store
      "-odir /tmp" # place object files in /tmp, otherwise ghc tries to write them to the nix store
      "-i${xmonad-contexts}" # tell ghc to search in the respective nix store path for the module
    ];
  };
}
</nowiki>
}}


==== if setting up xmonad with extra packages: ====
Don't forget to add the module to your flake inputs:


{{file|~/.config/home-config.nix|nix|<nowiki>
{{file|/etc/nixos/flake.nix|nix|
e.g:
<nowiki>
windowManager = {
inputs.xmonad-contexts = {
   xmonad = {
   url = "github:Procrat/xmonad-contexts";
    enable = true;
   flake = false;
    enableContribAndExtras = true;
    extraPackages = haskellPackages: [
      haskellPackages.dbus
      haskellPackages.List
      haskellPackages.monad-logger
      haskellPackages.xmonad
    ];
   };
};
};
</nowiki>}}
</nowiki>
}}


==== having ghc and other things for the lsp server in the system: ====
== Configuration ==
{{file|~/.config/home-config.nix|nix|<nowiki>
    home.packages = with pkgs; [
      haskellPackages.haskell-language-server
      haskellPackages.hoogle
      cabal-install
      stack
    ]
</nowiki>}}
(but I'm not sure whether all of those are required, maybe only one of cabal \ stack?)


==== creating project around `xmonad.hs` file ====
<code>$HOME/.xmonad</code> is the default path used for the configuration file. If your configuration is in a different location, give Nix your Xmonad config file like this:
{{file|~/.config/xmonad/hie-bios.sh|sh|<nowiki>
echo "xmonad" >> $HIE_BIOS_OUTPUT
</nowiki>}}


{{file|~/.config/xmonad/hie.yaml|yaml|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|
cradle:
<nowiki>
   bios:
services.xserver.windowManager.xmonad = {
    program: "./hie-bios.sh"
   ...
    with-ghc: "/nix/store/waa0dlvlszwbplrz5c7j674ab6v1n5wi-ghc-8.8.4-with-packages/bin/ghc"
  config = builtins.readFile ../path/to/xmonad.hs;
</nowiki>}}
};
</nowiki>
}}


The "with-ghc" should be ghc that's in the "ghc-with-packages" dependency of the "xmonad-with-packages"
See [https://search.nixos.org/options?query=services.xserver.windowManager.xmonad services.xserver.windowManager.xmonad] for a full list of available options and their descriptions.
It can be easily found with "nix-tree" utili, get with "nix-shell -p nix-tree"
this shows dependencies between packages on the machine, "/" is for searching for "with-packages"
see the store path in the bottom of the screen


==== to check what are the problems ====
More information on how to configure Xmonad can be found in the [https://wiki.archlinux.org/title/Xmonad Arch Wiki], and a list of starter configs can be found in the [https://wiki.haskell.org/Xmonad/Config_archive Xmonad Config Archive].
I try to manually run "haskell-language-server" in the directory with `xmonad.hs`, `hie.yaml` and `hie-bios.sh`
when there are no errors, my editor also successfully starts lsp


== Power management ==
== Power management ==


Xmonad is a Window Manager (WM) and not a Desktop Environment (DE). Therefore, among other things,
Xmonad is a Window Manager (WM) and not a Desktop Environment (DE). Therefore, among other things,
Xmonad does not handle power management related things such as sleeping.
Xmonad does not handle [[Power Management|power management]] related things such as sleeping.
However, there are several ways of still adding this functionality.
However, there are several ways of still adding this functionality.


Line 96: Line 123:
The approach goes through the following steps:
The approach goes through the following steps:


* Let the XServer detect idle-situation
* Let the [[Xorg|XServer]] detect idle-situation
* Inform "logind" (i.e. "systemd") about the situation
* Inform "[[Systemd/logind|logind]]" (i.e. "systemd") about the situation
* Let "logind" make the system sleep
* Let "logind" make the system sleep


Line 148: Line 175:
$ sleep 1s && xset s activate
$ sleep 1s && xset s activate
</syntaxhighlight>
</syntaxhighlight>
== Developer Environment for XMonad ==
When developing modules for XMonad, it can help to install the following packages
<syntaxHighlight lang="nix">
windowManager = {
  xmonad = {
    enable = true;
    enableContribAndExtras = true;
    extraPackages = haskellPackages: [
      haskellPackages.dbus
      haskellPackages.List
      haskellPackages.monad-logger
    ];
  };
};
</syntaxHighlight>
More information can be found [https://discourse.nixos.org/t/haskell-language-server-support-for-xmonad/12348 here] and [https://www.srid.ca/xmonad-conf-ide here].
==== Create a project around <code>xmonad.hs</code> ====
<syntaxHighlight lang="bash">
echo "xmonad" >> $HIE_BIOS_OUTPUT
</syntaxHighlight>
{{file|~/.config/xmonad/hie.yaml|yaml|<nowiki>
cradle:
  bios:
    program: "./hie-bios.sh"
    with-ghc: "/nix/store/waa0dlvlszwbplrz5c7j674ab6v1n5wi-ghc-8.8.4-with-packages/bin/ghc"
</nowiki>}}
The "with-ghc" should be ghc that's in the "ghc-with-packages" dependency of the "xmonad-with-packages".
It can be easily found with "[https://github.com/utdemir/nix-tree nix-tree]", which shows dependencies between packages on the machine.


[[Category:Window managers]]
[[Category:Window managers]]
[[Category:Applications]]
[[Category:Applications]]
Retrieved from "https://wiki.nixos.org/wiki/XMonad"