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">
6 SPDX-License-Identifier: LGPL-2.1+
8 Copyright 2013 Harald Hoyer
11 <refentry id=
"kernel-install">
14 <title>kernel-install
</title>
15 <productname>systemd
</productname>
19 <contrib>Developer
</contrib>
20 <firstname>Harald
</firstname>
21 <surname>Hoyer
</surname>
22 <email>harald@redhat.com
</email>
28 <refentrytitle>kernel-install
</refentrytitle>
29 <manvolnum>8</manvolnum>
33 <refname>kernel-install
</refname>
34 <refpurpose>Add and remove kernel and initramfs images to and from /boot
</refpurpose>
39 <command>kernel-install
</command>
40 <arg choice=
"plain">COMMAND
</arg>
41 <arg choice=
"plain"><replaceable>KERNEL-VERSION
</replaceable></arg>
42 <arg choice=
"opt"><replaceable>KERNEL-IMAGE
</replaceable></arg>
47 <title>Description
</title>
49 <command>kernel-install
</command> is used to install and remove kernel and
50 initramfs images to and from
<filename>/boot
</filename>.
53 <para><command>kernel-install
</command> will execute the files
54 located in the directory
<filename>/usr/lib/kernel/install.d/
</filename>
55 and the local administration directory
<filename>/etc/kernel/install.d/
</filename>.
56 All files are collectively sorted and executed in lexical order, regardless of the directory in
57 which they live. However, files with identical filenames replace each other.
58 Files in
<filename>/etc/kernel/install.d/
</filename> take precedence over files with the same name
59 in
<filename>/usr/lib/kernel/install.d/
</filename>. This can be used to override a system-supplied
60 executables with a local file if needed; a symbolic link in
<filename>/etc/kernel/install.d/
</filename>
61 with the same name as an executable in
<filename>/usr/lib/kernel/install.d/
</filename>,
62 pointing to
<filename>/dev/null
</filename>, disables the executable entirely. Executables must have the
63 extension
<literal>.install
</literal>; other extensions are ignored.
</para>
65 <para>An executable should return
<constant>0</constant> on success. It may also
66 return
<constant>77</constant> to cause the whole operation to terminate
67 (executables later in lexical order will be skipped).
</para>
71 <title>Commands
</title>
72 <para>The following commands are understood:
</para>
75 <term><command>add
<replaceable>KERNEL-VERSION
</replaceable> <replaceable>KERNEL-IMAGE
</replaceable></command></term>
77 <para><command>kernel-install
</command> creates the directory
78 <filename>/boot/
<replaceable>MACHINE-ID
</replaceable>/
<replaceable>KERNEL-VERSION
</replaceable>/
</filename>
79 and calls executables from
80 <filename>/usr/lib/kernel/install.d/*.install
</filename> and
81 <filename>/etc/kernel/install.d/*.install
</filename> with
83 <programlisting>add
<replaceable>KERNEL-VERSION
</replaceable> \
84 <filename>/boot/
<replaceable>MACHINE-ID
</replaceable>/
<replaceable>KERNEL-VERSION
</replaceable>/
</filename> <replaceable>KERNEL-IMAGE
</replaceable></programlisting>
87 <para>The kernel-install plugin
<filename>50-depmod.install
</filename> runs depmod for the
<replaceable>KERNEL-VERSION
</replaceable>.
</para>
89 <para>The kernel-install plugin
90 <filename>90-loaderentry.install
</filename> copies
91 <replaceable>KERNEL-IMAGE
</replaceable> to
92 <filename>/boot/
<replaceable>MACHINE-ID
</replaceable>/
<replaceable>KERNEL-VERSION
</replaceable>/linux
</filename>.
93 It also creates a boot loader entry according to the boot
94 loader specification in
95 <filename>/boot/loader/entries/
<replaceable>MACHINE-ID
</replaceable>-
<replaceable>KERNEL-VERSION
</replaceable>.conf
</filename>.
96 The title of the entry is the
97 <replaceable>PRETTY_NAME
</replaceable> parameter specified
98 in
<filename>/etc/os-release
</filename> or
99 <filename>/usr/lib/os-release
</filename> (if the former is
101 <replaceable>KERNEL-VERSION</replaceable>", if unset. If
102 the file
<filename>initrd
</filename> is found next to the
103 <filename>linux
</filename> file, the initrd will be added to
104 the configuration.
</para>
108 <term><command>remove
<replaceable>KERNEL-VERSION
</replaceable></command></term>
110 <para>Calls executables from
<filename>/usr/lib/kernel/install.d/*.install
</filename>
111 and
<filename>/etc/kernel/install.d/*.install
</filename> with the arguments
112 <programlisting>remove
<replaceable>KERNEL-VERSION
</replaceable> <filename>/boot/
<replaceable>MACHINE-ID
</replaceable>/
<replaceable>KERNEL-VERSION
</replaceable>/
</filename></programlisting>
115 <para><command>kernel-install
</command> removes the entire directory
116 <filename>/boot/
<replaceable>MACHINE-ID
</replaceable>/
<replaceable>KERNEL-VERSION
</replaceable>/
</filename> afterwards.
</para>
118 <para>The kernel-install plugin
<filename>90-loaderentry.install
</filename> removes the file
119 <filename>/boot/loader/entries/
<replaceable>MACHINE-ID
</replaceable>-
<replaceable>KERNEL-VERSION
</replaceable>.conf
</filename>.
</para>
128 <title>Exit status
</title>
129 <para>If every executable returns
0 or
77,
0 is returned, and a non-zero failure code otherwise.
</para>
137 <filename>/usr/lib/kernel/install.d/*.install
</filename>
138 <filename>/etc/kernel/install.d/*.install
</filename>
141 <para>Drop-in files which are executed by kernel-install.
</para>
146 <filename>/etc/kernel/cmdline
</filename>
147 <filename>/proc/cmdline
</filename>
150 <para>The content of the file
<filename>/etc/kernel/cmdline
</filename> specifies the kernel command line to use.
151 If that file does not exist,
<filename>/proc/cmdline
</filename> is used.
</para>
156 <filename>/etc/machine-id
</filename>
159 <para>The content of the file specifies the machine identification
<replaceable>MACHINE-ID
</replaceable>.
</para>
164 <filename>/etc/os-release
</filename>
165 <filename>/usr/lib/os-release
</filename>
168 <para>The content of the file specifies the operating system title
<replaceable>PRETTY_NAME
</replaceable>.
</para>
175 <title>See Also
</title>
177 <citerefentry><refentrytitle>machine-id
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
178 <citerefentry><refentrytitle>os-release
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
179 <ulink url=
"https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification
</ulink>