man: document systemd-vconsole-setup.service

1 files changed, 118 insertions, 0 deletions

diff --git a/man/systemd-vconsole-setup.service.xml b/man/systemd-vconsole-setup.service.xml
new file mode 100644
index 0000000000..b4ad3c271f
--- /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>