| 1 |
'\" t |
| 2 |
.TH "SYSTEMD\-GETTY\-GENERATOR" "8" "" "systemd 261~rc3" "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 kernel command line option may be used to control the execution mode of the generator\&. Takes an optional boolean argument\&. Since v258, this also takes comma\-separated list of special values: |
| 64 |
"credential", |
| 65 |
"container", |
| 66 |
"console", and |
| 67 |
"builtin"\&. |
| 68 |
.sp |
| 69 |
When |
| 70 |
"credential" |
| 71 |
is specified, the two credentials |
| 72 |
\fIgetty\&.ttys\&.serial\fR |
| 73 |
and |
| 74 |
\fIgetty\&.ttys\&.container\fR |
| 75 |
will be parsed\&. See System Credentials section below for more details\&. |
| 76 |
.sp |
| 77 |
When |
| 78 |
"container" |
| 79 |
is specified, |
| 80 |
console\-getty\&.service |
| 81 |
and |
| 82 |
container\-getty@\&.service |
| 83 |
will be enabled when the system is running in a container\&. This option will be ignored when the system is not in a container\&. |
| 84 |
.sp |
| 85 |
When |
| 86 |
"console" |
| 87 |
is specified, |
| 88 |
serial\-getty@\&.service |
| 89 |
for active kernel consoles will be enabled\&. This option will be ignored when the system is running in a container\&. |
| 90 |
.sp |
| 91 |
When |
| 92 |
"builtins" |
| 93 |
is specified, |
| 94 |
serial\-getty@\&.service |
| 95 |
for available virtualizer consoles will be enabled\&. This option will be ignored when the system is running in a container\&. |
| 96 |
.sp |
| 97 |
When yes, the above four options will be enabled\&. When no, all options are disabled and no service will be enabled\&. When the kernel command line option is specified without an argument, defaults to yes\&. The generator is enabled by default, and a false value may be used to disable it\&. |
| 98 |
.sp |
| 99 |
Added in version 250\&. |
| 100 |
.RE |
| 101 |
.SH "ENVIRONMENT" |
| 102 |
.PP |
| 103 |
\fI$SYSTEMD_GETTY_AUTO\fR |
| 104 |
.RS 4 |
| 105 |
This environment variable may be used to control the execution mode of the generator\&. Takes the same value as |
| 106 |
\fIsystemd\&.getty_auto=\fR |
| 107 |
kernel command line option\&. |
| 108 |
.sp |
| 109 |
Added in version 250\&. |
| 110 |
.RE |
| 111 |
.SH "SYSTEM CREDENTIALS" |
| 112 |
.PP |
| 113 |
\fIgetty\&.auto\fR |
| 114 |
.RS 4 |
| 115 |
The system credential may be used to control the execution mode of the generator\&. Takes the same value as |
| 116 |
\fIsystemd\&.getty_auto=\fR |
| 117 |
kernel command line option\&. |
| 118 |
.sp |
| 119 |
Added in version 258\&. |
| 120 |
.RE |
| 121 |
.PP |
| 122 |
\fIgetty\&.ttys\&.serial\fR, \fIgetty\&.ttys\&.container\fR |
| 123 |
.RS 4 |
| 124 |
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 |
| 125 |
serial\-getty@\&.service |
| 126 |
(in case of |
| 127 |
\fIgetty\&.ttys\&.serial\fR) and |
| 128 |
container\-getty@\&.service |
| 129 |
(in case of |
| 130 |
\fIgetty\&.ttys\&.container\fR) on\&. Any lines starting with a |
| 131 |
"#" |
| 132 |
will be ignored\&. |
| 133 |
.sp |
| 134 |
Added in version 254\&. |
| 135 |
.RE |
| 136 |
.SH "SEE ALSO" |
| 137 |
.PP |
| 138 |
\fBsystemd\fR(1), \fBkernel-command-line\fR(7), \fBsystemd.system-credentials\fR(7), \fBagetty\fR(8) |
| 139 |
.SH "NOTES" |
| 140 |
.IP " 1." 4 |
| 141 |
Container |
| 142 |
Interface |
| 143 |
.RS 4 |
| 144 |
\%https://systemd.io/CONTAINER_INTERFACE |
| 145 |
.RE |
| 146 |
.IP " 2." 4 |
| 147 |
The kernel's command-line parameters |
| 148 |
.RS 4 |
| 149 |
\%https://docs.kernel.org/admin-guide/kernel-parameters.html |
| 150 |
.RE |
| 151 |
.IP " 3." 4 |
| 152 |
systemd for Administrators, Part XVI: Gettys on Serial Consoles (and Elsewhere) |
| 153 |
.RS 4 |
| 154 |
\%https://0pointer.de/blog/projects/serial-console.html |
| 155 |
.RE |