home-manager module options

Options found when wrapper-manager is included as part of home-manager module environment. Here’s a quickstart to enabling more features for wrapper-manager.

  • wrapper-manager packages (e.g., wrapper-manager.packages) includes a special module argument hmConfig allowing you to set values conditionally. For example, you could generate certain systemd units if under NixOS or home-manager but none if compiled as standalone package.

  • You can add custom modules as part of the documentation with wrapper-manager.documentation.extraModules. Pretty nifty feature but it requires you to make sure that all of the included modules are documented properly.

wrapper-manager​.enableInstall

Enable installing the package to the wider-scoped environment list of packages​. This is to be set as the default value of enableInstall in the wrapper-manager package environment​.

Type: boolean

Default: true

Example: false

Declared by:

wrapper-manager​.packages

A set of wrappers to be added into the environment configuration​.

Type: attribute set of (wrapper-manager configuration)

Default: { }

Example:

{
  custom-ricing = { lib, pkgs, ... }: {
    wrappers.neofetch = {
      arg0 = lib.getExe' pkgs.neofetch "neofetch";
      appendArgs = [
        "--ascii-distro" "guix"
        "--config" ./config/neofetch/config
      ];
    };

    wrappers.fastfetch = {
      arg0 = lib.getExe' pkgs.fastfetch "fastfetch";
      appendArgs = [
        "--config" ./config/fastfetch/config
        "--logo" "Guix"
      ];
      env.NO_COLOR.value = 1;
    };
  };

  music-setup = { lib, pkgs, ... }: {
    wrappers.yt-dlp-audio = {
      arg0 = lib.getExe' pkgs.yt-dlp "yt-dlp";
      prependArgs = [
        "--config-location" ./config/yt-dlp/audio.conf
      ];
    };

    wrappers.yt-dlp-video = {
      arg0 = lib.getExe' pkgs.yt-dlp "yt-dlp";
      prependArgs = [
        "--config-location" ./config/yt-dlp/video.conf
      ];
    };

    wrappers.beets-fds = {
      arg0 = lib.getExe' pkgs.beet "beet";
      prependArgs = [
        "--config" ./config/beets/config
      ];
    };
  };

  writing = { lib, pkgs, ... }: {
    wrappers.asciidoctor-fds = {
      arg = lib.getExe' pkgs.asciidoctor-with-extensions "asciidoctor";
      executableName = "asciidoctor";
      prependArgs =
        builtins.map (v: "-r ${v}") [
          "asciidoctor-diagram"
          "asciidoctor-bibtex"
        ];
    };
  };
}

Declared by:

wrapper-manager​.documentation​.extraModules

List of extra wrapper-manager modules to be included as part of the documentation​.

Type: list of module

Default: [ ]

Example:

[
  ./modules/wrapper-manager
]

Declared by:

wrapper-manager​.documentation​.html​.enable

Whether to enable HTML output​.

Type: boolean

Default: false

Example: true

Declared by:

wrapper-manager​.documentation​.manpage​.enable

Whether to enable manpage output​.

Type: boolean

Default: false

Example: true

Declared by:

wrapper-manager​.extraSpecialArgs

Additional set of module arguments to be passed to specialArgs of the wrapper module evaluation​.

Type: attribute set of anything

Default: { }

Example:

{
  yourMomName = "Joe Mama";
}

Declared by:

wrapper-manager​.sharedModules

Extra modules to be added to all of the wrapper-manager configurations​.

Type: list of module

Default: [ ]

Example:

[
  {
    config.build = {
      variant = "shell";
    };
  }
]

Declared by: