X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fdracut.git;a=blobdiff_plain;f=dracut.8.asc;h=2e974fb0b632680494146d56f962def6515a9745;hp=bab5996ee91db4b9a59acfc34e6f18a1e9be3f29;hb=5e0f8c8a4ced36268d0077acafa1db2402776fa6;hpb=1d97bb8b390fbe52c5ec018f48f912eb2da10b87 diff --git a/dracut.8.asc b/dracut.8.asc index bab5996ee..2e974fb0b 100644 --- a/dracut.8.asc +++ b/dracut.8.asc @@ -6,14 +6,20 @@ DRACUT(8) 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 ----------- + +Create an initramfs for the kernel with the version . +If is omitted, then the version of the actual running +kernel is used. If is omitted or empty, then the default location +/boot/initramfs-.img is used. + dracut creates an initial image used by the kernel for preloading the block device modules (such as IDE, SCSI or RAID) which are needed to access the root filesystem, mounting the root filesystem and booting into the real system. @@ -22,64 +28,87 @@ 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) +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, +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. + +USAGE +----- + +include::dracut.usage.asc[] OPTIONS ------- +**--kver** __:: + set the kernel version. This enables to specify the kernel version, without + specifying the location of the initramfs image. For example: +---- +# dracut --kver 3.5.0-0.rc7.git1.2.fc18.x86_64 +---- + **-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" ... ---- =============================== @@ -111,6 +140,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. @@ -130,7 +172,7 @@ example: specify a space-separated list of kernel filesystem modules to exclusively include in the generic initramfs. This parameter can be specified multiple times. - ++ [NOTE] =============================== If [LIST] has multiple arguments, then you have to put these in quotes. For @@ -147,12 +189,25 @@ example: specify additional directories, where to look for firmwares. This parameter can be specified multiple times. +**--kernel-cmdline **:: + specify default kernel command line parameters + + **--kernel-only**:: only install kernel drivers and firmware files **--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_ @@ -188,6 +243,12 @@ example: **--nostrip**:: do not strip binaries in the initramfs +**--hardlink**:: + hardlink files in the initramfs (default) + +**--nohardlink**:: + do not hardlink files in the initramfs + **--prefix** __:: prefix initramfs files with the specified directory @@ -225,6 +286,12 @@ Default: **--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 @@ -241,38 +308,75 @@ If chrooted to another root other than the real root device, use "--fstab" and provide a valid _/etc/fstab_. ==== -**--no-hostonly**:: +**-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 - -**-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] =============================== If [LIST] has multiple arguments, then you have to put these in quotes. For example: -+ ---- # dracut --install "/bin/foo /sbin/bar" ... ---- =============================== +**--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 @@ -293,7 +397,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**:: @@ -302,8 +406,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** __:: @@ -312,11 +440,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. @@ -326,6 +461,62 @@ 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**. + FILES ----- _/var/log/dracut.log_:: @@ -341,6 +532,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/_:: @@ -349,6 +543,10 @@ _/etc/conf.d/_:: set in the configuration files. _/etc/cmdline_:: + Can contain additional command line options. Deprecated, better use + /etc/cmdline.d/*.conf. + +_/etc/cmdline.d/*.conf_:: Can contain additional command line options. AVAILABILITY @@ -358,30 +556,22 @@ link:$$https://dracut.wiki.kernel.org$$[https://dracut.wiki.kernel.org] AUTHORS ------- -*Harald Hoyer*:: - Project Leader and Developer +Harald Hoyer -*Victor Lowther*:: - Developer +Victor Lowther -*Philippe Seewer*:: - Developer +Philippe Seewer -*Warren Togami*:: - Developer +Warren Togami -*Amadeusz Żołnowski*:: - Developer +Amadeusz Żołnowski -*Jeremy Katz*:: - Developer +Jeremy Katz -*David Dillow*:: - Developer +David Dillow -*Will Woods*:: - Developer +Will Woods SEE ALSO -------- -*dracut.cmdline*(7) *dracut.conf*(5) +*dracut.cmdline*(7) *dracut.conf*(5) *lsinitrd*(1)