]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-firstboot.xml
namespace: implicitly adds DeviceAllow= when RootImage= is set
[thirdparty/systemd.git] / man / systemd-firstboot.xml
index b269e4811352b08fbbcbde35066ead30f245545e..a78e2d50676acf117b096da22c82836d4a76dad4 100644 (file)
@@ -3,22 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
-  This file is part of systemd.
-
-  Copyright 2014 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/>.
+  SPDX-License-Identifier: LGPL-2.1+
 -->
 
 <refentry id="systemd-firstboot" conditional='ENABLE_FIRSTBOOT'
   <refentryinfo>
     <title>systemd-firstboot</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
 
     <para><command>systemd-firstboot</command> initializes the most
     basic system settings interactively on the first boot, or
-    optionally non-interactively when a system image is created. The
-    following settings may be set up:</para>
+    optionally non-interactively when a system image is created.
+    The service is started if <varname>ConditionFirstBoot=yes</varname>
+    is satisfied. This essentially means that <filename>/etc</filename>
+    is empty, see
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    for details.</para>
+
+    <para>The following settings may be set up:</para>
 
     <itemizedlist>
       <listitem><para>The system locale, more specifically the two
       locale variables <varname>LANG=</varname> and
       <varname>LC_MESSAGES</varname></para></listitem>
 
+      <listitem><para>The system keyboard map</para></listitem>
+
       <listitem><para>The system time zone</para></listitem>
 
       <listitem><para>The system host name</para></listitem>
         configuration file.</para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>--keymap=<replaceable>KEYMAP</replaceable></option></term>
+
+        <listitem><para>Sets the system keyboard layout. The argument should be a valid keyboard map,
+        such as <literal>de-latin1</literal>. This controls the <literal>KEYMAP</literal> entry in the
+        <citerefentry project='man-pages'><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+        configuration file.</para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><option>--timezone=<replaceable>TIMEZONE</replaceable></option></term>
 
 
       <varlistentry>
         <term><option>--prompt-locale</option></term>
+        <term><option>--prompt-keymap</option></term>
         <term><option>--prompt-timezone</option></term>
         <term><option>--prompt-hostname</option></term>
         <term><option>--prompt-root-password</option></term>
       <varlistentry>
         <term><option>--prompt</option></term>
 
-        <listitem><para>Query the user for locale, timezone, hostname
+        <listitem><para>Query the user for locale, keymap, timezone, hostname
         and root password. This is equivalent to specifying
         <option>--prompt-locale</option>,
+        <option>--prompt-keymap</option>,
         <option>--prompt-timezone</option>,
         <option>--prompt-hostname</option>,
         <option>--prompt-root-password</option> in combination.</para>
 
       <varlistentry>
         <term><option>--copy-locale</option></term>
+        <term><option>--copy-keymap</option></term>
         <term><option>--copy-timezone</option></term>
         <term><option>--copy-root-password</option></term>
 
       <varlistentry>
         <term><option>--copy</option></term>
 
-        <listitem><para>Copy locale, time zone and root password from
+        <listitem><para>Copy locale, keymap, time zone and root password from
         the host. This is equivalent to specifying
         <option>--copy-locale</option>,
+        <option>--copy-keymap</option>,
         <option>--copy-timezone</option>,
         <option>--copy-root-password</option> in combination.</para>
         </listitem>
     otherwise.</para>
   </refsect1>
 
+  <refsect1>
+    <title>Kernel Command Line</title>
+
+    <variablelist class='kernel-commandline-options'>
+      <varlistentry>
+        <term><varname>systemd.firstboot=</varname></term>
+
+        <listitem><para>Takes a boolean argument, defaults to on. If off, <filename>systemd-firstboot.service</filename>
+        won't interactively query the user for basic settings at first boot, even if those settings are not
+        initialized yet.</para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
   <refsect1>
     <title>See Also</title>
     <para>
       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,