mirror of
https://github.com/nix-community/home-manager
synced 2024-11-18 09:09:45 +01:00
9f9e277b60
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.
Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.
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 \
--strip {} +
$ ./format
72 lines
2 KiB
Nix
72 lines
2 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.programs.senpai;
|
|
cfgFmt = pkgs.formats.yaml { };
|
|
in {
|
|
options.programs.senpai = {
|
|
enable = mkEnableOption "senpai";
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.senpai;
|
|
defaultText = literalExpression "pkgs.senpai";
|
|
description = "The `senpai` package to use.";
|
|
};
|
|
config = mkOption {
|
|
type = types.submodule {
|
|
freeformType = cfgFmt.type;
|
|
options = {
|
|
addr = mkOption {
|
|
type = types.str;
|
|
description = ''
|
|
The address (host[:port]) of the IRC server. senpai uses TLS
|
|
connections by default unless you specify no-tls option. TLS
|
|
connections default to port 6697, plain-text use port 6667.
|
|
'';
|
|
};
|
|
nick = mkOption {
|
|
type = types.str;
|
|
description = ''
|
|
Your nickname, sent with a NICK IRC message. It mustn't contain
|
|
spaces or colons (:).
|
|
'';
|
|
};
|
|
password = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
description = ''
|
|
Your password, used for SASL authentication. Note that it will
|
|
reside world-readable in the Nix store.
|
|
'';
|
|
};
|
|
no-tls = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = "Disables TLS encryption.";
|
|
};
|
|
};
|
|
};
|
|
example = literalExpression ''
|
|
{
|
|
addr = "libera.chat:6697";
|
|
nick = "nicholas";
|
|
password = "verysecurepassword";
|
|
}
|
|
'';
|
|
description = ''
|
|
Configuration for senpai. For a complete list of options, see
|
|
{manpage}`senpai(5)`.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
home.packages = [ cfg.package ];
|
|
xdg.configFile."senpai/senpai.yaml".source =
|
|
cfgFmt.generate "senpai.yaml" cfg.config;
|
|
};
|
|
|
|
meta.maintainers = [ hm.maintainers.malvo ];
|
|
}
|