]>
Commit | Line | Data |
---|---|---|
2a5a41e8 DR |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
681eb9cf FB |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ |
4 | <!ENTITY % entities SYSTEM "custom-entities.ent" > | |
5 | %entities; | |
6 | ]> | |
2a5a41e8 DR |
7 | |
8 | <!-- | |
9 | This file is part of systemd. | |
10 | ||
11 | Copyright 2014 Didier Roche | |
12 | ||
13 | systemd is free software; you can redistribute it and/or modify it | |
14 | under the terms of the GNU Lesser General Public License as published by | |
15 | the Free Software Foundation; either version 2.1 of the License, or | |
16 | (at your option) any later version. | |
17 | ||
18 | systemd is distributed in the hope that it will be useful, but | |
19 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
21 | Lesser General Public License for more details. | |
22 | ||
23 | You should have received a copy of the GNU Lesser General Public License | |
24 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
25 | --> | |
26 | ||
27 | <refentry id="systemd-machine-id-commit" | |
798d3a52 ZJS |
28 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
29 | ||
30 | <refentryinfo> | |
31 | <title>systemd-machine-id-commit</title> | |
32 | <productname>systemd</productname> | |
33 | ||
34 | <authorgroup> | |
35 | <author> | |
36 | <contrib>Developer</contrib> | |
37 | <firstname>Didier</firstname> | |
38 | <surname>Roche</surname> | |
39 | <email>didrocks@ubuntu.com</email> | |
40 | </author> | |
41 | </authorgroup> | |
42 | </refentryinfo> | |
43 | ||
44 | <refmeta> | |
45 | <refentrytitle>systemd-machine-id-commit</refentrytitle> | |
46 | <manvolnum>1</manvolnum> | |
47 | </refmeta> | |
48 | ||
49 | <refnamediv> | |
50 | <refname>systemd-machine-id-commit</refname> | |
51 | <refpurpose>Commit transient machine ID to /etc/machine-id</refpurpose> | |
52 | </refnamediv> | |
53 | ||
54 | <refsynopsisdiv> | |
55 | <cmdsynopsis> | |
56 | <command>systemd-machine-id-commit</command> | |
57 | </cmdsynopsis> | |
58 | </refsynopsisdiv> | |
59 | ||
60 | <refsect1> | |
61 | <title>Description</title> | |
62 | ||
63 | <para><command>systemd-machine-id-commit</command> may be used to | |
64 | write on disk any transient machine ID mounted as a temporary file | |
65 | system in <filename>/etc/machine-id</filename> at boot time. See | |
66 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
67 | for more information about this file.</para> | |
68 | ||
69 | <para>This tool will execute no operation if | |
70 | <filename>/etc/machine-id</filename> doesn't contain any valid | |
71 | machine ID, isn't mounted as an independent temporary file system, | |
72 | of <filename>/etc</filename> is read-only. If those conditions are | |
73 | met, it will then write current machine ID to disk and unmount the | |
74 | transient <filename>/etc/machine-id</filename> file in a race-free | |
75 | manner to ensure that this file is always valid for other | |
76 | processes.</para> | |
77 | ||
78 | <para>Note that the traditional way to initialize the machine ID | |
79 | in <filename>/etc/machine-id</filename> is to use | |
80 | <command>systemd-machine-id-setup</command> by system installer | |
81 | tools. You can also use | |
82 | <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
83 | to initialize the machine ID on mounted (but not booted) system | |
84 | images.</para> | |
85 | </refsect1> | |
86 | ||
87 | <refsect1> | |
88 | <title>Options</title> | |
89 | ||
90 | <para>The following options are understood:</para> | |
91 | ||
92 | <variablelist> | |
93 | <varlistentry> | |
94 | <term><option>--root=<replaceable>root</replaceable></option></term> | |
95 | <listitem><para>Takes a directory path | |
96 | as an argument. All paths will be | |
97 | prefixed with the given alternate | |
98 | <replaceable>root</replaceable> path, | |
99 | including config search paths. | |
100 | </para></listitem> | |
101 | </varlistentry> | |
102 | <xi:include href="standard-options.xml" xpointer="help" /> | |
103 | <xi:include href="standard-options.xml" xpointer="version" /> | |
104 | </variablelist> | |
105 | ||
106 | </refsect1> | |
107 | ||
108 | <refsect1> | |
109 | <title>Exit status</title> | |
110 | ||
111 | <para>On success, 0 is returned, a non-zero failure code | |
112 | otherwise.</para> | |
113 | </refsect1> | |
114 | ||
115 | <refsect1> | |
116 | <title>See Also</title> | |
117 | <para> | |
118 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
119 | <citerefentry><refentrytitle>systemd-machine-id-commit.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
120 | <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
121 | <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
122 | <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
123 | </para> | |
124 | </refsect1> | |
2a5a41e8 DR |
125 | |
126 | </refentry> |