summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorYu Watanabe <watanabe.yu+github@gmail.com>2018-06-15 15:40:12 +0900
committerYu Watanabe <watanabe.yu+github@gmail.com>2018-06-15 15:40:12 +0900
commitc779b82a5093b08e8bc69286400bb183e9e02034 (patch)
treec353975e1cea73f77978044594078192c307da91 /man
parent70c8db755558927bdea56e9571c5d71300a81e8e (diff)
downloadsystemd-c779b82a5093b08e8bc69286400bb183e9e02034.tar.gz
man: re-format man page for bootctl
Diffstat (limited to 'man')
-rw-r--r--man/bootctl.xml94
1 files changed, 52 insertions, 42 deletions
diff --git a/man/bootctl.xml b/man/bootctl.xml
index cd7d83ea67..0f8d0e0147 100644
--- a/man/bootctl.xml
+++ b/man/bootctl.xml
@@ -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>
@@ -48,33 +38,6 @@
available entries, and install, update, or remove the
<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>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>
-
- <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>
@@ -107,9 +70,56 @@
</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>