2012-06-27 17:03:02 +04:00
<?xml version="1.0"?>
<!-- * - nxml - * -->
2019-03-14 16:40:58 +03:00
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
2023-12-25 17:48:33 +03:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
2020-11-09 07:23:58 +03:00
<!-- SPDX - License - Identifier: LGPL - 2.1 - or - later -->
2023-08-22 19:52:02 +03:00
<refentry id= "systemd-getty-generator" xmlns:xi= "http://www.w3.org/2001/XInclude" >
2012-06-27 17:03:02 +04:00
2015-02-04 05:14:13 +03:00
<refentryinfo >
<title > systemd-getty-generator</title>
<productname > systemd</productname>
</refentryinfo>
2012-06-27 17:03:02 +04:00
2015-02-04 05:14:13 +03:00
<refmeta >
<refentrytitle > systemd-getty-generator</refentrytitle>
<manvolnum > 8</manvolnum>
</refmeta>
2012-06-27 17:03:02 +04:00
2015-02-04 05:14:13 +03:00
<refnamediv >
<refname > systemd-getty-generator</refname>
<refpurpose > Generator for enabling getty instances on the
console</refpurpose>
</refnamediv>
2012-06-27 17:03:02 +04:00
2015-02-04 05:14:13 +03:00
<refsynopsisdiv >
2015-06-18 20:47:44 +03:00
<para > <filename > /usr/lib/systemd/system-generators/systemd-getty-generator</filename> </para>
2015-02-04 05:14:13 +03:00
</refsynopsisdiv>
2012-06-27 17:03:02 +04:00
2015-02-04 05:14:13 +03:00
<refsect1 >
<title > Description</title>
2012-06-27 17:03:02 +04:00
2020-01-06 20:15:07 +03:00
<para > <filename > systemd-getty-generator</filename> is a generator that automatically instantiates
2022-10-15 17:06:20 +03:00
<filename > serial-getty@.service</filename> on the kernel consoles, if they can function as ttys and are
2020-01-06 20:15:07 +03:00
not provided by the virtual console subsystem. It will also instantiate
<filename > serial-getty@.service</filename> instances for virtualizer consoles, if execution in a
virtualized environment is detected. If execution in a container environment is detected, it will instead
enable <filename > console-getty.service</filename> for <filename > /dev/console</filename> , and
<filename > container-getty@.service</filename> instances for additional container pseudo TTYs as requested
by the container manager (see <ulink url= "https://systemd.io/CONTAINER_INTERFACE" > <filename > Container
Interface</filename> </ulink> ). 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 <varname > console=</varname> to
get both kernel messages and a getty prompt on a serial TTY. See <ulink
2022-07-04 17:26:30 +03:00
url="https://docs.kernel.org/admin-guide/kernel-parameters.html">The kernel's command-line
2022-07-01 19:03:09 +03:00
parameters</ulink> for more information on the <varname > console=</varname> kernel parameter.</para>
2012-06-27 17:03:02 +04:00
2015-03-05 02:43:20 +03:00
<para > <filename > systemd-getty-generator</filename> implements
<citerefentry > <refentrytitle > systemd.generator</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> .</para>
2012-11-20 23:09:38 +04:00
2017-08-07 20:30:56 +03:00
<para > Further information about configuration of gettys can be
found in
2023-06-23 14:08:57 +03:00
<ulink url= "https://0pointer.de/blog/projects/serial-console.html" > systemd
2015-02-04 05:14:13 +03:00
for Administrators, Part XVI: Gettys on Serial Consoles (and
Elsewhere)</ulink> .</para>
</refsect1>
2012-06-27 17:03:02 +04:00
2021-11-17 20:28:54 +03:00
<refsect1 >
<title > Kernel Command Line</title>
<para > <filename > systemd-getty-generator</filename> understands the following
<citerefentry > <refentrytitle > kernel-command-line</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry>
parameters:</para>
<variablelist class= 'kernel-commandline-options' >
<varlistentry >
<term > <varname > systemd.getty_auto=</varname> </term>
<listitem > <para > 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.
2023-08-22 19:52:36 +03:00
</para>
<xi:include href= "version-info.xml" xpointer= "v250" /> </listitem>
2021-11-17 20:28:54 +03:00
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > Environment</title>
<variablelist class= 'environment-variables' >
<varlistentry >
<term > <varname > $SYSTEMD_GETTY_AUTO</varname> </term>
<listitem > <para > 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.
2023-08-22 19:52:36 +03:00
</para>
<xi:include href= "version-info.xml" xpointer= "v250" /> </listitem>
2021-11-17 20:28:54 +03:00
</varlistentry>
</variablelist>
</refsect1>
2023-06-23 23:50:34 +03:00
<refsect1 >
<title > System Credentials</title>
<variablelist class= 'system-credentials' >
<varlistentry >
<term > <varname > getty.ttys.serial</varname> </term>
<term > <varname > getty.ttys.container</varname> </term>
<listitem > <para > 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
<filename > serial-getty@.service</filename> (in case of <varname > getty.ttys.serial</varname> ) and
<filename > container-getty@.service</filename> (in case of <varname > getty.ttys.container</varname> )
2023-08-22 19:52:36 +03:00
on.</para>
<xi:include href= "version-info.xml" xpointer= "v254" /> </listitem>
2023-06-23 23:50:34 +03:00
</varlistentry>
</variablelist>
</refsect1>
2015-02-04 05:14:13 +03:00
<refsect1 >
<title > See Also</title>
2023-12-22 21:09:32 +03:00
<para > <simplelist type= "inline" >
<member > <citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > kernel-command-line</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> </member>
<member > <citerefentry > <refentrytitle > systemd.system-credentials</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> </member>
<member > <citerefentry project= 'man-pages' > <refentrytitle > agetty</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> </member>
</simplelist> </para>
2015-02-04 05:14:13 +03:00
</refsect1>
2012-06-27 17:03:02 +04:00
</refentry>