SymbX/systemd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #9307 from yuwata/man-sd-boot

Browse Source 
man: use systemd-boot instead of sd-boot
This commit is contained in:
Zbigniew Jędrzejewski-Szmek
2018-06-15 16:17:28 +02:00
committed by GitHub
parent 88f375b8c2 c779b82a50
commit db13f206db
4 changed files with 71 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/bootctl.xml
+54 -44
View File
@@ -25,19 +25,9 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> status</command>
</cmdsynopsis>
<cmdsynopsis>
<command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> list</command>
</cmdsynopsis>
<cmdsynopsis>
<command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> update</command>
</cmdsynopsis>
<cmdsynopsis>
<command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> install</command>
</cmdsynopsis>
<cmdsynopsis>
<command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> remove</command>
<command>bootctl</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="req">COMMAND</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -46,35 +36,8 @@
<para><command>bootctl</command> can check the EFI boot loader status, list
available entries, and install, update, or remove the
<citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>
boot loader on the current system.</para>
<para><command>bootctl status</command> shows the currently installed versions of
the boot loader binaries and all current EFI boot variables.</para>
<para><command>bootctl list</command> displays all configured boot loader entries.
</para>
<para><command>bootctl update</command> updates all installed versions of
<citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
if the current version is newer than the version installed in the EFI system
partition. This also includes the EFI default/fallback loader at
<filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. A
systemd-boot entry in the EFI boot variables is created if there is no current
entry. The created entry will be added to the end of the boot order list.</para>
<para><command>bootctl install</command> installs systemd-boot into the EFI
system partition. A copy of systemd-boot will be stored as the EFI
default/fallback loader at
<filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. A
systemd-boot entry in the EFI boot variables is created and added to the top of
the boot order list.</para>
<para><command>bootctl remove</command> removes all installed versions of
systemd-boot from the EFI system partition, and removes systemd-boot from the EFI
boot variables.</para>
<para>If no command is passed, <command>status</command> is implied.</para>
</refsect1>
<refsect1>
@@ -106,16 +69,63 @@
</variablelist>
</refsect1>
<refsect1>
<title>Commands</title>
<variablelist>
<varlistentry>
<term><option>status</option></term>
<listitem><para>Shows the currently installed versions of the boot loader binaries and all current
EFI boot variables. If no command is specified, this is the implied default.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>list</option></term>
<listitem><para>Shows all configured boot loader entries.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>update</option></term>
<listitem><para>Updates all installed versions of
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
if the current version is newer than the version installed in the EFI system
partition. This also includes the EFI default/fallback loader at
<filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. A
systemd-boot entry in the EFI boot variables is created if there is no current
entry. The created entry will be added to the end of the boot order list.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>install</option></term>
<listitem><para>Installs systemd-boot into the EFI system partition. A copy of systemd-boot will
be stored as the EFI default/fallback loader at
<filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. A systemd-boot entry in
the EFI boot variables is created and added to the top of the boot order list.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>remove</option></term>
<listitem><para>Removes all installed versions of systemd-boot from the EFI system partition,
and removes systemd-boot from the EFI boot variables.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
<para>On success, 0 is returned, a non-zero failure code otherwise.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<ulink url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader Specification</ulink>,
<ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface</ulink>
</para>
man/loader.conf.xml
+4 -4
View File
@@ -18,7 +18,7 @@
<refnamediv>
<refname>loader.conf</refname>
<refpurpose>Configuration file for sd-boot</refpurpose>
<refpurpose>Configuration file for systemd-boot</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -31,7 +31,7 @@
<title>Description</title>
<para>
<citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>
will read <filename>/loader/loader.conf</filename> and any files with the
<literal>.conf</literal> extension under
<filename>/loader/loader.conf.d/</filename> on the EFI system partition (ESP).
@@ -72,7 +72,7 @@
<para>If the timeout is disabled, the default entry will be booted
immediately. The menu can be shown by pressing and holding a key before
sd-boot is launched.</para>
systemd-boot is launched.</para>
</listitem>
</varlistentry>
@@ -178,7 +178,7 @@ editor no
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
man/rules/meson.build
+1 -1
View File
@@ -47,7 +47,6 @@ manpages = [
['resolvectl', '1', ['resolvconf'], 'ENABLE_RESOLVE'],
['resolved.conf', '5', ['resolved.conf.d'], 'ENABLE_RESOLVE'],
['runlevel', '8', [], 'ENABLE_UTMP'],
['sd-boot', '7', [], 'ENABLE_EFI'],
['sd-bus-errors',
'3',
['SD_BUS_ERROR_ACCESS_DENIED',
@@ -541,6 +540,7 @@ manpages = [
['systemd-ask-password', '1', [], ''],
['systemd-backlight@.service', '8', ['systemd-backlight'], 'ENABLE_BACKLIGHT'],
['systemd-binfmt.service', '8', ['systemd-binfmt'], 'ENABLE_BINFMT'],
['systemd-boot', '7', ['sd-boot'], 'ENABLE_EFI'],
['systemd-cat', '1', [], ''],
['systemd-cgls', '1', [], ''],
['systemd-cgtop', '1', [], ''],
man/sd-boot.xml → man/systemd-boot.xml
+12 -11
View File
@@ -4,19 +4,20 @@
<!-- SPDX-License-Identifier: LGPL-2.1+ -->
<refentry id="sd-boot" conditional='ENABLE_EFI'
<refentry id="systemd-boot" conditional='ENABLE_EFI'
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>sd-boot</title>
<title>systemd-boot</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>sd-boot</refentrytitle>
<refentrytitle>systemd-boot</refentrytitle>
<manvolnum>7</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-boot</refname>
<refname>sd-boot</refname>
<refpurpose>A simple UEFI boot manager</refpurpose>
</refnamediv>
@@ -27,15 +28,15 @@
<para><command>systemd-boot</command> or <command>sd-boot</command> is a simple
UEFI boot manager, previously known as <command>gummiboot</command>. It provides
a graphical menu to select the entry to boot and an editor for the kernel command
line. sd-boot is only useful on machines using UEFI.
line. systemd-boot is only useful on machines using UEFI.
</para>
<para>sd-boot loads information from the EFI system partition (ESP), usually
<para>systemd-boot loads information from the EFI system partition (ESP), usually
mounted at <filename>/boot</filename>, <filename>/efi</filename>, or
<filename>/boot/efi</filename>. Configuration file fragments, kernels, initrds,
other EFI images need to reside on the ESP. Linux kernels must be built with
<option>CONFIG_EFI_STUB</option> to be able to be directly executed as an EFI
image. sd-boot will automatically list other boot entries registered as EFI boot
image. systemd-boot will automatically list other boot entries registered as EFI boot
variables, and a list of kernels from configuration files following the <ulink
url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader
Specification</ulink> located under <filename>/loader/entries/</filename> on the
@@ -46,9 +47,9 @@
with the Boot Loader Specification.
<citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
may be used from a running system to locate the ESP, list available entries, and
install sd-boot itself.</para>
install systemd-boot itself.</para>
<para>sd-boot will provide information about the time spent in UEFI firmware
<para>systemd-boot will provide information about the time spent in UEFI firmware
using the
<ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface</ulink>.
This information can be displayed using
@@ -59,7 +60,7 @@
<refsect1>
<title>Configuration</title>
<para>sd-boot reads configuration like the timeout and default entry from
<para>systemd-boot reads configuration like the timeout and default entry from
<filename>/loader/loader.conf</filename> on the ESP and from EFI variables. See
<citerefentry><refentrytitle>loader.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
@@ -111,7 +112,7 @@
<varlistentry>
<term>v</term>
<listitem><para>Show sd-boot, UEFI, and firmware versions</para></listitem>
<listitem><para>Show systemd-boot, UEFI, and firmware versions</para></listitem>
</varlistentry>
<varlistentry>
@@ -213,7 +214,7 @@
</varlistentry>
</variablelist>
<para>Note that unless configured otherwise in the UEFI firmware, sd-boot will
<para>Note that unless configured otherwise in the UEFI firmware, systemd-boot will
use the US keyboard layout, so key labels might not match for keys like +/-.
</para>
</refsect1>