chiark / gitweb /
man: add sd_event_add_child(3)
[elogind.git] / 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
46                 the 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
57                 a generator that automatically instantiates
58                 <filename>serial-getty@.service</filename> on the
59                 kernel console <filename>/dev/console</filename> if
60                 that is not directed to the virtual console
61                 subsystem. It will also instantiate
62                 <filename>serial-getty@.service</filename> instances
63                 for virtualizer consoles, if execution in a
64                 virtualized environment is detected. Finally, it will
65                 instantiate
66                 <filename>container-getty@.service</filename>
67                 instances for additional container pseudo TTYs as
68                 requested by the container manager (see <ulink
69                 url="http://www.freedesktop.org/wiki/Software/systemd/ContainerInterface/"><filename>Container Interface</filename></ulink>). This
70                 should ensure that the user is shown a login prompt at
71                 the right place, regardless of which environment the
72                 system is started in. For example, it is sufficient to
73                 redirect the kernel console with a kernel command line
74                 argument such as <varname>console=</varname> to get
75                 both kernel messages and a getty prompt on a serial
76                 TTY. See <ulink
77                 url="https://www.kernel.org/doc/Documentation/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
78                 for more information on the
79                 <varname>console=</varname> kernel parameter.</para>
80
81                 <para><filename>systemd-getty-generator</filename>
82                 implements the <ulink
83                 url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
84                 specification</ulink>.</para>
85
86                 <para>Further information about configuration of
87                 gettys you may find in <ulink
88                 url="http://0pointer.de/blog/projects/serial-console.html">systemd
89                 for Administrators, Part XVI: Gettys on Serial
90                 Consoles (and Elsewhere)</ulink>.</para>
91         </refsect1>
92
93         <refsect1>
94                 <title>See Also</title>
95                 <para>
96                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
97                         <citerefentry project='man-pages'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>
98                 </para>
99         </refsect1>
100
101 </refentry>