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 initramfs.
  34     Modules are located in _/usr/lib/dracut/modules.d_. This parameter can be
  35     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 specified multiple times.
  48
  49 [NOTE]
  50 ===============================
  51 If [LIST] has multiple arguments, then you have to put these in quotes. For
  52 example:
  53 ----
  54 # dracut --omit "module1 module2"  ...
  55 ----
  56 ===============================
  57
  58 **-a, --add** _<list of dracut modules>_::
  59     add a space-separated list of dracut modules to the default set of modules.
  60     This parameter can be specified multiple times.
  61 +
  62 [NOTE]
  63 ===============================
  64 If [LIST] has multiple arguments, then you have to put these in quotes. For
  65 example:
  66 ----
  67 # dracut --add "module1 module2"  ...
  68 ----
  69 ===============================
  70
  71 **--force-add** _<list of dracut modules>_::
  72     force to add a space-separated list of dracut modules to the default set of
  73     modules, when -H is specified. This parameter can be specified multiple
  74     times.
  75 +
  76 [NOTE]
  77 ===============================
  78 If [LIST] has multiple arguments, then you have to put these in quotes. For
  79 example:
  80 ----
  81 # dracut --force-add "module1 module2"  ...
  82 ----
  83 ===============================
  84
  85 **-d, --drivers** _<list of kernel modules>_::
  86     specify a space-separated list of kernel modules to exclusively include
  87     in the initramfs. The kernel modules have to be specified without the ".ko"
  88     suffix. This parameter can be specified multiple times.
  89 +
  90 [NOTE]
  91 ===============================
  92 If [LIST] has multiple arguments, then you have to put these in quotes. For
  93 example:
  94 ----
  95 # dracut --drivers "kmodule1 kmodule2"  ...
  96 ----
  97 ===============================
  98
  99 **--add-drivers** _<list of kernel modules>_::
 100     specify a space-separated list of kernel modules to add to the initramfs.
 101     The kernel modules have to be specified without the ".ko" suffix. This
 102     parameter can be specified multiple times.
 103 +
 104 [NOTE]
 105 ===============================
 106 If [LIST] has multiple arguments, then you have to put these in quotes. For
 107 example:
 108 ----
 109 # dracut --add-drivers "kmodule1 kmodule2"  ...
 110 ----
 111 ===============================
 112
 113 **--omit-drivers** _<list of kernel modules>_::
 114     specify a space-separated list of kernel modules not to add to the
 115     initramfs.
 116     The kernel modules have to be specified without the ".ko" suffix. This
 117     parameter can be specified multiple times.
 118 +
 119 [NOTE]
 120 ===============================
 121 If [LIST] has multiple arguments, then you have to put these in quotes. For
 122 example:
 123 ----
 124 # dracut --omit-drivers "kmodule1 kmodule2"  ...
 125 ----
 126 ===============================
 127
 128 **--filesystems** _<list of filesystems>_::
 129     specify a space-separated list of kernel filesystem modules to exclusively
 130     include in the generic initramfs. This parameter can be specified multiple
 131     times.
 132
 133 [NOTE]
 134 ===============================
 135 If [LIST] has multiple arguments, then you have to put these in quotes. For
 136 example:
 137 ----
 138 # dracut --filesystems "filesystem1 filesystem2"  ...
 139 ----
 140 ===============================
 141
 142 **-k, --kmoddir** _<kernel directory>_::
 143     specify the directory, where to look for kernel modules
 144
 145 **--fwdir** _<dir>[:<dir>...]++_::
 146     specify additional directories, where to look for firmwares. This parameter
 147     can be specified multiple times.
 148
 149 **--kernel-only**::
 150     only install kernel drivers and firmware files
 151
 152 **--no-kernel**::
 153     do not install kernel drivers and firmware files
 154
 155 **--mdadmconf**::
 156     include local _/etc/mdadm.conf_
 157
 158 **--nomdadmconf**::
 159     do not include local _/etc/mdadm.conf_
 160
 161 **--lvmconf**::
 162     include local _/etc/lvm/lvm.conf_
 163
 164 **--nolvmconf**::
 165     do not include local _/etc/lvm/lvm.conf_
 166
 167 **--fscks** [LIST]::
 168     add a space-separated list of fsck tools, in addition to _dracut.conf_'s
 169     specification; the installation is opportunistic (non-existing tools are
 170     ignored)
 171 +
 172 [NOTE]
 173 ===============================
 174 If [LIST] has multiple arguments, then you have to put these in quotes. For
 175 example:
 176 ----
 177 # dracut --fscks "fsck.foo barfsck"  ...
 178 ----
 179 ===============================
 180
 181 **--nofscks**::
 182     inhibit installation of any fsck tools
 183
 184 **--strip**::
 185     strip binaries in the initramfs (default)
 186
 187 **--nostrip**::
 188     do not strip binaries in the initramfs
 189
 190 **--prefix** _<dir>_::
 191     prefix initramfs files with the specified directory
 192
 193 **--noprefix**::
 194     do not prefix initramfs files (default)
 195
 196 **--ctty**::
 197     if possible, try to spawn an emergency shell on a terminal with job control
 198
 199 **-h, --help**::
 200     display help text and exit.
 201
 202 **--debug**::
 203     output debug information of the build process
 204
 205 **-v, --verbose**::
 206     increase verbosity level (default is info(4))
 207
 208 **-q, --quiet**:: decrease verbosity level (default is info(4))
 209
 210 **-c, --conf** _<dracut configuration file>_::
 211     specify configuration file to use.
 212 +
 213 Default:
 214    _/etc/dracut.conf_
 215
 216 **--confdir** _<configuration directory>_::
 217     specify configuration directory to use.
 218 +
 219 Default:
 220    _/etc/dracut.conf.d_
 221
 222 **--sshkey** _<sshkey file>_:: ssh key file used with ssh-client module.
 223
 224 **-l, --local**::
 225     activates the local mode. dracut will use modules from the current working
 226     directory instead of the system-wide installed modules in
 227     _/usr/lib/dracut/modules.d_.
 228     This is useful when running dracut from a git checkout.
 229
 230 **-H, --hostonly**::
 231     Host-Only mode: Install only what is needed for booting
 232     the local host instead of a generic host.
 233 +
 234 [WARNING]
 235 ====
 236 If chrooted to another root other than the real root device, use "--fstab" and provide a valid _/etc/fstab_.
 237 ====
 238
 239 **--fstab**::
 240     Use _/etc/fstab_ instead of _/proc/self/mountinfo_.
 241
 242 **--add_fstab** _<filename>_ ::
 243     Add entries of _<filename>_ to the initramfs /etc/fstab.
 244
 245 **--mount** "_<device>_ _<mountpoint>_ _<filesystem type>_ _<filesystem options>_"::
 246     Add entries of _<filename>_ to the initramfs /etc/fstab.
 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)