Debian Codegraph @

upstream/debian-trixie/man8/systemd-getty-generator.8

raw
1 '\" t
2 .TH "SYSTEMD\-GETTY\-GENERATOR" "8" "" "systemd 257.13" "systemd-getty-generator"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd-getty-generator \- Generator for enabling getty instances on the console
24 .SH "SYNOPSIS"
25 .PP
26 /usr/lib/systemd/system\-generators/systemd\-getty\-generator
27 .SH "DESCRIPTION"
28 .PP
29 systemd\-getty\-generator
30 is a generator that automatically instantiates
31 serial\-getty@\&.service
32 on the kernel consoles, if they can function as ttys and are not provided by the virtual console subsystem\&. It will also instantiate
33 serial\-getty@\&.service
34 instances for virtualizer consoles, if execution in a virtualized environment is detected\&. If execution in a container environment is detected, it will instead enable
35 console\-getty\&.service
36 for
37 /dev/console, and
38 container\-getty@\&.service
39 instances for additional container pseudo TTYs as requested by the container manager (see
40 \m[blue]\fBContainer Interface\fR\m[]\&\s-2\u[1]\d\s+2)\&. This should ensure that the user is shown a login prompt at the right place, regardless of which environment the system is started in\&. For example, it is sufficient to redirect the kernel console with a kernel command line argument such as
41 \fIconsole=\fR
42 to get both kernel messages and a getty prompt on a serial TTY\&. See
43 \m[blue]\fBThe kernel\*(Aqs command\-line parameters\fR\m[]\&\s-2\u[2]\d\s+2
44 for more information on the
45 \fIconsole=\fR
46 kernel parameter\&.
47 .PP
48 systemd\-getty\-generator
49 implements
50 \fBsystemd.generator\fR(7)\&.
51 .PP
52 Further information about configuration of gettys can be found in
53 \m[blue]\fBsystemd for Administrators, Part XVI: Gettys on Serial Consoles (and Elsewhere)\fR\m[]\&\s-2\u[3]\d\s+2\&.
54 .SH "KERNEL COMMAND LINE"
55 .PP
56 systemd\-getty\-generator
57 understands the following
58 \fBkernel-command-line\fR(7)
59 parameters:
60 .PP
61 \fIsystemd\&.getty_auto=\fR
62 .RS 4
63 this options take an optional boolean argument, and default to yes\&. The generator is enabled by default, and a false value may be used to disable it\&.
64 .sp
65 Added in version 250\&.
66 .RE
67 .SH "ENVIRONMENT"
68 .PP
69 \fI$SYSTEMD_GETTY_AUTO\fR
70 .RS 4
71 This variable takes an optional boolean argument, and default to yes\&. The generator is enabled by default, and a false value may be used to disable it\&.
72 .sp
73 Added in version 250\&.
74 .RE
75 .SH "SYSTEM CREDENTIALS"
76 .PP
77 \fIgetty\&.ttys\&.serial\fR, \fIgetty\&.ttys\&.container\fR
78 .RS 4
79 These system credentials may be used to spawn additional login prompts on selected TTYs\&. The two credentials should contain a newline\-separated list of TTY names to spawn instances of
80 serial\-getty@\&.service
81 (in case of
82 \fIgetty\&.ttys\&.serial\fR) and
83 container\-getty@\&.service
84 (in case of
85 \fIgetty\&.ttys\&.container\fR) on\&.
86 .sp
87 Added in version 254\&.
88 .RE
89 .SH "SEE ALSO"
90 .PP
91 \fBsystemd\fR(1), \fBkernel-command-line\fR(7), \fBsystemd.system-credentials\fR(7), \fBagetty\fR(8)
92 .SH "NOTES"
93 .IP " 1." 4
94 Container
95 Interface
96 .RS 4
97 \%https://systemd.io/CONTAINER_INTERFACE
98 .RE
99 .IP " 2." 4
100 The kernel's command-line parameters
101 .RS 4
102 \%https://docs.kernel.org/admin-guide/kernel-parameters.html
103 .RE
104 .IP " 3." 4
105 systemd for Administrators, Part XVI: Gettys on Serial Consoles (and Elsewhere)
106 .RS 4
107 \%https://0pointer.de/blog/projects/serial-console.html
108 .RE