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