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.
162 lines
4.5 KiB
Nix
162 lines
4.5 KiB
Nix
{ config, lib, pkgs, ... }:
|
||
|
||
with lib;
|
||
|
||
let
|
||
cfg = config.services.getty;
|
||
|
||
baseArgs = [
|
||
"--login-program" "${cfg.loginProgram}"
|
||
] ++ optionals (cfg.autologinUser != null) [
|
||
"--autologin" cfg.autologinUser
|
||
] ++ optionals (cfg.loginOptions != null) [
|
||
"--login-options" cfg.loginOptions
|
||
] ++ cfg.extraArgs;
|
||
|
||
gettyCmd = args:
|
||
"@${pkgs.util-linux}/sbin/agetty agetty ${escapeShellArgs baseArgs} ${args}";
|
||
|
||
in
|
||
|
||
{
|
||
|
||
###### interface
|
||
|
||
imports = [
|
||
(mkRenamedOptionModule [ "services" "mingetty" ] [ "services" "getty" ])
|
||
(mkRemovedOptionModule [ "services" "getty" "serialSpeed" ] ''set non-standard baudrates with `boot.kernelParams` i.e. boot.kernelParams = ["console=ttyS2,1500000"];'')
|
||
];
|
||
|
||
options = {
|
||
|
||
services.getty = {
|
||
|
||
autologinUser = mkOption {
|
||
type = types.nullOr types.str;
|
||
default = null;
|
||
description = lib.mdDoc ''
|
||
Username of the account that will be automatically logged in at the console.
|
||
If unspecified, a login prompt is shown as usual.
|
||
'';
|
||
};
|
||
|
||
loginProgram = mkOption {
|
||
type = types.path;
|
||
default = "${pkgs.shadow}/bin/login";
|
||
defaultText = literalExpression ''"''${pkgs.shadow}/bin/login"'';
|
||
description = lib.mdDoc ''
|
||
Path to the login binary executed by agetty.
|
||
'';
|
||
};
|
||
|
||
loginOptions = mkOption {
|
||
type = types.nullOr types.str;
|
||
default = null;
|
||
description = ''
|
||
Template for arguments to be passed to
|
||
<citerefentry><refentrytitle>login</refentrytitle>
|
||
<manvolnum>1</manvolnum></citerefentry>.
|
||
|
||
See <citerefentry><refentrytitle>agetty</refentrytitle>
|
||
<manvolnum>1</manvolnum></citerefentry> for details,
|
||
including security considerations. If unspecified, agetty
|
||
will not be invoked with a <option>--login-options</option>
|
||
option.
|
||
'';
|
||
example = "-h darkstar -- \\u";
|
||
};
|
||
|
||
extraArgs = mkOption {
|
||
type = types.listOf types.str;
|
||
default = [ ];
|
||
description = lib.mdDoc ''
|
||
Additional arguments passed to agetty.
|
||
'';
|
||
example = [ "--nohostname" ];
|
||
};
|
||
|
||
greetingLine = mkOption {
|
||
type = types.str;
|
||
description = lib.mdDoc ''
|
||
Welcome line printed by agetty.
|
||
The default shows current NixOS version label, machine type and tty.
|
||
'';
|
||
};
|
||
|
||
helpLine = mkOption {
|
||
type = types.lines;
|
||
default = "";
|
||
description = lib.mdDoc ''
|
||
Help line printed by agetty below the welcome line.
|
||
Used by the installation CD to give some hints on
|
||
how to proceed.
|
||
'';
|
||
};
|
||
|
||
};
|
||
|
||
};
|
||
|
||
|
||
###### implementation
|
||
|
||
config = {
|
||
# Note: this is set here rather than up there so that changing
|
||
# nixos.label would not rebuild manual pages
|
||
services.getty.greetingLine = mkDefault ''<<< Welcome to NixOS ${config.system.nixos.label} (\m) - \l >>>'';
|
||
|
||
systemd.services."getty@" =
|
||
{ serviceConfig.ExecStart = [
|
||
"" # override upstream default with an empty ExecStart
|
||
(gettyCmd "--noclear --keep-baud %I 115200,38400,9600 $TERM")
|
||
];
|
||
restartIfChanged = false;
|
||
};
|
||
|
||
systemd.services."serial-getty@" =
|
||
{ serviceConfig.ExecStart = [
|
||
"" # override upstream default with an empty ExecStart
|
||
(gettyCmd "%I --keep-baud $TERM")
|
||
];
|
||
restartIfChanged = false;
|
||
};
|
||
|
||
systemd.services."autovt@" =
|
||
{ serviceConfig.ExecStart = [
|
||
"" # override upstream default with an empty ExecStart
|
||
(gettyCmd "--noclear %I $TERM")
|
||
];
|
||
restartIfChanged = false;
|
||
};
|
||
|
||
systemd.services."container-getty@" =
|
||
{ serviceConfig.ExecStart = [
|
||
"" # override upstream default with an empty ExecStart
|
||
(gettyCmd "--noclear --keep-baud pts/%I 115200,38400,9600 $TERM")
|
||
];
|
||
restartIfChanged = false;
|
||
};
|
||
|
||
systemd.services.console-getty =
|
||
{ serviceConfig.ExecStart = [
|
||
"" # override upstream default with an empty ExecStart
|
||
(gettyCmd "--noclear --keep-baud console 115200,38400,9600 $TERM")
|
||
];
|
||
serviceConfig.Restart = "always";
|
||
restartIfChanged = false;
|
||
enable = mkDefault config.boot.isContainer;
|
||
};
|
||
|
||
environment.etc.issue =
|
||
{ # Friendly greeting on the virtual consoles.
|
||
source = pkgs.writeText "issue" ''
|
||
|
||
[1;32m${config.services.getty.greetingLine}[0m
|
||
${config.services.getty.helpLine}
|
||
|
||
'';
|
||
};
|
||
|
||
};
|
||
|
||
}
|