dracut.8.asc

   1 DRACUT(8)
   2 =========
   3 :doctype: manpage
   4 :man source:   dracut
   5 :man manual:   dracut
   6
   7 NAME
   8 ----
   9 dracut - low-level tool for generating an initramfs image
  10
  11 SYNOPSIS
  12 --------
  13 *dracut* ['OPTION...'] [<image> [_<kernel version>_]]
  14
  15 DESCRIPTION
  16 -----------
  17 dracut creates an initial image used by the kernel for preloading the block
  18 device modules (such as IDE, SCSI or RAID) which are needed to access the root
  19 filesystem, mounting the root filesystem and booting into the real system.
  20
  21 At boot time, the kernel unpacks that archive into RAM disk, mounts and uses it
  22 as initial root file system. All finding of the root device happens in this
  23 early userspace.
  24
  25 For a complete list of kernel command line options see *dracut.cmdline*(7)
  26
  27 OPTIONS
  28 -------
  29 **-f, --force**::
  30     overwrite existing initramfs file.
  31
  32 **-m, --modules** _<list of dracut modules>_::
  33     specify a space-separated list of dracut modules to call when building the
  34     initramfs. Modules are located in _/usr/lib/dracut/modules.d_. This
  35     parameter can be specified multiple times.
  36 +
  37 [NOTE]
  38 ===============================
  39 If [LIST] has multiple arguments, then you have to put these in quotes. For
  40 example:
  41 ----
  42 # dracut --modules "module1 module2"  ...
  43 ----
  44 ===============================
  45
  46 **-o, --omit** _<list of dracut modules>_::
  47     omit a space-separated list of dracut modules. This parameter can be
  48     specified multiple times.
  49
  50 [NOTE]
  51 ===============================
  52 If [LIST] has multiple arguments, then you have to put these in quotes. For
  53 example:
  54 ----
  55 # dracut --omit "module1 module2"  ...
  56 ----
  57 ===============================
  58
  59 **-a, --add** _<list of dracut modules>_::
  60     add a space-separated list of dracut modules to the default set of modules.
  61     This parameter can be specified multiple times.
  62 +
  63 [NOTE]
  64 ===============================
  65 If [LIST] has multiple arguments, then you have to put these in quotes. For
  66 example:
  67 ----
  68 # dracut --add "module1 module2"  ...
  69 ----
  70 ===============================
  71
  72 **--force-add** _<list of dracut modules>_::
  73     force to add a space-separated list of dracut modules to the default set of
  74     modules, when -H is specified. This parameter can be specified multiple
  75     times.
  76 +
  77 [NOTE]
  78 ===============================
  79 If [LIST] has multiple arguments, then you have to put these in quotes. For
  80 example:
  81 ----
  82 # dracut --force-add "module1 module2"  ...
  83 ----
  84 ===============================
  85
  86 **-d, --drivers** _<list of kernel modules>_::
  87     specify a space-separated list of kernel modules to exclusively include
  88     in the initramfs. The kernel modules have to be specified without the ".ko"
  89     suffix. This parameter can be specified multiple times.
  90 +
  91 [NOTE]
  92 ===============================
  93 If [LIST] has multiple arguments, then you have to put these in quotes. For
  94 example:
  95 ----
  96 # dracut --drivers "kmodule1 kmodule2"  ...
  97 ----
  98 ===============================
  99
 100 **--add-drivers** _<list of kernel modules>_::
 101     specify a space-separated list of kernel modules to add to the initramfs.
 102     The kernel modules have to be specified without the ".ko" suffix. This
 103     parameter can be specified multiple times.
 104 +
 105 [NOTE]
 106 ===============================
 107 If [LIST] has multiple arguments, then you have to put these in quotes. For
 108 example:
 109 ----
 110 # dracut --add-drivers "kmodule1 kmodule2"  ...
 111 ----
 112 ===============================
 113
 114 **--omit-drivers** _<list of kernel modules>_::
 115     specify a space-separated list of kernel modules not to add to the
 116     initramfs.
 117     The kernel modules have to be specified without the ".ko" suffix. This
 118     parameter can be specified multiple times.
 119 +
 120 [NOTE]
 121 ===============================
 122 If [LIST] has multiple arguments, then you have to put these in quotes. For
 123 example:
 124 ----
 125 # dracut --omit-drivers "kmodule1 kmodule2"  ...
 126 ----
 127 ===============================
 128
 129 **--filesystems** _<list of filesystems>_::
 130     specify a space-separated list of kernel filesystem modules to exclusively
 131     include in the generic initramfs. This parameter can be specified multiple
 132     times.
 133
 134 [NOTE]
 135 ===============================
 136 If [LIST] has multiple arguments, then you have to put these in quotes. For
 137 example:
 138 ----
 139 # dracut --filesystems "filesystem1 filesystem2"  ...
 140 ----
 141 ===============================
 142
 143 **-k, --kmoddir** _<kernel directory>_::
 144     specify the directory, where to look for kernel modules
 145
 146 **--fwdir** _<dir>[:<dir>...]++_::
 147     specify additional directories, where to look for firmwares. This parameter
 148     can be specified multiple times.
 149
 150 **--kernel-only**::
 151     only install kernel drivers and firmware files
 152
 153 **--no-kernel**::
 154     do not install kernel drivers and firmware files
 155
 156 **--mdadmconf**::
 157     include local _/etc/mdadm.conf_
 158
 159 **--nomdadmconf**::
 160     do not include local _/etc/mdadm.conf_
 161
 162 **--lvmconf**::
 163     include local _/etc/lvm/lvm.conf_
 164
 165 **--nolvmconf**::
 166     do not include local _/etc/lvm/lvm.conf_
 167
 168 **--fscks** [LIST]::
 169     add a space-separated list of fsck tools, in addition to _dracut.conf_'s
 170     specification; the installation is opportunistic (non-existing tools are
 171     ignored)
 172 +
 173 [NOTE]
 174 ===============================
 175 If [LIST] has multiple arguments, then you have to put these in quotes. For
 176 example:
 177 ----
 178 # dracut --fscks "fsck.foo barfsck"  ...
 179 ----
 180 ===============================
 181
 182 **--nofscks**::
 183     inhibit installation of any fsck tools
 184
 185 **--strip**::
 186     strip binaries in the initramfs (default)
 187
 188 **--nostrip**::
 189     do not strip binaries in the initramfs
 190
 191 **--prefix** _<dir>_::
 192     prefix initramfs files with the specified directory
 193
 194 **--noprefix**::
 195     do not prefix initramfs files (default)
 196
 197 **-h, --help**::
 198     display help text and exit.
 199
 200 **--debug**::
 201     output debug information of the build process
 202
 203 **-v, --verbose**::
 204     increase verbosity level (default is info(4))
 205
 206 **-q, --quiet**:: decrease verbosity level (default is info(4))
 207
 208 **-c, --conf** _<dracut configuration file>_::
 209     specify configuration file to use.
 210 +
 211 Default:
 212    _/etc/dracut.conf_
 213
 214 **--confdir** _<configuration directory>_::
 215     specify configuration directory to use.
 216 +
 217 Default:
 218    _/etc/dracut.conf.d_
 219
 220 **--sshkey** _<sshkey file>_:: ssh key file used with ssh-client module.
 221
 222 **-l, --local**::
 223     activates the local mode. dracut will use modules from the current working
 224     directory instead of the system-wide installed modules in
 225     _/usr/lib/dracut/modules.d_.
 226     This is useful when running dracut from a git checkout.
 227
 228 **-H, --hostonly**::
 229     Host-Only mode: Install only what is needed for booting
 230     the local host instead of a generic host.
 231 +
 232 [WARNING]
 233 ====
 234 If chrooted to another root other than the real root device, use "--fstab" and
 235 provide a valid _/etc/fstab_.
 236 ====
 237
 238 **--fstab**::
 239     Use _/etc/fstab_ instead of _/proc/self/mountinfo_.
 240
 241 **--add_fstab** _<filename>_ ::
 242     Add entries of _<filename>_ to the initramfs /etc/fstab.
 243
 244 **--mount** "_<device>_ _<mountpoint>_ _<filesystem type>_ _<filesystem options>_"::
 245     Mount _<device>_ on _<mountpoint>_ with _<filesystem type>_ and _<filesystem
 246     options>_ in the initramfs
 247
 248 **-i, --include** _<SOURCE>_ _<TARGET>_::
 249     include the files in the SOURCE directory into the
 250     TARGET directory in the final initramfs. If SOURCE is a file, it will be
 251     installed to TARGET in the final initramfs. This parameter can be specified
 252     multiple times.
 253
 254 **-I, --install** _<file list>_::
 255     install the space separated list of files into the initramfs.
 256 +
 257 [NOTE]
 258 ===============================
 259 If [LIST] has multiple arguments, then you have to put these in quotes. For
 260 example:
 261 +
 262 ----
 263 # dracut --install "/bin/foo /sbin/bar"  ...
 264 ----
 265 ===============================
 266
 267 **--gzip**::
 268     Compress the generated initramfs using gzip. This will be done by default,
 269     unless another compression option or --no-compress is passed. Equivalent to
 270     "--compress=gzip -9"
 271
 272 **--bzip2**::
 273     Compress the generated initramfs using bzip2.
 274 +
 275 [WARNING]
 276 ====
 277 Make sure your kernel has bzip2 decompression support compiled in, otherwise you
 278 will not be able to boot. Equivalent to "--compress=bzip2"
 279 ====
 280
 281 **--lzma**::
 282     Compress the generated initramfs using lzma.
 283 +
 284 [WARNING]
 285 ====
 286 Make sure your kernel has lzma decompression support compiled in, otherwise you
 287 will not be able to boot. Equivalent to "--compress=lzma -9"
 288 ====
 289
 290 **--xz**::
 291     Compress the generated initramfs using xz.
 292 +
 293 [WARNING]
 294 ====
 295 Make sure your kernel has xz decompression support compiled in, otherwise you
 296 will not be able to boot. Equivalent to "--compress=xz --check=crc32
 297 --lzma2=dict=1MiB"
 298 ====
 299
 300 **--compress** _<compressor>_::
 301     Compress the generated initramfs using the passed compression program. If
 302     you pass it just the name of a compression program, it will call that
 303     program with known-working arguments. If you pass a quoted string with
 304     arguments, it will be called with exactly those arguments. Depending on what
 305     you pass, this may result in an initramfs that the kernel cannot decompress.
 306
 307 **--no-compress**::
 308     Do not compress the generated initramfs. This will override any other
 309     compression options.
 310
 311 **--list-modules**::
 312     List all available dracut modules.
 313
 314 **-M, --show-modules**::
 315     Print included module's name to standard output during build.
 316
 317 **--keep**::
 318     Keep the initramfs temporary directory for debugging purposes.
 319
 320 FILES
 321 -----
 322 _/var/log/dracut.log_::
 323     logfile of initramfs image creation
 324
 325 _/tmp/dracut.log_::
 326     logfile of initramfs image creation, if _/var/log/dracut.log_ is not
 327     writable
 328
 329 _/etc/dracut.conf_::
 330     see dracut.conf5
 331
 332 _/etc/dracut.conf.d/*.conf_::
 333     see dracut.conf5
 334
 335 Configuration in the initramfs
 336 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 337 _/etc/conf.d/_::
 338     Any files found in _/etc/conf.d/_ will be sourced in the initramfs to
 339     set initial values. Command line options will override these values
 340     set in the configuration files.
 341
 342 _/etc/cmdline_::
 343     Can contain additional command line options.
 344
 345 AVAILABILITY
 346 ------------
 347 The dracut command is part of the dracut package and is available from
 348 link:$$https://dracut.wiki.kernel.org$$[https://dracut.wiki.kernel.org]
 349
 350 AUTHORS
 351 -------
 352 *Harald Hoyer*::
 353     Project Leader and Developer
 354
 355 *Victor Lowther*::
 356     Developer
 357
 358 *Philippe Seewer*::
 359     Developer
 360
 361 *Warren Togami*::
 362     Developer
 363
 364 *Amadeusz Żołnowski*::
 365     Developer
 366
 367 *Jeremy Katz*::
 368     Developer
 369
 370 *David Dillow*::
 371     Developer
 372
 373 *Will Woods*::
 374     Developer
 375
 376 SEE ALSO
 377 --------
 378 *dracut.cmdline*(7) *dracut.conf*(5)