document /usr/lib/dracut/dracut.conf.d
[platform/upstream/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_ _/etc/dracut.conf.d/*.conf_  _/usr/lib/dracut/dracut.conf.d/*.conf_
14
15 Description
16 -----------
17 _dracut.conf_ is loaded during the initialisation phase of dracut. Command line
18 parameter will overwrite any values set here.
19
20 _*.conf_ files are read from /usr/lib/dracut/dracut.conf.d and /etc/dracut.conf.d.
21 Files with the same name in /etc/dracut.conf.d will replace files in /usr/lib/dracut/dracut.conf.d.
22 The files are then read in alphanumerical order and will overwrite parameters set in
23 _/etc/dracut.conf_. Each line specifies an attribute and a value. A '#'
24 indicates the beginning of a comment; following characters, up to the end of the
25 line are not interpreted.
26
27 dracut command line options will overwrite any values set here.
28
29 Configuration files must have the extension .conf; other extensions are ignored.
30
31 *dracutmodules+=*" __<dracut modules>__ "::
32     Specify a space-separated list of dracut modules to call when building the
33     initramfs. Modules are located in _/usr/lib/dracut/modules.d_.
34
35 *omit_dracutmodules+=*" __<dracut modules>__ "::
36     Omit a space-separated list of dracut modules.
37
38 *add_dracutmodules+=*" __<dracut modules>__ "::
39     Add a space-separated list of dracut modules.
40
41 *drivers+=*" __<kernel modules>__ "::
42     Specify a space-separated list of kernel modules to exclusively include in
43     the initramfs. The kernel modules have to be specified without the ".ko"
44     suffix.
45
46 *add_drivers+=*" __<kernel modules>__ "::
47     Specify a space-separated list of kernel modules to add to the initramfs.
48     The kernel modules have to be specified without the ".ko" suffix.
49
50 *omit_drivers+=*" __<kernel modules>__ "::
51     Specify a space-separated list of kernel modules not to add to the
52     initramfs. The kernel modules have to be specified without the ".ko" suffix.
53
54 *install_items+=*" __<kernel modules>__ "::
55     Specify a space-separated list of files, which are added to the initramfs
56     image.
57
58 *filesystems+=*" __<filesystem names>__ "::
59     Specify a space-separated list of kernel filesystem modules to exclusively
60     include in the generic initramfs.
61
62 *drivers_dir=*"__<kernel modules directory>__"::
63     Specify the directory, where to look for kernel modules
64
65 *fw_dir+=*" :__<dir>__[:__<dir>__ ...] "::
66     Specify additional directories, where to look for firmwares, separated by :
67
68 *install_items+=*" __<file>__[ __<file>__ ...] "::
69     Specify additional files to include in the initramfs, separated by spaces.
70
71 *do_strip=*"__{yes|no}__"::
72     Strip binaries in the initramfs (default=yes)
73
74 *hostonly=*"__{yes|no}__"::
75     Host-Only mode: Install only what is needed for booting the local host
76     instead of a generic host and generate host-specific configuration.
77
78 *tmpdir=*"__<temporary directory>__"::
79     Specify temporary directory to use.
80
81 [WARNING]
82 ====
83 If chrooted to another root other than the real root device, use --fstab and provide a valid _/etc/fstab_.
84 ====
85
86 *use_fstab=*"__{yes|no}__"::
87     Use _/etc/fstab_ instead of _/proc/self/mountinfo_.
88
89 *add_fstab+=*" __<filename>__ "::
90     Add entries of __<filename>__ to the initramfs /etc/fstab.
91
92 *add_device+=*" __<device>__ "::
93     Bring up _<device>_ in initramfs, _<device>_ should be the device name.
94     This can be useful in hostonly mode for resume support when your swap is on
95     LVM an encrypted partition.
96
97 *mdadmconf=*"__{yes|no}__"::
98     Include local _/etc/mdadm.conf_ (default=yes)
99
100 *lvmconf=*"__{yes|no}__"::
101     Include local _/etc/lvm/lvm.conf_ (default=yes)
102
103 *fscks=*" __<fsck tools>__ "::
104     Add a space-separated list of fsck tools. If nothing is specified, the
105     default is: "umount mount /sbin/fsck* xfs_db xfs_check xfs_repair e2fsck
106     jfs_fsck reiserfsck btrfsck". The installation is opportunistic
107     (non-existing tools are ignored).
108
109 *nofscks=*"__{yes|no}__"::
110     If specified, inhibit installation of any fsck tools.
111
112 *ro_mnt*
113     Mount _/_ and _/usr_ read-only by default.
114
115 *kernel_cmdline=*"__parameters__"::
116     Specify default kernel command line parameters
117
118 *kernel_only=*"__{yes|no}__"::
119     Only install kernel drivers and firmware files. (default=no)
120
121 *no_kernel=*"{yes|no}"::
122     Do not install kernel drivers and firmware files (default=no)
123
124 *stdloglvl*="__\{0-6\}__"::
125     Set logging to standard error level.
126
127 *sysloglvl*="__\{0-6\}__"::
128     Set logging to syslog level.
129
130 *fileloglvl=*"__\{0-6\}__"::
131     Set logging to file level.
132
133 *logfile=*"__<file>__"::
134     Path to log file.
135
136 *show_modules=*"__{yes|no}__"::
137     Print the name of the included modules to standard output during build.
138
139 Files
140 -----
141 _/etc/dracut.conf_::
142     Old configuration file. You better use your own file in
143     _/etc/dracut/conf.d/_.
144
145 _/etc/dracut.conf.d/_::
146     Any _/etc/dracut.conf.d/*.conf_ file can overwrite the values in
147     _/etc/dracut.conf_. The configuration files are read in alphanumerical
148     order.
149
150 AUTHOR
151 ------
152 Harald Hoyer
153
154 See Also
155 --------
156 *dracut*(8) *dracut.cmdline*(7)
157