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

80 lines
2 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.foot;
iniFormat = pkgs.formats.ini { };
in {
meta.maintainers = with lib.maintainers; [ plabadens ];
options.programs.foot = {
enable = mkEnableOption (lib.mdDoc "Foot terminal");
package = mkOption {
type = types.package;
default = pkgs.foot;
defaultText = literalExpression "pkgs.foot";
description = lib.mdDoc "The foot package to install";
};
server.enable = mkEnableOption (lib.mdDoc "Foot terminal server");
settings = mkOption {
type = iniFormat.type;
default = { };
description = lib.mdDoc ''
Configuration written to
{file}`$XDG_CONFIG_HOME/foot/foot.ini`. See <https://codeberg.org/dnkl/foot/src/branch/master/foot.ini>
for a list of available options.
'';
example = literalExpression ''
{
main = {
term = "xterm-256color";
font = "Fira Code:size=11";
dpi-aware = "yes";
};
mouse = {
hide-when-typing = "yes";
};
}
'';
};
};
config = mkIf cfg.enable {
assertions =
[ (hm.assertions.assertPlatform "programs.foot" pkgs platforms.linux) ];
home.packages = [ cfg.package ];
xdg.configFile."foot/foot.ini" = mkIf (cfg.settings != { }) {
source = iniFormat.generate "foot.ini" cfg.settings;
};
systemd.user.services = mkIf cfg.server.enable {
foot = {
Unit = {
Description =
"Fast, lightweight and minimalistic Wayland terminal emulator.";
Documentation = "man:foot(1)";
PartOf = [ "graphical-session.target" ];
After = [ "graphical-session.target" ];
};
Service = {
ExecStart = "${cfg.package}/bin/foot --server";
Restart = "on-failure";
OOMPolicy = "continue";
};
Install = { WantedBy = [ "graphical-session.target" ]; };
};
};
};
}