man: Add xinclude namespace

[thirdparty/systemd.git] / man / vconsole.conf.xml

diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml
index dc874d2a49976f65e065e90ddf3f77685e0a7aef..07959d837a6a2546b556f761b2d0f6351b874f8c 100644 (file)
--- a/man/vconsole.conf.xml
+++ b/man/vconsole.conf.xml
@@ -1,24 +1,16 @@
 <?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">
-
-<!--
-  SPDX-License-Identifier: LGPL-2.1+
--->
-
-<refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % entities SYSTEM "custom-entities.ent" >
+%entities;
+]>
+<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
+
+<refentry id="vconsole.conf" conditional='ENABLE_VCONSOLE'
+          xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <title>vconsole.conf</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
@@ -44,13 +36,13 @@
     You can safely mask this file if you want to avoid this kind of initialization.
     </para>
 
-    <para>The basic file format of the
-    <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>The format of <filename>vconsole.conf</filename> is a newline-separated list of environment-like
+    shell-compatible variable assignments, ignoring comments and empty lines. 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. See
+    <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a
+    detailed description of the format.</para>
 
     <para>Note that the kernel command line options
     <varname>vconsole.keymap=</varname>,
@@ -77,16 +69,17 @@
 
     <para>The following options are understood:</para>
 
-    <variablelist>
+    <variablelist class='environment-variables'>
 
       <varlistentry>
         <term><varname>KEYMAP=</varname></term>
         <term><varname>KEYMAP_TOGGLE=</varname></term>
 
-        <listitem><para>Configures the key 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 configure a second toggle keymap and is by
-        default unset.</para></listitem>
+        <listitem><para>Configures the key mapping table for the keyboard.  <varname>KEYMAP=</varname>
+        defaults to <literal>&DEFAULT_KEYMAP;</literal> if not set. Specially, if <literal>@kernel</literal>
+        is specified, no keymap will be loaded, i.e. the kernel's default keymap is used.  The
+        <varname>KEYMAP_TOGGLE=</varname> can be used to configure a second toggle keymap and is by default
+        unset.</para></listitem>
       </varlistentry>
 
       <varlistentry>