plymouth: removed console_init call
[dracut/plouj.git] / dracut.8
blobbcf603f61f0355bbc31ce849fcc846fc0e034a09
1 .TH DRACUT 8 "June 2009" "Linux"
2 .SH NAME
3 switch_root \- switch to another filesystem as the root of the mount tree.
4 .SH SYNOPSIS
5 \fBdracut\fR [\fIOPTION\fR]... \fI<image>\fR  \fI<kernel-version>\fR
7 .SH DESCRIPTION
8 .B switch_root
9 \fBdracut\fR creates an initial image used by the kernel for
10 preloading the block device modules (such as IDE, SCSI or RAID)
11 which are needed to access the root filesystem.
13 .SH OPTIONS
14 .TP
15 .BR \-f ", " \-\-force
16 overwrite existing initramfs file.
17 .TP
18 .BR \-m ", " \-\-modules " \fILIST\fR"
19 specify a space-separated list of dracut modules to call 
20 when building the initramfs. 
21 Modules are located in 
22 .IR /usr/share/dracut/modules.d .
23 .TP
24 .BR \-o ", " \-\-omit " \fILIST\fR"
25 omit a space-separated list of dracut modules.
26 .TP
27 .BR \-a ", " \-\-add " \fILIST\fR"
28 add a space-separated list of dracut modules.
29 .TP
30 .BR \-d ", " \-\-drivers " \fILIST\fR"
31 specify a space-separated list of kernel modules to include in the initramfs.
32 .TP
33 .BR \-h ", " \-\-help
34 display help text and exit. 
35 .TP
36 .B \-\-debug
37 output debug information of the build process
38 .TP
39 .BR \-v ", " \-\-verbose
40 verbose output during the build process
41 .TP
42 .BR \-c ", " \-\-conf " \fIFILE\fR"
43 specify configuration file to use.
44 Default: 
45 .IR /etc/dracut.conf
46 .TP
47 .BR \-l ", " \-\-local
48 local mode. Use modules from the current working
49 directory instead of the system-wide installed in
50 .IR /usr/share/dracut/modules.d .
51 Useful when running dracut from a git checkout.
52 .TP
53 .BR \-H ", " \-\-hostonly
54 Host-Only mode: Install only what is needed for
55 booting the local host instead of a generic host.
56 .TP
57 .BR \-i ", " \-\-include " \fISOURCE\fR" "" " \fITARGET\fR"
58 include the files in the SOURCE directory into the
59 target directory in the final initramfs.
60 .TP
61 .BR \-I ", " \-\-install " \fILIST\fR"
62 install the space separated list of files into the initramfs.
64 .SH KERNEL COMMAND LINE
65 The root filesystem used by the kernel is specified in the boot configuration
66 file, as always. The traditional \fBroot=/dev/hda1\fR style device 
67 specification is allowed. If a label is used, as in \fBroot=LABEL=rootPart\fR
68 the initrd will search all available devices for an ext2 or ext3 filesystem
69 with the appropriate label, and mount that device as the root filesystem.
70 \fBroot=UUID=uuidnumber\fR will mount the partition with that UUID as the 
71 root filesystem.
73 .SH Standard
74 .TP
75 .B init=<path to real init>
76 .TP
77 .B root=<path to blockdevice>
78 specify e.g. \fI/dev/sda1\fR or
79 \fI/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1\fR
81 .SH I18N
82 e.g. LANG=en_US.UTF-8 SYSFONT=latarcyrheb-sun16 KEYTABLE=de-latin1-nodeadkeys
83 .TP
84 .B KEYBOARDTYPE=sun|pc
85 will be written to /etc/sysconfig/keyboard in the initramfs
86 .TP
87 .B KEYTABLE=<keytable filename>
88 will be written to /etc/sysconfig/keyboard in the initramfs
89 .TP
90 .B SYSFONT= Console font
91 will be written to /etc/sysconfig/i18n in the initramfs
92 .TP
93 .B SYSFONTACM= Unicode font map
94 will be written to /etc/sysconfig/i18n in the initramfs
95 .TP
96 .B UNIMAP= Unicode font map
97 will be written to /etc/sysconfig/i18n in the initramfs
98 .TP
99 .B LANG=<locale>
100 will be written to /etc/sysconfig/i18n in the initramfs
102 .SH LVM
104 .B rd_NO_LVM
105 disable LVM detection
107 .B rd_LVM_VG=<volume group name>
108 only activate the volume groups with the given name
110 .SH crypto LUKS
112 .B rd_NO_LUKS
113 disable crypto LUKS detection
115 .B rd_LUKS_UUID=<luks uuid>
116 only activate the LUKS partitions with the given UUID
118 .SH MD
120 .B rd_NO_MD
121 disable MD RAID detection
123 .B rd_MD_UUID=<md uuid>
124 only activate the raid sets with the given UUID
126 .SH DMRAID
128 .B rd_NO_DM
129 disable DM RAID detection
131 .B rd_DM_UUID=<dmraid uuid>
132 only activate the raid sets with the given UUID
134 .SH DHCP
136 .B root=dhcp
137 get IP from dhcp server, root-path option from dhcp specifies root location
139 .SH NFS
141 .B root=[<server-ip>:]<root-dir>[:<nfs-options>]
142 mount nfs share from <server-ip>:/<root-dir>, if no server-ip is given,
143 use dhcp next_server. 
144 NFS options can be appended with the prefix "." or ","
146 .B root=nfs:[<server-ip>:]<root-dir>[:<nfs-options>] 
148 .B root=nfs4:[<server-ip>:]<root-dir>[:<nfs-options>]
150 .B root=dhcp 
151 root=dhcp alone directs initrd to look at the DHCP root-path where NFS 
152 options can be specified.
153     root-path=<server-ip>:<root-dir>[,<nfs-options>]
154     root-path=nfs:<server-ip>:<root-dir>[,<nfs-options>]
155     root-path=nfs4:<server-ip>:<root-dir>[,<nfs-options>] 
157 .B root=/dev/nfs nfsroot=[<server-ip>:]<root-dir>[,<nfs-options>]
158 \fBDeprecated!\fR kernel Documentation/filesystems/nfsroot.txt defines 
159 this method.  
160 This is supported by dracut but not recommended.
162 .SH iSCSI
164 .B root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname>
165 protocol defaults to "6", LUN defaults to "0".
167 If the "servername" field is provided by BOOTP or DHCP, then that
168 field is used in conjunction with other associated fields to contact
169 the boot server in the Boot stage (Section 7).  However, if the
170 "servername" field is not provided, then the "targetname" field is
171 then used in the Discovery Service stage in conjunction with other
172 associated fields.
174 http://tools.ietf.org/html/rfc4173
177 .B root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname>
178 e.g. root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
181 .B root=??? netroot=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname> ...
182 multiple netroot options allow setting up multiple iscsi disks
183 e.g. 
184    root=UUID=12424547 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0 netroot=iscsi:192.168.50.1::::iqn.2009-06.dracut:target1
185 .B not yet implemented
187 .B root=??? iscsi_initiator= iscsi_target_name= iscsi_target_ip= iscsi_target_port= iscsi_target_group= iscsi_username=  iscsi_password= iscsi_in_username= iscsi_in_password=
190 .B root=??? iscsi_firmware
191 will read the iscsi parameter from the BIOS firmware
193 .SH NBD
195 .B root=nbd:<server>:<port>[:<fstype>][:<mountopts>]
196 mount nbd share from <server>
198 .B root=dhcp 
199    with dhcp root-path=nbd:<server>:<port>[:<fstype>][:<mountopts>]
200 root=dhcp alone directs initrd to look at the DHCP root-path where NBD options can be specified.
201 This syntax is only usable in cases where you are directly mounting the volume as the rootfs.
203 .SH Network
204 .TP bootdev=<interface>
205 .B specify the network interface to boot from
207 .B ip=[dhcp|on|any]
208 get ip from dhcp server from all interfaces. If root=dhcp, loop sequentially through all interfaces (eth0, eth1, ...) and use the first with a valid DHCP root-path.
210 .B ip=<interface>:[dhcp|on|any]
211 get ip from dhcp server on a specific interface
213 .B ip=<client-IP-number>:<gateway-IP-number>:<netmask>:<client-hostname>:<interface>:[dhcp|on|any|]
214 explicit network configuration
216 .SH Misc
218 .B rdblacklist=<drivername>
219 do not load kernel module <drivername>
221 .SH Debug
223 .B rdshell
224 drop to a shell, if the imitramfs fails
226 .B rdinitdebug
227 set -x for the dracut shell
229 .B rdbreak=[pre-udev|pre-mount|mount|pre-pivot|]
230 drop the shell on defined breakpoint
232 .B rdudevinfo
233 set udev to loglevel info
235 .B rdudevdebug
236 set udev to loglevel debug
238 .B rdnetdebug
239 debug network scripts in dracut. Output is written to /tmp/
241 .SH CONFIGURATION IN INITRAMFS
242 .TP 
243 .B /conf/conf.d/
244 Any files found in /conf/conf.d/ will be sourced in the initramfs to 
245 set initial values. Command line options will override these values 
246 set in the configuration files.
248 .SH AUTHORS
250 Andreas Thienemann <andreas@bawue.net>
251 Bill Nottingham <notting@redhat.com>
252 Dave Jones <davej@redhat.com>
253 David Dillow <dave@thedillows.org>
254 Harald Hoyer <harald@redhat.com>
255 Jeremy Katz <katzj@redhat.com>
256 Peter Jones <pjones@redhat.com>
257 Seewer Philippe <philippe.seewer@bfh.ch>
258 Victor Lowther <victor.lowther@gmail.com>
259 Warren Togami <wtogami@redhat.com>
261 .SH AVAILABILITY
262 The dracut command is part of the dracut package and is available from
263 https://sourceforge.net/apps/trac/dracut/wiki