networkd: support vxlan parameters

[elogind.git] / man / vconsole.conf.xml

diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml
index 1926f337bb7e171fde91ab71dd61d8bb65e64fd1..09a4776705e5de68975051c5aa1cda48ff38da92 100644 (file)
--- a/man/vconsole.conf.xml
+++ b/man/vconsole.conf.xml
@@ -9,20 +9,20 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  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
-  General Public License for more details.
+  Lesser General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
+  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="hostname">
+<refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'>
         <refentryinfo>
                 <title>vconsole.conf</title>
                 <productname>systemd</productname>
@@ -44,7 +44,7 @@
 
         <refnamediv>
                 <refname>vconsole.conf</refname>
-                <refpurpose>configuration file for the virtual console</refpurpose>
+                <refpurpose>Configuration file for the virtual console</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -56,23 +56,25 @@
 
                 <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 set of
-                environment-like shell-compatible variable
-                assignments. It is possible to source the
-                configuration from shell scripts, however, beyond mere
-                variable assignments no shell features are supported,
-                allowing applications to read the file without
-                containing a shell compatible execution engine.</para>
+                <filename>vconsole.conf</filename> is a
+                newline-separated list of environment-like
+                shell-compatible variable assignments. It is possible
+                to source the configuration from shell scripts,
+                however, beyond mere variable assignments no shell
+                features are supported, allowing applications to read
+                the file without implementing a shell compatible
+                execution engine.</para>
 
                 <para>Note that the kernel command line options
                 <varname>vconsole.keymap=</varname>,
                 <varname>vconsole.keymap.toggle=</varname>,
                 <varname>vconsole.font=</varname>,
                 <varname>vconsole.font.map=</varname>,
-                <varname>vconsole.font.unimap=</varname> can be used
+                <varname>vconsole.font.unimap=</varname> may be used
                 to override the console settings at boot.</para>
 
                 <para>Depending on the operating system other
@@ -93,12 +95,12 @@
                                 <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
                                 <varname>KEYMAP_TOGGLE=</varname> can
-                                be used to configured a second toggle
+                                be used to configure a second toggle
                                 keymap and is by default
                                 unset.</para></listitem>
                         </varlistentry>
@@ -110,21 +112,35 @@
 
                                 <listitem><para>Configures the console
                                 font, the console map and the unicode
-                                font map. <varname>FONT=</varname>
-                                defaults to
-                                <literal>latarcyrheb-sun16</literal>.</para></listitem>
+                                font map.</para></listitem>
                         </varlistentry>
 
                 </variablelist>
         </refsect1>
 
+        <refsect1>
+                <title>Example</title>
+
+                <example>
+                        <title>German keyboard and console</title>
+
+                        <para><filename>/etc/vconsole.conf</filename>:</para>
+
+                        <programlisting>KEYMAP=de-latin1
+FONT=latarcyrheb-sun16</programlisting>
+                </example>
+
+        </refsect1>
+
         <refsect1>
                   <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>