diff options
author | Lennart Poettering <lennart@poettering.net> | 2014-07-07 18:45:53 +0200 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2014-07-07 18:49:17 +0200 |
commit | 30f10abf42f9e4d251a0b45b07812aafdef6be7c (patch) | |
tree | be041a8917b3f254b2bee678c40b6457d1b4153f | |
parent | ed3e4a3fd96891b5e7015723978e78cd21efd4fe (diff) |
man: document systemd-firstboot(1)
-rw-r--r-- | Makefile-man.am | 7 | ||||
-rw-r--r-- | man/hostname.xml | 10 | ||||
-rw-r--r-- | man/hostnamectl.xml | 10 | ||||
-rw-r--r-- | man/locale.conf.xml | 11 | ||||
-rw-r--r-- | man/localectl.xml | 8 | ||||
-rw-r--r-- | man/localtime.xml | 8 | ||||
-rw-r--r-- | man/machine-id.xml | 8 | ||||
-rw-r--r-- | man/systemd-firstboot.xml | 286 | ||||
-rw-r--r-- | man/systemd-machine-id-setup.xml | 10 | ||||
-rw-r--r-- | man/timedatectl.xml | 8 |
10 files changed, 352 insertions, 14 deletions
diff --git a/Makefile-man.am b/Makefile-man.am index 5c289dda2a..e6043f1ff8 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -63,6 +63,7 @@ MANPAGES += \ man/systemd-delta.1 \ man/systemd-detect-virt.1 \ man/systemd-efi-boot-generator.8 \ + man/systemd-firstboot.8 \ man/systemd-fsck@.service.8 \ man/systemd-fstab-generator.8 \ man/systemd-getty-generator.8 \ @@ -193,6 +194,7 @@ MANPAGES_ALIAS += \ man/systemd-ask-password-console.path.8 \ man/systemd-ask-password-wall.path.8 \ man/systemd-ask-password-wall.service.8 \ + man/systemd-firstboot.service.8 \ man/systemd-fsck-root.service.8 \ man/systemd-fsck.8 \ man/systemd-hibernate.service.8 \ @@ -298,6 +300,7 @@ man/sd_notifyf.3: man/sd_notify.3 man/systemd-ask-password-console.path.8: man/systemd-ask-password-console.service.8 man/systemd-ask-password-wall.path.8: man/systemd-ask-password-console.service.8 man/systemd-ask-password-wall.service.8: man/systemd-ask-password-console.service.8 +man/systemd-firstboot.service.8: man/systemd-firstboot.8 man/systemd-fsck-root.service.8: man/systemd-fsck@.service.8 man/systemd-fsck.8: man/systemd-fsck@.service.8 man/systemd-hibernate.service.8: man/systemd-suspend.service.8 @@ -553,6 +556,9 @@ man/systemd-ask-password-wall.path.html: man/systemd-ask-password-console.servic man/systemd-ask-password-wall.service.html: man/systemd-ask-password-console.service.html $(html-alias) +man/systemd-firstboot.service.html: man/systemd-firstboot.html + $(html-alias) + man/systemd-fsck-root.service.html: man/systemd-fsck@.service.html $(html-alias) @@ -1600,6 +1606,7 @@ EXTRA_DIST += \ man/systemd-delta.xml \ man/systemd-detect-virt.xml \ man/systemd-efi-boot-generator.xml \ + man/systemd-firstboot.xml \ man/systemd-fsck@.service.xml \ man/systemd-fstab-generator.xml \ man/systemd-getty-generator.xml \ diff --git a/man/hostname.xml b/man/hostname.xml index a8648c5291..2f949dedd3 100644 --- a/man/hostname.xml +++ b/man/hostname.xml @@ -73,8 +73,11 @@ <para>You may use <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - to change the value of this file from the command - line.</para> + to change the value of this file during runtime from + the command line. Use + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> + to initialize it on mounted (but not booted) system + images.</para> </refsect1> <refsect1> @@ -95,7 +98,8 @@ <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml index 4e456eb8f9..7729ef692a 100644 --- a/man/hostnamectl.xml +++ b/man/hostnamectl.xml @@ -84,7 +84,12 @@ for more information. The pretty hostname, chassis type, and icon name are stored in <filename>/etc/machine-info</filename>, see - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + + <para>Use + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> + to initialize the system host name for mounted (but + not booted) system images.</para> </refsect1> <refsect1> @@ -236,7 +241,8 @@ <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/locale.conf.xml b/man/locale.conf.xml index e97092102c..67bcc18e2a 100644 --- a/man/locale.conf.xml +++ b/man/locale.conf.xml @@ -96,6 +96,13 @@ configuration files might be checked for locale configuration as well, however only as fallback.</para> + + <para><citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + may be used to alter the settings in this file during + runtime from the command line. Use + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> + to initialize them on mounted (but not booted) system + images.</para> </refsect1> <refsect1> @@ -142,7 +149,9 @@ LC_MESSAGES=en_US.UTF-8</programlisting> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/localectl.xml b/man/localectl.xml index 9c32c794aa..38e73c794e 100644 --- a/man/localectl.xml +++ b/man/localectl.xml @@ -73,6 +73,11 @@ UI before the user logs in, such as the display manager, as well as the default for users after login.</para> + + <para>Use + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> + to initialize the system locale for mounted (but not + booted) system images.</para> </refsect1> <refsect1> @@ -233,7 +238,8 @@ The XKB Configuration Guide </ulink>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/localtime.xml b/man/localtime.xml index dbf2379e7d..2d6372026a 100644 --- a/man/localtime.xml +++ b/man/localtime.xml @@ -86,7 +86,10 @@ <para>You may use <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to change the settings of this file from the command - line.</para> + line during runtime. Use + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> + to initialize the time zone on mounted (but not + booted) system images.</para> </refsect1> <refsect1> @@ -96,7 +99,8 @@ <citerefentry><refentrytitle>tzset</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/machine-id.xml b/man/machine-id.xml index 4b4759e48d..725370d32d 100644 --- a/man/machine-id.xml +++ b/man/machine-id.xml @@ -85,7 +85,10 @@ <para>The <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool may be used by installer tools to initialize the - machine ID at install time.</para> + machine ID at install time. Use + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> + to initialize it on mounted (but not booted) system + images.</para> </refsect1> <refsect1> @@ -138,7 +141,8 @@ id[8] = (id[8] & 0x3F) | 0x80;</programlisting> <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> diff --git a/man/systemd-firstboot.xml b/man/systemd-firstboot.xml new file mode 100644 index 0000000000..42fd753f53 --- /dev/null +++ b/man/systemd-firstboot.xml @@ -0,0 +1,286 @@ +<?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 Lennart Poettering + + 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-firstboot" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>systemd-firstboot</title> + <productname>systemd</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Lennart</firstname> + <surname>Poettering</surname> + <email>lennart@poettering.net</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-firstboot</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-firstboot</refname> + <refname>systemd-firstboot.service</refname> + <refpurpose>Initialize basic system settings on or before the first boot-up of a system</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>systemd-firstboot</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> + </cmdsynopsis> + + <para><filename>systemd-firstboot.service</filename></para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>systemd-firstboot</command> initializes + the most basic system settings interactively on the + first boot, or optionally non-interactively when a + system image is created. The following settings may be + set up:</para> + + <itemizedlist> + <listitem><para>The system locale, more + specifically the two locale variables + <varname>LANG=</varname> and + <varname>LC_MESSAGES</varname></para></listitem> + + <listitem><para>The system time zone</para></listitem> + + <listitem><para>The system host name</para></listitem> + + <listitem><para>The machine ID of the system</para></listitem> + + <listitem><para>The root user's password</para></listitem> + </itemizedlist> + + <para>Each of the fields may either be queried + interactively from the users, set non-interactively on + the tool's command line, or be copied from a host + system that is used to set up the system image.</para> + + <para>If a setting is already initialized it will not + be overwritten and the user will not be prompted for + the setting.</para> + + <para>Note that this tool operates directly on the + file system and does not involve any running system + services, unlike + <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + or + <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. This + allows <command>systemd-firstboot</command> to operate + on mounted but not booted disk images and in early + boot. It is not recommended to use + <command>systemd-firsboot</command> on the running + system while it is up.</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. This is + useful to operate on a system image + mounted to the specified directory + instead of the host system itself. + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--locale=<replaceable>LOCALE</replaceable></option></term> + <term><option>--locale-messages=<replaceable>LOCALE</replaceable></option></term> + + <listitem><para>Sets the system + locale, more specifically the + <varname>LANG=</varname> and + <varname>LC_MESSAGES</varname> + settings. The argument should be a + valid locale identifier, such as + <literal>de_DE.UTF-8</literal>. This + controls the + <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + configuration file.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--timezone=<replaceable>TIMEZONE</replaceable></option></term> + + <listitem><para>Sets the system time + zone. The argument should be a valid + time zone identifier, such as + <literal>Europe/Berlin</literal>. This + controls the + <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry> + symlink.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--hostname=<replaceable>HOSTNAME</replaceable></option></term> + + <listitem><para>Sets the system + hostname. The argument should be a + host name, compatible with DNS. This + controls the + <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry> + configuration file.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--machine-id=<replaceable>ID</replaceable></option></term> + + <listitem><para>Sets the system's machine ID. This + controls the + <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> + file.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--root-password=<replaceable>PASSWORD</replaceable></option></term> + <term><option>--root-password-file=<replaceable>PATH</replaceable></option></term> + + <listitem><para>Sets the password of + the system's root user. This creates a + <citerefentry><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry> + file. This setting exists in two + forms: + <option>--root-password=</option> + accepts the password to set directly + on the command line, + <option>--root-password-file=</option> + reads it from a file. Note that + it is not recommended specifying + passwords on the command line as other + users might be able to see them + simply by invoking + <citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--prompt-locale</option></term> + <term><option>--prompt-timezone</option></term> + <term><option>--prompt-hostname</option></term> + <term><option>--prompt-root-password</option></term> + + <para>Prompt the user interactively + for a specific basic setting. Note + that any explicit configuration + settings specified on the command line + take precedence, and the user is not + prompted for it.</para> + </varlistentry> + + <varlistentry> + <term><option>--prompt</option></term> + + <para>Query the user for locale, + timezone, hostname and root + password. This is equivalent to + specifiying + <option>--prompt-locale</option>, + <option>--prompt-timezone</option>, + <option>--prompt-hostname</option>, + <option>--prompt-root-password</option> + in combination.</para> + </varlistentry> + + <varlistentry> + <term><option>--copy-locale</option></term> + <term><option>--copy-timezone</option></term> + <term><option>--copy-root-password</option></term> + + <para>Copy a specific basic setting + from the host. This only works in + combination with + <option>--root=</option> (see + above).</para> + </varlistentry> + + <varlistentry> + <term><option>--copy</option></term> + + <para>Copy locale, time zone and root + password from the host. This is + equivalent to specifiying + <option>--copy-locale</option>, + <option>--copy-timezone</option>, + <option>--copy-root-password</option> + in combination.</para> + </varlistentry> + + <varlistentry> + <term><option>--setup-machine-id</option></term> + + <para>Initialize the system's machine + ID to a random ID. This only works + combination with + <option>--root=</option>.</para> + </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>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/systemd-machine-id-setup.xml b/man/systemd-machine-id-setup.xml index 62630fbcab..28352e357f 100644 --- a/man/systemd-machine-id-setup.xml +++ b/man/systemd-machine-id-setup.xml @@ -81,13 +81,18 @@ UUID passed is sufficiently unique and is different for every booted instanced of the VM.</para> - <para>Similarly, if run inside a Linux container + <para>Similar, if run inside a Linux container environment and a UUID is set for the container this is used to initialize the machine ID. For details see the documentation of the <ulink 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> @@ -123,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> diff --git a/man/timedatectl.xml b/man/timedatectl.xml index ee75d423d7..fbd6600802 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -60,6 +60,11 @@ <para><command>timedatectl</command> may be used to query and change the system clock and its settings.</para> + + <para>Use + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> + to initialize the system time zone for mounted (but not + booted) system images.</para> </refsect1> <refsect1> @@ -240,7 +245,8 @@ chronyd.service - NTP client/server <citerefentry><refentrytitle>date</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> </refsect1> |