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>-d</option>
 142           </term>
 143           <term>
 144             <option>--drivers&nbsp;<replaceable>&lt;list of kernel modules&gt;</replaceable></option>
 145           </term>
 146           <listitem>
 147             <para>specify a space-separated list of kernel modules to exclusively include
 148 in the initramfs.
 149 The kernel modules have to be specified without the &quot;.ko&quot; suffix. This parameter can be specified multiple times.</para>
 150           </listitem>
 151         </varlistentry>
 152         <varlistentry>
 153           <term>
 154             <option>--add-drivers&nbsp;<replaceable>&lt;list of kernel modules&gt;</replaceable></option>
 155           </term>
 156           <listitem>
 157             <para>specify a space-separated list of kernel modules to add to 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>--filesystems&nbsp;<replaceable>&lt;list of filesystems&gt;</replaceable></option>
 164           </term>
 165           <listitem>
 166             <para>specify a space-separated list of kernel filesystem modules to exclusively
 167 include in the generic initramfs. This parameter can be specified multiple times.</para>
 168           </listitem>
 169         </varlistentry>
 170         <varlistentry>
 171           <term>
 172             <option>-k</option>
 173           </term>
 174           <term>
 175             <option>--kmoddir&nbsp;<replaceable>&lt;kernel directory&gt;</replaceable></option>
 176           </term>
 177           <listitem>
 178             <para>specify the directory, where to look for kernel modules</para>
 179           </listitem>
 180         </varlistentry>
 181         <varlistentry>
 182           <term>
 183             <option> --fwdir&nbsp;<replaceable>&lt;dir&gt;[:&lt;dir&gt;...]</replaceable></option>
 184           </term>
 185           <listitem>
 186             <para>specify additional directories, where to look for firmwares. This parameter can be specified multiple times.</para>
 187           </listitem>
 188         </varlistentry>
 189         <varlistentry>
 190           <term>
 191             <option>--kernel-only</option>
 192           </term>
 193           <listitem>
 194             <para>only install kernel drivers and firmware files</para>
 195           </listitem>
 196         </varlistentry>
 197         <varlistentry>
 198           <term>
 199             <option>--no-kernel</option>
 200           </term>
 201           <listitem>
 202             <para>do not install kernel drivers and firmware files</para>
 203           </listitem>
 204         </varlistentry>
 205         <varlistentry>
 206           <term>
 207             <option>--mdadmconf</option>
 208           </term>
 209           <listitem>
 210             <para>include local <filename>/etc/mdadm.conf</filename></para>
 211           </listitem>
 212         </varlistentry>
 213         <varlistentry>
 214           <term>
 215             <option>--nomdadmconf</option>
 216           </term>
 217           <listitem>
 218             <para>do not include local <filename>/etc/mdadm.conf</filename></para>
 219           </listitem>
 220         </varlistentry>
 221         <varlistentry>
 222           <term>
 223             <option>--strip</option>
 224           </term>
 225           <listitem>
 226             <para>strip binaries in the initramfs (default)</para>
 227           </listitem>
 228         </varlistentry>
 229         <varlistentry>
 230           <term>
 231             <option>--nostrip</option>
 232           </term>
 233           <listitem>
 234             <para>do not strip binaries in the initramfs</para>
 235           </listitem>
 236         </varlistentry>
 237         <varlistentry>
 238           <term>
 239             <option>-h</option>
 240           </term>
 241           <term>
 242             <option>--help</option>
 243           </term>
 244           <listitem>
 245             <para>display help text and exit.</para>
 246           </listitem>
 247         </varlistentry>
 248         <varlistentry>
 249           <term>
 250             <option>--debug</option>
 251           </term>
 252           <listitem>
 253             <para>output debug information of the build process</para>
 254           </listitem>
 255         </varlistentry>
 256         <varlistentry>
 257           <term>
 258             <option>-v</option>
 259           </term>
 260           <term>
 261             <option>--verbose</option>
 262           </term>
 263           <listitem>
 264             <para>verbose output during the build process</para>
 265           </listitem>
 266         </varlistentry>
 267         <varlistentry>
 268           <term>
 269             <option>-c</option>
 270           </term>
 271           <term>
 272             <option>--conf&nbsp;<replaceable>&lt;dracut configuration file&gt;</replaceable></option>
 273           </term>
 274           <listitem>
 275             <para>specify configuration file to use.
 276 Default:
 277 <filename>/etc/dracut.conf</filename></para>
 278           </listitem>
 279         </varlistentry>
 280         <varlistentry>
 281           <term>
 282             <option>--confdir&nbsp;<replaceable>&lt;configuration directory&gt;</replaceable></option>
 283           </term>
 284           <listitem>
 285             <para>specify configuration directory to use.
 286 Default:
 287 <filename>/etc/dracut.conf.d</filename></para>
 288           </listitem>
 289         </varlistentry>
 290         <varlistentry>
 291           <term>
 292             <option>-l</option>
 293           </term>
 294           <term>
 295             <option>--local</option>
 296           </term>
 297           <listitem>
 298             <para>activates the local mode. dracut will use modules from the current working
 299 directory instead of the system-wide installed modules in
 300 <filename>/usr/share/dracut/modules.d</filename>.
 301 This is useful when running dracut from a git checkout.</para>
 302           </listitem>
 303         </varlistentry>
 304         <varlistentry>
 305           <term>
 306             <option>-H</option>
 307           </term>
 308           <term>
 309             <option>--hostonly</option>
 310           </term>
 311           <listitem>
 312             <para>Host-Only mode: Install only what is needed for booting
 313 the local host instead of a generic host.
 314      <warning>
 315                 <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>
 316               </warning></para>
 317           </listitem>
 318         </varlistentry>
 319         <varlistentry>
 320           <term>
 321             <option>--fstab</option>
 322           </term>
 323           <listitem>
 324             <para>Use <filename>/etc/fstab</filename> instead of <filename>/proc/self/mountinfo</filename>.</para>
 325           </listitem>
 326         </varlistentry>
 327         <varlistentry>
 328           <term>
 329             <option>-i</option>
 330           </term>
 331           <term>
 332             <option>--include&nbsp;<replaceable>&lt;SOURCE&gt;</replaceable>&nbsp;<replaceable>&lt;TARGET&gt;</replaceable></option>
 333           </term>
 334           <listitem>
 335             <para>include the files in the SOURCE directory into the
 336 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>
 337           </listitem>
 338         </varlistentry>
 339         <varlistentry>
 340           <term>
 341             <option>-I</option>
 342           </term>
 343           <term>
 344             <option>--install&nbsp;<replaceable>&lt;file list&gt;</replaceable></option>
 345           </term>
 346           <listitem>
 347             <para>install the space separated list of files into the initramfs.</para>
 348           </listitem>
 349         </varlistentry>
 350         <varlistentry>
 351           <term>
 352             <option>--gzip</option>
 353           </term>
 354           <listitem>
 355             <para>Compress the generated initramfs using gzip.
 356      This will be done by default, unless another compression option or --no-compress is passed. Equivalent to "--compress=gzip -9"</para>
 357           </listitem>
 358         </varlistentry>
 359         <varlistentry>
 360           <term>
 361             <option>--bzip2</option>
 362           </term>
 363           <listitem>
 364             <para>Compress the generated initramfs using bzip2.
 365      <warning>
 366                 <para>Make sure your kernel has bzip2 decompression support compiled in, otherwise you will not be able to boot. Equivalent to "--compress=bzip2"</para>
 367               </warning></para>
 368           </listitem>
 369         </varlistentry>
 370         <varlistentry>
 371           <term>
 372             <option>--lzma</option>
 373           </term>
 374           <listitem>
 375             <para>Compress the generated initramfs using lzma.
 376      <warning>
 377                 <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>
 378               </warning></para>
 379           </listitem>
 380         </varlistentry>
 381         <varlistentry>
 382           <term>
 383             <option>--xz</option>
 384           </term>
 385           <listitem>
 386             <para>Compress the generated initramfs using xz.
 387      <warning>
 388                 <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>
 389               </warning></para>
 390           </listitem>
 391         </varlistentry>
 392         <varlistentry>
 393           <term>
 394             <option>--compress&nbsp;<replaceable>&lt;compressor&gt;</replaceable></option>
 395           </term>
 396           <listitem>
 397             <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>
 398           </listitem>
 399         </varlistentry>
 400         <varlistentry>
 401           <term>
 402             <option>--no-compress</option>
 403           </term>
 404           <listitem>
 405             <para>Do not compress the generated initramfs. This will override any other compression options.</para>
 406           </listitem>
 407         </varlistentry>
 408         <varlistentry>
 409           <term>
 410             <option>--list-modules</option>
 411           </term>
 412           <listitem>
 413             <para>List all available dracut modules.</para>
 414           </listitem>
 415         </varlistentry>
 416       </variablelist>
 417     </refsect2>
 418   </refsect1>
 419   <refsect1>
 420     <title>Files</title>
 421     <variablelist>
 422       <varlistentry>
 423         <term>
 424           <filename>/var/log/dracut.log</filename>
 425         </term>
 426         <listitem>
 427           <para>logfile of initramfs image creation</para>
 428         </listitem>
 429       </varlistentry>
 430       <varlistentry>
 431         <term>
 432           <filename>/tmp/dracut.log</filename>
 433         </term>
 434         <listitem>
 435           <para>logfile of initramfs image creation, if <filename>/var/log/dracut.log</filename> is not writable</para>
 436         </listitem>
 437       </varlistentry>
 438       <varlistentry>
 439         <term>
 440           <filename>/etc/dracut.conf</filename>
 441         </term>
 442         <listitem>
 443           <para>see <citerefentry>
 444               <refentrytitle>dracut.conf</refentrytitle>
 445               <manvolnum>5</manvolnum>
 446             </citerefentry></para>
 447         </listitem>
 448       </varlistentry>
 449       <varlistentry>
 450         <term>
 451           <filename>/etc/dracut.conf.d/*.conf</filename>
 452         </term>
 453         <listitem>
 454           <para>see <citerefentry>
 455               <refentrytitle>dracut.conf</refentrytitle>
 456               <manvolnum>5</manvolnum>
 457             </citerefentry></para>
 458         </listitem>
 459       </varlistentry>
 460     </variablelist>
 461     <refsect2>
 462       <title>Configuration in the Initramfs</title>
 463       <variablelist>
 464         <varlistentry>
 465           <term>
 466             <filename>/etc/conf.d/</filename>
 467           </term>
 468           <listitem>
 469             <para>Any files found in <filename>/etc/conf.d/</filename> will be sourced in the initramfs to
 470 set initial values. Command line options will override these values
 471 set in the configuration files.</para>
 472           </listitem>
 473         </varlistentry>
 474         <varlistentry>
 475           <term>
 476             <filename>/etc/cmdline</filename>
 477           </term>
 478           <listitem>
 479             <para>Can contain additional command line options.</para>
 480           </listitem>
 481         </varlistentry>
 482       </variablelist>
 483     </refsect2>
 484   </refsect1>
 485   <refsect1>
 486     <title>Availability</title>
 487     <para>The dracut command is part of the dracut package and is available from
 488 <ulink url="http://sourceforge.net/apps/trac/dracut/wiki">http://sourceforge.net/apps/trac/dracut/wiki</ulink></para>
 489   </refsect1>
 490   <refsect1>
 491     <title>See Also</title>
 492     <para>
 493       <citerefentry>
 494         <refentrytitle>dracut.kernel</refentrytitle>
 495         <manvolnum>7</manvolnum>
 496       </citerefentry>
 497       <citerefentry>
 498         <refentrytitle>dracut.conf</refentrytitle>
 499         <manvolnum>5</manvolnum>
 500       </citerefentry>
 501     </para>
 502   </refsect1>
 503 </refentry>