forked from mirrors/nixpkgs
2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
101 lines
2.5 KiB
Nix
101 lines
2.5 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.lirc;
|
|
in {
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
services.lirc = {
|
|
|
|
enable = mkEnableOption "LIRC daemon";
|
|
|
|
options = mkOption {
|
|
type = types.lines;
|
|
example = ''
|
|
[lircd]
|
|
nodaemon = False
|
|
'';
|
|
description = lib.mdDoc "LIRC default options descriped in man:lircd(8) ({file}`lirc_options.conf`)";
|
|
};
|
|
|
|
configs = mkOption {
|
|
type = types.listOf types.lines;
|
|
description = lib.mdDoc "Configurations for lircd to load, see man:lircd.conf(5) for details ({file}`lircd.conf`)";
|
|
};
|
|
|
|
extraArguments = mkOption {
|
|
type = types.listOf types.str;
|
|
default = [];
|
|
description = lib.mdDoc "Extra arguments to lircd.";
|
|
};
|
|
};
|
|
};
|
|
|
|
###### implementation
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
# Note: LIRC executables raises a warning, if lirc_options.conf do not exists
|
|
environment.etc."lirc/lirc_options.conf".text = cfg.options;
|
|
|
|
passthru.lirc.socket = "/run/lirc/lircd";
|
|
|
|
environment.systemPackages = [ pkgs.lirc ];
|
|
|
|
systemd.sockets.lircd = {
|
|
description = "LIRC daemon socket";
|
|
wantedBy = [ "sockets.target" ];
|
|
socketConfig = {
|
|
ListenStream = config.passthru.lirc.socket;
|
|
SocketUser = "lirc";
|
|
SocketMode = "0660";
|
|
};
|
|
};
|
|
|
|
systemd.services.lircd = let
|
|
configFile = pkgs.writeText "lircd.conf" (builtins.concatStringsSep "\n" cfg.configs);
|
|
in {
|
|
description = "LIRC daemon service";
|
|
after = [ "network.target" ];
|
|
|
|
unitConfig.Documentation = [ "man:lircd(8)" ];
|
|
|
|
serviceConfig = {
|
|
RuntimeDirectory = ["lirc" "lirc/lock"];
|
|
|
|
# Service runtime directory and socket share same folder.
|
|
# Following hacks are necessary to get everything right:
|
|
|
|
# 1. prevent socket deletion during stop and restart
|
|
RuntimeDirectoryPreserve = true;
|
|
|
|
# 2. fix runtime folder owner-ship, happens when socket activation
|
|
# creates the folder
|
|
PermissionsStartOnly = true;
|
|
ExecStartPre = [
|
|
"${pkgs.coreutils}/bin/chown lirc /run/lirc/"
|
|
];
|
|
|
|
ExecStart = ''
|
|
${pkgs.lirc}/bin/lircd --nodaemon \
|
|
${escapeShellArgs cfg.extraArguments} \
|
|
${configFile}
|
|
'';
|
|
User = "lirc";
|
|
};
|
|
};
|
|
|
|
users.users.lirc = {
|
|
uid = config.ids.uids.lirc;
|
|
group = "lirc";
|
|
description = "LIRC user for lircd";
|
|
};
|
|
|
|
users.groups.lirc.gid = config.ids.gids.lirc;
|
|
};
|
|
}
|