man: add some basic documentation for sd-boot (#8379)

I'm sure this can be improved in various ways, but I think
it's a good start.

1 files changed, 29 insertions, 23 deletions

diff --git a/man/bootctl.xml b/man/bootctl.xml
index 7662593a70..8dc3f35d26 100644
--- a/man/bootctl.xml
+++ b/man/bootctl.xml
@@ -68,32 +68,37 @@
   <refsect1>
     <title>Description</title>
 
-    <para><command>bootctl</command> checks, updates,
-    installs or removes the boot loader from the current
-    system.</para>
+    <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>
+    boot loader on the current system.</para>
 
-    <para><command>bootctl status</command> checks and prints the
-    currently installed versions of the boot loader binaries and
-    all current EFI boot variables.</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 systemd-boot, 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>/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>/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>
+    <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>
@@ -134,8 +139,9 @@
   <refsect1>
     <title>See Also</title>
     <para>
-      <ulink url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>
-      <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">systemd boot loader interface</ulink>
+      <citerefentry><refentrytitle>sd-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>
   </refsect1>
 </refentry>