Merge pull request #362 from danimo/persistance_policy

[thirdparty/dracut.git] / dracut.conf.5.asc

DRACUT.CONF(5)
==============
:doctype: manpage
:man source:   dracut
:man manual:   dracut

NAME
----
dracut.conf - configuration file(s) for dracut

SYNOPSIS
--------
_/etc/dracut.conf_
_/etc/dracut.conf.d/\*.conf_
_/usr/lib/dracut/dracut.conf.d/*.conf_

Description
-----------
_dracut.conf_ is loaded during the initialisation phase of dracut. Command line
parameter will override any values set here.

_*.conf_ files are read from /usr/lib/dracut/dracut.conf.d and
/etc/dracut.conf.d. Files with the same name in /etc/dracut.conf.d will replace
files in /usr/lib/dracut/dracut.conf.d.
The files are then read in alphanumerical order and will override parameters
set in _/etc/dracut.conf_. Each line specifies an attribute and a value. A '#'
indicates the beginning of a comment; following characters, up to the end of the
line are not interpreted.

dracut command line options will override any values set here.

Configuration files must have the extension .conf; other extensions are ignored.

*add_dracutmodules+=*" __<dracut modules>__ "::
    Add a space-separated list of dracut modules to call when building the
    initramfs. Modules are located in _/usr/lib/dracut/modules.d_.

*dracutmodules+=*" __<dracut 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 option forces dracut to only include the specified dracut modules.
    In most cases the "add_dracutmodules" option is what you want to use.

*omit_dracutmodules+=*" __<dracut modules>__ "::
    Omit a space-separated list of dracut modules to call when building the
    initramfs. Modules are located in _/usr/lib/dracut/modules.d_.

*drivers+=*" __<kernel modules>__ "::
    Specify a space-separated list of kernel modules to exclusively include in
    the initramfs. The kernel modules have to be specified without the ".ko"
    suffix.

*add_drivers+=*" __<kernel modules>__ "::
    Specify a space-separated list of kernel modules to add to the initramfs.
    The kernel modules have to be specified without the ".ko" suffix.

*force_drivers+=*" __<list of kernel modules>__ "::
    See add_drivers above. But in this case it is ensured that the drivers
    are tried to be loaded early via modprobe.

*omit_drivers+=*" __<kernel modules>__ "::
    Specify a space-separated list of kernel modules not to add to the
    initramfs. The kernel modules have to be specified without the ".ko" suffix.

*filesystems+=*" __<filesystem names>__ "::
    Specify a space-separated list of kernel filesystem modules to exclusively
    include in the generic initramfs.

*drivers_dir=*"__<kernel modules directory>__"::
    Specify the directory, where to look for kernel modules

*fw_dir+=*" :__<dir>__[:__<dir>__ ...] "::
    Specify additional directories, where to look for firmwares, separated by :

*install_items+=*" __<file>__[ __<file>__ ...] "::
    Specify additional files to include in the initramfs, separated by spaces.

*install_optional_items+=*" __<file>__[ __<file>__ ...] "::
    Specify additional files to include in the initramfs, separated by spaces,
    if they exist.

*compress=*"__{bzip2|lzma|xz|gzip|lzo|lz4|zstd|<compressor [args ...]>}__"::
    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 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.

*do_strip=*"__{yes|no}__"::
    Strip binaries in the initramfs (default=yes)

*do_prelink=*"__{yes|no}__"::
    Prelink binaries in the initramfs (default=yes)

*hostonly=*"__{yes|no}__"::
    Host-Only mode: Install only what is needed for booting the local host
    instead of a generic host and generate host-specific configuration.

*hostonly_cmdline=*"__{yes|no}__"::
    If set to "yes", store the kernel command line arguments needed in the initramfs

*persistent_policy=*"__<policy>__"::
    Use _<policy>_ to address disks and partitions.
    _<policy>_ can be any directory name found in /dev/disk.
    E.g. "by-uuid", "by-label"

*tmpdir=*"__<temporary directory>__"::
    Specify temporary directory to use.

[WARNING]
====
If chrooted to another root other than the real root device, use --fstab and
provide a valid _/etc/fstab_.
====

*use_fstab=*"__{yes|no}__"::
    Use _/etc/fstab_ instead of _/proc/self/mountinfo_.

*add_fstab+=*" __<filename>__ "::
    Add entries of __<filename>__ to the initramfs /etc/fstab.

*add_device+=*" __<device>__ "::
    Bring up _<device>_ in initramfs, _<device>_ should be the device name.
    This can be useful in hostonly mode for resume support when your swap is on
    LVM an encrypted partition.

*mdadmconf=*"__{yes|no}__"::
    Include local _/etc/mdadm.conf_ (default=yes)

*lvmconf=*"__{yes|no}__"::
    Include local _/etc/lvm/lvm.conf_ (default=yes)

*fscks=*" __<fsck tools>__ "::
    Add a space-separated list of fsck tools. If nothing is specified, the
    default is: "umount mount /sbin/fsck* xfs_db xfs_check xfs_repair e2fsck
    jfs_fsck reiserfsck btrfsck". The installation is opportunistic
    (non-existing tools are ignored).

*nofscks=*"__{yes|no}__"::
    If specified, inhibit installation of any fsck tools.

*ro_mnt=*"__{yes|no}__"::
    Mount _/_ and _/usr_ read-only by default.

*kernel_cmdline=*"__parameters__"::
    Specify default kernel command line parameters

*kernel_only=*"__{yes|no}__"::
    Only install kernel drivers and firmware files. (default=no)

*no_kernel=*"__{yes|no}__"::
    Do not install kernel drivers and firmware files (default=no)

*acpi_override=*"__{yes|no}__"::
    [WARNING] ONLY USE THIS IF YOU KNOW WHAT YOU ARE DOING! +
    Override BIOS provided ACPI tables. For further documentation read
    Documentation/acpi/initrd_table_override.txt in the kernel sources.
    Search for ACPI table files (must have .aml suffix) in acpi_table_dir=
    directory (see below) and add them to a separate uncompressed cpio
    archive. This cpio archive gets glued (concatenated, uncompressed one
    must be the first one) to the compressed cpio archive. The first,
    uncompressed cpio archive is for data which the kernel must be able
    to access very early (and cannot make use of uncompress alogrithms yet)
    like microcode or ACPI tables (default=no).

*acpi_table_dir=*"__<dir>__"::
    Directory to search for ACPI tables if acpi_override= is set to yes.

*early_microcode=*"{yes|no}"::
    Combine early microcode with ramdisk (default=no)

*stdloglvl*="__\{0-6\}__"::
    Set logging to standard error level.

*sysloglvl*="__\{0-6\}__"::
    Set logging to syslog level.

*fileloglvl=*"__\{0-6\}__"::
    Set logging to file level.

*logfile=*"__<file>__"::
    Path to log file.

*show_modules=*"__{yes|no}__"::
    Print the name of the included modules to standard output during build.

*i18n_vars=*"__<variable mapping>__"::
    Distribution specific variable mapping.
    See dracut/modules.d/10i18n/README for a detailed description.

*i18n_default_font=*"__<fontname>__"::
    The font <fontname> to install, if not specified otherwise.
    Default is "LatArCyrHeb-16".

*i18n_install_all=*"__{yes|no}__"::
    Install everything regardless of generic or hostonly mode.

*reproducible=*"__{yes|no}__"::
    Create reproducible images.

*loginstall=*"__<DIR>__"::
    Log all files installed from the host to _<DIR>_.

*uefi_stub=*"_<FILE>_"::
    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-MACHINE-TYPE-NAME>.efi.stub_
    or _/usr/lib/gummiboot/linux<EFI-MACHINE-TYPE-NAME>.efi.stub_

*kernel_image=*"_<FILE>_"::
    Specifies the kernel image, which to include in the UEFI executable. The default is
    _/lib/modules/<KERNEL-VERSION>/vmlinuz_ or _/boot/vmlinuz-<KERNEL-VERSION>_

Files
-----
_/etc/dracut.conf_::
    Old configuration file. You better use your own file in
    _/etc/dracut.conf.d/_.

_/etc/dracut.conf.d/_::
    Any _/etc/dracut.conf.d/*.conf_ file can override the values in
    _/etc/dracut.conf_. The configuration files are read in alphanumerical
    order.

AUTHOR
------
Harald Hoyer

See Also
--------
*dracut*(8) *dracut.cmdline*(7)