X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fkernel-install.xml;h=d4d01807a4b69df92e2e91981c4b234b0dbe91ab;hp=4634680b398a4042ade3bf0045a7d09f70847329;hb=0a6f50c0afdfc434b492493bd9efab20cbee8623;hpb=46e6e4f1e50a56d69f87653f30996766fcb23f8a

diff --git a/man/kernel-install.xml b/man/kernel-install.xml
index 4634680b3..d4d01807a 100644
--- a/man/kernel-install.xml
+++ b/man/kernel-install.xml
@@ -1,4 +1,4 @@
-<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
@@ -49,7 +49,10 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>kernel-install</command> <arg choice="req">COMMAND</arg> <arg choice="req">KERNEL VERSION</arg> <arg choice="req">KERNEL IMAGE</arg>
+      <command>kernel-install</command>
+      <arg choice="plain">COMMAND</arg>
+      <arg choice="plain"><replaceable>KERNEL-VERSION</replaceable></arg>
+      <arg choice="opt"><replaceable>KERNEL-IMAGE</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -60,16 +63,17 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       initramfs images to and from <filename>/boot</filename>.
     </para>
 
-    <para>kernel-install will execute the files located in the directory <filename>/usr/lib/kernel/install.d/</filename>
+    <para><command>kernel-install</command> will execute the files
+    located in the directory <filename>/usr/lib/kernel/install.d/</filename>
     and the local administration directory <filename>/etc/kernel/install.d/</filename>.
-    All files are collectively sorted and executed in lexical order, regardless of the directories in
-    which they live. However, files with identical file names replace each other.
+    All files are collectively sorted and executed in lexical order, regardless of the directory in
+    which they live. However, files with identical filenames replace each other.
     Files in <filename>/etc/kernel/install.d/</filename> take precedence over files with the same name
     in <filename>/usr/lib/kernel/install.d/</filename>. This can be used to override a system-supplied
     executables with a local file if needed; a symbolic link in <filename>/etc/kernel/install.d/</filename>
     with the same name as an executable in <filename>/usr/lib/kernel/install.d/</filename>,
     pointing to /dev/null, disables the executable entirely. Executables must have the
-    extension .install; other extensions are ignored.</para>
+    extension <literal>.install</literal>; other extensions are ignored.</para>
 
   </refsect1>
 
@@ -78,29 +82,50 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para>The following commands are understood:</para>
     <variablelist>
       <varlistentry>
-        <term>add &lt;KERNEL VERSION> &lt;KERNEL IMAGE></term>
+        <term><command>add <replaceable>KERNEL-VERSION</replaceable> <replaceable>KERNEL-IMAGE</replaceable></command></term>
         <listitem>
