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