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
 187
 188 **--nostrip**::
 189     do not strip binaries in the initramfs (default)
 190
 191 **--hardlink**::
 192     hardlink files in the initramfs (default)
 193
 194 **--nohardlink**::
 195     do not hardlink files in the initramfs
 196
 197 **--prefix** _<dir>_::
 198     prefix initramfs files with the specified directory
 199
 200 **--noprefix**::
 201     do not prefix initramfs files (default)
 202
 203 **-h, --help**::
 204     display help text and exit.
 205
 206 **--debug**::
 207     output debug information of the build process
 208
 209 **-v, --verbose**::
 210     increase verbosity level (default is info(4))
 211
 212 **-q, --quiet**:: decrease verbosity level (default is info(4))
 213
 214 **-c, --conf** _<dracut configuration file>_::
 215     specify configuration file to use.
 216 +
 217 Default:
 218    _/etc/dracut.conf_
 219
 220 **--confdir** _<configuration directory>_::
 221     specify configuration directory to use.
 222 +
 223 Default:
 224    _/etc/dracut.conf.d_
 225
 226 **--tmpdir** _<temporary directory>_::
 227     specify temporary directory to use.
 228 +
 229 Default:
 230    _/var/tmp_
 231
 232 **--sshkey** _<sshkey file>_:: ssh key file used with ssh-client module.
 233
 234 **-l, --local**::
 235     activates the local mode. dracut will use modules from the current working
 236     directory instead of the system-wide installed modules in
 237     _/usr/lib/dracut/modules.d_.
 238     This is useful when running dracut from a git checkout.
 239
 240 **-H, --hostonly**::
 241     Host-Only mode: Install only what is needed for booting the local host
 242     instead of a generic host and generate host-specific configuration.
 243 +
 244 [WARNING]
 245 ====
 246 If chrooted to another root other than the real root device, use "--fstab" and
 247 provide a valid _/etc/fstab_.
 248 ====
 249
 250 **--no-hostonly**::
 251     Disable Host-Only mode
 252
 253 **--fstab**::
 254     Use _/etc/fstab_ instead of _/proc/self/mountinfo_.
 255
 256 **--add-fstab** _<filename>_ ::
 257     Add entries of _<filename>_ to the initramfs /etc/fstab.
 258
 259 **--mount** "_<device>_ _<mountpoint>_ _<filesystem type>_ _<filesystem options>_"::
 260     Mount _<device>_ on _<mountpoint>_ with _<filesystem type>_ and _<filesystem
 261     options>_ in the initramfs
 262
 263 **-i, --include** _<SOURCE>_ _<TARGET>_::
 264     include the files in the SOURCE directory into the
 265     TARGET directory in the final initramfs. If SOURCE is a file, it will be
 266     installed to TARGET in the final initramfs. This parameter can be specified
 267     multiple times.
 268
 269 **-I, --install** _<file list>_::
 270     install the space separated list of files into the initramfs.
 271 +
 272 [NOTE]
 273 ===============================
 274 If [LIST] has multiple arguments, then you have to put these in quotes. For
 275 example:
 276 +
 277 ----
 278 # dracut --install "/bin/foo /sbin/bar"  ...
 279 ----
 280 ===============================
 281
 282 **--gzip**::
 283     Compress the generated initramfs using gzip. This will be done by default,
 284     unless another compression option or --no-compress is passed. Equivalent to
 285     "--compress=gzip -9"
 286
 287 **--bzip2**::
 288     Compress the generated initramfs using bzip2.
 289 +
 290 [WARNING]
 291 ====
 292 Make sure your kernel has bzip2 decompression support compiled in, otherwise you
 293 will not be able to boot. Equivalent to "--compress=bzip2"
 294 ====
 295
 296 **--lzma**::
 297     Compress the generated initramfs using lzma.
 298 +
 299 [WARNING]
 300 ====
 301 Make sure your kernel has lzma decompression support compiled in, otherwise you
 302 will not be able to boot. Equivalent to "--compress=lzma -9"
 303 ====
 304
 305 **--xz**::
 306     Compress the generated initramfs using xz.
 307 +
 308 [WARNING]
 309 ====
 310 Make sure your kernel has xz decompression support compiled in, otherwise you
 311 will not be able to boot. Equivalent to "--compress=xz --check=crc32
 312 --lzma2=dict=1MiB"
 313 ====
 314
 315 **--compress** _<compressor>_::
 316     Compress the generated initramfs using the passed compression program. If
 317     you pass it just the name of a compression program, it will call that
 318     program with known-working arguments. If you pass a quoted string with
 319     arguments, it will be called with exactly those arguments. Depending on what
 320     you pass, this may result in an initramfs that the kernel cannot decompress.
 321
 322 **--no-compress**::
 323     Do not compress the generated initramfs. This will override any other
 324     compression options.
 325
 326 **--list-modules**::
 327     List all available dracut modules.
 328
 329 **-M, --show-modules**::
 330     Print included module's name to standard output during build.
 331
 332 **--keep**::
 333     Keep the initramfs temporary directory for debugging purposes.
 334
 335 FILES
 336 -----
 337 _/var/log/dracut.log_::
 338     logfile of initramfs image creation
 339
 340 _/tmp/dracut.log_::
 341     logfile of initramfs image creation, if _/var/log/dracut.log_ is not
 342     writable
 343
 344 _/etc/dracut.conf_::
 345     see dracut.conf5
 346
 347 _/etc/dracut.conf.d/*.conf_::
 348     see dracut.conf5
 349
 350 Configuration in the initramfs
 351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 352 _/etc/conf.d/_::
 353     Any files found in _/etc/conf.d/_ will be sourced in the initramfs to
 354     set initial values. Command line options will override these values
 355     set in the configuration files.
 356
 357 _/etc/cmdline_::
 358     Can contain additional command line options.
 359
 360 AVAILABILITY
 361 ------------
 362 The dracut command is part of the dracut package and is available from
 363 link:$$https://dracut.wiki.kernel.org$$[https://dracut.wiki.kernel.org]
 364
 365 AUTHORS
 366 -------
 367 *Harald Hoyer*::
 368     Project Leader and Developer
 369
 370 *Victor Lowther*::
 371     Developer
 372
 373 *Philippe Seewer*::
 374     Developer
 375
 376 *Warren Togami*::
 377     Developer
 378
 379 *Amadeusz Żołnowski*::
 380     Developer
 381
 382 *Jeremy Katz*::
 383     Developer
 384
 385 *David Dillow*::
 386     Developer
 387
 388 *Will Woods*::
 389     Developer
 390
 391 SEE ALSO
 392 --------
 393 *dracut.cmdline*(7) *dracut.conf*(5)