X-Git-Url: http://git.ipfire.org/?a=blobdiff_plain;f=dracut.8.asc;h=d3f135db094817d5078c09e4c5701fb2b97aec1e;hb=958ca9e912d3a3a1ebe79a8d4fc36de2a60e4381;hp=1fbbda41f3c2a219d5303115560d80188e5c1c72;hpb=820f81016a31f069dc8ef9d7a6b65ffc1166daa5;p=thirdparty%2Fdracut.git diff --git a/dracut.8.asc b/dracut.8.asc index 1fbbda41f..d3f135db0 100644 --- a/dracut.8.asc +++ b/dracut.8.asc @@ -3,10 +3,11 @@ 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 -------- @@ -28,6 +29,8 @@ 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. +Initramfs images are also called "initrd". + For a complete list of kernel command line options see *dracut.cmdline*(7). If you are dropped to an emergency shell, while booting your initramfs, @@ -54,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" ... ---- =============================== @@ -239,12 +244,6 @@ example: **--nostrip**:: do not strip binaries in the initramfs -**--prelink**:: - prelink binaries in the initramfs (default) - -**--noprelink**:: - do not prelink binaries in the initramfs - **--hardlink**:: hardlink files in the initramfs (default) @@ -286,6 +285,15 @@ 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 @@ -319,6 +327,16 @@ provide a valid _/etc/fstab_. **--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. @@ -338,6 +356,10 @@ provide a valid _/etc/fstab_. 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 @@ -414,12 +436,21 @@ 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** __:: Compress the generated initramfs using the passed compression program. If you pass it just the name of a compression program, it will call that 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 @@ -428,6 +459,9 @@ will not be able to boot. **--reproducible**:: Create reproducible images. +**--no-reproducible**:: + Do not create reproducible images. + **--list-modules**:: List all available dracut modules. @@ -467,18 +501,117 @@ will not be able to boot. **--uefi**:: Instead of creating an initramfs image, dracut will create an UEFI executable, - which can be executed by an UEFI BIOS. + 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 - _/lib/systemd/boot/efi/linux.efi.stub_ - or _/usr/lib/gummiboot/linux.efi.stub_ + _$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_::