home-manager/modules/services/swayosd.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.4 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.swayosd;
in {
meta.maintainers = [ hm.maintainers.pltanton ];
options.services.swayosd = {
enable = mkEnableOption (lib.mdDoc ''
swayosd, a GTK based on screen display for keyboard shortcuts like
caps-lock and volume'');
package = mkPackageOption pkgs "swayosd" { };
maxVolume = mkOption {
type = types.nullOr types.ints.unsigned;
default = null;
example = 120;
description = lib.mdDoc ''
Sets the maximum volume.
'';
};
};
config = mkIf cfg.enable {
assertions = [
(hm.assertions.assertPlatform "services.swayosd" pkgs platforms.linux)
];
home.packages = [ cfg.package ];
systemd.user = {
services.swayosd = {
Unit = {
Description = "Volume/backlight OSD indicator";
PartOf = [ "graphical-session.target" ];
After = [ "graphical-session.target" ];
ConditionEnvironment = "WAYLAND_DISPLAY";
Documentation = "man:swayosd(1)";
};
Service = {
Type = "simple";
ExecStart = "${cfg.package}/bin/swayosd"
+ (optionalString (cfg.maxVolume != null)
" --max-volume ${toString cfg.maxVolume}");
Restart = "always";
};
Install = { WantedBy = [ "graphical-session.target" ]; };
};
};
};
}