mirror of
https://github.com/systemd/systemd.git
synced 2024-12-22 17:35:35 +03:00
machine-id-commit: add man pages
Add man pages for systemd-machine-id-commit.service and systemd-machine-id-commit.
This commit is contained in:
Didier Roche
Lennart Poettering
parent
a1405db67c
commit
2a5a41e86b
@ -75,6 +75,7 @@ MANPAGES += \
|
||||
man/systemd-inhibit.1 \
|
||||
man/systemd-initctl.service.8 \
|
||||
man/systemd-journald.service.8 \
|
||||
man/systemd-machine-id-commit.1 \
|
||||
man/systemd-machine-id-setup.1 \
|
||||
man/systemd-notify.1 \
|
||||
man/systemd-nspawn.1 \
|
||||
@ -213,6 +214,7 @@ MANPAGES_ALIAS += \
|
||||
man/systemd-journald.8 \
|
||||
man/systemd-journald.socket.8 \
|
||||
man/systemd-kexec.service.8 \
|
||||
man/systemd-machine-id-commit.service.8 \
|
||||
man/systemd-poweroff.service.8 \
|
||||
man/systemd-reboot.service.8 \
|
||||
man/systemd-remount-fs.8 \
|
||||
|
||||
101
man/systemd-machine-id-commit.service.xml
Normal file
101
man/systemd-machine-id-commit.service.xml
Normal file
@ -0,0 +1,101 @@
|
||||
<?xml version="1.0"?>
|
||||
<!--*-nxml-*-->
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
<!--
|
||||
This file is part of systemd.
|
||||
|
||||
Copyright 2014 Didier Roche
|
||||
|
||||
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/>.
|
||||
-->
|
||||
<refentry id="systemd-machine-id-commit.service">
|
||||
|
||||
<refentryinfo>
|
||||
<title>systemd-machine-id-commit.service</title>
|
||||
<productname>systemd</productname>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<contrib>Developer</contrib>
|
||||
<firstname>Didier</firstname>
|
||||
<surname>Roche</surname>
|
||||
<email>didrocks@ubuntu.com</email>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>systemd-machine-id-commit.service</refentrytitle>
|
||||
<manvolnum>8</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>systemd-machine-id-commit.service</refname>
|
||||
<refpurpose>Commit transient machine-id to disk</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<para><filename>systemd-machine-id-commit.service</filename></para>
|
||||
<para><filename>/usr/lib/systemd/systemd-machine-id-commit</filename></para>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<para><filename>systemd-machine-id-commit.service</filename> is
|
||||
a service responsible for commiting any transient
|
||||
<filename>/etc/machine-id</filename> file to a writable file
|
||||
system. See
|
||||
<citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
||||
for more information about this file.</para>
|
||||
|
||||
<para>This service is started shortly after
|
||||
<filename>local-fs.target</filename> if
|
||||
<filename>/etc/machine-id</filename> is an independent mount
|
||||
point (probably a tmpfs one) and /etc is writable.
|
||||
<command>systemd-machine-id-commit</command> will then
|
||||
write current machine ID to disk and unmount the transient
|
||||
<filename>/etc/machine-id</filename> file in a race-free
|
||||
manner to ensure that file is always valid for other
|
||||
processes.</para>
|
||||
|
||||
<para>Note that the traditional way to initialize the machine
|
||||
ID in <filename>/etc/machine-id</filename> is to use
|
||||
<command>systemd-machine-id-setup</command> by system
|
||||
installer tools. You can also use
|
||||
<citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
to initialize the machine ID on mounted (but not
|
||||
booted) system images. The main use case for that service is
|
||||
<filename>/etc/machine-id</filename> being an empty file at
|
||||
boot and initrd chaining to systemd giving it a read only file
|
||||
system that will be turned read-write later during the boot
|
||||
process.</para>
|
||||
|
||||
<para>There is no consequence if that service fails other than
|
||||
a newer machine-id will be generated during next system boot.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd-machine-id-commit</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
125
man/systemd-machine-id-commit.xml
Normal file
125
man/systemd-machine-id-commit.xml
Normal file
@ -0,0 +1,125 @@
|
||||
<?xml version='1.0'?> <!--*-nxml-*-->
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
|
||||
<!--
|
||||
This file is part of systemd.
|
||||
|
||||
Copyright 2014 Didier Roche
|
||||
|
||||
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/>.
|
||||
-->
|
||||
|
||||
<refentry id="systemd-machine-id-commit"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
|
||||
<refentryinfo>
|
||||
<title>systemd-machine-id-commit</title>
|
||||
<productname>systemd</productname>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<contrib>Developer</contrib>
|
||||
<firstname>Didier</firstname>
|
||||
<surname>Roche</surname>
|
||||
<email>didrocks@ubuntu.com</email>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>systemd-machine-id-commit</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>systemd-machine-id-commit</refname>
|
||||
<refpurpose>Commit transient machine ID to /etc/machine-id</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>systemd-machine-id-commit</command>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<para><command>systemd-machine-id-commit</command> may
|
||||
be used to write on disk any transient machine ID
|
||||
mounted as a temporary file system in
|
||||
<filename>/etc/machine-id</filename> at boot time. See
|
||||
<citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
||||
for more information about this file.</para>
|
||||
|
||||
<para>This tool will execute no operation if
|
||||
<filename>/etc/machine-id</filename> doesn't contain any
|
||||
valid machine ID, isn't mounted as an independent temporary
|
||||
file system, of <filename>/etc</filename> is read-only. If
|
||||
those conditions are met, it will then write current machine ID
|
||||
to disk and unmount the transient
|
||||
<filename>/etc/machine-id</filename> file in a race-free
|
||||
manner to ensure that this file is always valid for other
|
||||
processes.</para>
|
||||
|
||||
<para>Note that the traditional way to initialize the machine
|
||||
ID in <filename>/etc/machine-id</filename> is to use
|
||||
<command>systemd-machine-id-setup</command> by system
|
||||
installer tools. You can also 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>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
|
||||
code otherwise.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd-machine-id-commit.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
Loading…
Reference in New Issue
Block a user