home-manager/modules/programs/imv.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

46 lines
1.1 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.imv;
toConfig = attrs:
''
# Generated by Home Manager.
'' + generators.toINI { } attrs;
in {
meta.maintainers = [ maintainers.christoph-heiss ];
options.programs.imv = {
enable = mkEnableOption (lib.mdDoc
"imv: a command line image viewer intended for use with tiling window managers");
package = mkPackageOptionMD pkgs "imv" { };
settings = mkOption {
default = { };
type = with types; attrsOf (attrsOf (oneOf [ bool int str ]));
description = lib.mdDoc ''
Configuration options for imv. See
{manpage}`imv(5)`.
'';
example = literalExpression ''
{
options.background = "ffffff";
aliases.x = "close";
}
'';
};
};
config = mkIf cfg.enable {
assertions =
[ (hm.assertions.assertPlatform "programs.imv" pkgs platforms.linux) ];
home.packages = [ cfg.package ];
xdg.configFile =
mkIf (cfg.settings != { }) { "imv/config".text = toConfig cfg.settings; };
};
}