public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/xmonad: improve module docs

Browse Source
This commit is contained in:
Dominik Xaver Hörl 2020-10-12 12:18:26 +02:00
parent 0a42b8cac6
commit 206c668d7f
1 changed files with 39 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
nixos/modules/services/x11/window-managers/xmonad.nix
View File

@ -65,19 +65,50 @@ in
default = null; default = null;
type = with lib.types; nullOr (either path str); type = with lib.types; nullOr (either path str);
description = '' description = ''
Configuration from which XMonad gets compiled. If no value Configuration from which XMonad gets compiled. If no value is
is specified, the xmonad config from $HOME/.xmonad is taken. specified, a vanilla xmonad binary is put in PATH, which will
If you use xmonad --recompile, $HOME/.xmonad will be taken as attempt to recompile and exec your xmonad config from $HOME/.xmonad.
the configuration, but on the next restart of display-manager This setup is then analogous to other (non-NixOS) linux distributions.
this config will be reapplied.
If you do set this option, you likely want to use "launch" as your
entry point for xmonad (as in the example), to avoid xmonads
recompilation logic on startup. Doing so will render the default
"mod+q" restart key binding dysfunctional though, because that attempts
to call your binary with the "--restart" command line option, unless
you implement that yourself. You way mant to bind "mod+q" to
<literal>(restart "xmonad" True)</literal> instead, which will just restart
xmonad from PATH. This allows e.g. switching to the new xmonad binary,
after rebuilding your system with nixos-rebuild.
If you actually want to run xmonad with a config specified here, but
also be able to recompile and restart it from a copy of that source in
$HOME/.xmonad on the fly, you will have to implement that yourself
using something like "compileRestart" from the example.
This should allow you to switch at will between the local xmonad and
the one NixOS puts in your PATH.
''; '';
example = '' example = ''
import XMonad import XMonad
import XMonad.Util.EZConfig (additionalKeys)
import Text.Printf (printf)
import System.Posix.Process (executeFile)
import System.Info (arch,os)
import System.Environment (getArgs)
import System.FilePath ((</>))
compiledConfig = printf "xmonad-%s-%s" arch os
compileRestart = whenX (recompile True) . catchIO $ do
dir <- getXMonadDataDir
args <- getArgs
executeFile (dir </> compiledConfig) False args Nothing
main = launch defaultConfig main = launch defaultConfig
{ modMask = mod4Mask -- Use Super instead of Alt { modMask = mod4Mask -- Use Super instead of Alt
, terminal = "urxvt" , terminal = "urxvt" }
} `additionalKeys`
[ ( (mod4Mask,xK_r), compileRestart )
, ( (mod4Mask,xK_q), restart "xmonad" True ) ]
''; '';
}; };