]>
Commit | Line | Data |
---|---|---|
44f44a29 LP |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2012 Lennart Poettering | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
11 | under the terms of the GNU Lesser General Public License as published by |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
44f44a29 LP |
13 | (at your option) any later version. |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
5430f7f2 | 18 | Lesser General Public License for more details. |
44f44a29 | 19 | |
5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
44f44a29 LP |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
22 | --> | |
23 | ||
dfdebb1b ZJS |
24 | <refentry id="systemd-machine-id-setup" |
25 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
44f44a29 LP |
26 | |
27 | <refentryinfo> | |
28 | <title>systemd-machine-id-setup</title> | |
29 | <productname>systemd</productname> | |
30 | ||
31 | <authorgroup> | |
32 | <author> | |
33 | <contrib>Developer</contrib> | |
34 | <firstname>Lennart</firstname> | |
35 | <surname>Poettering</surname> | |
36 | <email>lennart@poettering.net</email> | |
37 | </author> | |
38 | </authorgroup> | |
39 | </refentryinfo> | |
40 | ||
41 | <refmeta> | |
42 | <refentrytitle>systemd-machine-id-setup</refentrytitle> | |
43 | <manvolnum>1</manvolnum> | |
44 | </refmeta> | |
45 | ||
46 | <refnamediv> | |
47 | <refname>systemd-machine-id-setup</refname> | |
34511ca7 | 48 | <refpurpose>Initialize the machine ID in /etc/machine-id</refpurpose> |
44f44a29 LP |
49 | </refnamediv> |
50 | ||
51 | <refsynopsisdiv> | |
52 | <cmdsynopsis> | |
53 | <command>systemd-machine-id-setup</command> | |
54 | </cmdsynopsis> | |
55 | </refsynopsisdiv> | |
56 | ||
57 | <refsect1> | |
58 | <title>Description</title> | |
59 | ||
60 | <para><command>systemd-machine-id-setup</command> may | |
61 | be used by system installer tools to initialize the | |
62 | machine ID stored in | |
63 | <filename>/etc/machine-id</filename> at install time | |
64 | with a randomly generated ID. See | |
65 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
66 | for more information about this file.</para> | |
67 | ||
68 | <para>This tool will execute no operation if | |
69 | <filename>/etc/machine-id</filename> is already | |
70 | initialized.</para> | |
71 | ||
72 | <para>If a valid D-Bus machine ID is already | |
79640424 | 73 | configured for the system, the D-Bus machine ID is |
44f44a29 LP |
74 | copied and used to initialize the machine ID in |
75 | <filename>/etc/machine-id</filename>.</para> | |
76 | ||
77 | <para>If run inside a KVM virtual machine and a UUID | |
79640424 | 78 | is passed via the <option>-uuid</option> option, this |
44f44a29 LP |
79 | UUID is used to initialize the machine ID instead of a |
80 | randomly generated one. The caller must ensure that the | |
81 | UUID passed is sufficiently unique and is different | |
82 | for every booted instanced of the VM.</para> | |
83 | ||
494a6682 | 84 | <para>Similarly, if run inside a Linux container |
44f44a29 LP |
85 | environment and a UUID is set for the container this |
86 | is used to initialize the machine ID. For details see | |
87 | the documentation of the <ulink | |
88 | url="http://www.freedesktop.org/wiki/Software/systemd/ContainerInterface">Container | |
89 | Interface</ulink>.</para> | |
90 | ||
91 | </refsect1> | |
92 | ||
93 | <refsect1> | |
94 | <title>Options</title> | |
95 | ||
984bf931 LP |
96 | <para>The following options are understood:</para> |
97 | ||
98 | <variablelist> | |
92f2f92e | 99 | <varlistentry> |
fe970a8a | 100 | <term><option>--root=<replaceable>root</replaceable></option></term> |
92f2f92e GKH |
101 | <listitem><para>Takes a directory path |
102 | as an argument. All paths will be | |
fe970a8a ZJS |
103 | prefixed with the given alternate |
104 | <replaceable>root</replaceable> path, | |
105 | including config search paths. | |
92f2f92e GKH |
106 | </para></listitem> |
107 | </varlistentry> | |
dfdebb1b ZJS |
108 | <xi:include href="standard-options.xml" xpointer="help" /> |
109 | <xi:include href="standard-options.xml" xpointer="version" /> | |
984bf931 LP |
110 | </variablelist> |
111 | ||
44f44a29 LP |
112 | </refsect1> |
113 | ||
114 | <refsect1> | |
115 | <title>Exit status</title> | |
116 | ||
b040723e | 117 | <para>On success, 0 is returned, a non-zero failure |
44f44a29 LP |
118 | code otherwise.</para> |
119 | </refsect1> | |
120 | ||
121 | <refsect1> | |
122 | <title>See Also</title> | |
123 | <para> | |
124 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
125 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
126 | <citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
127 | </para> | |
128 | </refsect1> | |
129 | ||
130 | </refentry> |