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