man/kernel-install.xml

   1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2013 Harald Hoyer
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="kernel-install">
  25
  26   <refentryinfo>
  27     <title>kernel-install</title>
  28     <productname>systemd</productname>
  29
  30     <authorgroup>
  31       <author>
  32         <contrib>Developer</contrib>
  33         <firstname>Harald</firstname>
  34         <surname>Hoyer</surname>
  35         <email>harald@redhat.com</email>
  36       </author>
  37     </authorgroup>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>kernel-install</refentrytitle>
  42     <manvolnum>8</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>kernel-install</refname>
  47     <refpurpose>Add and remove kernel and initramfs images to and from /boot</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <cmdsynopsis>
  52       <command>kernel-install</command>
  53       <arg choice="plain">COMMAND</arg>
  54       <arg choice="plain"><replaceable>KERNEL-VERSION</replaceable></arg>
  55       <arg choice="opt"><replaceable>KERNEL-IMAGE</replaceable></arg>
  56     </cmdsynopsis>
  57   </refsynopsisdiv>
  58
  59   <refsect1>
  60     <title>Description</title>
  61     <para>
  62       <command>kernel-install</command> is used to install and remove kernel and
  63       initramfs images to and from <filename>/boot</filename>.
  64     </para>
  65
  66     <para><command>kernel-install</command> will execute the files
  67     located in the directory <filename>/usr/lib/kernel/install.d/</filename>
  68     and the local administration directory <filename>/etc/kernel/install.d/</filename>.
  69     All files are collectively sorted and executed in lexical order, regardless of the directory in
  70     which they live. However, files with identical filenames replace each other.
  71     Files in <filename>/etc/kernel/install.d/</filename> take precedence over files with the same name
  72     in <filename>/usr/lib/kernel/install.d/</filename>. This can be used to override a system-supplied
  73     executables with a local file if needed; a symbolic link in <filename>/etc/kernel/install.d/</filename>
  74     with the same name as an executable in <filename>/usr/lib/kernel/install.d/</filename>,
  75     pointing to <filename>/dev/null</filename>, disables the executable entirely. Executables must have the
  76     extension <literal>.install</literal>; other extensions are ignored.</para>
  77
  78     <para>An executable should return <constant>0</constant> on success. It may also
  79     return <constant>77</constant> to cause the whole operation to terminate
  80     (executables later in lexical order will be skipped).</para>
  81   </refsect1>
  82
  83   <refsect1>
  84     <title>Commands</title>
  85     <para>The following commands are understood:</para>
  86     <variablelist>
  87       <varlistentry>
  88         <term><command>add <replaceable>KERNEL-VERSION</replaceable> <replaceable>KERNEL-IMAGE</replaceable></command></term>
  89         <listitem>
  90           <para><command>kernel-install</command> creates the directory
  91           <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename>
  92           and calls executables from
  93           <filename>/usr/lib/kernel/install.d/*.install</filename> and
  94           <filename>/etc/kernel/install.d/*.install</filename> with
  95           the arguments
  96           <programlisting>add <replaceable>KERNEL-VERSION</replaceable> \
  97     <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> <replaceable>KERNEL-IMAGE</replaceable></programlisting>
  98           </para>
  99
 100           <para>The kernel-install plugin <filename>50-depmod.install</filename> runs depmod for the <replaceable>KERNEL-VERSION</replaceable>.</para>
 101
 102           <para>The kernel-install plugin
 103           <filename>90-loaderentry.install</filename> copies
 104           <replaceable>KERNEL-IMAGE</replaceable> to
 105           <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/linux</filename>.
 106           It also creates a boot loader entry according to the boot
 107           loader specification in
 108           <filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.
 109           The title of the entry is the
 110           <replaceable>PRETTY_NAME</replaceable> parameter specified
 111           in <filename>/etc/os-release</filename> or
 112           <filename>/usr/lib/os-release</filename> (if the former is
 113           missing), or "Linux
 114           <replaceable>KERNEL-VERSION</replaceable>", if unset.  If
 115           the file <filename>initrd</filename> is found next to the
 116           <filename>linux</filename> file, the initrd will be added to
 117           the configuration.</para>
 118         </listitem>
 119       </varlistentry>
 120       <varlistentry>
 121         <term><command>remove <replaceable>KERNEL-VERSION</replaceable></command></term>
 122         <listitem>
 123           <para>Calls executables from <filename>/usr/lib/kernel/install.d/*.install</filename>
 124           and <filename>/etc/kernel/install.d/*.install</filename> with the arguments
 125           <programlisting>remove <replaceable>KERNEL-VERSION</replaceable> <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename></programlisting>
 126           </para>
 127
 128           <para><command>kernel-install</command> removes the entire directory
 129           <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> afterwards.</para>
 130
 131           <para>The kernel-install plugin <filename>90-loaderentry.install</filename> removes the file
 132           <filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.</para>
 133         </listitem>
 134       </varlistentry>
 135
 136     </variablelist>
 137
 138   </refsect1>
 139
 140   <refsect1>
 141     <title>Exit status</title>
 142     <para>If every executable returns 0 or 77, 0 is returned, and a non-zero failure code otherwise.</para>
 143   </refsect1>
 144
 145   <refsect1>
 146     <title>Files</title>
 147     <variablelist>
 148       <varlistentry>
 149         <term>
 150           <filename>/usr/lib/kernel/install.d/*.install</filename>
 151           <filename>/etc/kernel/install.d/*.install</filename>
 152         </term>
 153           <listitem>
 154             <para>Drop-in files which are executed by kernel-install.</para>
 155           </listitem>
 156       </varlistentry>
 157       <varlistentry>
 158         <term>
 159           <filename>/etc/kernel/cmdline</filename>
 160           <filename>/proc/cmdline</filename>
 161         </term>
 162           <listitem>
 163             <para>The content of the file <filename>/etc/kernel/cmdline</filename> specifies the kernel command line to use.
 164             If that file does not exist, <filename>/proc/cmdline</filename> is used.</para>
 165           </listitem>
 166       </varlistentry>
 167       <varlistentry>
 168         <term>
 169           <filename>/etc/machine-id</filename>
 170         </term>
 171           <listitem>
 172             <para>The content of the file specifies the machine identification <replaceable>MACHINE-ID</replaceable>.</para>
 173           </listitem>
 174       </varlistentry>
 175       <varlistentry>
 176         <term>
 177           <filename>/etc/os-release</filename>
 178           <filename>/usr/lib/os-release</filename>
 179         </term>
 180           <listitem>
 181             <para>The content of the file specifies the operating system title <replaceable>PRETTY_NAME</replaceable>.</para>
 182           </listitem>
 183       </varlistentry>
 184     </variablelist>
 185   </refsect1>
 186
 187   <refsect1>
 188     <title>See Also</title>
 189     <para>
 190       <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 191       <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 192       <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>
 193     </para>
 194   </refsect1>
 195
 196 </refentry>