home-manager/modules/services/betterlockscreen.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

58 lines
1.4 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let cfg = config.services.betterlockscreen;
in {
meta.maintainers = with maintainers; [ sebtm ];
options = {
services.betterlockscreen = {
enable =
mkEnableOption (lib.mdDoc "betterlockscreen, a screen-locker module");
package = mkOption {
type = types.package;
default = pkgs.betterlockscreen;
defaultText = literalExpression "pkgs.betterlockscreen";
description =
lib.mdDoc "Package providing {command}`betterlockscreen`.";
};
arguments = mkOption {
type = types.listOf types.str;
default = [ ];
description = lib.mdDoc
"List of arguments appended to `./betterlockscreen --lock [args]`";
};
inactiveInterval = mkOption {
type = types.int;
default = 10;
description = lib.mdDoc ''
Value used for {option}`services.screen-locker.inactiveInterval`.
'';
};
};
};
config = mkIf cfg.enable {
assertions = [
(lib.hm.assertions.assertPlatform "services.betterlockscreen" pkgs
lib.platforms.linux)
];
home.packages = [ cfg.package ];
services.screen-locker = {
enable = true;
inactiveInterval = cfg.inactiveInterval;
lockCmd = "${cfg.package}/bin/betterlockscreen --lock ${
concatStringsSep " " cfg.arguments
}";
};
};
}