diff --git a/man/kernel-install.xml b/man/kernel-install.xml index 797e78f2917..9a21fd65e81 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -78,23 +78,32 @@ The following commands are understood: - add KERNEL-VERSION KERNEL-IMAGE [INITRD-FILE ...] + + add + KERNEL-VERSION + KERNEL-IMAGE [INITRD-FILE ...] + + This command expects a kernel version string and a path to a kernel image file as arguments. Optionally, one or more initrd images may be specified as well (note that plugins might generate - additional ones). kernel-install calls the executable files from - /usr/lib/kernel/install.d/*.install and - /etc/kernel/install.d/*.install (i.e. the plugins) with the following - arguments: + additional ones). - add KERNEL-VERSION $BOOT/ENTRY-TOKEN/KERNEL-VERSION/ KERNEL-IMAGE [INITRD-FILE ...] + The executable files from /usr/lib/kernel/install.d/*.install and + /etc/kernel/install.d/*.install (i.e. the plugins) are called with the + following arguments: + + add KERNEL-VERSION $BOOT/ENTRY-TOKEN/KERNEL-VERSION/ KERNEL-IMAGE \ + [INITRD-FILE ...] The third argument directly refers to the path where to place kernel images, initrd - images and other resources for Boot + images and other resources for + Boot Loader Specification Type #1 entries (the "entry directory"). If other boot loader schemes - are used the parameter may be ignored. The ENTRY-TOKEN string is - typically the machine ID and is supposed to identify the local installation on the system. For - details see below. + are used the parameter may be ignored. + + The ENTRY-TOKEN string is typically the machine ID and is supposed + to identify the local installation on the system. For details see below. Two default plugins execute the following operations in this case: @@ -136,10 +145,11 @@ remove KERNEL-VERSION - This command expects a kernel version string as single argument. This calls executables from - /usr/lib/kernel/install.d/*.install and - /etc/kernel/install.d/*.install with the following arguments: - + This command expects a kernel version string as single argument. + + The executable files from /usr/lib/kernel/install.d/*.install and + /etc/kernel/install.d/*.install (i.e. the plugins) are called with the + following arguments: remove KERNEL-VERSION $BOOT/ENTRY-TOKEN/KERNEL-VERSION/ @@ -150,13 +160,16 @@ Two default plugins execute the following operations in this case: - 50-depmod.install removes the files generated by depmod for this kernel again. + 50-depmod.install removes the files generated by + depmod for this kernel again. 90-loaderentry.install removes the file - $BOOT/loader/entries/ENTRY-TOKEN-KERNEL-VERSION.conf. + $BOOT/loader/entries/ENTRY-TOKEN-KERNEL-VERSION.conf. + 90-uki-copy.install removes the file - $BOOT/EFI/Linux/ENTRY-TOKEN-KERNEL-VERSION.efi. + $BOOT/EFI/Linux/ENTRY-TOKEN-KERNEL-VERSION.efi. + @@ -518,11 +531,16 @@ /etc/kernel/uki.conf - Ini-style configuration file for ukify1 which is only effective when $KERNEL_INSTALL_LAYOUT or layout= in install.conf is set to and $KERNEL_INSTALL_UKI_GENERATOR or uki_generator= in install.conf is set to . + Ini-style configuration file for + ukify1 which + is only effective when $KERNEL_INSTALL_LAYOUT or layout= in + install.conf is set to and + $KERNEL_INSTALL_UKI_GENERATOR or uki_generator= in + install.conf is set to . $KERNEL_INSTALL_CONF_ROOT may be used to override the path. - +