nixpkgs/nixos/modules/services/x11/unclutter.nix
h7x4 0a37316d6c
treewide: use mkPackageOption
This commit replaces a lot of usages of `mkOption` with the package
type, to be `mkPackageOption`, in order to reduce the amount of code.
2023-11-27 01:28:36 +01:00

78 lines
2.1 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let cfg = config.services.unclutter;
in {
options.services.unclutter = {
enable = mkOption {
description = lib.mdDoc "Enable unclutter to hide your mouse cursor when inactive";
type = types.bool;
default = false;
};
package = mkPackageOption pkgs "unclutter" { };
keystroke = mkOption {
description = lib.mdDoc "Wait for a keystroke before hiding the cursor";
type = types.bool;
default = false;
};
timeout = mkOption {
description = lib.mdDoc "Number of seconds before the cursor is marked inactive";
type = types.int;
default = 1;
};
threshold = mkOption {
description = lib.mdDoc "Minimum number of pixels considered cursor movement";
type = types.int;
default = 1;
};
excluded = mkOption {
description = lib.mdDoc "Names of windows where unclutter should not apply";
type = types.listOf types.str;
default = [];
example = [ "" ];
};
extraOptions = mkOption {
description = lib.mdDoc "More arguments to pass to the unclutter command";
type = types.listOf types.str;
default = [];
example = [ "noevent" "grab" ];
};
};
config = mkIf cfg.enable {
systemd.user.services.unclutter = {
description = "unclutter";
wantedBy = [ "graphical-session.target" ];
partOf = [ "graphical-session.target" ];
serviceConfig.ExecStart = ''
${cfg.package}/bin/unclutter \
-idle ${toString cfg.timeout} \
-jitter ${toString (cfg.threshold - 1)} \
${optionalString cfg.keystroke "-keystroke"} \
${concatMapStrings (x: " -"+x) cfg.extraOptions} \
-not ${concatStringsSep " " cfg.excluded} \
'';
serviceConfig.PassEnvironment = "DISPLAY";
serviceConfig.RestartSec = 3;
serviceConfig.Restart = "always";
};
};
imports = [
(mkRenamedOptionModule [ "services" "unclutter" "threeshold" ]
[ "services" "unclutter" "threshold" ])
];
meta.maintainers = with lib.maintainers; [ rnhmjoj ];
}