1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-12-22 01:39:47 +01:00
home-manager/modules/services/random-background.nix
Emily 9f9e277b60 treewide: remove now-redundant lib.mdDoc calls
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.

Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.

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 \
      --strip {} +
    $ ./format
2023-07-17 18:49:09 +01:00

102 lines
2.9 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.random-background;
flags = lib.concatStringsSep " "
([ "--bg-${cfg.display}" "--no-fehbg" "--randomize" ]
++ lib.optional (!cfg.enableXinerama) "--no-xinerama");
in {
meta.maintainers = [ maintainers.rycee ];
options = {
services.random-background = {
enable = mkEnableOption "" // {
description = ''
Whether to enable random desktop background.
Note, if you are using NixOS and have set up a custom
desktop manager session for Home Manager, then the session
configuration must have the `bgSupport`
option set to `true` or the background
image set by this module may be overwritten.
'';
};
imageDirectory = mkOption {
type = types.str;
example = "%h/backgrounds";
description = ''
The directory of images from which a background should be
chosen. Should be formatted in a way understood by systemd,
e.g., '%h' is the home directory.
'';
};
display = mkOption {
type = types.enum [ "center" "fill" "max" "scale" "tile" ];
default = "fill";
description = "Display background images according to this option.";
};
interval = mkOption {
default = null;
type = types.nullOr types.str;
example = "1h";
description = ''
The duration between changing background image, set to null
to only set background when logging in. Should be formatted
as a duration understood by systemd.
'';
};
enableXinerama = mkOption {
default = true;
type = types.bool;
description = ''
Will place a separate image per screen when enabled,
otherwise a single image will be stretched across all
screens.
'';
};
};
};
config = mkIf cfg.enable (mkMerge ([
{
assertions = [
(hm.assertions.assertPlatform "services.random-background" pkgs
platforms.linux)
];
systemd.user.services.random-background = {
Unit = {
Description = "Set random desktop background using feh";
After = [ "graphical-session-pre.target" ];
PartOf = [ "graphical-session.target" ];
};
Service = {
Type = "oneshot";
ExecStart = "${pkgs.feh}/bin/feh ${flags} ${cfg.imageDirectory}";
IOSchedulingClass = "idle";
};
Install = { WantedBy = [ "graphical-session.target" ]; };
};
}
(mkIf (cfg.interval != null) {
systemd.user.timers.random-background = {
Unit = { Description = "Set random desktop background using feh"; };
Timer = { OnUnitActiveSec = cfg.interval; };
Install = { WantedBy = [ "timers.target" ]; };
};
})
]));
}