man/systemd-getty-generator.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!--
   5   SPDX-License-Identifier: LGPL-2.1+
   6
   7   This file is part of systemd.
   8
   9   Copyright 2012 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24 <refentry id="systemd-getty-generator">
  25
  26   <refentryinfo>
  27     <title>systemd-getty-generator</title>
  28     <productname>systemd</productname>
  29
  30     <authorgroup>
  31       <author>
  32         <contrib>Developer</contrib>
  33         <firstname>Lennart</firstname>
  34         <surname>Poettering</surname>
  35         <email>lennart@poettering.net</email>
  36       </author>
  37     </authorgroup>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>systemd-getty-generator</refentrytitle>
  42     <manvolnum>8</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>systemd-getty-generator</refname>
  47     <refpurpose>Generator for enabling getty instances on the
  48     console</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <para><filename>/usr/lib/systemd/system-generators/systemd-getty-generator</filename></para>
  53   </refsynopsisdiv>
  54
  55   <refsect1>
  56     <title>Description</title>
  57
  58     <para><filename>systemd-getty-generator</filename> is a generator
  59     that automatically instantiates
  60     <filename>serial-getty@.service</filename> on the kernel
  61     console(s), if they can function as ttys and are not provided by
  62     the virtual console subsystem. It will also instantiate
  63     <filename>serial-getty@.service</filename> instances for
  64     virtualizer consoles, if execution in a virtualized environment is
  65     detected. If execution in a container environment is detected, it
  66     will instead enable <filename>console-getty.service</filename> for
  67     <filename>/dev/console</filename>, and
  68     <filename>container-getty@.service</filename> instances for
  69     additional container pseudo TTYs as requested by the container
  70     manager (see <ulink
  71     url="https://www.freedesktop.org/wiki/Software/systemd/ContainerInterface/"><filename>Container
  72     Interface</filename></ulink>). This should ensure that the user is
  73     shown a login prompt at the right place, regardless of which
  74     environment the system is started in. For example, it is
  75     sufficient to redirect the kernel console with a kernel command
  76     line argument such as <varname>console=</varname> to get both
  77     kernel messages and a getty prompt on a serial TTY. See <ulink
  78     url="https://www.kernel.org/doc/Documentation/admin-guide/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
  79     for more information on the <varname>console=</varname> kernel
  80     parameter.</para>
  81
  82     <para><filename>systemd-getty-generator</filename> implements
  83     <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
  84
  85     <para>Further information about configuration of gettys can be
  86     found in
  87     <ulink url="http://0pointer.de/blog/projects/serial-console.html">systemd
  88     for Administrators, Part XVI: Gettys on Serial Consoles (and
  89     Elsewhere)</ulink>.</para>
  90   </refsect1>
  91
  92   <refsect1>
  93     <title>See Also</title>
  94     <para>
  95       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  96       <citerefentry project='man-pages'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  97     </para>
  98   </refsect1>
  99
 100 </refentry>