home-manager/modules/programs/xmobar.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.8 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let cfg = config.programs.xmobar;
in {
options.programs.xmobar = {
enable = mkEnableOption (lib.mdDoc "Xmobar, a minimalistic status bar");
package = mkOption {
default = pkgs.haskellPackages.xmobar;
defaultText = literalExpression "pkgs.haskellPackages.xmobar";
type = types.package;
description = lib.mdDoc ''
Package providing the {command}`xmobar` binary.
'';
};
extraConfig = mkOption {
default = "";
example = literalExpression ''
Config
{ font = "Fira Code"
, borderColor = "#d0d0d0"
, border = FullB
, borderWidth = 3
, bgColor = "#222"
, fgColor = "grey"
, position = TopSize C 99 30
, commands =
[ Run Cpu ["-t", "cpu: <fc=#4eb4fa><bar> <total>%</fc>"] 10
, Run Network "enp3s0" ["-S", "True", "-t", "eth: <fc=#4eb4fa><rx></fc>/<fc=#4eb4fa><tx></fc>"] 10
, Run Memory ["-t","mem: <fc=#4eb4fa><usedbar> <usedratio>%</fc>"] 10
, Run Date "date: <fc=#4eb4fa>%a %d %b %Y %H:%M:%S </fc>" "date" 10
, Run StdinReader
]
, sepChar = "%"
, alignSep = "}{"
, template = " %StdinReader% | %cpu% | %memory% | %enp3s0% }{%date% "
}
'';
type = types.lines;
description = lib.mdDoc ''
Extra configuration lines to add to
{file}`$XDG_CONFIG_HOME/xmobar/.xmobarrc`.
See
<https://xmobar.org/#configuration>
for options.
'';
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
xdg.configFile."xmobar/.xmobarrc".text = cfg.extraConfig;
};
meta.maintainers = [ hm.maintainers.t4ccer ];
}