crypt-lib.sh: 'command -v' preferred over 'type'
[dracut.git] / dracut.kernel.7.xml
blob445af992f26cd05d1198d1ef01e66f08f0de6554
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.3/docbookx.dtd" []>
3 <refentry id="dracutkernel7">
4   <refentryinfo>
5     <title>dracut.kernel</title>
6     <productname>dracut</productname>
7     <authorgroup>
8       <author>
9         <contrib>Developer</contrib>
10         <firstname>Harald</firstname>
11         <surname>Hoyer</surname>
12         <email>harald@redhat.com</email>
13       </author>
14     </authorgroup>
15   </refentryinfo>
16   <refmeta>
17     <refentrytitle>dracut.kernel</refentrytitle>
18     <manvolnum>7</manvolnum>
19     <refmiscinfo class="version"/>
20   </refmeta>
21   <refnamediv>
22     <refname>dracut.kernel</refname>
23     <refpurpose>dracut kernel command line options</refpurpose>
24   </refnamediv>
25   <refsect1>
26     <title>Description</title>
27     <para>The root filesystem used by the kernel is specified in the boot configuration
28 file, as always. The traditional <emphasis remap="B">root=/dev/hda1</emphasis> style device 
29 specification is allowed. If a label is used, as in <emphasis remap="B">root=LABEL=rootPart</emphasis>
30 the initramfs will search all available devices for an ext2 or ext3 filesystem
31 with the appropriate label, and mount that device as the root filesystem.
32 <emphasis remap="B">root=UUID=uuidnumber</emphasis> will mount the partition with that UUID as the 
33 root filesystem.</para>
34     <refsect2>
35       <title>Standard</title>
36       <variablelist>
37         <varlistentry>
38           <term>
39             <envar>init=<replaceable>&lt;path to real init&gt;</replaceable></envar>
40           </term>
41           <listitem>
42             <para> </para>
43           </listitem>
44         </varlistentry>
45         <varlistentry>
46           <term>
47             <envar>root=<replaceable>&lt;path to blockdevice&gt;</replaceable></envar>
48           </term>
49           <listitem>
50             <para>specify blockdevice to use as root filesystem. 
51      e.g.: <programlisting>root=/dev/sda1
52 root=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1     </programlisting></para>
53           </listitem>
54         </varlistentry>
55         <varlistentry>
56           <term>
57             <envar>rootfstype=<replaceable>&lt;filesystem type&gt;</replaceable></envar>
58           </term>
59           <listitem>
60             <para>&quot;auto&quot; if not specified, e.g.: <programlisting>rootfstype=ext3</programlisting></para>
61           </listitem>
62         </varlistentry>
63         <varlistentry>
64           <term>
65             <envar>rootflags=<replaceable>&lt;mount options&gt;</replaceable></envar>
66           </term>
67           <listitem>
68             <para>specify additional mount options for the root filesystem. If not set, <filename>/etc/fstab</filename>
69 of the real root will be parsed for special mount options and mounted 
70 accordingly.</para>
71           </listitem>
72         </varlistentry>
73         <varlistentry>
74           <term><envar>rd.fstab</envar>=0</term>
75           <listitem>
76             <para>do not honor special mount options for the root filesystem found in 
77 <filename>/etc/fstab</filename> of the real root.</para>
78           </listitem>
79         </varlistentry>
80       </variablelist>
81     </refsect2>
82     <refsect2>
83       <title>Misc</title>
84       <variablelist>
85         <varlistentry>
86           <term>
87             <envar>rd.driver.blacklist=<replaceable>&lt;drivername&gt;<optional>,&lt;drivername&gt;,...</optional></replaceable></envar>
88           </term>
89           <listitem>
90             <para>do not load kernel module &lt;drivername&gt;
91 This parameter can be specified multiple times.</para>
92           </listitem>
93         </varlistentry>
94         <varlistentry>
95           <term>
96             <envar>rd.driver.pre=<replaceable>&lt;drivername&gt;<optional>,&lt;drivername&gt;,...</optional></replaceable></envar>
97           </term>
98           <listitem>
99             <para>force loading kernel module &lt;drivername&gt;
100 This parameter can be specified multiple times.</para>
101           </listitem>
102         </varlistentry>
103         <varlistentry>
104           <term>
105             <envar>rd.driver.post=<replaceable>&lt;drivername&gt;<optional>,&lt;drivername&gt;,...</optional></replaceable></envar>
106           </term>
107           <listitem>
108             <para>force loading kernel module &lt;drivername&gt; after all automatic loading modules have been loaded. This parameter can be specified multiple times.</para>
109           </listitem>
110         </varlistentry>
111       </variablelist>
112     </refsect2>
113     <refsect2 id="dracut-kernel-debug">
114       <title>Debug</title>
115       <variablelist>
116         <varlistentry>
117           <term>
118             <envar>rd.info</envar>
119           </term>
120           <listitem>
121             <para>print informational output though &quot;quiet&quot; is set</para>
122           </listitem>
123         </varlistentry>
124         <varlistentry>
125           <term>
126             <envar>rd.shell</envar>
127           </term>
128           <listitem>
129             <para>allow dropping to a shell, if root mounting fails</para>
130           </listitem>
131         </varlistentry>
132         <varlistentry>
133           <term>
134             <envar>rd.debug</envar>
135           </term>
136           <listitem>
137             <para>set -x for the dracut shell and logs to dmesg, console and <filename>/run/initramfs/init.log</filename></para>
138           </listitem>
139         </varlistentry>
140         <varlistentry>
141           <term>
142             <envar>rd.break</envar>
143           </term>
144           <listitem>
145             <para>drop to a shell at the end</para>
146           </listitem>
147         </varlistentry>
148         <varlistentry>
149           <term>
150             <envar>rd.break=</envar><replaceable>{cmdline|pre-udev|pre-trigger|initqueue|pre-mount|mount|pre-pivot}</replaceable>
151           </term>
152           <listitem>
153             <para>drop to a shell on defined breakpoint</para>
154           </listitem>
155         </varlistentry>
156         <varlistentry>
157           <term>
158             <envar>rd.udev.info</envar>
159           </term>
160           <listitem>
161             <para>set udev to loglevel info</para>
162           </listitem>
163         </varlistentry>
164         <varlistentry>
165           <term>
166             <envar>rd.udev.debug</envar>
167           </term>
168           <listitem>
169             <para>set udev to loglevel debug</para>
170           </listitem>
171         </varlistentry>
172       </variablelist>
173     </refsect2>
174     <refsect2>
175       <title>I18N</title>
176       <variablelist>
177         <varlistentry>
178           <term>
179             <envar>voonsole.keymap=</envar>
180             <replaceable>&lt;keymap base file name&gt;</replaceable>
181           </term>
182           <listitem>
183             <para>keyboard translation table loaded by loadkeys; taken from keymaps directory; will be written as <envar>KEYMAP</envar> to <filename>/etc/vconsole.conf</filename> in the initramfs, e.g.: <programlisting>vconsole.keymap=de-latin1-nodeadkeys</programlisting></para>
184           </listitem>
185         </varlistentry>
186         <varlistentry>
187           <term>
188             <envar>vconsole.keymap.ext=</envar><replaceable>&lt;list of keymap base file names&gt;</replaceable>
189           </term>
190           <listitem>
191             <para>list of extra keymaps to bo loaded (sep. by space); will be written as <envar>EXT_KEYMAP</envar> to <filename>/etc/vconsole.conf</filename> in the initramfs</para>
192           </listitem>
193         </varlistentry>
194         <varlistentry>
195           <term>
196             <envar>vconsole.unicode=</envar><replaceable>&lt;1|0&gt;</replaceable>
197           </term>
198           <listitem>
199             <para>boolean, indicating UTF-8 mode; will be written as <envar>UNICODE</envar> to <filename>/etc/vconsole.conf</filename> in the initramfs</para>
200           </listitem>
201         </varlistentry>
202         <varlistentry>
203           <term>
204             <envar>vconsole.font=</envar><replaceable>&lt;font base file name&gt;</replaceable>
205           </term>
206           <listitem>
207             <para>console font; taken from consolefonts directory;  will be written as <envar>FONT</envar> to <filename>/etc/vconsole.conf</filename> in the initramfs; e.g.: <programlisting>vconsole.font=LatArCyrHeb-16</programlisting></para>
208           </listitem>
209         </varlistentry>
210         <varlistentry>
211           <term>
212             <envar>vconsole.font.map=</envar><replaceable>&lt;console map base file name&gt;</replaceable>
213           </term>
214           <listitem>
215             <para>see description of &apos;-m&apos; parameter in setfont manual; taken from consoletrans directory; will be written as <envar>FONT_MAP</envar> to <filename>/etc/vconsole.conf</filename> in the initramfs</para>
216           </listitem>
217         </varlistentry>
218         <varlistentry>
219           <term>
220             <envar>vconsole.font.unimap=</envar><replaceable>&lt;unicode table base file name&gt;</replaceable>
221           </term>
222           <listitem>
223             <para>see description of &apos;-u&apos; parameter in setfont manual; taken from unimaps directory; will be written as <envar>FONT_UNIMAP</envar> to <filename>/etc/vconsole.conf</filename> in the initramfs</para>
224           </listitem>
225         </varlistentry>
226         <varlistentry>
227           <term>
228             <envar>locale.LANG=</envar><replaceable>&lt;locale&gt;</replaceable>
229           </term>
230           <listitem>
231             <para>taken from the environment; if no UNICODE is defined we set its value in basis of LANG value (whether it ends with &quot;.utf8&quot; (or similar) or not); will be written as <envar>LANG</envar> to <filename>/etc/locale.conf</filename> in the initramfs; e.g.: <programlisting>locale.LANG=pl_PL.utf8</programlisting></para>
232           </listitem>
233         </varlistentry>
234         <varlistentry>
235           <term>
236             <envar>locale.LC_ALL=</envar><replaceable>&lt;locale&gt;</replaceable>
237           </term>
238           <listitem>
239             <para>taken from the environment; will be written as <envar>LC_ALL</envar> to <filename>/etc/locale.conf</filename> in the initramfs</para>
240           </listitem>
241         </varlistentry>
242       </variablelist>
243     </refsect2>
244     <refsect2>
245       <title>LVM</title>
246       <variablelist>
247         <varlistentry>
248           <term><envar>rd.lvm</envar>=0</term>
249           <listitem>
250             <para>disable LVM detection</para>
251           </listitem>
252         </varlistentry>
253         <varlistentry>
254           <term>
255             <envar>rd.lvm.vg=<replaceable>&lt;volume group name&gt;</replaceable></envar>
256           </term>
257           <listitem>
258             <para>only activate the volume groups with the given name
259 <envar>rd.lvm.vg</envar> can be specified multiple times on the kernel command line.</para>
260           </listitem>
261         </varlistentry>
262         <varlistentry>
263           <term>
264             <envar>rd.lvm.lv=<replaceable>&lt;logical volume name&gt;</replaceable></envar>
265           </term>
266           <listitem>
267             <para>only activate the logical volumes with the given name
268 <envar>rd.lvm.lv</envar> can be specified multiple times on the kernel command line.</para>
269           </listitem>
270         </varlistentry>
271         <varlistentry>
272           <term>
273             <envar>rd.lvm.conf</envar>=0
274           </term>
275           <listitem>
276             <para>remove any <filename>/etc/lvm/lvm.conf</filename>, which may exist in the initramfs</para>
277           </listitem>
278         </varlistentry>
279       </variablelist>
280     </refsect2>
281     <refsect2>
282       <title>crypto LUKS</title>
283       <variablelist>
284         <varlistentry>
285           <term><envar>rd.luks</envar>=0</term>
286           <listitem>
287             <para>disable crypto LUKS detection</para>
288           </listitem>
289         </varlistentry>
290         <varlistentry>
291           <term>
292             <envar>rd.luks.uuid=<replaceable>&lt;luks uuid&gt;</replaceable></envar>
293           </term>
294           <listitem>
295             <para>only activate the LUKS partitions with the given UUID
296 Any &quot;luks-&quot; of the LUKS UUID is removed before comparing to <replaceable>&lt;luks uuid&gt;</replaceable>.
297 The comparisons also matches, if <replaceable>&lt;luks uuid&gt;</replaceable> is only the beginning of the 
298 LUKS UUID, so you don&apos;t have to specify the full UUID.
299 This parameter can be specified multiple times.</para>
300           </listitem>
301         </varlistentry>
302         <varlistentry>
303           <term>
304             <envar>rd.luks.crypttab</envar>=0
305           </term>
306           <listitem>
307             <para>do not check, if LUKS partition is in <filename>/etc/crypttab</filename></para>
308           </listitem>
309         </varlistentry>
310       </variablelist>
311     </refsect2>
312     <refsect2>
313       <title>crypto LUKS - key on removable device support</title>
314       <variablelist>
315         <varlistentry>
316           <term>
317             <envar>rd.luks.key=</envar><replaceable>&lt;keypath&gt;:&lt;keydev&gt;:&lt;luksdev&gt;</replaceable>
318           </term>
319           <listitem>
320             <para><replaceable>keypath</replaceable> is a path to key file to look for. It&apos;s REQUIRED.</para>
321             <para><replaceable>keydev</replaceable> is a device on which key file resides. It might be kernel name of devices (should start with &quot;/dev/&quot;), UUID (prefixed with &quot;UUID=&quot;) or label (prefix with &quot;LABEL=&quot;).  You don&apos;t have to specify full UUID. Just its beginning will suffice, even if its ambiguous. All matching devices will be probed. This parameter is recommended, but not required. If not present, all block devices will be probed, which may significantly increase boot time.</para>
322             <para>If <replaceable>luksdev</replaceable> is given, the specified key will only be applied for that LUKS device. Possible values are the same as for <replaceable>keydev</replaceable>. Unless you have several LUKS devices, you don&apos;t have to specify this parameter.</para>
323             <para>The simplest usage is:</para>
324             <programlisting>rd.luks.key=/foo/bar.key</programlisting>
325             <para>As you see, you can skip colons in such case.</para>
326           </listitem>
327         </varlistentry>
328       </variablelist>
329     </refsect2>
330     <refsect2>
331       <title>MD</title>
332       <variablelist>
333         <varlistentry>
334           <term><envar>rd.md</envar>=0</term>
335           <listitem>
336             <para>disable MD RAID detection</para>
337           </listitem>
338         </varlistentry>
339         <varlistentry>
340           <term><envar>rd.md.imsm</envar>=0</term>
341           <listitem>
342             <para>disable MD RAID for imsm/isw raids, use DM RAID instead</para>
343           </listitem>
344         </varlistentry>
345         <varlistentry>
346           <term>
347             <envar>rd.md.conf</envar>=0
348           </term>
349           <listitem>
350             <para>ignore mdadm.conf included in initramfs</para>
351           </listitem>
352         </varlistentry>
353         <varlistentry>
354           <term>
355             <envar>rd.md.uuid=<replaceable>&lt;md raid uuid&gt;</replaceable></envar>
356           </term>
357           <listitem>
358             <para>only activate the raid sets with the given UUID.
359 This parameter can be specified multiple times.</para>
360           </listitem>
361         </varlistentry>
362       </variablelist>
363     </refsect2>
364     <refsect2>
365       <title>DM RAID</title>
366       <variablelist>
367         <varlistentry>
368           <term><envar>rd.dm</envar>=0</term>
369           <listitem>
370             <para>disable DM RAID detection</para>
371           </listitem>
372         </varlistentry>
373         <varlistentry>
374           <term>
375             <envar>rd.dm.uuid=<replaceable>&lt;dm raid uuid&gt;</replaceable></envar>
376           </term>
377           <listitem>
378             <para>only activate the raid sets with the given UUID.
379 This parameter can be specified multiple times.</para>
380           </listitem>
381         </varlistentry>
382       </variablelist>
383     </refsect2>
384     <refsect2>
385       <title>FIPS</title>
386       <variablelist>
387         <varlistentry>
388           <term><envar>rd.fips</envar></term>
389           <listitem>
390             <para>enable FIPS</para>
391           </listitem>
392         </varlistentry>
393         <varlistentry>
394           <term>
395             <envar>boot=<replaceable>&lt;boot device&gt;</replaceable></envar>
396           </term>
397           <listitem>
398             <para>specify the device, where /boot is located.<programlisting>
399 e.g.
400   boot=/dev/sda1
401   boot=/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1
402   boot=UUID=&lt;uuid&gt;
403   boot=LABEL=&lt;label&gt;</programlisting>
404 </para>
405           </listitem>
406         </varlistentry>
407         <varlistentry>
408           <term><envar>rd.fips.skipkernel</envar></term>
409           <listitem>
410             <para>skip checksum check of the kernel image. Useful, if the kernel image is not in a separate boot partition.</para>
411           </listitem>
412         </varlistentry>
413       </variablelist>
414     </refsect2>
415     <refsect2>
416       <title>Network</title>
417       <variablelist>
418         <varlistentry>
419           <term>
420             <envar>ip=</envar><replaceable>{dhcp|on|any|dhcp6|auto6|ibft}</replaceable>
421           </term>
422           <listitem>
423             <para>dhcp|on|any: get ip from dhcp server from all interfaces. If root=dhcp, 
424 loop sequentially through all interfaces (eth0, eth1, ...) and use the first 
425 with a valid DHCP root-path.</para>
426             <para><constant>auto6</constant>: IPv6 autoconfiguration</para>
427             <para><constant>dhcp6</constant>: IPv6 DHCP</para>
428             <para><constant>ibft</constant>: iBFT autoconfiguration</para>
429           </listitem>
430         </varlistentry>
431         <varlistentry>
432           <term><envar>ip=</envar><replaceable>&lt;interface&gt;</replaceable>:<replaceable>{dhcp|on|any|dhcp6|auto6}</replaceable></term>
433           <listitem>
434             <para>dhcp|on|any|dhcp6: get ip from dhcp server on a specific interface
435 auto6: do IPv6 autoconfiguration
436 This parameter can be specified multiple times.</para>
437           </listitem>
438         </varlistentry>
439         <varlistentry>
440           <term><envar>ip=</envar><replaceable>&lt;client-IP&gt;</replaceable>:<optional>
441               <replaceable>&lt;server-id&gt;</replaceable>
442             </optional>:<replaceable>&lt;gateway-IP&gt;</replaceable>:<replaceable>&lt;netmask&gt;</replaceable>:<replaceable>&lt;client_hostname&gt;</replaceable>:<replaceable>&lt;interface&gt;</replaceable>:<replaceable>{none|off}</replaceable></term>
443           <listitem>
444             <para>explicit network configuration. If you want do define a IPv6 address, put it in brackets (e.g. [2001:DB8::1]).
445 This parameter can be specified multiple times.</para>
446           </listitem>
447         </varlistentry>
448         <varlistentry>
449           <term><envar>ifname=</envar><replaceable>&lt;interface&gt;</replaceable>:<replaceable>&lt;MAC&gt;</replaceable></term>
450           <listitem>
451             <para>Assign network device name &lt;interface&gt; (ie eth0) to the NIC with MAC &lt;MAC&gt;.
452 Note letters in the MAC-address must be lowercase!
453 <remark>Note: If you use this option you <emphasis remap="B">must</emphasis> specify an ifname= argument for all interfaces used in ip= or fcoe= arguments.</remark>
454 This parameter can be specified multiple times.</para>
455           </listitem>
456         </varlistentry>
457         <varlistentry>
458           <term>
459             <envar>bootdev=</envar><replaceable>&lt;interface&gt;</replaceable>
460           </term>
461           <listitem>
462             <para>specify network interface to use routing and netroot information from. 
463 Required if multiple ip= lines are used.</para>
464           </listitem>
465         </varlistentry>
466         <varlistentry>
467           <term>
468             <envar>nameserver=</envar><replaceable>&lt;IP&gt;</replaceable><optional><envar>nameserver</envar>=<replaceable>&lt;IP&gt;</replaceable> ...</optional>
469           </term>
470           <listitem>
471             <para>specify nameserver(s) to use</para>
472           </listitem>
473         </varlistentry>
474         <varlistentry>
475           <term>
476             <envar>biosdevname=</envar><replaceable>{0|1}</replaceable>
477           </term>
478           <listitem>
479             <para>turn on/off biosdevname network interface renaming</para>
480           </listitem>
481         </varlistentry>
482       </variablelist>
483     </refsect2>
484     <refsect2>
485       <title>NFS</title>
486       <variablelist>
487         <varlistentry>
488           <term>
489             <envar>root=</envar><optional><replaceable>&lt;server-ip&gt;</replaceable>:</optional><replaceable>&lt;root-dir&gt;</replaceable><optional>:<replaceable>&lt;nfs-options&gt;</replaceable></optional>
490           </term>
491           <listitem>
492             <para>mount nfs share from &lt;server-ip&gt;:/&lt;root-dir&gt;, if no server-ip is given,
493 use dhcp next_server. if server-ip is an IPv6 address it has to be put in brackets, e.g. [2001:DB8::1].
494 NFS options can be appended with the prefix &quot;:&quot; or &quot;,&quot; and are seperated by &quot;,&quot;.</para>
495           </listitem>
496         </varlistentry>
497         <varlistentry>
498           <term><envar>root=</envar><constant>nfs</constant>:<optional><replaceable>&lt;server-ip&gt;</replaceable>:</optional><replaceable>&lt;root-dir&gt;</replaceable><optional>:<replaceable>&lt;nfs-options&gt;</replaceable></optional></term>
499           <term><envar>root=</envar>nfs4:<optional><replaceable>&lt;server-ip&gt;</replaceable>:</optional><replaceable>&lt;root-dir&gt;</replaceable><optional>:<replaceable>&lt;nfs-options&gt;</replaceable></optional></term>
500           <term>
501             <envar>root=</envar><replaceable>{dhcp|dhcp6}</replaceable>
502           </term>
503           <listitem>
504             <para>root=dhcp alone directs initrd to look at the DHCP root-path where NFS 
505 options can be specified.
506     root-path=&lt;server-ip&gt;:&lt;root-dir&gt;[,&lt;nfs-options&gt;]
507     root-path=nfs:&lt;server-ip&gt;:&lt;root-dir&gt;[,&lt;nfs-options&gt;]
508     root-path=nfs4:&lt;server-ip&gt;:&lt;root-dir&gt;[,&lt;nfs-options&gt;]</para>
509           </listitem>
510         </varlistentry>
511         <varlistentry>
512           <term>
513             <envar>root=</envar><filename>/dev/nfs</filename>
514             <envar> nfsroot=</envar><optional><replaceable>&lt;server-ip&gt;</replaceable>:</optional><replaceable>&lt;root-dir&gt;</replaceable><optional>:<replaceable>&lt;nfs-options&gt;</replaceable></optional>
515           </term>
516           <listitem>
517             <para><emphasis remap="B">Deprecated!</emphasis> kernel Documentation<filename>/filesystems/nfsroot.txt</filename> defines 
518 this method.  
519 This is supported by dracut, but not recommended.</para>
520           </listitem>
521         </varlistentry>
522         <varlistentry>
523           <term>
524             <envar remap="B">rd.nfs.domain=</envar>
525             <replaceable>&lt;NFSv4 domain name&gt;</replaceable>
526           </term>
527           <listitem>
528             <para>Set the NFSv4 domain name. Will overwrite the settings in <filename>/etc/idmap.conf</filename>.</para>
529           </listitem>
530         </varlistentry>
531       </variablelist>
532     </refsect2>
533     <refsect2>
534       <title>iSCSI</title>
535       <variablelist>
536         <varlistentry>
537           <term><envar>root=</envar><constant>iscsi</constant>:<optional><replaceable>&lt;username&gt;</replaceable>:<replaceable>&lt;password&gt;</replaceable><optional>:<replaceable>&lt;reverse&gt;</replaceable>:<replaceable>&lt;password&gt;</replaceable></optional>@</optional><optional>
538               <replaceable>&lt;servername&gt;</replaceable>
539             </optional>:<optional>
540               <replaceable>&lt;protocol&gt;</replaceable>
541             </optional>:<optional>
542               <replaceable>&lt;port&gt;</replaceable>
543             </optional>:<optional>
544               <replaceable>&lt;LUN&gt;</replaceable>
545             </optional>:<replaceable>&lt;targetname&gt;</replaceable></term>
546           <listitem>
547             <para>protocol defaults to &quot;6&quot;, LUN defaults to &quot;0&quot;.</para>
548             <para>If the &quot;servername&quot; field is provided by <acronym>BOOTP</acronym> or <acronym>DHCP</acronym>, then that
549 field is used in conjunction with other associated fields to contact
550 the boot server in the Boot stage.  However, if the
551 &quot;servername&quot; field is not provided, then the &quot;targetname&quot; field is
552 then used in the Discovery Service stage in conjunction with other
553 associated fields.</para>
554             <para>See <ulink url="http://tools.ietf.org/html/rfc4173#section-5">http://tools.ietf.org/html/rfc4173</ulink>.</para>
555             <para>e.g.:<programlisting>root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0    </programlisting></para>
556             <para>If servername is an IPv6 address, it has to be put in brackets. e.g.: 
557      <programlisting>root=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0    </programlisting></para>
558           </listitem>
559         </varlistentry>
560         <varlistentry>
561           <term><envar>root=</envar><replaceable>???</replaceable><envar> netroot=</envar><constant>iscsi</constant>:<optional><replaceable>&lt;username&gt;</replaceable>:<replaceable>&lt;password&gt;</replaceable><optional>:<replaceable>&lt;reverse&gt;</replaceable>:<replaceable>&lt;password&gt;</replaceable></optional>@</optional><optional>
562               <replaceable>&lt;servername&gt;</replaceable>
563             </optional>:<optional>
564               <replaceable>&lt;protocol&gt;</replaceable>
565             </optional>:<optional>
566               <replaceable>&lt;port&gt;</replaceable>
567             </optional>:<optional>
568               <replaceable>&lt;LUN&gt;</replaceable>
569             </optional>:<replaceable>&lt;targetname&gt;</replaceable> ...</term>
570           <listitem>
571             <para>multiple netroot options allow setting up multiple iscsi disks. e.g.: 
572      <programlisting>root=UUID=12424547
573 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
574 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1  </programlisting></para>
575             <para>If servername is an IPv6 address, it has to be put in brackets.
576  e.g.:
577   <programlisting>netroot=iscsi:[2001:DB8::1]::::iqn.2009-06.dracut:target0</programlisting></para>
578           </listitem>
579         </varlistentry>
580         <varlistentry>
581           <term>
582             <envar>root=<replaceable>???</replaceable></envar>
583             <envar>rd.iscsi.initiator=<replaceable>&lt;initiator&gt; </replaceable></envar>
584             <envar>rd.iscsi.target.name=<replaceable>&lt;target name&gt; </replaceable></envar>
585             <envar>rd.iscsi.target.ip=<replaceable>&lt;target ip&gt; </replaceable></envar>
586             <envar>rd.iscsi.target.port=<replaceable>&lt;target port&gt; </replaceable></envar>
587             <envar>rd.iscsi.target.group=<replaceable>&lt;target group&gt; </replaceable></envar>
588             <envar>rd.iscsi.username=<replaceable>&lt;username&gt; </replaceable></envar>
589             <envar>rd.iscsi.password=<replaceable>&lt;password&gt; </replaceable></envar>
590             <envar>rd.iscsi.in.username=<replaceable>&lt;in username&gt; </replaceable></envar>
591             <envar>rd.iscsi.in.password=<replaceable>&lt;in password&gt; </replaceable></envar>
592           </term>
593           <listitem>
594             <para>manually specify all iscsistart parameter (see <userinput>iscsistart&nbsp;--help</userinput>)</para>
595           </listitem>
596         </varlistentry>
597         <varlistentry>
598           <term>
599             <envar>root=</envar><replaceable>??? </replaceable><envar>netroot=iscsi </envar><envar>rd.iscsi.firmware=1</envar>
600           </term>
601           <listitem>
602             <para>will read the iscsi parameter from the BIOS firmware</para>
603           </listitem>
604         </varlistentry>
605       </variablelist>
606     </refsect2>
607     <refsect2>
608       <title>FCoE</title>
609       <variablelist>
610         <varlistentry>
611           <term><envar>fcoe=</envar><replaceable>&lt;edd|interface|MAC&gt;</replaceable>:<replaceable>{dcb|nodcb}</replaceable></term>
612           <listitem>
613             <para>Try to connect to a FCoE SAN through the NIC specified by <replaceable>&lt;interface&gt;</replaceable> or <replaceable>&lt;MAC&gt;</replaceable> or EDD settings.
614 For the second argument, currently only nodcb is supported. This parameter can be specified multiple times. <remark>Note: letters in the MAC-address must be lowercase!</remark></para>
615           </listitem>
616         </varlistentry>
617       </variablelist>
618     </refsect2>
619     <refsect2>
620       <title>NBD</title>
621       <variablelist>
622         <varlistentry>
623           <term><envar>root=</envar><constant>nbd</constant>:<replaceable>&lt;server&gt;</replaceable>:<replaceable>&lt;port&gt;</replaceable><optional>:<replaceable>&lt;fstype&gt;</replaceable></optional><optional>:<replaceable>&lt;mountopts&gt;</replaceable></optional></term>
624           <listitem>
625             <para>mount nbd share from &lt;server&gt;</para>
626           </listitem>
627         </varlistentry>
628         <varlistentry>
629           <term>
630             <envar>root=dhcp</envar>
631           </term>
632           <listitem>
633             <para>with dhcp root-path=nbd:&lt;server&gt;:&lt;port&gt;[:&lt;fstype&gt;][:&lt;mountopts&gt;]
634 root=dhcp alone directs initrd to look at the DHCP root-path where NBD 
635 options can be specified.
636 This syntax is only usable in cases where you are directly mounting the volume 
637 as the rootfs.</para>
638           </listitem>
639         </varlistentry>
640       </variablelist>
641     </refsect2>
642     <refsect2>
643       <title>DASD</title>
644       <variablelist>
645         <varlistentry>
646           <term><envar>rd.dasd_mod.dasd=</envar>....</term>
647           <listitem>
648             <para>same syntax as the kernel module parameter (s390 only)</para>
649           </listitem>
650         </varlistentry>
651         <varlistentry>
652           <term>
653             <envar>rd.dasd=</envar><replaceable>&lt;dasd_adaptor device bus ID&gt;</replaceable><optional>,readonly=<replaceable>X</replaceable></optional><optional>,use_diag=<replaceable>X</replaceable></optional><optional>,erplog=<replaceable>X</replaceable></optional>
654           </term>
655           <listitem>
656             <para>activate DASD device with the given adaptor device bus ID and setting the sysfs attributes
657 to the specified values
658 This parameter can be specified multiple times.</para>
659           </listitem>
660         </varlistentry>
661       </variablelist>
662     </refsect2>
663     <refsect2>
664       <title>ZFCP</title>
665       <variablelist>
666         <varlistentry>
667           <term><envar>rd.zfcp=</envar><replaceable>&lt;zfcp adaptor device bus ID&gt;</replaceable>,<replaceable>&lt;WWPN&gt;</replaceable>,<replaceable>&lt;FCPLUN&gt;</replaceable></term>
668           <listitem>
669             <para>rd.zfcp can be specified multiple times on the kernel command line. e.g.: <programlisting>rd.zfcp=0.0.4000,0x5005076300C213e9,0x5022000000000000</programlisting></para>
670           </listitem>
671         </varlistentry>
672         <varlistentry>
673           <term>
674             <envar>rd.zfcp.conf</envar>
675           </term>
676           <listitem>
677             <para>ignore zfcp.conf included in the initramfs</para>
678           </listitem>
679         </varlistentry>
680       </variablelist>
681     </refsect2>
682     <refsect2>
683       <title>ZNET</title>
684       <variablelist>
685         <varlistentry>
686           <term><envar>rd.znet=</envar><replaceable>&lt;nettype&gt;</replaceable>,<replaceable>&lt;subchannels&gt;</replaceable>,<replaceable>&lt;options&gt;</replaceable></term>
687           <listitem>
688             <para>rd.znet can be specified multiple times on the kernel command line. e.g.:
689     <programlisting>rd.znet=qeth,0.0.0600,0.0.0601,0.0.0602,layer2=1,portname=foo
690 rd.znet=ctc,0.0.0600,0.0.0601,0.0.0602,protocol=bar</programlisting></para>
691           </listitem>
692         </varlistentry>
693       </variablelist>
694     </refsect2>
695     <refsect2>
696       <title>Plymouth Boot Splash</title>
697       <variablelist>
698         <varlistentry>
699           <term><envar>rd.plymouth</envar>=0</term>
700           <listitem>
701             <para>disable plymouth. This will not work with encrypted partitions.</para>
702           </listitem>
703         </varlistentry>
704       </variablelist>
705     </refsect2>
706     <refsect2>
707       <title>Deprecated, renamed Options</title>
708       <para>Here is a list of options, which were used in dracut prior to version 008, and their new replacement.</para>
709       <variablelist>
710         <varlistentry>
711           <term>
712             <envar>rdbreak</envar>
713           </term>
714           <listitem>
715             <para><envar>rd.break</envar></para>
716           </listitem>
717         </varlistentry>
718         <varlistentry>
719           <term>
720             <envar>rd_CCW</envar>
721           </term>
722           <listitem>
723             <para><envar>rd.ccw</envar></para>
724           </listitem>
725         </varlistentry>
726         <varlistentry>
727           <term>
728             <envar>rd_DASD_MOD</envar>
729           </term>
730           <listitem>
731             <para><envar>rd.dasd_mod.dasd</envar></para>
732           </listitem>
733         </varlistentry>
734         <varlistentry>
735           <term>
736             <envar>rd_DASD</envar>
737           </term>
738           <listitem>
739             <para><envar>rd.dasd</envar></para>
740           </listitem>
741         </varlistentry>
742         <varlistentry>
743           <term>
744             <envar>rdinitdebug rdnetdebug</envar>
745           </term>
746           <listitem>
747             <para><envar>rd.debug</envar></para>
748           </listitem>
749         </varlistentry>
750         <varlistentry>
751           <term>
752             <envar>rd_NO_DM</envar>
753           </term>
754           <listitem>
755             <para><envar>rd.dm</envar>=0</para>
756           </listitem>
757         </varlistentry>
758         <varlistentry>
759           <term>
760             <envar>rd_DM_UUID</envar>
761           </term>
762           <listitem>
763             <para><envar>rd.dm.uuid</envar></para>
764           </listitem>
765         </varlistentry>
766         <varlistentry>
767           <term>
768             <envar>rdblacklist</envar>
769           </term>
770           <listitem>
771             <para><envar>rd.driver.blacklist</envar></para>
772           </listitem>
773         </varlistentry>
774         <varlistentry>
775           <term>
776             <envar>rdinsmodpost</envar>
777           </term>
778           <listitem>
779             <para><envar>rd.driver.post</envar></para>
780           </listitem>
781         </varlistentry>
782         <varlistentry>
783           <term>
784             <envar>rdloaddriver</envar>
785           </term>
786           <listitem>
787             <para><envar>rd.driver.pre</envar></para>
788           </listitem>
789         </varlistentry>
790         <varlistentry>
791           <term>
792             <envar>rd_NO_FSTAB</envar>
793           </term>
794           <listitem>
795             <para><envar>rd.fstab</envar>=0</para>
796           </listitem>
797         </varlistentry>
798         <varlistentry>
799           <term>
800             <envar>rdinfo</envar>
801           </term>
802           <listitem>
803             <para><envar>rd.info</envar></para>
804           </listitem>
805         </varlistentry>
806         <varlistentry>
807           <term>
808             <envar>check</envar>
809           </term>
810           <listitem>
811             <para><envar>rd.live.check</envar></para>
812           </listitem>
813         </varlistentry>
814         <varlistentry>
815           <term>
816             <envar>rdlivedebug</envar>
817           </term>
818           <listitem>
819             <para><envar>rd.live.debug</envar></para>
820           </listitem>
821         </varlistentry>
822         <varlistentry>
823           <term>
824             <envar>live_dir</envar>
825           </term>
826           <listitem>
827             <para><envar>rd.live.dir</envar></para>
828           </listitem>
829         </varlistentry>
830         <varlistentry>
831           <term>
832             <envar>liveimg</envar>
833           </term>
834           <listitem>
835             <para><envar>rd.live.image</envar></para>
836           </listitem>
837         </varlistentry>
838         <varlistentry>
839           <term>
840             <envar>overlay</envar>
841           </term>
842           <listitem>
843             <para><envar>rd.live.overlay</envar></para>
844           </listitem>
845         </varlistentry>
846         <varlistentry>
847           <term>
848             <envar>readonly_overlay</envar>
849           </term>
850           <listitem>
851             <para><envar>rd.live.overlay.readonly</envar></para>
852           </listitem>
853         </varlistentry>
854         <varlistentry>
855           <term>
856             <envar>reset_overlay</envar>
857           </term>
858           <listitem>
859             <para><envar>rd.live.overlay.reset</envar></para>
860           </listitem>
861         </varlistentry>
862         <varlistentry>
863           <term>
864             <envar>live_ram</envar>
865           </term>
866           <listitem>
867             <para><envar>rd.live.ram</envar></para>
868           </listitem>
869         </varlistentry>
870         <varlistentry>
871           <term>
872             <envar>rd_NO_CRYPTTAB</envar>
873           </term>
874           <listitem>
875             <para><envar>rd.luks.crypttab</envar>=0</para>
876           </listitem>
877         </varlistentry>
878         <varlistentry>
879           <term>
880             <envar>rd_LUKS_KEYDEV_UUID</envar>
881           </term>
882           <listitem>
883             <para><envar>rd.luks.keydev.uuid</envar></para>
884           </listitem>
885         </varlistentry>
886         <varlistentry>
887           <term>
888             <envar>rd_LUKS_KEYPATH</envar>
889           </term>
890           <listitem>
891             <para><envar>rd.luks.keypath</envar></para>
892           </listitem>
893         </varlistentry>
894         <varlistentry>
895           <term>
896             <envar>rd_NO_LUKS</envar>
897           </term>
898           <listitem>
899             <para><envar>rd.luks</envar>=0</para>
900           </listitem>
901         </varlistentry>
902         <varlistentry>
903           <term>
904             <envar>rd_LUKS_UUID</envar>
905           </term>
906           <listitem>
907             <para><envar>rd.luks.uuid</envar></para>
908           </listitem>
909         </varlistentry>
910         <varlistentry>
911           <term>
912             <envar>rd_NO_LVMCONF</envar>
913           </term>
914           <listitem>
915             <para><envar>rd.lvm.conf</envar></para>
916           </listitem>
917         </varlistentry>
918         <varlistentry>
919           <term>
920             <envar>rd_LVM_LV</envar>
921           </term>
922           <listitem>
923             <para><envar>rd.lvm.lv</envar></para>
924           </listitem>
925         </varlistentry>
926         <varlistentry>
927           <term>
928             <envar>rd_NO_LVM</envar>
929           </term>
930           <listitem>
931             <para><envar>rd.lvm</envar>=0</para>
932           </listitem>
933         </varlistentry>
934         <varlistentry>
935           <term>
936             <envar>rd_LVM_SNAPSHOT</envar>
937           </term>
938           <listitem>
939             <para><envar>rd.lvm.snapshot</envar></para>
940           </listitem>
941         </varlistentry>
942         <varlistentry>
943           <term>
944             <envar>rd_LVM_SNAPSIZE</envar>
945           </term>
946           <listitem>
947             <para><envar>rd.lvm.snapsize</envar></para>
948           </listitem>
949         </varlistentry>
950         <varlistentry>
951           <term>
952             <envar>rd_LVM_VG</envar>
953           </term>
954           <listitem>
955             <para><envar>rd.lvm.vg</envar></para>
956           </listitem>
957         </varlistentry>
958         <varlistentry>
959           <term>
960             <envar>rd_NO_MDADMCONF</envar>
961           </term>
962           <listitem>
963             <para><envar>rd.md.conf</envar>=0</para>
964           </listitem>
965         </varlistentry>
966         <varlistentry>
967           <term>
968             <envar>rd_NO_MDIMSM</envar>
969           </term>
970           <listitem>
971             <para><envar>rd.md.imsm</envar>=0</para>
972           </listitem>
973         </varlistentry>
974         <varlistentry>
975           <term>
976             <envar>rd_NO_MD</envar>
977           </term>
978           <listitem>
979             <para><envar>rd.md</envar>=0</para>
980           </listitem>
981         </varlistentry>
982         <varlistentry>
983           <term>
984             <envar>rd_MD_UUID</envar>
985           </term>
986           <listitem>
987             <para><envar>rd.md.uuid</envar></para>
988           </listitem>
989         </varlistentry>
990         <varlistentry>
991           <term>
992             <envar>rd_NFS_DOMAIN</envar>
993           </term>
994           <listitem>
995             <para><envar>rd.nfs.domain</envar></para>
996           </listitem>
997         </varlistentry>
998         <varlistentry>
999           <term>
1000             <envar>iscsi_initiator</envar>
1001           </term>
1002           <listitem>
1003             <para><envar>rd.iscsi.initiator</envar></para>
1004           </listitem>
1005         </varlistentry>
1006         <varlistentry>
1007           <term>
1008             <envar>iscsi_target_name</envar>
1009           </term>
1010           <listitem>
1011             <para><envar>rd.iscsi.target.name</envar></para>
1012           </listitem>
1013         </varlistentry>
1014         <varlistentry>
1015           <term>
1016             <envar>iscsi_target_ip</envar>
1017           </term>
1018           <listitem>
1019             <para><envar>rd.iscsi.target.ip</envar></para>
1020           </listitem>
1021         </varlistentry>
1022         <varlistentry>
1023           <term>
1024             <envar>iscsi_target_port</envar>
1025           </term>
1026           <listitem>
1027             <para><envar>rd.iscsi.target.port</envar></para>
1028           </listitem>
1029         </varlistentry>
1030         <varlistentry>
1031           <term>
1032             <envar>iscsi_target_group</envar>
1033           </term>
1034           <listitem>
1035             <para><envar>rd.iscsi.target.group</envar></para>
1036           </listitem>
1037         </varlistentry>
1038         <varlistentry>
1039           <term>
1040             <envar>iscsi_username</envar>
1041           </term>
1042           <listitem>
1043             <para><envar>rd.iscsi.username</envar></para>
1044           </listitem>
1045         </varlistentry>
1046         <varlistentry>
1047           <term>
1048             <envar>iscsi_password</envar>
1049           </term>
1050           <listitem>
1051             <para><envar>rd.iscsi.password</envar></para>
1052           </listitem>
1053         </varlistentry>
1054         <varlistentry>
1055           <term>
1056             <envar>iscsi_in_username</envar>
1057           </term>
1058           <listitem>
1059             <para><envar>rd.iscsi.in.username</envar></para>
1060           </listitem>
1061         </varlistentry>
1062         <varlistentry>
1063           <term>
1064             <envar>iscsi_in_password</envar>
1065           </term>
1066           <listitem>
1067             <para><envar>rd.iscsi.in.password</envar></para>
1068           </listitem>
1069         </varlistentry>
1070         <varlistentry>
1071           <term>
1072             <envar>iscsi_firmware</envar>
1073           </term>
1074           <listitem>
1075             <para><envar>rd.iscsi.firmware</envar>=0</para>
1076           </listitem>
1077         </varlistentry>
1078         <varlistentry>
1079           <term>
1080             <envar>rd_NO_PLYMOUTH</envar>
1081           </term>
1082           <listitem>
1083             <para><envar>rd.plymouth</envar>=0</para>
1084           </listitem>
1085         </varlistentry>
1086         <varlistentry>
1087           <term>
1088             <envar>rd_retry</envar>
1089           </term>
1090           <listitem>
1091             <para><envar>rd.retry</envar></para>
1092           </listitem>
1093         </varlistentry>
1094         <varlistentry>
1095           <term>
1096             <envar>rdshell</envar>
1097           </term>
1098           <listitem>
1099             <para><envar>rd.shell</envar></para>
1100           </listitem>
1101         </varlistentry>
1102         <varlistentry>
1103           <term>
1104             <envar>rd_NO_SPLASH</envar>
1105           </term>
1106           <listitem>
1107             <para><envar>rd.splash</envar></para>
1108           </listitem>
1109         </varlistentry>
1110         <varlistentry>
1111           <term>
1112             <envar>rdudevdebug</envar>
1113           </term>
1114           <listitem>
1115             <para><envar>rd.udev.debug</envar></para>
1116           </listitem>
1117         </varlistentry>
1118         <varlistentry>
1119           <term>
1120             <envar>rdudevinfo</envar>
1121           </term>
1122           <listitem>
1123             <para><envar>rd.udev.info</envar></para>
1124           </listitem>
1125         </varlistentry>
1126         <varlistentry>
1127           <term>
1128             <envar>rd_NO_ZFCPCONF</envar>
1129           </term>
1130           <listitem>
1131             <para><envar>rd.zfcp.conf</envar>=0</para>
1132           </listitem>
1133         </varlistentry>
1134         <varlistentry>
1135           <term>
1136             <envar>rd_ZFCP</envar>
1137           </term>
1138           <listitem>
1139             <para><envar>rd.zfcp</envar></para>
1140           </listitem>
1141         </varlistentry>
1142         <varlistentry>
1143           <term>
1144             <envar>rd_ZNET</envar>
1145           </term>
1146           <listitem>
1147             <para><envar>rd.znet</envar></para>
1148           </listitem>
1149         </varlistentry>
1150         <varlistentry>
1151           <term>
1152             <envar>KEYMAP</envar>
1153           </term>
1154           <listitem>
1155             <para><envar>vconsole.keymap</envar></para>
1156           </listitem>
1157         </varlistentry>
1158         <varlistentry>
1159           <term>
1160             <envar>KEYTABLE</envar>
1161           </term>
1162           <listitem>
1163             <para><envar>vconsole.keymap</envar></para>
1164           </listitem>
1165         </varlistentry>
1166         <varlistentry>
1167           <term>
1168             <envar>SYSFONT</envar>
1169           </term>
1170           <listitem>
1171             <para><envar>vconsole.font</envar></para>
1172           </listitem>
1173         </varlistentry>
1174         <varlistentry>
1175           <term>
1176             <envar>CONTRANS</envar>
1177           </term>
1178           <listitem>
1179             <para><envar>vconsole.font.map</envar></para>
1180           </listitem>
1181         </varlistentry>
1182         <varlistentry>
1183           <term>
1184             <envar>UNIMAP</envar>
1185           </term>
1186           <listitem>
1187             <para><envar>vconsole.font.unimap</envar></para>
1188           </listitem>
1189         </varlistentry>
1190         <varlistentry>
1191           <term>
1192             <envar>UNICODE</envar>
1193           </term>
1194           <listitem>
1195             <para><envar>vconsole.unicode</envar></para>
1196           </listitem>
1197         </varlistentry>
1198         <varlistentry>
1199           <term>
1200             <envar>EXT_KEYMAP</envar>
1201           </term>
1202           <listitem>
1203             <para><envar>vconsole.keymap.ext</envar></para>
1204           </listitem>
1205         </varlistentry>
1206       </variablelist>
1207     </refsect2>
1208   </refsect1>
1209   <refsect1>
1210     <title>Configuration in the Initramfs</title>
1211     <variablelist>
1212       <varlistentry>
1213         <term>
1214           <filename>/etc/conf.d/</filename>
1215         </term>
1216         <listitem>
1217           <para>Any files found in <filename>/etc/conf.d/</filename> will be sourced in the initramfs to
1218 set initial values. Command line options will override these values 
1219 set in the configuration files.</para>
1220         </listitem>
1221       </varlistentry>
1222       <varlistentry>
1223         <term>
1224           <filename>/etc/cmdline</filename>
1225         </term>
1226         <listitem>
1227           <para>Can contain additional command line options.</para>
1228         </listitem>
1229       </varlistentry>
1230     </variablelist>
1231   </refsect1>
1232   <refsect1>
1233     <title>See Also</title>
1234     <para>
1235       <citerefentry>
1236         <refentrytitle>dracut</refentrytitle>
1237         <manvolnum>8</manvolnum>
1238       </citerefentry>
1239       <citerefentry>
1240         <refentrytitle>dracut.conf</refentrytitle>
1241         <manvolnum>5</manvolnum>
1242       </citerefentry>
1243     </para>
1244   </refsect1>
1245 </refentry>