plymouth: also trigger dri subsystem
[dracut/plouj.git] / dracut.8
blobfdec91934e4218f184a4bed494c14a68cb21c151
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 Bootsplash - plymouth
104 .B rd_plytheme=<theme name>
105 specify the plymouth bootsplash theme (fallback is text)
107 .SH LVM
109 .B rd_NO_LVM
110 disable LVM detection
112 .B rd_LVM_VG=<volume group name>
113 only activate the volume groups with the given name
115 .SH crypto LUKS
117 .B rd_NO_LUKS
118 disable crypto LUKS detection
120 .B rd_LUKS_UUID=<luks uuid>
121 only activate the LUKS partitions with the given UUID
123 .SH MD
125 .B rd_NO_MD
126 disable MD RAID detection
128 .B rd_NO_MDIMSM
129 no MD RAID for imsm/isw raids, use dmraid instead
131 .B rd_MD_UUID=<md uuid>
132 only activate the raid sets with the given UUID
134 .SH DMRAID
136 .B rd_NO_DM
137 disable DM RAID detection
139 .B rd_DM_UUID=<dmraid uuid>
140 only activate the raid sets with the given UUID
142 .SH DHCP
144 .B root=dhcp
145 get IP from dhcp server, root-path option from dhcp specifies root location
147 .SH NFS
149 .B root=[<server-ip>:]<root-dir>[:<nfs-options>]
150 mount nfs share from <server-ip>:/<root-dir>, if no server-ip is given,
151 use dhcp next_server. 
152 NFS options can be appended with the prefix "." or ","
154 .B root=nfs:[<server-ip>:]<root-dir>[:<nfs-options>] 
156 .B root=nfs4:[<server-ip>:]<root-dir>[:<nfs-options>]
158 .B root=dhcp 
159 root=dhcp alone directs initrd to look at the DHCP root-path where NFS 
160 options can be specified.
161     root-path=<server-ip>:<root-dir>[,<nfs-options>]
162     root-path=nfs:<server-ip>:<root-dir>[,<nfs-options>]
163     root-path=nfs4:<server-ip>:<root-dir>[,<nfs-options>] 
165 .B root=/dev/nfs nfsroot=[<server-ip>:]<root-dir>[,<nfs-options>]
166 \fBDeprecated!\fR kernel Documentation/filesystems/nfsroot.txt defines 
167 this method.  
168 This is supported by dracut but not recommended.
170 .SH iSCSI
172 .B root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname>
173 protocol defaults to "6", LUN defaults to "0".
175 If the "servername" field is provided by BOOTP or DHCP, then that
176 field is used in conjunction with other associated fields to contact
177 the boot server in the Boot stage (Section 7).  However, if the
178 "servername" field is not provided, then the "targetname" field is
179 then used in the Discovery Service stage in conjunction with other
180 associated fields.
182 http://tools.ietf.org/html/rfc4173
185 .B root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname>
186 e.g. root=iscsi:192.168.50.1::::iqn.2009-06.dracut:target0
189 .B root=??? netroot=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname> ...
190 multiple netroot options allow setting up multiple iscsi disks
191 e.g. 
192    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
193 .B not yet implemented
195 .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=
198 .B root=??? iscsi_firmware
199 will read the iscsi parameter from the BIOS firmware
201 .SH NBD
203 .B root=nbd:<server>:<port>[:<fstype>][:<mountopts>]
204 mount nbd share from <server>
206 .B root=dhcp 
207    with dhcp root-path=nbd:<server>:<port>[:<fstype>][:<mountopts>]
208 root=dhcp alone directs initrd to look at the DHCP root-path where NBD options can be specified.
209 This syntax is only usable in cases where you are directly mounting the volume as the rootfs.
211 .SH Network
212 .TP bootdev=<interface>
213 .B specify the network interface to boot from
215 .B ip=[dhcp|on|any]
216 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.
218 .B ip=<interface>:[dhcp|on|any]
219 get ip from dhcp server on a specific interface
221 .B ip=<client-IP-number>:<gateway-IP-number>:<netmask>:<client-hostname>:<interface>:[dhcp|on|any|]
222 explicit network configuration
224 .SH Misc
226 .B rdblacklist=<drivername>
227 do not load kernel module <drivername>
229 .SH Debug
231 .B rdshell
232 drop to a shell, if the imitramfs fails
234 .B rdinitdebug
235 set -x for the dracut shell
237 .B rdbreak=[pre-udev|pre-mount|mount|pre-pivot|]
238 drop the shell on defined breakpoint
240 .B rdudevinfo
241 set udev to loglevel info
243 .B rdudevdebug
244 set udev to loglevel debug
246 .B rdnetdebug
247 debug network scripts in dracut. Output is written to /tmp/
249 .SH CONFIGURATION IN INITRAMFS
250 .TP 
251 .B /conf/conf.d/
252 Any files found in /conf/conf.d/ will be sourced in the initramfs to 
253 set initial values. Command line options will override these values 
254 set in the configuration files.
256 .SH AUTHORS
258 Andreas Thienemann <andreas@bawue.net>
259 Bill Nottingham <notting@redhat.com>
260 Dave Jones <davej@redhat.com>
261 David Dillow <dave@thedillows.org>
262 Harald Hoyer <harald@redhat.com>
263 Jeremy Katz <katzj@redhat.com>
264 Peter Jones <pjones@redhat.com>
265 Seewer Philippe <philippe.seewer@bfh.ch>
266 Victor Lowther <victor.lowther@gmail.com>
267 Warren Togami <wtogami@redhat.com>
269 .SH AVAILABILITY
270 The dracut command is part of the dracut package and is available from
271 https://sourceforge.net/apps/trac/dracut/wiki