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 <refentry id="dracut8">
   4   <refentryinfo>
   5     <title>dracut</title>
   6     <productname>dracut</productname>
   7     <authorgroup>
   8       <author>
   9         <contrib>Project Leader, Developer</contrib>
  10         <firstname>Harald</firstname>
  11         <surname>Hoyer</surname>
  12         <email>harald@redhat.com</email>
  13       </author>
  14       <author>
  15         <contrib>Developer</contrib>
  16         <firstname>Victor</firstname>
  17         <surname>Lowther</surname>
  18         <email>victor.lowther@gmail.com</email>
  19       </author>
  20       <author>
  21         <contrib>Developer</contrib>
  22         <firstname>Warren</firstname>
  23         <surname>Togami</surname>
  24         <email>wtogami@redhat.com</email>
  25       </author>
  26       <author>
  27         <contrib>Developer</contrib>
  28         <firstname>Jeremy</firstname>
  29         <surname>Katz</surname>
  30         <email>katzj@redhat.com</email>
  31       </author>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Philippe</firstname>
  35         <surname>Seewer</surname>
  36         <email>philippe.seewer@bfh.ch</email>
  37       </author>
  38       <author>
  39         <contrib>Developer</contrib>
  40         <firstname>David</firstname>
  41         <surname>Dillow</surname>
  42         <email>dave@thedillows.org</email>
  43       </author>
  44       <author>
  45         <contrib>Developer</contrib>
  46         <firstname>Amadeusz</firstname>
  47         <surname>Żołnowski</surname>
  48         <email>aidecoe@aidecoe.name</email>
  49       </author>
  50     </authorgroup>
  51   </refentryinfo>
  52   <refmeta>
  53     <refentrytitle>dracut</refentrytitle>
  54     <manvolnum>8</manvolnum>
  55     <refmiscinfo class="version"/>
  56   </refmeta>
  57   <refnamediv>
  58     <refname>dracut</refname>
  59     <refpurpose>create initial ramdisk images for preloading modules</refpurpose>
  60   </refnamediv>
  61   <refsynopsisdiv>
  62     <cmdsynopsis>
  63       <command>dracut</command>
  64       <arg choice="opt" rep="repeat">
  65         <replaceable>OPTION</replaceable>
  66       </arg>
  67       <arg choice="opt">
  68         <replaceable>&lt;image&gt;</replaceable>
  69         <arg choice="opt">
  70           <replaceable>&lt;kernel-version&gt;</replaceable>
  71         </arg>
  72       </arg>
  73       <sbr/>
  74     </cmdsynopsis>
  75   </refsynopsisdiv>
  76   <refsect1>
  77     <title>Description</title>
  78     <para><command>dracut</command>
  79 creates an initial image used by the kernel for
  80 preloading the block device modules (such as IDE, SCSI or RAID)
  81 which are needed to access the root filesystem.</para>
  82     <para>
  83 For a complete list of kernel command line options see
  84       <citerefentry>
  85         <refentrytitle>dracut.kernel</refentrytitle>
  86         <manvolnum>7</manvolnum>
  87       </citerefentry>
  88 </para>
  89     <refsect2>
  90       <title>Options</title>
  91       <variablelist>
  92         <varlistentry>
  93           <term>
  94             <option>-f</option>
  95           </term>
  96           <term>
  97             <option>--force</option>
  98           </term>
  99           <listitem>
 100             <para>overwrite existing initramfs file.</para>
 101           </listitem>
 102         </varlistentry>
 103         <varlistentry>
 104           <term>
 105             <option>-m</option>
 106           </term>
 107           <term>
 108             <option>--modules&nbsp;<replaceable>&lt;list of dracut modules&gt;</replaceable></option>
 109           </term>
 110           <listitem>
 111             <para>specify a space-separated list of dracut modules to call
 112 when building the initramfs.
 113 Modules are located in
 114 <filename>/usr/share/dracut/modules.d</filename>. This parameter can be specified multiple times.</para>
 115           </listitem>
 116         </varlistentry>
 117         <varlistentry>
 118           <term>
 119             <option>-o</option>
 120           </term>
 121           <term>
 122             <option>--omit&nbsp;<replaceable>&lt;list of dracut modules&gt;</replaceable></option>
 123           </term>
 124           <listitem>
 125             <para>omit a space-separated list of dracut modules. This parameter can be specified multiple times.</para>
 126           </listitem>
 127         </varlistentry>
 128         <varlistentry>
 129           <term>
 130             <option>-a</option>
 131           </term>
 132           <term>
 133             <option>--add&nbsp;<replaceable>&lt;list of dracut modules&gt;</replaceable></option>
 134           </term>
 135           <listitem>
 136             <para>add a space-separated list of dracut modules to the default set of modules. This parameter can be specified multiple times.</para>
 137           </listitem>
 138         </varlistentry>
 139         <varlistentry>
 140           <term>
 141             <option>--force-add&nbsp;<replaceable>&lt;list of dracut modules&gt;</replaceable></option>
 142           </term>
 143           <listitem>
 144             <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>
 145           </listitem>
 146         </varlistentry>
 147
 148         <varlistentry>
 149           <term>
 150             <option>-d</option>
 151           </term>
 152           <term>
 153             <option>--drivers&nbsp;<replaceable>&lt;list of kernel modules&gt;</replaceable></option>
 154           </term>
 155           <listitem>
 156             <para>specify a space-separated list of kernel modules to exclusively include
 157 in the initramfs.
 158 The kernel modules have to be specified without the &quot;.ko&quot; suffix. This parameter can be specified multiple times.</para>
 159           </listitem>
 160         </varlistentry>
 161         <varlistentry>
 162           <term>
 163             <option>--add-drivers&nbsp;<replaceable>&lt;list of kernel modules&gt;</replaceable></option>
 164           </term>
 165           <listitem>
 166             <para>specify a space-separated list of kernel modules to add to the initramfs.
 167 The kernel modules have to be specified without the &quot;.ko&quot; suffix. This parameter can be specified multiple times.</para>
 168           </listitem>
 169         </varlistentry>
 170         <varlistentry>
 171           <term>
 172             <option>--filesystems&nbsp;<replaceable>&lt;list of filesystems&gt;</replaceable></option>
 173           </term>
 174           <listitem>
 175             <para>specify a space-separated list of kernel filesystem modules to exclusively
 176 include in the generic initramfs. This parameter can be specified multiple times.</para>
 177           </listitem>
 178         </varlistentry>
 179         <varlistentry>
 180           <term>
 181             <option>-k</option>
 182           </term>
 183           <term>
 184             <option>--kmoddir&nbsp;<replaceable>&lt;kernel directory&gt;</replaceable></option>
 185           </term>
 186           <listitem>
 187             <para>specify the directory, where to look for kernel modules</para>
 188           </listitem>
 189         </varlistentry>
 190         <varlistentry>
 191           <term>
 192             <option> --fwdir&nbsp;<replaceable>&lt;dir&gt;[:&lt;dir&gt;...]</replaceable></option>
 193           </term>
 194           <listitem>
 195             <para>specify additional directories, where to look for firmwares. This parameter can be specified multiple times.</para>
 196           </listitem>
 197         </varlistentry>
 198         <varlistentry>
 199           <term>
 200             <option>--kernel-only</option>
 201           </term>
 202           <listitem>
 203             <para>only install kernel drivers and firmware files</para>
 204           </listitem>
 205         </varlistentry>
 206         <varlistentry>
 207           <term>
 208             <option>--no-kernel</option>
 209           </term>
 210           <listitem>
 211             <para>do not install kernel drivers and firmware files</para>
 212           </listitem>
 213         </varlistentry>
 214         <varlistentry>
 215           <term>
 216             <option>--mdadmconf</option>
 217           </term>
 218           <listitem>
 219             <para>include local <filename>/etc/mdadm.conf</filename></para>
 220           </listitem>
 221         </varlistentry>
 222         <varlistentry>
 223           <term>
 224             <option>--nomdadmconf</option>
 225           </term>
 226           <listitem>
 227             <para>do not include local <filename>/etc/mdadm.conf</filename></para>
 228           </listitem>
 229         </varlistentry>
 230         <varlistentry>
 231           <term>
 232             <option>--strip</option>
 233           </term>
 234           <listitem>
 235             <para>strip binaries in the initramfs (default)</para>
 236           </listitem>
 237         </varlistentry>
 238         <varlistentry>
 239           <term>
 240             <option>--nostrip</option>
 241           </term>
 242           <listitem>
 243             <para>do not strip binaries in the initramfs</para>
 244           </listitem>
 245         </varlistentry>
 246         <varlistentry>
 247           <term>
 248             <option>--prefix&nbsp;<replaceable>&lt;dir&gt;</replaceable></option>
 249           </term>
 250           <listitem>
 251             <para>prefix initramfs files with the specified directory</para>
 252           </listitem>
 253         </varlistentry>
 254         <varlistentry>
 255           <term>
 256             <option>--noprefix</option>
 257           </term>
 258           <listitem>
 259             <para>do not prefix initramfs files (default)</para>
 260           </listitem>
 261         </varlistentry>
 262         <varlistentry>
 263           <term>
 264             <option>-h</option>
 265           </term>
 266           <term>
 267             <option>--help</option>
 268           </term>
 269           <listitem>
 270             <para>display help text and exit.</para>
 271           </listitem>
 272         </varlistentry>
 273         <varlistentry>
 274           <term>
 275             <option>--debug</option>
 276           </term>
 277           <listitem>
 278             <para>output debug information of the build process</para>
 279           </listitem>
 280         </varlistentry>
 281         <varlistentry>
 282           <term>
 283             <option>-v</option>
 284           </term>
 285           <term>
 286             <option>--verbose</option>
 287           </term>
 288           <listitem>
 289             <para>increase verbosity level (default is info(4))</para>
 290           </listitem>
 291         </varlistentry>
 292         <varlistentry>
 293           <term>
 294             <option>-q</option>
 295           </term>
 296           <term>
 297             <option>--quiet</option>
 298           </term>
 299           <listitem>
 300             <para>decrease verbosity level (default is info(4))</para>
 301           </listitem>
 302         </varlistentry>
 303         <varlistentry>
 304           <term>
 305             <option>-c</option>
 306           </term>
 307           <term>
 308             <option>--conf&nbsp;<replaceable>&lt;dracut configuration file&gt;</replaceable></option>
 309           </term>
 310           <listitem>
 311             <para>specify configuration file to use.
 312 Default:
 313 <filename>/etc/dracut.conf</filename></para>
 314           </listitem>
 315         </varlistentry>
 316         <varlistentry>
 317           <term>
 318             <option>--confdir&nbsp;<replaceable>&lt;configuration directory&gt;</replaceable></option>
 319           </term>
 320           <listitem>
 321             <para>specify configuration directory to use.
 322 Default:
 323 <filename>/etc/dracut.conf.d</filename></para>
 324           </listitem>
 325         </varlistentry>
 326         <varlistentry>
 327           <term>
 328             <option>-l</option>
 329           </term>
 330           <term>
 331             <option>--local</option>
 332           </term>
 333           <listitem>
 334             <para>activates the local mode. dracut will use modules from the current working
 335 directory instead of the system-wide installed modules in
 336 <filename>/usr/share/dracut/modules.d</filename>.
 337 This is useful when running dracut from a git checkout.</para>
 338           </listitem>
 339         </varlistentry>
 340         <varlistentry>
 341           <term>
 342             <option>-H</option>
 343           </term>
 344           <term>
 345             <option>--hostonly</option>
 346           </term>
 347           <listitem>
 348             <para>Host-Only mode: Install only what is needed for booting
 349 the local host instead of a generic host.
 350      <warning>
 351                 <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>
 352               </warning></para>
 353           </listitem>
 354         </varlistentry>
 355         <varlistentry>
 356           <term>
 357             <option>--fstab</option>
 358           </term>
 359           <listitem>
 360             <para>Use <filename>/etc/fstab</filename> instead of <filename>/proc/self/mountinfo</filename>.</para>
 361           </listitem>
 362         </varlistentry>
 363         <varlistentry>
 364           <term>
 365             <option>-i</option>
 366           </term>
 367           <term>
 368             <option>--include&nbsp;<replaceable>&lt;SOURCE&gt;</replaceable>&nbsp;<replaceable>&lt;TARGET&gt;</replaceable></option>
 369           </term>
 370           <listitem>
 371             <para>include the files in the SOURCE directory into the
 372 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>
 373           </listitem>
 374         </varlistentry>
 375         <varlistentry>
 376           <term>
 377             <option>-I</option>
 378           </term>
 379           <term>
 380             <option>--install&nbsp;<replaceable>&lt;file list&gt;</replaceable></option>
 381           </term>
 382           <listitem>
 383             <para>install the space separated list of files into the initramfs.</para>
 384           </listitem>
 385         </varlistentry>
 386         <varlistentry>
 387           <term>
 388             <option>--gzip</option>
 389           </term>
 390           <listitem>
 391             <para>Compress the generated initramfs using gzip.
 392      This will be done by default, unless another compression option or --no-compress is passed. Equivalent to "--compress=gzip -9"</para>
 393           </listitem>
 394         </varlistentry>
 395         <varlistentry>
 396           <term>
 397             <option>--bzip2</option>
 398           </term>
 399           <listitem>
 400             <para>Compress the generated initramfs using bzip2.
 401      <warning>
 402                 <para>Make sure your kernel has bzip2 decompression support compiled in, otherwise you will not be able to boot. Equivalent to "--compress=bzip2"</para>
 403               </warning></para>
 404           </listitem>
 405         </varlistentry>
 406         <varlistentry>
 407           <term>
 408             <option>--lzma</option>
 409           </term>
 410           <listitem>
 411             <para>Compress the generated initramfs using lzma.
 412      <warning>
 413                 <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>
 414               </warning></para>
 415           </listitem>
 416         </varlistentry>
 417         <varlistentry>
 418           <term>
 419             <option>--xz</option>
 420           </term>
 421           <listitem>
 422             <para>Compress the generated initramfs using xz.
 423      <warning>
 424                 <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>
 425               </warning></para>
 426           </listitem>
 427         </varlistentry>
 428         <varlistentry>
 429           <term>
 430             <option>--compress&nbsp;<replaceable>&lt;compressor&gt;</replaceable></option>
 431           </term>
 432           <listitem>
 433             <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>
 434           </listitem>
 435         </varlistentry>
 436         <varlistentry>
 437           <term>
 438             <option>--no-compress</option>
 439           </term>
 440           <listitem>
 441             <para>Do not compress the generated initramfs. This will override any other compression options.</para>
 442           </listitem>
 443         </varlistentry>
 444         <varlistentry>
 445           <term>
 446             <option>--list-modules</option>
 447           </term>
 448           <listitem>
 449             <para>List all available dracut modules.</para>
 450           </listitem>
 451         </varlistentry>
 452         <varlistentry>
 453           <term>
 454             <option>-M</option>
 455           </term>
 456           <term>
 457             <option>--show-modules</option>
 458           </term>
 459           <listitem>
 460             <para>Print included module's name to standard output during build.</para>
 461           </listitem>
 462         </varlistentry>
 463         <varlistentry>
 464           <term>
 465             <option>--keep</option>
 466           </term>
 467           <listitem>
 468             <para>Keep the initramfs temporary directory for debugging purposes.</para>
 469           </listitem>
 470         </varlistentry>
 471       </variablelist>
 472     </refsect2>
 473   </refsect1>
 474   <refsect1>
 475     <title>Files</title>
 476     <variablelist>
 477       <varlistentry>
 478         <term>
 479           <filename>/var/log/dracut.log</filename>
 480         </term>
 481         <listitem>
 482           <para>logfile of initramfs image creation</para>
 483         </listitem>
 484       </varlistentry>
 485       <varlistentry>
 486         <term>
 487           <filename>/tmp/dracut.log</filename>
 488         </term>
 489         <listitem>
 490           <para>logfile of initramfs image creation, if <filename>/var/log/dracut.log</filename> is not writable</para>
 491         </listitem>
 492       </varlistentry>
 493       <varlistentry>
 494         <term>
 495           <filename>/etc/dracut.conf</filename>
 496         </term>
 497         <listitem>
 498           <para>see <citerefentry>
 499               <refentrytitle>dracut.conf</refentrytitle>
 500               <manvolnum>5</manvolnum>
 501             </citerefentry></para>
 502         </listitem>
 503       </varlistentry>
 504       <varlistentry>
 505         <term>
 506           <filename>/etc/dracut.conf.d/*.conf</filename>
 507         </term>
 508         <listitem>
 509           <para>see <citerefentry>
 510               <refentrytitle>dracut.conf</refentrytitle>
 511               <manvolnum>5</manvolnum>
 512             </citerefentry></para>
 513         </listitem>
 514       </varlistentry>
 515     </variablelist>
 516     <refsect2>
 517       <title>Configuration in the Initramfs</title>
 518       <variablelist>
 519         <varlistentry>
 520           <term>
 521             <filename>/etc/conf.d/</filename>
 522           </term>
 523           <listitem>
 524             <para>Any files found in <filename>/etc/conf.d/</filename> will be sourced in the initramfs to
 525 set initial values. Command line options will override these values
 526 set in the configuration files.</para>
 527           </listitem>
 528         </varlistentry>
 529         <varlistentry>
 530           <term>
 531             <filename>/etc/cmdline</filename>
 532           </term>
 533           <listitem>
 534             <para>Can contain additional command line options.</para>
 535           </listitem>
 536         </varlistentry>
 537       </variablelist>
 538     </refsect2>
 539   </refsect1>
 540   <refsect1>
 541     <title>Availability</title>
 542     <para>The dracut command is part of the dracut package and is available from
 543 <ulink url='https://dracut.wiki.kernel.org'>https://dracut.wiki.kernel.org</ulink></para>
 544   </refsect1>
 545   <refsect1>
 546     <title>See Also</title>
 547     <para>
 548       <citerefentry>
 549         <refentrytitle>dracut.kernel</refentrytitle>
 550         <manvolnum>7</manvolnum>
 551       </citerefentry>
 552       <citerefentry>
 553         <refentrytitle>dracut.conf</refentrytitle>
 554         <manvolnum>5</manvolnum>
 555       </citerefentry>
 556     </para>
 557   </refsect1>
 558 </refentry>