X-Git-Url: http://git.ipfire.org/?a=blobdiff_plain;f=dracut.8.asc;h=d3f135db094817d5078c09e4c5701fb2b97aec1e;hb=958ca9e912d3a3a1ebe79a8d4fc36de2a60e4381;hp=5062db3ff4d78aefd5b79e1abb6ce2722085dff4;hpb=6c128565b10871eef5ab048cc25e59940919f140;p=thirdparty%2Fdracut.git diff --git a/dracut.8.asc b/dracut.8.asc index 5062db3ff..d3f135db0 100644 --- a/dracut.8.asc +++ b/dracut.8.asc @@ -3,14 +3,15 @@ DRACUT(8) :doctype: manpage :man source: dracut :man manual: dracut +:man version: {version} NAME ---- -dracut - low-level tool for generating an initramfs image +dracut - low-level tool for generating an initramfs/initrd image SYNOPSIS -------- -*dracut* ['OPTION...'] [ [__]] +*dracut* [__OPTION...__] [____ [____]] DESCRIPTION ----------- @@ -28,55 +29,21 @@ At boot time, the kernel unpacks that archive into RAM disk, mounts and uses it as initial root file system. All finding of the root device happens in this early userspace. -For a complete list of kernel command line options see *dracut.cmdline*(7). - -EXAMPLE -------- - -To create a initramfs image, the most simple command is: ----- -# dracut ----- - -This will generate a general purpose initramfs image, with all possible -functionality resulting of the combination of the installed dracut modules and -system tools. The image is /boot/initramfs-_++++_.img and -contains the kernel modules of the currently active kernel with version -_++++_. - -If the initramfs image already exists, dracut will display an error message, and -to overwrite the existing image, you have to use the --force option. ----- -# dracut --force ----- +Initramfs images are also called "initrd". -If you want to specify another filename for the resulting image you would issue -a command like: ----- -# dracut foobar.img ----- - -To generate an image for a specific kernel version, the command would be: ----- -# dracut foobar.img 2.6.40-1.rc5.f20 ----- +For a complete list of kernel command line options see *dracut.cmdline*(7). -A shortcut to generate the image at the default location for a specific kernel -version is: ----- -# dracut --kver 2.6.40-1.rc5.f20 ----- +If you are dropped to an emergency shell, while booting your initramfs, +the file _/run/initramfs/rdsosreport.txt_ is created, which can be saved to a +(to be mounted by hand) partition (usually /boot) or a USB stick. +Additional debugging info can be produced by adding **rd.debug** to the kernel +command line. _/run/initramfs/rdsosreport.txt_ contains all logs and the output +of some tools. It should be attached to any report about dracut problems. -If you want to create lighter, smaller initramfs images, you may want to specify -the --host-only or -H option. Using this option, the resulting image will -contain only those dracut modules, kernel modules and filesystems, which are -needed to boot this specific machine. This has the drawback, that you can't put -the disk on another controller or machine, and that you can't switch to another -root filesystem, without recreating the initramfs image. The usage of the ---host-only option is only for experts and you will have to keep the broken -pieces. At least keep a copy of a general purpose image (and corresponding -kernel) as a fallback to rescue your system. +USAGE +----- +include::dracut.usage.asc[] OPTIONS ------- @@ -90,57 +57,59 @@ OPTIONS **-f, --force**:: overwrite existing initramfs file. -**-m, --modules** __:: - specify a space-separated list of dracut modules to call when building the - initramfs. Modules are located in _/usr/lib/dracut/modules.d_. This - parameter can be specified multiple times. +**-a, --add** __:: + add a space-separated list of dracut modules to the default set of modules. + This parameter can be specified multiple times. + [NOTE] =============================== If [LIST] has multiple arguments, then you have to put these in quotes. For example: ---- -# dracut --modules "module1 module2" ... +# dracut --add "module1 module2" ... ---- =============================== -**-o, --omit** __:: - omit a space-separated list of dracut modules. This parameter can be - specified multiple times. +**--force-add** __:: + force to add a space-separated list of dracut modules to the default set of + modules, when -H is specified. This parameter can be specified multiple + times. + [NOTE] =============================== If [LIST] has multiple arguments, then you have to put these in quotes. For example: ---- -# dracut --omit "module1 module2" ... +# dracut --force-add "module1 module2" ... ---- =============================== -**-a, --add** __:: - add a space-separated list of dracut modules to the default set of modules. - This parameter can be specified multiple times. +**-o, --omit** __:: + omit a space-separated list of dracut modules. This parameter can be + specified multiple times. + [NOTE] =============================== If [LIST] has multiple arguments, then you have to put these in quotes. For example: ---- -# dracut --add "module1 module2" ... +# dracut --omit "module1 module2" ... ---- =============================== -**--force-add** __:: - force to add a space-separated list of dracut modules to the default set of - modules, when -H is specified. This parameter can be specified multiple - times. +**-m, --modules** __:: + specify a space-separated list of dracut modules to call when building the + initramfs. Modules are located in _/usr/lib/dracut/modules.d_. This + parameter can be specified multiple times. + This option forces dracut to only include the specified dracut modules. + In most cases the "--add" option is what you want to use. + [NOTE] =============================== If [LIST] has multiple arguments, then you have to put these in quotes. For example: ---- -# dracut --force-add "module1 module2" ... +# dracut --modules "module1 module2" ... ---- =============================== @@ -172,6 +141,19 @@ example: ---- =============================== +**--force-drivers** __:: + See add-drivers above. But in this case it is ensured that the drivers + are tried to be loaded early via modprobe. ++ +[NOTE] +=============================== +If [LIST] has multiple arguments, then you have to put these in quotes. For +example: +---- +# dracut --force-drivers "kmodule1 kmodule2" ... +---- +=============================== + **--omit-drivers** __:: specify a space-separated list of kernel modules not to add to the initramfs. @@ -218,6 +200,15 @@ example: **--no-kernel**:: do not install kernel drivers and firmware files +**--early-microcode**:: + Combine early microcode with ramdisk + +**--no-early-microcode**:: + Do not combine early microcode with ramdisk + +**--print-cmdline**:: + print the kernel command line for the current disk layout + **--mdadmconf**:: include local _/etc/mdadm.conf_ @@ -294,8 +285,23 @@ Default: Default: _/var/tmp_ +**-r, --sysroot** __:: + specify the sysroot directory to collect files from. + This is useful to create the initramfs image from + a cross-compiled sysroot directory. For the extra helper + variables, see *ENVIRONMENT* below. ++ +Default: + _empty_ + **--sshkey** __:: ssh key file used with ssh-client module. +**--logfile** __:: logfile to use; overrides any setting from + the configuration files. ++ +Default: + _/var/log/dracut.log_ + **-l, --local**:: activates the local mode. dracut will use modules from the current working directory instead of the system-wide installed modules in @@ -315,26 +321,58 @@ provide a valid _/etc/fstab_. **-N, --no-hostonly**:: Disable Host-Only mode +**--hostonly-cmdline**: + Store kernel command line arguments needed in the initramfs + +**--no-hostonly-cmdline**: + Do not store kernel command line arguments needed in the initramfs + +**--no-hostonly-default-device**: + Do not generate implicit host devices like root, swap, fstab, etc. + Use "--mount" or "--add-device" to explicitly add devices as needed. + +**--hostonly-i18n**: + Install only needed keyboard and font files according to the host configuration (default). + +**--no-hostonly-i18n**: + Install all keyboard and font files available. + +**--persistent-policy** __:: + Use __ to address disks and partitions. + __ can be any directory name found in /dev/disk. + E.g. "by-uuid", "by-label" + **--fstab**:: Use _/etc/fstab_ instead of _/proc/self/mountinfo_. -**--add-fstab** __ :: +**--add-fstab** __:: Add entries of __ to the initramfs /etc/fstab. -**--mount** "__ __ __ __":: - Mount __ on __ with __ and __ in the initramfs - -**--device** __ :: - Bring up __ in initramfs, __ should be the device name - -**-i, --include** __ __:: +**--mount** "__ __ __ [__ [__ [__]]]":: + Mount __ on __ with __ in the + initramfs. __, __ and __ can + be specified, see fstab manpage for the details. + The default __ is "defaults". + The default __ is "0". + the default __ is "2". + +**--mount** "__":: + Like above, but __, __ and __ + are determined by looking at the current mounts. + +**--add-device** __ :: + Bring up __ in initramfs, __ should be the device name. + This can be useful in hostonly mode for resume support when your swap is on + LVM or an encrypted partition. + [NB --device can be used for compatibility with earlier releases] + +**-i, --include** __ __:: include the files in the SOURCE directory into the TARGET directory in the final initramfs. If SOURCE is a file, it will be installed to TARGET in the final initramfs. This parameter can be specified multiple times. -**-I, --install** __:: +**-I, --install** __:: install the space separated list of files into the initramfs. + [NOTE] @@ -346,6 +384,9 @@ example: ---- =============================== +**--install-optional** __:: + install the space separated list of files into the initramfs, if they exist. + **--gzip**:: Compress the generated initramfs using gzip. This will be done by default, unless another compression option or --no-compress is passed. Equivalent to @@ -366,7 +407,7 @@ will not be able to boot. Equivalent to "--compress=bzip2" [WARNING] ==== Make sure your kernel has lzma decompression support compiled in, otherwise you -will not be able to boot. Equivalent to "--compress=lzma -9" +will not be able to boot. Equivalent to "lzma --compress=lzma -9" ==== **--xz**:: @@ -375,8 +416,32 @@ will not be able to boot. Equivalent to "--compress=lzma -9" [WARNING] ==== Make sure your kernel has xz decompression support compiled in, otherwise you -will not be able to boot. Equivalent to "--compress=xz --check=crc32 ---lzma2=dict=1MiB" +will not be able to boot. Equivalent to +"lzma --compress=xz --check=crc32 --lzma2=dict=1MiB" +==== + +**--lzo**:: + Compress the generated initramfs using lzop. +[WARNING] +==== +Make sure your kernel has lzo decompression support compiled in, otherwise you +will not be able to boot. +==== + +**--lz4**:: + Compress the generated initramfs using lz4. +[WARNING] +==== +Make sure your kernel has lz4 decompression support compiled in, otherwise you +will not be able to boot. +==== + +**--zstd**:: + Compress the generated initramfs using Zstandard. +[WARNING] +==== +Make sure your kernel has zstd decompression support compiled in, otherwise you +will not be able to boot. ==== **--compress** __:: @@ -385,11 +450,18 @@ will not be able to boot. Equivalent to "--compress=xz --check=crc32 program with known-working arguments. If you pass a quoted string with arguments, it will be called with exactly those arguments. Depending on what you pass, this may result in an initramfs that the kernel cannot decompress. + The default value can also be set via the _INITRD_COMPRESS_ environment variable. **--no-compress**:: Do not compress the generated initramfs. This will override any other compression options. +**--reproducible**:: + Create reproducible images. + +**--no-reproducible**:: + Do not create reproducible images. + **--list-modules**:: List all available dracut modules. @@ -399,6 +471,147 @@ will not be able to boot. Equivalent to "--compress=xz --check=crc32 **--keep**:: Keep the initramfs temporary directory for debugging purposes. +**--printsize**:: + Print out the module install size + +**--profile**: + Output profile information of the build process + +**--ro-mnt**: + Mount / and /usr read-only by default. + +**-L, --stdlog** __:: + [0-6] Specify logging level (to standard error) +---- + 0 - suppress any messages + 1 - only fatal errors + 2 - all errors + 3 - warnings + 4 - info + 5 - debug info (here starts lots of output) + 6 - trace info (and even more) +---- + +**--regenerate-all**:: + Regenerate all initramfs images at the default location with the kernel + versions found on the system. Additional parameters are passed through. + +**--loginstall __**:: + Log all files installed from the host to __. + +**--uefi**:: + Instead of creating an initramfs image, dracut will create an UEFI executable, + which can be executed by an UEFI BIOS. The default output filename is + _/EFI/Linux/linux-$kernel$--.efi_. might be + _/efi_, _/boot_ or _/boot/efi_ depending on where the ESP partition is mounted. + The is taken from BUILD_ID in _/usr/lib/os-release_ or if it exists + _/etc/os-release_ and is left out, if BUILD_ID is non-existant or empty. + +**--no-machineid**:: + affects the default output filename of **--uefi** and will discard the + part. + +**--uefi-stub __**:: + Specifies the UEFI stub loader, which will load the attached kernel, initramfs and + kernel command line and boots the kernel. The default is + _$prefix/lib/systemd/boot/efi/linux.efi.stub_ + or _$prefix/lib/gummiboot/linux.efi.stub_ + +**--kernel-image __**:: + Specifies the kernel image, which to include in the UEFI executable. The default is + _/lib/modules//vmlinuz_ or _/boot/vmlinuz-_ + +ENVIRONMENT +----------- + +_INITRD_COMPRESS_:: + sets the default compression program. See **--compress**. + +_DRACUT_LDCONFIG_:: + sets the _ldconfig_ program path and options. Optional. + Used for **--sysroot**. ++ +Default: + _ldconfig_ + +_DRACUT_LDD_:: + sets the _ldd_ program path and options. Optional. + Used for **--sysroot**. ++ +Default: + _ldd_ + +_DRACUT_TESTBIN_:: + sets the initially tested binary for detecting library paths. + Optional. Used for **--sysroot**. In the cross-compiled sysroot, + the default value (_/bin/sh_) is unusable, as it is an absolute + symlink and points outside the sysroot directory. ++ +Default: + _/bin/sh_ + +_DRACUT_INSTALL_:: + overrides path and options for executing _dracut-install_ internally. + Optional. Can be used to debug _dracut-install_ while running the + main dracut script. ++ +Default: + _dracut-install_ ++ +Example: + DRACUT_INSTALL="valgrind dracut-install" + +_DRACUT_COMPRESS_BZIP2_:: +_DRACUT_COMPRESS_BZIP2_:: +_DRACUT_COMPRESS_LBZIP2_:: +_DRACUT_COMPRESS_LZMA_:: +_DRACUT_COMPRESS_XZ_:: +_DRACUT_COMPRESS_GZIP_:: +_DRACUT_COMPRESS_PIGZ_:: +_DRACUT_COMPRESS_LZOP_:: +_DRACUT_COMPRESS_ZSTD_:: +_DRACUT_COMPRESS_LZ4_:: +_DRACUT_COMPRESS_CAT_:: + overrides for compression utilities to support using them from + non-standard paths. ++ +Default values are the default compression utility names to be found in **PATH**. + +_DRACUT_ARCH_:: + overrides the value of **uname -m**. Used for **--sysroot**. ++ +Default: + _empty_ (the value of **uname -m** on the host system) + +_SYSTEMD_VERSION_:: + overrides systemd version. Used for **--sysroot**. + +_DRACUT_INSTALL_PATH_:: + overrides **PATH** environment for **dracut-install** to look for + binaries relative to **--sysroot**. In a cross-compiled environment + (e.g. Yocto), PATH points to natively built binaries that are not + in the host's /bin, /usr/bin, etc. **dracut-install** still needs plain + /bin and /usr/bin that are relative to the cross-compiled sysroot. ++ +Default: + _PATH_ + +_DRACUT_INSTALL_LOG_TARGET_:: + overrides **DRACUT_LOG_TARGET** for **dracut-install**. It allows + running **dracut-install* to run with different log target that + **dracut** runs with. ++ +Default: + _DRACUT_LOG_TARGET_ + +_DRACUT_INSTALL_LOG_LEVEL_:: + overrides **DRACUT_LOG_LEVEL** for **dracut-install**. It allows + running **dracut-install* to run with different log level that + **dracut** runs with. ++ +Default: + _DRACUT_LOG_LEVEL_ + FILES ----- _/var/log/dracut.log_:: @@ -414,6 +627,9 @@ _/etc/dracut.conf_:: _/etc/dracut.conf.d/*.conf_:: see dracut.conf5 +_/usr/lib/dracut/dracut.conf.d/*.conf_:: + see dracut.conf5 + Configuration in the initramfs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ _/etc/conf.d/_:: @@ -422,9 +638,10 @@ _/etc/conf.d/_:: set in the configuration files. _/etc/cmdline_:: - Can contain additional command line options. Deprecated, better use /etc/cmdline.d/*.conf. + Can contain additional command line options. Deprecated, better use + /etc/cmdline.d/*.conf. -_/etc/cmdline.d/*.conf:: +_/etc/cmdline.d/*.conf_:: Can contain additional command line options. AVAILABILITY @@ -452,4 +669,4 @@ Will Woods SEE ALSO -------- -*dracut.cmdline*(7) *dracut.conf*(5) +*dracut.cmdline*(7) *dracut.conf*(5) *lsinitrd*(1)