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