man/systemd-firstboot.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>systemd-firstboot</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
   2     a.headerlink {
   3       color: #c60f0f;
   4       font-size: 0.8em;
   5       padding: 0 4px 0 4px;
   6       text-decoration: none;
   7       visibility: hidden;
   8     }
   9
  10     a.headerlink:hover {
  11       background-color: #c60f0f;
  12       color: white;
  13     }
  14
  15     h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
  16       visibility: visible;
  17     }
  18   </style><a href="index.html">Index </a>·
  19   <a href="systemd.directives.html">Directives </a>·
  20   <a href="../python-systemd/index.html">Python </a>·
  21   <a href="../libudev/index.html">libudev </a>·
  22   <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 218</span><hr><div class="refentry"><a name="systemd-firstboot"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>systemd-firstboot, systemd-firstboot.service — Initialize basic system settings on or before the first boot-up of a system</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">systemd-firstboot</code>  [OPTIONS...]</p></div><p><code class="filename">systemd-firstboot.service</code></p></div><div class="refsect1"><a name="idm139906241361824"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p><span class="command"><strong>systemd-firstboot</strong></span> initializes
  23                 the most basic system settings interactively on the
  24                 first boot, or optionally non-interactively when a
  25                 system image is created. The following settings may be
  26                 set up:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>The system locale, more
  27                         specifically the two locale variables
  28                         <code class="varname">LANG=</code> and
  29                         <code class="varname">LC_MESSAGES</code></p></li><li class="listitem"><p>The system time zone</p></li><li class="listitem"><p>The system host name</p></li><li class="listitem"><p>The machine ID of the system</p></li><li class="listitem"><p>The root user's password</p></li></ul></div><p>Each of the fields may either be queried
  30                 interactively from the users, set non-interactively on
  31                 the tool's command line, or be copied from a host
  32                 system that is used to set up the system image.</p><p>If a setting is already initialized it will not
  33                 be overwritten and the user will not be prompted for
  34                 the setting.</p><p>Note that this tool operates directly on the
  35                 file system and does not involve any running system
  36                 services, unlike
  37                 <a href="localectl.html"><span class="citerefentry"><span class="refentrytitle">localectl</span>(1)</span></a>,
  38                 <a href="timedatectl.html"><span class="citerefentry"><span class="refentrytitle">timedatectl</span>(1)</span></a>
  39                 or
  40                 <a href="hostnamectl.html"><span class="citerefentry"><span class="refentrytitle">hostnamectl</span>(1)</span></a>. This
  41                 allows <span class="command"><strong>systemd-firstboot</strong></span> to operate
  42                 on mounted but not booted disk images and in early
  43                 boot. It is not recommended to use
  44                 <span class="command"><strong>systemd-firstboot</strong></span> on the running
  45                 system while it is up.</p></div><div class="refsect1"><a name="idm139906241246048"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt id="--root=root"><span class="term"><code class="option">--root=<em class="replaceable"><code>root</code></em></code></span><a class="headerlink" title="Permalink to this term" href="#--root=root">¶</a></dt><dd><p>Takes a directory path
  46                                 as an argument. All paths will be
  47                                 prefixed with the given alternate
  48                                 <em class="replaceable"><code>root</code></em> path,
  49                                 including config search paths. This is
  50                                 useful to operate on a system image
  51                                 mounted to the specified directory
  52                                 instead of the host system itself.
  53                                 </p></dd><dt id="--locale=LOCALE"><span class="term"><code class="option">--locale=<em class="replaceable"><code>LOCALE</code></em></code>, </span><span class="term"><code class="option">--locale-messages=<em class="replaceable"><code>LOCALE</code></em></code></span><a class="headerlink" title="Permalink to this term" href="#--locale=LOCALE">¶</a></dt><dd><p>Sets the system
  54                                 locale, more specifically the
  55                                 <code class="varname">LANG=</code> and
  56                                 <code class="varname">LC_MESSAGES</code>
  57                                 settings. The argument should be a
  58                                 valid locale identifier, such as
  59                                 "<code class="literal">de_DE.UTF-8</code>". This
  60                                 controls the
  61                                 <a href="locale.conf.html"><span class="citerefentry"><span class="refentrytitle">locale.conf</span>(5)</span></a>
  62                                 configuration file.</p></dd><dt id="--timezone=TIMEZONE"><span class="term"><code class="option">--timezone=<em class="replaceable"><code>TIMEZONE</code></em></code></span><a class="headerlink" title="Permalink to this term" href="#--timezone=TIMEZONE">¶</a></dt><dd><p>Sets the system time
  63                                 zone. The argument should be a valid
  64                                 time zone identifier, such as
  65                                 "<code class="literal">Europe/Berlin</code>". This
  66                                 controls the
  67                                 <a href="localtime.html"><span class="citerefentry"><span class="refentrytitle">localtime</span>(5)</span></a>
  68                                 symlink.</p></dd><dt id="--hostname=HOSTNAME"><span class="term"><code class="option">--hostname=<em class="replaceable"><code>HOSTNAME</code></em></code></span><a class="headerlink" title="Permalink to this term" href="#--hostname=HOSTNAME">¶</a></dt><dd><p>Sets the system
  69                                 hostname. The argument should be a
  70                                 host name, compatible with DNS. This
  71                                 controls the
  72                                 <a href="hostname.html"><span class="citerefentry"><span class="refentrytitle">hostname</span>(5)</span></a>
  73                                 configuration file.</p></dd><dt id="--machine-id=ID"><span class="term"><code class="option">--machine-id=<em class="replaceable"><code>ID</code></em></code></span><a class="headerlink" title="Permalink to this term" href="#--machine-id=ID">¶</a></dt><dd><p>Sets the system's machine ID. This
  74                                 controls the
  75                                 <a href="machine-id.html"><span class="citerefentry"><span class="refentrytitle">machine-id</span>(5)</span></a>
  76                                 file.</p></dd><dt id="--root-password=PASSWORD"><span class="term"><code class="option">--root-password=<em class="replaceable"><code>PASSWORD</code></em></code>, </span><span class="term"><code class="option">--root-password-file=<em class="replaceable"><code>PATH</code></em></code></span><a class="headerlink" title="Permalink to this term" href="#--root-password=PASSWORD">¶</a></dt><dd><p>Sets the password of
  77                                 the system's root user. This creates a
  78                                 <a href="shadow.html"><span class="citerefentry"><span class="refentrytitle">shadow</span>(5)</span></a>
  79                                 file. This setting exists in two
  80                                 forms:
  81                                 <code class="option">--root-password=</code>
  82                                 accepts the password to set directly
  83                                 on the command line,
  84                                 <code class="option">--root-password-file=</code>
  85                                 reads it from a file. Note that
  86                                 it is not recommended specifying
  87                                 passwords on the command line as other
  88                                 users might be able to see them
  89                                 simply by invoking
  90                                 <a href="ps.html"><span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span></a>.</p></dd><dt id="--prompt-locale"><span class="term"><code class="option">--prompt-locale</code>, </span><span class="term"><code class="option">--prompt-timezone</code>, </span><span class="term"><code class="option">--prompt-hostname</code>, </span><span class="term"><code class="option">--prompt-root-password</code></span><a class="headerlink" title="Permalink to this term" href="#--prompt-locale">¶</a></dt><dd></dd><dt id="--prompt"><span class="term"><code class="option">--prompt</code></span><a class="headerlink" title="Permalink to this term" href="#--prompt">¶</a></dt><dd></dd><dt id="--copy-locale"><span class="term"><code class="option">--copy-locale</code>, </span><span class="term"><code class="option">--copy-timezone</code>, </span><span class="term"><code class="option">--copy-root-password</code></span><a class="headerlink" title="Permalink to this term" href="#--copy-locale">¶</a></dt><dd></dd><dt id="--copy"><span class="term"><code class="option">--copy</code></span><a class="headerlink" title="Permalink to this term" href="#--copy">¶</a></dt><dd></dd><dt id="--setup-machine-id"><span class="term"><code class="option">--setup-machine-id</code></span><a class="headerlink" title="Permalink to this term" href="#--setup-machine-id">¶</a></dt><dd></dd><dt id="-h"><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span><a class="headerlink" title="Permalink to this term" href="#-h">¶</a></dt><dd><p><a name="help-text"></a>Print a short help text and exit.
  91     </p></dd><dt id="--version"><span class="term"><code class="option">--version</code></span><a class="headerlink" title="Permalink to this term" href="#--version">¶</a></dt><dd><p><a name="version-text"></a>Print a short version string and exit.</p></dd></dl></div></div><div class="refsect1"><a name="idm139906243188992"></a><h2 id="Exit status">Exit status<a class="headerlink" title="Permalink to this headline" href="#Exit%20status">¶</a></h2><p>On success, 0 is returned, a non-zero failure
  92                 code otherwise.</p></div><div class="refsect1"><a name="idm139906239590048"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
  93                         <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
  94                         <a href="locale.conf.html"><span class="citerefentry"><span class="refentrytitle">locale.conf</span>(5)</span></a>,
  95                         <a href="localtime.html"><span class="citerefentry"><span class="refentrytitle">localtime</span>(5)</span></a>,
  96                         <a href="hostname.html"><span class="citerefentry"><span class="refentrytitle">hostname</span>(5)</span></a>,
  97                         <a href="machine-id.html"><span class="citerefentry"><span class="refentrytitle">machine-id</span>(5)</span></a>,
  98                         <a href="shadow.html"><span class="citerefentry"><span class="refentrytitle">shadow</span>(5)</span></a>,
  99                         <a href="systemd-machine-id-setup.html"><span class="citerefentry"><span class="refentrytitle">systemd-machine-id-setup</span>(1)</span></a>,
 100                         <a href="localectl.html"><span class="citerefentry"><span class="refentrytitle">localectl</span>(1)</span></a>,
 101                         <a href="timedatectl.html"><span class="citerefentry"><span class="refentrytitle">timedatectl</span>(1)</span></a>,
 102                         <a href="hostnamectl.html"><span class="citerefentry"><span class="refentrytitle">hostnamectl</span>(1)</span></a>
 103                 </p></div></div></body></html>