use 128M for the test virtual machines instead of 512M
[dracut/plouj.git] / dracut.8
blob525892588e385764eb453e78802465f3edb528b6
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/lib/dracut/modules.d .
23 .TP
24 .BR \-o ", " \-\-omit " \fILIST\fR"
25 omit a space-separated list of dracut modules.
26 .TP
27 .BR \-d ", " \-\-drivers " \fILIST\fR"
28 specify a space-separated list of kernel modules to include in the initramfs.
29 .TP
30 .BR \-h ", " \-\-help
31 display help text and exit. 
32 .TP
33 .B \-\-debug
34 output debug information of the build process
35 .TP
36 .BR \-v ", " \-\-verbose
37 verbose output during the build process
38 .TP
39 .BR \-c ", " \-\-conf " \fIFILE\fR"
40 specify configuration file to use.
41 Default: 
42 .IR /etc/dracut.conf
43 .TP
44 .BR \-l ", " \-\-local
45 local mode. Use modules from the current working
46 directory instead of the system-wide installed in
47 .IR /usr/lib/dracut/modules.d .
48 Useful when running dracut from a git checkout.
49 .TP
50 .BR \-H ", " \-\-hostonly
51 Host-Only mode: Install only what is needed for
52 booting the local host instead of a generic host.
53 .TP
54 .BR \-i ", " \-\-include " \fISOURCE\fR" "" " \fITARGET\fR"
55 include the files in the SOURCE directory into the
56 target directory in the final initramfs.
57 .TP
58 .BR \-I ", " \-\-install " \fILIST\fR"
59 install the space separated list of files into the initramfs.
61 .SH KERNEL COMMAND LINE
62 The root filesystem used by the kernel is specified in the boot configuration
63 file, as always. The traditional \fBroot=/dev/hda1\fR style device 
64 specification is allowed. If a label is used, as in \fBroot=LABEL=rootPart\fR
65 the initrd will search all available devices for an ext2 or ext3 filesystem
66 with the appropriate label, and mount that device as the root filesystem.
67 \fBroot=UUID=uuidnumber\fR will mount the partition with that UUID as the 
68 root filesystem.
70 .SH Standard
71 .TP
72 .B init=<path to real init>
73 .TP
74 .B root=<path to blockdevice>
75 specify e.g. \fI/dev/sda1\fR or
76 \fI/dev/disk/by-path/pci-0000:00:1f.1-scsi-0:0:1:0-part1\fR
78 .SH DHCP
79 .TP
80 .B root=dhcp
81 get IP from dhcp server, root-path option from dhcp specifies root location
83 .SH NFS
84 .TP
85 .B root=[<server-ip>:]<root-dir>[:<nfs-options>]
86 mount nfs share from <server-ip>:/<root-dir>, if no server-ip is given,
87 use dhcp next_server. 
88 NFS options can be appended with the prefix "." or ","
89 .TP
90 .B root=dhcp root-path=<server-ip>:<root-dir>[:<nfs-options>]
91 root=dhcp alone directs initrd to look at the DHCP root-path where NFS 
92 options can be specified.
93 .TP
94 .B root=/dev/nfs nfsroot=[<server-ip>:]<root-dir>[,<nfs-options>]
95 \fBDeprecated!\fR kernel Documentation/filesystems/nfsroot.txt defines 
96 this method.  
97 This is supported by dracut but not recommended.
99 .SH iSCSI
101 .B root=iscsi:[<servername>]:[<protocol>]:[<port>]:[<LUN>]:<targetname>
102 protocol defaults to "6", LUN defaults to "0".
104 If the "servername" field is provided by BOOTP or DHCP, then that
105 field is used in conjunction with other associated fields to contact
106 the boot server in the Boot stage (Section 7).  However, if the
107 "servername" field is not provided, then the "targetname" field is
108 then used in the Discovery Service stage in conjunction with other
109 associated fields.
111 http://tools.ietf.org/html/rfc4173
114 .B root=??? iscsiroot=...
116 .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=
118 .B root=??? iscsi_firmware
120 .SH NBD
122 .B root=nbd:<server>:<port>[:<fstype>][:<mountopts>]
123 mount nbd share from <server>
125 .B root=dhcp root-path=nbd:<server>:<port>[:<fstype>][:<mountopts>]
126 root=dhcp alone directs initrd to look at the DHCP root-path where NBD options can be specified.
127 This syntax is only usable in cases where you are directly mounting the volume as the rootfs.
129 .SH Network
130 .TP bootdev=<interface>
131 .B specify the network interface to boot from
133 .B ip=[dhcp|on|any]
134 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.
136 .B ip=<interface>:[dhcp|on|any]
137 get ip from dhcp server on a specific interface
139 .B ip=<client-IP-number>:<gateway-IP-number>:<netmask>:<client-hostname>:<interface>:[dhcp|on|any|]
140 explicit network configuration
142 .SH Misc
144 .B rdblacklist=<drivername>
145 TBD: do not load kernel drivername
147 .SH Debug
149 .B rdinitdebug
150 set -x for the dracut shell
152 .B rdbreak=[pre-udev|pre-mount|mount|pre-pivot|]
153 drop the shell on defined breakpoint
155 .B rdudevinfo
156 set udev to loglevel info
158 .B rdudevdebug
159 set udev to loglevel debug
161 .B rdnetdebug
162 debug network scripts in dracut. Output is written to /tmp/
165 .SH CONFIGURATION IN INITRAMFS
166 .TP 
167 .B /conf/conf.d/
168 Any files found in /conf/conf.d/ will be sourced in the initramfs to 
169 specify special variables. 
170 Command line options can override values set here.
172 .SH AUTHORS
174 Andreas Thienemann <andreas@bawue.net>
175 Bill Nottingham <notting@redhat.com>
176 Dave Jones <davej@redhat.com>
177 David Dillow <dave@thedillows.org>
178 Harald Hoyer <harald@redhat.com>
179 Jeremy Katz <katzj@redhat.com>
180 Peter Jones <pjones@redhat.com>
181 Seewer Philippe <philippe.seewer@bfh.ch>
182 Victor Lowther <victor.lowther@gmail.com>
183 Warren Togami <wtogami@redhat.com>
185 .SH AVAILABILITY
186 The dracut command is part of the dracut package and is available from
187 https://sourceforge.net/apps/trac/dracut/wiki