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