From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 25 Jun 2012 10:00:43 +0000 (+0200)
Subject: man: document systemd-vconsole-setup.service
X-Git-Tag: v186~106
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=4aa6e7782a1b693a8e4fa1d84c87dd76fe1e536d;hp=013d8a39a6178179080bcfee9122b29cf9d29259

man: document systemd-vconsole-setup.service
---

diff --git a/Makefile.am b/Makefile.am
index e4fcecbba..b7fb370c0 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2381,7 +2381,13 @@ INSTALL_DATA_HOOKS += \
 	vconsole-install-data-hook
 
 MANPAGES += \
-	man/vconsole.conf.5
+	man/vconsole.conf.5 \
+	man/systemd-vconsole-setup.service.8
+
+MANPAGES_ALIAS += \
+	man/systemd-vconsole-setup.8
+
+man/systemd-vconsole-setup.8: man/systemd-vconsole-setup.service.8
 
 EXTRA_DIST += \
 	units/systemd-vconsole-setup.service.in
diff --git a/man/locale.conf.xml b/man/locale.conf.xml
index 0c4d351ec..b90efea50 100644
--- a/man/locale.conf.xml
+++ b/man/locale.conf.xml
@@ -55,7 +55,9 @@
                 <title>Description</title>
 
                 <para>The <filename>/etc/locale.conf</filename> file
-                configures system-wide locale settings.</para>
+                configures system-wide locale settings. It is read at
+                early-boot by
+                <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
 
                 <para>The basic file format of
                 <filename>locale.conf</filename> is a
@@ -139,7 +141,8 @@ LC_MESSAGES=C</programlisting>
                   <title>See Also</title>
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                   </para>
         </refsect1>
 
diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml
index 5c4f03159..43df3e7cf 100644
--- a/man/systemd-journald.service.xml
+++ b/man/systemd-journald.service.xml
@@ -153,7 +153,6 @@
                                 </listitem>
 
                         </varlistentry>
-
                 </variablelist>
         </refsect1>
 
diff --git a/man/systemd-vconsole-setup.service.xml b/man/systemd-vconsole-setup.service.xml
new file mode 100644
index 000000000..b4ad3c271
--- /dev/null
+++ b/man/systemd-vconsole-setup.service.xml
@@ -0,0 +1,118 @@
+<?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-vconsole-setup.service">
+
+        <refentryinfo>
+                <title>systemd-vconsole-setup.service</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-vconsole-setup.service</refentrytitle>
+                <manvolnum>8</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-vconsole-setup.service</refname>
+                <refname>systemd-vconsole-setup</refname>
+                <refpurpose>Configure the virtual console at boot</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd-vconsole-setup.service</filename></para>
+                <para><filename>/usr/lib/systemd/systemd-vconsole-setup</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><filename>systemd-vconsole-setup.service</filename>
+                is an early-boot service that configures the virtual
+                console font and console keymap. Internally it calls
+                <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                and
+                <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+
+                <para>See
+                <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                for information about the configuration files understood by this
+                service.</para>
+
+
+        </refsect1>
+
+        <refsect1>
+                <title>Kernel Command Line</title>
+
+                <para>A few configuration parameters from
+                <filename>vconsole.conf</filename> may be overriden on
+                the kernel command line:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><varname>vconsole.keymap=</varname></term>
+                                <term><varname>vconsole.keymap.toggle=</varname></term>
+
+                                <listitem><para>Overrides the key
+                                mapping table for the keybaord and the
+                                second toggle keymap.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+
+                                <term><varname>vconsole.font=</varname></term>
+                                <term><varname>vconsole.font.map=</varname></term>
+                                <term><varname>vconsole.font.unimap=</varname></term>
+
+                                <listitem><para>Configures the console
+                                font, the console map, and the unicode
+                                font map.</para></listitem>
+
+
+                        </varlistentry>
+                </variablelist>
+
+                <para>See
+                <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                for information about these settings.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
diff --git a/man/systemd.conf.xml b/man/systemd.conf.xml
index 613763e8a..fb038eaf6 100644
--- a/man/systemd.conf.xml
+++ b/man/systemd.conf.xml
@@ -48,8 +48,8 @@
         </refnamediv>
 
         <refsynopsisdiv>
-                <para><filename>system.conf</filename></para>
-                <para><filename>user.conf</filename></para>
+                <para><filename>/etc/systemd/system.conf</filename></para>
+                <para><filename>/etc/systemd/user.conf</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
diff --git a/man/systemd.xml b/man/systemd.xml
index 5168049be..75a0defc4 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -1223,6 +1223,8 @@
         <refsect1>
                 <title>See Also</title>
                 <para>
+                        <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-notify</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml
index 72f153062..861772166 100644
--- a/man/vconsole.conf.xml
+++ b/man/vconsole.conf.xml
@@ -56,7 +56,8 @@
 
                 <para>The <filename>/etc/vconsole.conf</filename> file
                 configures the virtual console, i.e. keyboard mapping
-                and console font.</para>
+                and console font. It is applied at boot by
+                <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 
                 <para>The basic file format of the
                 <filename>vconsole.conf</filename> is a
@@ -94,7 +95,7 @@
                                 <term><varname>KEYMAP_TOGGLE=</varname></term>
 
                                 <listitem><para>Configures the key
-                                mapping table of for they
+                                mapping table for the
                                 keyboard. <varname>KEYMAP=</varname>
                                 defaults to <literal>us</literal> if
                                 not set. The
@@ -137,9 +138,11 @@ FONT=latarcyrheb-sun16</programlisting>
                   <title>See Also</title>
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                   </para>
         </refsect1>
 
diff --git a/units/hibernate.target b/units/hibernate.target
index 23a9f9998..fc8493c20 100644
--- a/units/hibernate.target
+++ b/units/hibernate.target
@@ -11,3 +11,4 @@ Documentation=man:systemd.special(7)
 DefaultDependencies=no
 BindTo=hibernate.service
 After=hibernate.service
+StopWhenUnneeded=yes
diff --git a/units/systemd-vconsole-setup.service.in b/units/systemd-vconsole-setup.service.in
index 51fc0b512..18faa63f2 100644
--- a/units/systemd-vconsole-setup.service.in
+++ b/units/systemd-vconsole-setup.service.in
@@ -7,7 +7,7 @@
 
 [Unit]
 Description=Setup Virtual Console
-Documentation=man:vconsole.conf(5)
+Documentation=man:systemd-vconsole-setup.service(8) man:vconsole.conf(5)
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service