dracut.8.xml

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <!-- This document was created with Syntext Serna Free. --><!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []>
   3 <!-- vim: set ts=8 sts=2 sw=2 et: -->
   4 <refentry id="dracut8">
   5   <refentryinfo>
   6     <title>dracut</title>
   7     <productname>dracut</productname>
   8     <authorgroup>
   9       <author>
  10         <contrib>Project Leader, Developer</contrib>
  11         <firstname>Harald</firstname>
  12         <surname>Hoyer</surname>
  13         <email>harald@redhat.com</email>
  14       </author>
  15       <author>
  16         <contrib>Developer</contrib>
  17         <firstname>Victor</firstname>
  18         <surname>Lowther</surname>
  19         <email>victor.lowther@gmail.com</email>
  20       </author>
  21       <author>
  22         <contrib>Developer</contrib>
  23         <firstname>Philippe</firstname>
  24         <surname>Seewer</surname>
  25         <email>philippe.seewer@bfh.ch</email>
  26       </author>
  27       <author>
  28         <contrib>Developer</contrib>
  29         <firstname>Warren</firstname>
  30         <surname>Togami</surname>
  31       </author>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Amadeusz</firstname>
  35         <surname>Żołnowski</surname>
  36         <email>aidecoe@aidecoe.name</email>
  37       </author>
  38       <author>
  39         <contrib>Developer</contrib>
  40         <firstname>Jeremy</firstname>
  41         <surname>Katz</surname>
  42       </author>
  43       <author>
  44         <contrib>Developer</contrib>
  45         <firstname>David</firstname>
  46         <surname>Dillow</surname>
  47         <email>dave@thedillows.org</email>
  48       </author>
  49     </authorgroup>
  50   </refentryinfo>
  51   <refmeta>
  52     <refentrytitle>dracut</refentrytitle>
  53     <manvolnum>8</manvolnum>
  54     <refmiscinfo class="version"/>
  55   </refmeta>
  56   <refnamediv>
  57     <refname>dracut</refname>
  58     <refpurpose>create initial ramdisk images for preloading modules</refpurpose>
  59   </refnamediv>
  60   <refsynopsisdiv>
  61     <cmdsynopsis>
  62       <command>dracut</command>
  63       <arg choice="opt" rep="repeat">
  64         <replaceable>OPTION</replaceable>
  65       </arg>
  66       <arg choice="opt">
  67         <replaceable>&lt;image&gt;</replaceable>
  68         <arg choice="opt">
  69           <replaceable>&lt;kernel-version&gt;</replaceable>
  70         </arg>
  71       </arg>
  72       <sbr/>
  73     </cmdsynopsis>
  74   </refsynopsisdiv>
  75   <refsect1>
  76     <title>Description</title>
  77     <para><command>dracut</command>
  78 creates an initial image used by the kernel for
  79 preloading the block device modules (such as IDE, SCSI or RAID)
  80 which are needed to access the root filesystem.</para>
  81     <para>
  82 For a complete list of kernel command line options see
  83       <citerefentry>
  84         <refentrytitle>dracut.cmdline</refentrytitle>
  85         <manvolnum>7</manvolnum>
  86       </citerefentry>
  87 </para>
  88     <refsect2>
  89       <title>Options</title>
  90       <variablelist>
  91         <varlistentry>
  92           <term>
  93             <option>-f</option>
  94           </term>
  95           <term>
  96             <option>--force</option>
  97           </term>
  98           <listitem>
  99             <para>overwrite existing initramfs file.</para>
 100           </listitem>
 101         </varlistentry>
 102         <varlistentry>
 103           <term>
 104             <option>-m</option>
 105           </term>
 106           <term>
 107             <option>--modules&nbsp;<replaceable>&lt;list of dracut modules&gt;</replaceable></option>
 108           </term>
 109           <listitem>
 110             <para>specify a space-separated list of dracut modules to call
 111 when building the initramfs.
 112 Modules are located in
 113 <filename>/usr/lib/dracut/modules.d</filename>. This parameter can be specified multiple times.</para>
 114             <para>
 115               If [LIST] has multiple arguments, then you have to put these in quotes.
 116               For example:
 117               <screen># dracut --modules "module1 module2"  ...</screen>
 118             </para>
 119           </listitem>
 120         </varlistentry>
 121         <varlistentry>
 122           <term>
 123             <option>-o</option>
 124           </term>
 125           <term>
 126             <option>--omit&nbsp;<replaceable>&lt;list of dracut modules&gt;</replaceable></option>
 127           </term>
 128           <listitem>
 129             <para>omit a space-separated list of dracut modules. This parameter can be specified multiple times.</para>
 130             <para>
 131               If [LIST] has multiple arguments, then you have to put these in quotes.
 132               For example:
 133               <screen># dracut --omit "module1 module2"  ...</screen>
 134             </para>
 135           </listitem>
 136         </varlistentry>
 137         <varlistentry>
 138           <term>
 139             <option>-a</option>
 140           </term>
 141           <term>
 142             <option>--add&nbsp;<replaceable>&lt;list of dracut modules&gt;</replaceable></option>
 143           </term>
 144           <listitem>
 145             <para>add a space-separated list of dracut modules to the default set of modules. This parameter can be specified multiple times.</para>
 146             <para>
 147               If [LIST] has multiple arguments, then you have to put these in quotes.
 148               For example:
 149               <screen># dracut --add "module1 module2"  ...</screen>
 150             </para>
 151           </listitem>
 152         </varlistentry>
 153         <varlistentry>
 154           <term>
 155             <option>--force-add&nbsp;<replaceable>&lt;list of dracut modules&gt;</replaceable></option>
 156           </term>
 157           <listitem>
 158             <para>force to add a space-separated list of dracut modules to the default set of modules, when -H is specified. This parameter can be specified multiple times.</para>
 159             <para>
 160               If [LIST] has multiple arguments, then you have to put these in quotes.
 161               For example:
 162               <screen># dracut --force-add "module1 module2"  ...</screen>
 163             </para>
 164           </listitem>
 165         </varlistentry>
 166
 167         <varlistentry>
 168           <term>
 169             <option>-d</option>
 170           </term>
 171           <term>
 172             <option>--drivers&nbsp;<replaceable>&lt;list of kernel modules&gt;</replaceable></option>
 173           </term>
 174           <listitem>
 175             <para>specify a space-separated list of kernel modules to exclusively include
 176 in the initramfs.
 177 The kernel modules have to be specified without the &quot;.ko&quot; suffix. This parameter can be specified multiple times.</para>
 178             <para>
 179               If [LIST] has multiple arguments, then you have to put these in quotes.
 180               For example:
 181               <screen># dracut --drivers "kmodule1 kmodule2"  ...</screen>
 182             </para>
 183           </listitem>
 184         </varlistentry>
 185         <varlistentry>
 186           <term>
 187             <option>--add-drivers&nbsp;<replaceable>&lt;list of kernel modules&gt;</replaceable></option>
 188           </term>
 189           <listitem>
 190             <para>specify a space-separated list of kernel modules to add to the initramfs.
 191 The kernel modules have to be specified without the &quot;.ko&quot; suffix. This parameter can be specified multiple times.</para>
 192             <para>
 193               If [LIST] has multiple arguments, then you have to put these in quotes.
 194               For example:
 195               <screen># dracut --add-drivers "kmodule1 kmodule2"  ...</screen>
 196             </para>
 197           </listitem>
 198         </varlistentry>
 199         <varlistentry>
 200           <term>
 201             <option>--omit-drivers&nbsp;<replaceable>&lt;list of kernel modules&gt;</replaceable></option>
 202           </term>
 203           <listitem>
 204             <para>specify a space-separated list of kernel modules not to add to the initramfs.
 205 The kernel modules have to be specified without the &quot;.ko&quot; suffix. This parameter can be specified multiple times.</para>
 206             <para>
 207               If [LIST] has multiple arguments, then you have to put these in quotes.
 208               For example:
 209               <screen># dracut --omit-drivers "kmodule1 kmodule2"  ...</screen>
 210             </para>
 211           </listitem>
 212         </varlistentry>
 213         <varlistentry>
 214           <term>
 215             <option>--filesystems&nbsp;<replaceable>&lt;list of filesystems&gt;</replaceable></option>
 216           </term>
 217           <listitem>
 218             <para>specify a space-separated list of kernel filesystem modules to exclusively
 219 include in the generic initramfs. This parameter can be specified multiple times.</para>
 220             <para>
 221               If [LIST] has multiple arguments, then you have to put these in quotes.
 222               For example:
 223               <screen># dracut --filesystems "filesystem1 filesystem2"  ...</screen>
 224             </para>
 225           </listitem>
 226         </varlistentry>
 227         <varlistentry>
 228           <term>
 229             <option>-k</option>
 230           </term>
 231           <term>
 232             <option>--kmoddir&nbsp;<replaceable>&lt;kernel directory&gt;</replaceable></option>
 233           </term>
 234           <listitem>
 235             <para>specify the directory, where to look for kernel modules</para>
 236           </listitem>
 237         </varlistentry>
 238         <varlistentry>
 239           <term>
 240             <option> --fwdir&nbsp;<replaceable>&lt;dir&gt;[:&lt;dir&gt;...]</replaceable></option>
 241           </term>
 242           <listitem>
 243             <para>specify additional directories, where to look for firmwares. This parameter can be specified multiple times.</para>
 244           </listitem>
 245         </varlistentry>
 246         <varlistentry>
 247           <term>
 248             <option>--kernel-only</option>
 249           </term>
 250           <listitem>
 251             <para>only install kernel drivers and firmware files</para>
 252           </listitem>
 253         </varlistentry>
 254         <varlistentry>
 255           <term>
 256             <option>--no-kernel</option>
 257           </term>
 258           <listitem>
 259             <para>do not install kernel drivers and firmware files</para>
 260           </listitem>
 261         </varlistentry>
 262         <varlistentry>
 263           <term>
 264             <option>--mdadmconf</option>
 265           </term>
 266           <listitem>
 267             <para>include local <filename>/etc/mdadm.conf</filename></para>
 268           </listitem>
 269         </varlistentry>
 270         <varlistentry>
 271           <term>
 272             <option>--nomdadmconf</option>
 273           </term>
 274           <listitem>
 275             <para>do not include local <filename>/etc/mdadm.conf</filename></para>
 276           </listitem>
 277         </varlistentry>
 278         <varlistentry>
 279           <term>
 280             <option>--lvmconf</option>
 281           </term>
 282           <listitem>
 283             <para>include local <filename>/etc/lvm/lvm.conf</filename></para>
 284           </listitem>
 285         </varlistentry>
 286         <varlistentry>
 287           <term>
 288             <option>--nolvmconf</option>
 289           </term>
 290           <listitem>
 291             <para>do not include local <filename>/etc/lvm/lvm.conf</filename></para>
 292           </listitem>
 293         </varlistentry>
 294         <varlistentry>
 295           <term>
 296             <option>--fscks [LIST]</option>
 297           </term>
 298           <listitem>
 299             <para>add a space-separated list of fsck tools, in addition to
 300               <filename>dracut.conf</filename>'s specification; the
 301               installation is opportunistic (non-existing tools are ignored)
 302             </para>
 303             <para>
 304               If [LIST] has multiple arguments, then you have to put these in quotes.
 305               For example:
 306               <screen># dracut --fscks "fsck.foo barfsck"  ...</screen>
 307             </para>
 308           </listitem>
 309         </varlistentry>
 310         <varlistentry>
 311           <term>
 312             <option>--nofscks</option>
 313           </term>
 314           <listitem>
 315             <para>inhibit installation of any fsck tools</para>
 316           </listitem>
 317         </varlistentry>
 318         <varlistentry>
 319           <term>
 320             <option>--strip</option>
 321           </term>
 322           <listitem>
 323             <para>strip binaries in the initramfs (default)</para>
 324           </listitem>
 325         </varlistentry>
 326         <varlistentry>
 327           <term>
 328             <option>--nostrip</option>
 329           </term>
 330           <listitem>
 331             <para>do not strip binaries in the initramfs</para>
 332           </listitem>
 333         </varlistentry>
 334         <varlistentry>
 335           <term>
 336             <option>--prefix&nbsp;<replaceable>&lt;dir&gt;</replaceable></option>
 337           </term>
 338           <listitem>
 339             <para>prefix initramfs files with the specified directory</para>
 340           </listitem>
 341         </varlistentry>
 342         <varlistentry>
 343           <term>
 344             <option>--noprefix</option>
 345           </term>
 346           <listitem>
 347             <para>do not prefix initramfs files (default)</para>
 348           </listitem>
 349         </varlistentry>
 350         <varlistentry>
 351           <term>
 352             <option>--ctty</option>
 353           </term>
 354           <listitem>
 355             <para>if possible, try to spawn an emergency shell on a terminal
 356               with job control</para>
 357           </listitem>
 358         </varlistentry>
 359         <varlistentry>
 360           <term>
 361             <option>-h</option>
 362           </term>
 363           <term>
 364             <option>--help</option>
 365           </term>
 366           <listitem>
 367             <para>display help text and exit.</para>
 368           </listitem>
 369         </varlistentry>
 370         <varlistentry>
 371           <term>
 372             <option>--debug</option>
 373           </term>
 374           <listitem>
 375             <para>output debug information of the build process</para>
 376           </listitem>
 377         </varlistentry>
 378         <varlistentry>
 379           <term>
 380             <option>-v</option>
 381           </term>
 382           <term>
 383             <option>--verbose</option>
 384           </term>
 385           <listitem>
 386             <para>increase verbosity level (default is info(4))</para>
 387           </listitem>
 388         </varlistentry>
 389         <varlistentry>
 390           <term>
 391             <option>-q</option>
 392           </term>
 393           <term>
 394             <option>--quiet</option>
 395           </term>
 396           <listitem>
 397             <para>decrease verbosity level (default is info(4))</para>
 398           </listitem>
 399         </varlistentry>
 400         <varlistentry>
 401           <term>
 402             <option>-c</option>
 403           </term>
 404           <term>
 405             <option>--conf&nbsp;<replaceable>&lt;dracut configuration file&gt;</replaceable></option>
 406           </term>
 407           <listitem>
 408             <para>specify configuration file to use.
 409 Default:
 410 <filename>/etc/dracut.conf</filename></para>
 411           </listitem>
 412         </varlistentry>
 413         <varlistentry>
 414           <term>
 415             <option>--confdir&nbsp;<replaceable>&lt;configuration directory&gt;</replaceable></option>
 416           </term>
 417           <listitem>
 418             <para>specify configuration directory to use.
 419 Default:
 420 <filename>/etc/dracut.conf.d</filename></para>
 421           </listitem>
 422         </varlistentry>
 423         <varlistentry>
 424           <term>
 425             <option>--sshkey&nbsp;<replaceable>&lt;sshkey file&gt;</replaceable></option>
 426           </term>
 427           <listitem>
 428             <para>ssh key file used with ssh-client module.</para>
 429           </listitem>
 430         </varlistentry>
 431         <varlistentry>
 432           <term>
 433             <option>-l</option>
 434           </term>
 435           <term>
 436             <option>--local</option>
 437           </term>
 438           <listitem>
 439             <para>activates the local mode. dracut will use modules from the current working
 440 directory instead of the system-wide installed modules in
 441 <filename>/usr/lib/dracut/modules.d</filename>.
 442 This is useful when running dracut from a git checkout.</para>
 443           </listitem>
 444         </varlistentry>
 445         <varlistentry>
 446           <term>
 447             <option>-H</option>
 448           </term>
 449           <term>
 450             <option>--hostonly</option>
 451           </term>
 452           <listitem>
 453             <para>Host-Only mode: Install only what is needed for booting
 454 the local host instead of a generic host.
 455      <warning>
 456                 <para>If chrooted to another root other than the real root device, use &quot;--fstab&quot; and provide a valid <filename>/etc/fstab</filename>.</para>
 457               </warning></para>
 458           </listitem>
 459         </varlistentry>
 460         <varlistentry>
 461           <term>
 462             <option>--fstab</option>
 463           </term>
 464           <listitem>
 465             <para>Use <filename>/etc/fstab</filename> instead of <filename>/proc/self/mountinfo</filename>.</para>
 466           </listitem>
 467         </varlistentry>
 468         <varlistentry>
 469           <term>
 470             <option>--add_fstab&nbsp;<replaceable>&lt;filename&gt;</replaceable>&nbsp;</option>
 471           </term>
 472           <listitem>
 473             <para>Add entries of <replaceable>&lt;filename&gt;</replaceable> to the initramfs /etc/fstab.</para>
 474           </listitem>
 475           </varlistentry>
 476         <varlistentry>
 477           <term>
 478             <option>--mount&nbsp;&quot;<replaceable>&lt;device&gt;</replaceable> <replaceable>&lt;mountpoint&gt;</replaceable> <replaceable>&lt;filesystem type&gt;</replaceable> <replaceable>&lt;filesystem options&gt;</replaceable>&quot;</option>
 479           </term>
 480           <listitem>
 481             <para>Add entries of <replaceable>&lt;filename&gt;</replaceable> to the initramfs /etc/fstab.</para>
 482           </listitem>
 483           </varlistentry>
 484           <varlistentry>
 485           <term>
 486             <option>-i</option>
 487           </term>
 488           <term>
 489             <option>--include&nbsp;<replaceable>&lt;SOURCE&gt;</replaceable>&nbsp;<replaceable>&lt;TARGET&gt;</replaceable></option>
 490           </term>
 491           <listitem>
 492             <para>include the files in the SOURCE directory into the
 493 TARGET directory in the final initramfs. If SOURCE is a file, it will be installed to TARGET in the final initramfs. This parameter can be specified multiple times.</para>
 494           </listitem>
 495         </varlistentry>
 496         <varlistentry>
 497           <term>
 498             <option>-I</option>
 499           </term>
 500           <term>
 501             <option>--install&nbsp;<replaceable>&lt;file list&gt;</replaceable></option>
 502           </term>
 503           <listitem>
 504             <para>install the space separated list of files into the initramfs.</para>
 505             <para>
 506               If [LIST] has multiple arguments, then you have to put these in quotes.
 507               For example:
 508               <screen># dracut --install "/bin/foo /sbin/bar"  ...</screen>
 509             </para>
 510           </listitem>
 511         </varlistentry>
 512         <varlistentry>
 513           <term>
 514             <option>--gzip</option>
 515           </term>
 516           <listitem>
 517             <para>Compress the generated initramfs using gzip.
 518      This will be done by default, unless another compression option or --no-compress is passed. Equivalent to "--compress=gzip -9"</para>
 519           </listitem>
 520         </varlistentry>
 521         <varlistentry>
 522           <term>
 523             <option>--bzip2</option>
 524           </term>
 525           <listitem>
 526             <para>Compress the generated initramfs using bzip2.
 527      <warning>
 528                 <para>Make sure your kernel has bzip2 decompression support compiled in, otherwise you will not be able to boot. Equivalent to "--compress=bzip2"</para>
 529               </warning></para>
 530           </listitem>
 531         </varlistentry>
 532         <varlistentry>
 533           <term>
 534             <option>--lzma</option>
 535           </term>
 536           <listitem>
 537             <para>Compress the generated initramfs using lzma.
 538      <warning>
 539                 <para>Make sure your kernel has lzma decompression support compiled in, otherwise you will not be able to boot. Equivalent to "--compress=lzma -9"</para>
 540               </warning></para>
 541           </listitem>
 542         </varlistentry>
 543         <varlistentry>
 544           <term>
 545             <option>--xz</option>
 546           </term>
 547           <listitem>
 548             <para>Compress the generated initramfs using xz.
 549      <warning>
 550                 <para>Make sure your kernel has xz decompression support compiled in, otherwise you will not be able to boot. Equivalent to "--compress=xz --check=crc32 --lzma2=dict=1MiB"</para>
 551               </warning></para>
 552           </listitem>
 553         </varlistentry>
 554         <varlistentry>
 555           <term>
 556             <option>--compress&nbsp;<replaceable>&lt;compressor&gt;</replaceable></option>
 557           </term>
 558           <listitem>
 559             <para>Compress the generated initramfs using the passed compression program.  If you pass it just the name of a compression program, it will call that program with known-working arguments.  If you pass a quoted string with arguments, it will be called with exactly those arguments.  Depending on what you pass, this may result in an initramfs that the kernel cannot decompress.</para>
 560           </listitem>
 561         </varlistentry>
 562         <varlistentry>
 563           <term>
 564             <option>--no-compress</option>
 565           </term>
 566           <listitem>
 567             <para>Do not compress the generated initramfs. This will override any other compression options.</para>
 568           </listitem>
 569         </varlistentry>
 570         <varlistentry>
 571           <term>
 572             <option>--list-modules</option>
 573           </term>
 574           <listitem>
 575             <para>List all available dracut modules.</para>
 576           </listitem>
 577         </varlistentry>
 578         <varlistentry>
 579           <term>
 580             <option>-M</option>
 581           </term>
 582           <term>
 583             <option>--show-modules</option>
 584           </term>
 585           <listitem>
 586             <para>Print included module's name to standard output during build.</para>
 587           </listitem>
 588         </varlistentry>
 589         <varlistentry>
 590           <term>
 591             <option>--keep</option>
 592           </term>
 593           <listitem>
 594             <para>Keep the initramfs temporary directory for debugging purposes.</para>
 595           </listitem>
 596         </varlistentry>
 597       </variablelist>
 598     </refsect2>
 599   </refsect1>
 600   <refsect1>
 601     <title>Files</title>
 602     <variablelist>
 603       <varlistentry>
 604         <term>
 605           <filename>/var/log/dracut.log</filename>
 606         </term>
 607         <listitem>
 608           <para>logfile of initramfs image creation</para>
 609         </listitem>
 610       </varlistentry>
 611       <varlistentry>
 612         <term>
 613           <filename>/tmp/dracut.log</filename>
 614         </term>
 615         <listitem>
 616           <para>logfile of initramfs image creation, if <filename>/var/log/dracut.log</filename> is not writable</para>
 617         </listitem>
 618       </varlistentry>
 619       <varlistentry>
 620         <term>
 621           <filename>/etc/dracut.conf</filename>
 622         </term>
 623         <listitem>
 624           <para>see <citerefentry>
 625               <refentrytitle>dracut.conf</refentrytitle>
 626               <manvolnum>5</manvolnum>
 627             </citerefentry></para>
 628         </listitem>
 629       </varlistentry>
 630       <varlistentry>
 631         <term>
 632           <filename>/etc/dracut.conf.d/*.conf</filename>
 633         </term>
 634         <listitem>
 635           <para>see <citerefentry>
 636               <refentrytitle>dracut.conf</refentrytitle>
 637               <manvolnum>5</manvolnum>
 638             </citerefentry></para>
 639         </listitem>
 640       </varlistentry>
 641     </variablelist>
 642     <refsect2>
 643       <title>Configuration in the Initramfs</title>
 644       <variablelist>
 645         <varlistentry>
 646           <term>
 647             <filename>/etc/conf.d/</filename>
 648           </term>
 649           <listitem>
 650             <para>Any files found in <filename>/etc/conf.d/</filename> will be sourced in the initramfs to
 651 set initial values. Command line options will override these values
 652 set in the configuration files.</para>
 653           </listitem>
 654         </varlistentry>
 655         <varlistentry>
 656           <term>
 657             <filename>/etc/cmdline</filename>
 658           </term>
 659           <listitem>
 660             <para>Can contain additional command line options.</para>
 661           </listitem>
 662         </varlistentry>
 663       </variablelist>
 664     </refsect2>
 665   </refsect1>
 666   <refsect1>
 667     <title>Availability</title>
 668     <para>The dracut command is part of the dracut package and is available from
 669 <ulink url='https://dracut.wiki.kernel.org'>https://dracut.wiki.kernel.org</ulink></para>
 670   </refsect1>
 671   <refsect1>
 672     <title>See Also</title>
 673     <para>
 674       <citerefentry>
 675         <refentrytitle>dracut.cmdline</refentrytitle>
 676         <manvolnum>7</manvolnum>
 677       </citerefentry>
 678       <citerefentry>
 679         <refentrytitle>dracut.conf</refentrytitle>
 680         <manvolnum>5</manvolnum>
 681       </citerefentry>
 682     </para>
 683   </refsect1>
 684 </refentry>