diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/ttys/getty.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/ttys/getty.nix | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/nixpkgs/nixos/modules/services/ttys/getty.nix b/nixpkgs/nixos/modules/services/ttys/getty.nix index 7021a2c80f85..aec65903cecb 100644 --- a/nixpkgs/nixos/modules/services/ttys/getty.nix +++ b/nixpkgs/nixos/modules/services/ttys/getty.nix @@ -34,7 +34,7 @@ in autologinUser = mkOption { type = types.nullOr types.str; default = null; - description = '' + 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. ''; @@ -44,7 +44,7 @@ in type = types.path; default = "${pkgs.shadow}/bin/login"; defaultText = literalExpression ''"''${pkgs.shadow}/bin/login"''; - description = '' + description = lib.mdDoc '' Path to the login binary executed by agetty. ''; }; @@ -52,15 +52,13 @@ in loginOptions = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Template for arguments to be passed to - <citerefentry><refentrytitle>login</refentrytitle> - <manvolnum>1</manvolnum></citerefentry>. + {manpage}`login(1)`. - See <citerefentry><refentrytitle>agetty</refentrytitle> - <manvolnum>1</manvolnum></citerefentry> for details, + See {manpage}`agetty(1)` for details, including security considerations. If unspecified, agetty - will not be invoked with a <option>--login-options</option> + will not be invoked with a {option}`--login-options` option. ''; example = "-h darkstar -- \\u"; @@ -69,7 +67,7 @@ in extraArgs = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' Additional arguments passed to agetty. ''; example = [ "--nohostname" ]; @@ -77,7 +75,7 @@ in greetingLine = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Welcome line printed by agetty. The default shows current NixOS version label, machine type and tty. ''; @@ -86,7 +84,7 @@ in helpLine = mkOption { type = types.lines; default = ""; - description = '' + 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. @@ -104,6 +102,7 @@ in # 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 >>>''; + services.getty.helpLine = mkIf (config.documentation.nixos.enable && config.documentation.doc.enable) "\nRun 'nixos-help' for the NixOS manual."; systemd.services."getty@" = { serviceConfig.ExecStart = [ |