95iscsi/module-setup.sh: do not require 'hostname' anymore
[thirdparty/dracut.git] / dracut.conf.5.asc
CommitLineData
888d53f2
HH
1DRACUT.CONF(5)
2==============
3:doctype: manpage
4:man source: dracut
5:man manual: dracut
6
7NAME
8----
9dracut.conf - configuration file(s) for dracut
10
11SYNOPSIS
12--------
8b52e96f
HH
13_/etc/dracut.conf_
14_/etc/dracut.conf.d/\*.conf_
ef9ddb91 15_/usr/lib/dracut/dracut.conf.d/*.conf_
888d53f2
HH
16
17Description
18-----------
19_dracut.conf_ is loaded during the initialisation phase of dracut. Command line
85c8217d 20parameter will override any values set here.
c4e098a5 21
ef9ddb91
HH
22_*.conf_ files are read from /usr/lib/dracut/dracut.conf.d and
23/etc/dracut.conf.d. Files with the same name in /etc/dracut.conf.d will replace
24files in /usr/lib/dracut/dracut.conf.d.
85c8217d 25The files are then read in alphanumerical order and will override parameters
ef9ddb91 26set in _/etc/dracut.conf_. Each line specifies an attribute and a value. A '#'
888d53f2
HH
27indicates the beginning of a comment; following characters, up to the end of the
28line are not interpreted.
29
85c8217d 30dracut command line options will override any values set here.
c4e098a5
HH
31
32Configuration files must have the extension .conf; other extensions are ignored.
33
319867fa
HH
34*add_dracutmodules+=*" __<dracut modules>__ "::
35 Add a space-separated list of dracut modules to call when building the
36 initramfs. Modules are located in _/usr/lib/dracut/modules.d_.
37
888d53f2
HH
38*dracutmodules+=*" __<dracut modules>__ "::
39 Specify a space-separated list of dracut modules to call when building the
40 initramfs. Modules are located in _/usr/lib/dracut/modules.d_.
319867fa
HH
41 This option forces dracut to only include the specified dracut modules.
42 In most cases the "add_dracutmodules" option is what you want to use.
888d53f2
HH
43
44*omit_dracutmodules+=*" __<dracut modules>__ "::
319867fa
HH
45 Omit a space-separated list of dracut modules to call when building the
46 initramfs. Modules are located in _/usr/lib/dracut/modules.d_.
888d53f2
HH
47
48*drivers+=*" __<kernel modules>__ "::
49 Specify a space-separated list of kernel modules to exclusively include in
50 the initramfs. The kernel modules have to be specified without the ".ko"
51 suffix.
52
53*add_drivers+=*" __<kernel modules>__ "::
54 Specify a space-separated list of kernel modules to add to the initramfs.
55 The kernel modules have to be specified without the ".ko" suffix.
56
cea907f6
TR
57*force_drivers+=*" __<list of kernel modules>__ "::
58 See add_drivers above. But in this case it is ensured that the drivers
59 are tried to be loaded early via modprobe.
60
888d53f2
HH
61*omit_drivers+=*" __<kernel modules>__ "::
62 Specify a space-separated list of kernel modules not to add to the
63 initramfs. The kernel modules have to be specified without the ".ko" suffix.
64
888d53f2
HH
65*filesystems+=*" __<filesystem names>__ "::
66 Specify a space-separated list of kernel filesystem modules to exclusively
67 include in the generic initramfs.
68
69*drivers_dir=*"__<kernel modules directory>__"::
70 Specify the directory, where to look for kernel modules
71
72*fw_dir+=*" :__<dir>__[:__<dir>__ ...] "::
73 Specify additional directories, where to look for firmwares, separated by :
74
75*install_items+=*" __<file>__[ __<file>__ ...] "::
76 Specify additional files to include in the initramfs, separated by spaces.
77
54b68829
HH
78*install_optional_items+=*" __<file>__[ __<file>__ ...] "::
79 Specify additional files to include in the initramfs, separated by spaces,
80 if they exist.
81
7dbadcc7 82*compress=*"__{bzip2|lzma|xz|gzip|lzo|lz4|zstd|<compressor [args ...]>}__"::
8b52e96f
HH
83 Compress the generated initramfs using the passed compression program. If
84 you pass it just the name of a compression program, it will call that
85 program with known-working arguments. If you pass arguments, it will be called
86 with exactly those arguments. Depending on what you pass, this may result in
87 an initramfs that the kernel cannot decompress.
88
888d53f2
HH
89*do_strip=*"__{yes|no}__"::
90 Strip binaries in the initramfs (default=yes)
91
92*hostonly=*"__{yes|no}__"::
1d97bb8b
93 Host-Only mode: Install only what is needed for booting the local host
94 instead of a generic host and generate host-specific configuration.
888d53f2 95
0ad2471c 96*hostonly_cmdline=*"__{yes|no}__"::
76dd870b 97 If set to "yes", store the kernel command line arguments needed in the initramfs
ab9457ef 98
3411ad66
HH
99*persistent_policy=*"__<policy>__"::
100 Use _<policy>_ to address disks and partitions.
101 _<policy>_ can be any directory name found in /dev/disk.
102 E.g. "by-uuid", "by-label"
103
4dd68ca4
104*tmpdir=*"__<temporary directory>__"::
105 Specify temporary directory to use.
106
888d53f2
HH
107[WARNING]
108====
ef9ddb91
HH
109If chrooted to another root other than the real root device, use --fstab and
110provide a valid _/etc/fstab_.
888d53f2
HH
111====
112
113*use_fstab=*"__{yes|no}__"::
114 Use _/etc/fstab_ instead of _/proc/self/mountinfo_.
115
116*add_fstab+=*" __<filename>__ "::
117 Add entries of __<filename>__ to the initramfs /etc/fstab.
118
c586b033
CG
119*add_device+=*" __<device>__ "::
120 Bring up _<device>_ in initramfs, _<device>_ should be the device name.
121 This can be useful in hostonly mode for resume support when your swap is on
122 LVM an encrypted partition.
123
888d53f2
HH
124*mdadmconf=*"__{yes|no}__"::
125 Include local _/etc/mdadm.conf_ (default=yes)
126
127*lvmconf=*"__{yes|no}__"::
128 Include local _/etc/lvm/lvm.conf_ (default=yes)
129
130*fscks=*" __<fsck tools>__ "::
131 Add a space-separated list of fsck tools. If nothing is specified, the
132 default is: "umount mount /sbin/fsck* xfs_db xfs_check xfs_repair e2fsck
133 jfs_fsck reiserfsck btrfsck". The installation is opportunistic
134 (non-existing tools are ignored).
135
136*nofscks=*"__{yes|no}__"::
137 If specified, inhibit installation of any fsck tools.
138
a2b64e30 139*ro_mnt=*"__{yes|no}__"::
ff3953ef
140 Mount _/_ and _/usr_ read-only by default.
141
d20fb951
HH
142*kernel_cmdline=*"__parameters__"::
143 Specify default kernel command line parameters
144
888d53f2
HH
145*kernel_only=*"__{yes|no}__"::
146 Only install kernel drivers and firmware files. (default=no)
147
45845cb6 148*no_kernel=*"__{yes|no}__"::
888d53f2
HH
149 Do not install kernel drivers and firmware files (default=no)
150
45845cb6 151*acpi_override=*"__{yes|no}__"::
4e93c3f7
TR
152 [WARNING] ONLY USE THIS IF YOU KNOW WHAT YOU ARE DOING! +
153 Override BIOS provided ACPI tables. For further documentation read
154 Documentation/acpi/initrd_table_override.txt in the kernel sources.
155 Search for ACPI table files (must have .aml suffix) in acpi_table_dir=
156 directory (see below) and add them to a separate uncompressed cpio
157 archive. This cpio archive gets glued (concatenated, uncompressed one
158 must be the first one) to the compressed cpio archive. The first,
159 uncompressed cpio archive is for data which the kernel must be able
f18d069d 160 to access very early (and cannot make use of uncompress algorithms yet)
4e93c3f7
TR
161 like microcode or ACPI tables (default=no).
162
163*acpi_table_dir=*"__<dir>__"::
164 Directory to search for ACPI tables if acpi_override= is set to yes.
165
b7c770e1 166*early_microcode=*"{yes|no}"::
b25ef46f 167 Combine early microcode with ramdisk (default=yes)
b7c770e1 168
888d53f2
HH
169*stdloglvl*="__\{0-6\}__"::
170 Set logging to standard error level.
171
172*sysloglvl*="__\{0-6\}__"::
173 Set logging to syslog level.
174
175*fileloglvl=*"__\{0-6\}__"::
176 Set logging to file level.
177
178*logfile=*"__<file>__"::
179 Path to log file.
180
181*show_modules=*"__{yes|no}__"::
c4e098a5 182 Print the name of the included modules to standard output during build.
888d53f2 183
472928ec 184*i18n_vars=*"__<variable mapping>__"::
45845cb6
HH
185 Distribution specific variable mapping.
186 See dracut/modules.d/10i18n/README for a detailed description.
187
188*i18n_default_font=*"__<fontname>__"::
ef9ddb91
HH
189 The font <fontname> to install, if not specified otherwise.
190 Default is "LatArCyrHeb-16".
45845cb6
HH
191
192*i18n_install_all=*"__{yes|no}__"::
193 Install everything regardless of generic or hostonly mode.
194
80626ded
HH
195*reproducible=*"__{yes|no}__"::
196 Create reproducible images.
197
37383f71
HH
198*loginstall=*"__<DIR>__"::
199 Log all files installed from the host to _<DIR>_.
200
636d2d46
HH
201*uefi_stub=*"_<FILE>_"::
202 Specifies the UEFI stub loader, which will load the attached kernel, initramfs and
203 kernel command line and boots the kernel. The default is
204 _/lib/systemd/boot/efi/linux<EFI-MACHINE-TYPE-NAME>.efi.stub_
205 or _/usr/lib/gummiboot/linux<EFI-MACHINE-TYPE-NAME>.efi.stub_
206
207*kernel_image=*"_<FILE>_"::
208 Specifies the kernel image, which to include in the UEFI executable. The default is
209 _/lib/modules/<KERNEL-VERSION>/vmlinuz_ or _/boot/vmlinuz-<KERNEL-VERSION>_
210
888d53f2
HH
211Files
212-----
213_/etc/dracut.conf_::
214 Old configuration file. You better use your own file in
81b676a6 215 _/etc/dracut.conf.d/_.
888d53f2 216
dece5ee1 217_/etc/dracut.conf.d/_::
85c8217d 218 Any _/etc/dracut.conf.d/*.conf_ file can override the values in
888d53f2
HH
219 _/etc/dracut.conf_. The configuration files are read in alphanumerical
220 order.
221
222AUTHOR
223------
224Harald Hoyer
225
226See Also
227--------
228*dracut*(8) *dracut.cmdline*(7)
229