-          <para>calls every executable <filename>/usr/lib/kernel/install.d/*.install</filename>
-          and <filename>/etc/kernel/install.d/*.install</filename> with the arguments
-          "add &lt;KERNEL VERSION> <filename>/boot/&lt;MACHINE-ID>/&lt;KERNEL VERSION>/</filename>"</para>
-
-          <para>kernel-install copies &lt;KERNEL IMAGE> to
-          <filename>/boot/&lt;MACHINE-ID>/&lt;KERNEL VERSION>/linux</filename>.</para>
-
-          <para>kernel-install also creates a boot loader entry according to the boot loader specification
-          in <filename>/boot/loader/entries/&lt;MACHINE-ID>-&lt;KERNEL VERSION>.conf</filename>.
-          If the file <filename>initrd</filename> is found next to the <filename>linux</filename> file,
-          the initrd will be added to the configuration.</para>
+          <para><command>kernel-install</command> creates the directory
+          <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename>
+          and calls every executable
+          <filename>/usr/lib/kernel/install.d/*.install</filename> and
+          <filename>/etc/kernel/install.d/*.install</filename> with
+          the arguments
+          <programlisting>add <replaceable>KERNEL-VERSION</replaceable> <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename></programlisting>
+          </para>
+
+          <para>The kernel-install plugin <filename>50-depmod.install</filename> runs depmod for the <replaceable>KERNEL-VERSION</replaceable>.</para>
+
+          <para>The kernel-install plugin
+          <filename>90-loaderentry.install</filename> copies
+          <replaceable>KERNEL-IMAGE</replaceable> to
+          <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/linux</filename>.
+          It also creates a boot loader entry according to the boot
+          loader specification in
+          <filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.
+          The title of the entry is the
+          <replaceable>PRETTY_NAME</replaceable> parameter specified
+          in <filename>/etc/os-release</filename> or
+          <filename>/usr/lib/os-release</filename> (if the former is
+          missing), or "Linux
+          <replaceable>KERNEL-VERSION</replaceable>", if unset.  If
+          the file <filename>initrd</filename> is found next to the
+          <filename>linux</filename> file, the initrd will be added to
+          the configuration.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>remove &lt;KERNEL VERSION> &lt;KERNEL IMAGE></term>
-        <listitem><para>calls every executable <filename>/usr/lib/kernel/install.d/*.install</filename>
-        and <filename>/etc/kernel/install.d/*.install</filename> with the arguments:
-        "remove &lt;KERNEL VERSION> <filename>/boot/&lt;MACHINE-ID>/&lt;KERNEL VERSION>/</filename>"
-        </para>
-        <para>kernel-install removes the entire directory <filename>/boot/&lt;MACHINE-ID>/&lt;KERNEL VERSION>/</filename>
-        and the file <filename>/boot/loader/entries/&lt;MACHINE-ID>-&lt;KERNEL VERSION>.conf</filename></para>
+        <term><command>remove <replaceable>KERNEL-VERSION</replaceable></command></term>
+        <listitem>
+          <para>Calls every executable <filename>/usr/lib/kernel/install.d/*.install</filename>
+          and <filename>/etc/kernel/install.d/*.install</filename> with the arguments
+          <programlisting>remove <replaceable>KERNEL-VERSION</replaceable> <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename></programlisting>
+          </para>
+
+          <para><command>kernel-install</command> removes the entire directory
+          <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> afterwards.</para>
+
+          <para>The kernel-install plugin <filename>90-loaderentry.install</filename> removes the file
+          <filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.</para>
         </listitem>
       </varlistentry>
 
@@ -122,7 +147,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           <filename>/etc/kernel/install.d/*.install</filename>
         </term>
           <listitem>
-            <para>Drop-in files, which are executed by kernel-install.</para>
+            <para>Drop-in files which are executed by kernel-install.</para>
           </listitem>
       </varlistentry>
       <varlistentry>
@@ -131,7 +156,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           <filename>/proc/cmdline</filename>
         </term>
           <listitem>
-            <para>The contents of the file <filename>/etc/kernel/cmdline</filename> specifies the kernel command line to use.
+            <para>The content of the file <filename>/etc/kernel/cmdline</filename> specifies the kernel command line to use.
             If that file does not exist, <filename>/proc/cmdline</filename> is used.</para>
           </listitem>
       </varlistentry>
@@ -140,15 +165,16 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           <filename>/etc/machine-id</filename>
         </term>
           <listitem>
-            <para>The contents of the file specifies the machine identifaction &lt;MACHINE-ID>.</para>
+            <para>The content of the file specifies the machine identification <replaceable>MACHINE-ID</replaceable>.</para>
           </listitem>
       </varlistentry>
       <varlistentry>
         <term>
           <filename>/etc/os-release</filename>
+          <filename>/usr/lib/os-release</filename>
         </term>
           <listitem>
-            <para>The contents of the file specifies the the operating system id &lt;OS-ID>.</para>
+            <para>The content of the file specifies the operating system title <replaceable>PRETTY_NAME</replaceable>.</para>
           </listitem>
       </varlistentry>
     </variablelist>