1
0
mirror of https://github.com/nix-community/home-manager synced 2024-07-07 22:03:27 +02:00
home-manager/modules/services/window-managers/awesome.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

59 lines
1.6 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.xsession.windowManager.awesome;
awesome = cfg.package;
getLuaPath = lib: dir: "${lib}/${dir}/lua/${awesome.lua.luaversion}";
makeSearchPath = lib.concatMapStrings (path:
" --search ${getLuaPath path "share"}"
+ " --search ${getLuaPath path "lib"}");
in {
options = {
xsession.windowManager.awesome = {
enable = mkEnableOption (lib.mdDoc "Awesome window manager");
package = mkOption {
type = types.package;
default = pkgs.awesome;
defaultText = literalExpression "pkgs.awesome";
description = lib.mdDoc "Package to use for running the Awesome WM.";
};
luaModules = mkOption {
default = [ ];
type = types.listOf types.package;
description = lib.mdDoc ''
List of lua packages available for being
used in the Awesome configuration.
'';
example = literalExpression "[ pkgs.luaPackages.vicious ]";
};
noArgb = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
Disable client transparency support, which can be greatly
detrimental to performance in some setups
'';
};
};
};
config = mkIf cfg.enable {
assertions = [
(hm.assertions.assertPlatform "xsession.windowManager.awesome" pkgs
platforms.linux)
];
home.packages = [ awesome ];
xsession.windowManager.command = "${awesome}/bin/awesome "
+ optionalString cfg.noArgb "--no-argb " + makeSearchPath cfg.luaModules;
};
}