man: bring machinectl man page up-to-date

[elogind.git] / man / systemd-machine-id-setup.xml

diff --git a/man/systemd-machine-id-setup.xml b/man/systemd-machine-id-setup.xml
index 49b92f689135ca438ab93da4adc25015c309d934..28352e357f9faa987a358e61a6831def0429742e 100644 (file)
--- a/man/systemd-machine-id-setup.xml
+++ b/man/systemd-machine-id-setup.xml
@@ -8,20 +8,21 @@
   Copyright 2012 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="systemd-machine-id-setup">
+<refentry id="systemd-machine-id-setup"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>systemd-machine-id-setup</title>
@@ -44,7 +45,7 @@
 
         <refnamediv>
                 <refname>systemd-machine-id-setup</refname>
-                <refpurpose>Initialize the machine ID in <filename>/etc/machine-id</filename></refpurpose>
+                <refpurpose>Initialize the machine ID in /etc/machine-id</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -69,12 +70,12 @@
                 initialized.</para>
 
                 <para>If a valid D-Bus machine ID is already
-                configured for the system the D-Bus machine ID is
+                configured for the system, the D-Bus machine ID is
                 copied and used to initialize the machine ID in
                 <filename>/etc/machine-id</filename>.</para>
 
                 <para>If run inside a KVM virtual machine and a UUID
-                is passed via the <option>-uuid</option> option this
+                is passed via the <option>-uuid</option> option, this
                 UUID is used to initialize the machine ID instead of a
                 randomly generated one. The caller must ensure that the
                 UUID passed is sufficiently unique and is different
@@ -87,18 +88,38 @@
                 url="http://www.freedesktop.org/wiki/Software/systemd/ContainerInterface">Container
                 Interface</ulink>.</para>
 
+                <para>Use
+                <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                to initialize the machine ID on mounted (but not
+                booted) system images.</para>
+
         </refsect1>
 
         <refsect1>
                 <title>Options</title>
 
-                <para>This tool does not take any options or arguments.</para>
+                <para>The following options are understood:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><option>--root=<replaceable>root</replaceable></option></term>
+                                <listitem><para>Takes a directory path
+                                as an argument. All paths will be
+                                prefixed with the given alternate
+                                <replaceable>root</replaceable> path,
+                                including config search paths.
+                                </para></listitem>
+                        </varlistentry>
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
+                </variablelist>
+
         </refsect1>
 
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
@@ -107,7 +128,8 @@
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 </para>
         </refsect1>