summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2012-06-27 15:03:02 +0200
committerLennart Poettering <lennart@poettering.net>2012-06-27 15:03:02 +0200
commitf220d83cbc63678c765dd0b80983f17b1d5e615b (patch)
tree3fe7f4364e00a0f2ac30f606fdae9736c63bafb3
parent8e129f5156569e1bc858b002ca54cd447c38f4f1 (diff)
man: document getty-generator
-rw-r--r--Makefile.am3
-rw-r--r--man/systemd-cryptsetup-generator.xml4
-rw-r--r--man/systemd-getty-generator.xml90
3 files changed, 94 insertions, 3 deletions
diff --git a/Makefile.am b/Makefile.am
index fb2fdfa011..acbdeedd18 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -497,7 +497,8 @@ MANPAGES = \
man/systemd-fsck@.service.8 \
man/systemd-ask-password-console.service.8 \
man/systemd-analyze.1 \
- man/systemd-tty-ask-password-agent.1
+ man/systemd-tty-ask-password-agent.1 \
+ man/systemd-getty-generator.8
MANPAGES_ALIAS = \
man/reboot.8 \
diff --git a/man/systemd-cryptsetup-generator.xml b/man/systemd-cryptsetup-generator.xml
index 17e0ed9a64..dfe55c7251 100644
--- a/man/systemd-cryptsetup-generator.xml
+++ b/man/systemd-cryptsetup-generator.xml
@@ -42,11 +42,11 @@
<refnamediv>
<refname>systemd-cryptsetup-generator</refname>
- <refpurpose>Unit generated for <filename>/etc/crypttab</filename></refpurpose>
+ <refpurpose>Unit generator for <filename>/etc/crypttab</filename></refpurpose>
</refnamediv>
<refsynopsisdiv>
- <para><filename>/usr/lib/systemd/systemd-cryptsetup</filename></para>
+ <para><filename>/usr/lib/systemd/system-generators/systemd-cryptsetup-generator</filename></para>
</refsynopsisdiv>
<refsect1>
diff --git a/man/systemd-getty-generator.xml b/man/systemd-getty-generator.xml
new file mode 100644
index 0000000000..4c6a2475b9
--- /dev/null
+++ b/man/systemd-getty-generator.xml
@@ -0,0 +1,90 @@
+<?xml version="1.0"?>
+<!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!--
+ This file is part of systemd.
+
+ Copyright 2012 Lennart Poettering
+
+ systemd is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
+
+ systemd is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+<refentry id="systemd-getty-generator">
+
+ <refentryinfo>
+ <title>systemd-getty-generator</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart@poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>systemd-getty-generator</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>systemd-getty-generator</refname>
+ <refpurpose>Generator for enabling getty instances on
+ the console</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/usr/lib/systemd/system-generators/systemd-getty-generator</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><filename>systemd-getty-generator</filename> is
+ a generator that automatically instantiates
+ <filename>serial-getty@.service</filename> on the
+ kernel console <filename>/dev/console</filename> if
+ that is not directed to 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. This should
+ ensure that the user is shown a login prompt at the
+ right place, regardless in which environment the
+ system is started. 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
+ url="https://www.kernel.org/doc/Documentation/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
+ for more information on the
+ <varname>console=</varname> kernel parameter.</para>
+
+ <para><filename>systemd-getty-generator</filename>
+ implements the <ulink
+ url="http://www.freedesktop.org/wiki/Software/systemd/Generator">generator
+ specification</ulink>.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>