1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 <refentrytitle>geninitrd</refentrytitle>
7 <manvolnum>8</manvolnum>
8 <refmiscinfo class="software">PLD</refmiscinfo>
9 <refmiscinfo class="date">$Date: 2003/04/09 11:40:39 $</refmiscinfo>
12 <refname>geninitrd</refname>
14 creates initial ramdisk images for preloading modules
19 <command>geninitrd</command>
22 <arg rep="repeat">--with=module</arg>
23 <arg rep="repeat">--preload=module</arg>
24 <arg>--fstab=fstab</arg>
25 <arg>--raidtab=raidtab</arg>
26 <arg>--modules-conf=modules.conf</arg>
27 <arg>--fs=rom|ext2|cram</arg>
28 <arg>--with-insmod-static</arg>
29 <arg choice="req">image</arg>
30 <arg choice="req">kernel-version</arg>
33 <command>geninitrd</command>
39 <title>Description</title>
41 <application>geninitrd</application> creates filesystem images
42 which are suitable for use as Linux initial ramdisk (initrd)
43 images. Such images are often used for preloading the block
44 device modules (such as IDE, SCSI or RAID) which are needed to
45 access the root filesystem. <application>geninitrd</application>
46 automatically loads all <varname>scsi_hostadapter</varname>
47 entries in <filename>/etc/modules.conf</filename> when it finds
48 that root fs is mounted on SCSI device, which makes it simple to
49 build and use kernels using modular SCSI devices. It will also
50 load IDE and RAID modules when needed. </para>
51 <para>Any module options specified in
52 <filename>/etc/modules.conf</filename> are passed to the modules
53 as they are loaded by the initial ramdisk. </para>
54 <para>If the root filesystem is modular, initrd will automatically
55 add the filesystem's modules to the initrd image.</para>
57 <!-- <para>If the root device is on a loop device (such as
58 <filename>/dev/loop0</filename>), <application>geninitrd</application>
59 will attempt to build an initrd which sets up the loopback file
60 properly. To do this, the fstab must contain a comment of the form:
62 # LOOP0: /dev/hda1 vfat /linux/rootfs
64 LOOP0 must be the name of the loop device which needs to be configured, in
65 all capital lettes. The parameters after the color are the device which
66 contains the filesystem with the loopback image on it, the filesystem which
67 is on the device, and the full path to the loopback image.
71 <title>Options</title>
77 <para>Allows <application>geninitrd</application> to
78 overwrite an existing image file.</para>
82 <term>--fstab=<filename>fstab</filename></term>
84 <para>Use <filename>fstab</filename> to automatically
85 determine what type of filesystem the root device is on.
86 Normally, <filename>/etc/fstab</filename> is used.</para>
90 <term>--raidtab=<filename>raidtab</filename></term>
92 <para>Use <filename>raidtab</filename> to automatically
93 determine raid settings of the root device. Normally,
94 <filename>/etc/raidtab</filename> is used.</para>
98 <term>--ifneeded</term>
100 <para>Only builds the image if their are modules that need
101 to be loaded at boot time.</para>
105 <term>--image-version</term>
107 <para>Append kernel version to initrd name.</para>
111 <term>--nocompress</term>
113 <para>Don't compress initrd.</para>
117 <term>-(hack)-no-bsp</term>
119 <para>Don't use Braindamaged Script Processor (/bin/bsp) and use /bin/trash instead.</para>
123 <term>--preload=<filename>module</filename></term>
125 <para>Load the module <filename>module</filename> in the
126 initial ramdisk image. The module gets loaded before any
127 SCSI modules which are specified in
128 <filename>/etc/modules.conf</filename>. This option may be
129 used as many times as necessary.
134 <term>--with=<filename>module</filename></term>
136 <para>Alias to --preload.</para>
142 <para>Prints out verbose information while creating the
143 image (normally the <application>geninitrd</application>
149 <term>--version</term>
151 <para>Prints the version of
152 <application>geninitrd</application> that's being used and
157 <term>--initrdfs=<filename>ext2|rom|cram</filename></term>
159 <para>Filesystem type to be used for the image. Only
160 selected filesystem should always be compiled into
165 <term>--with-insmod-static</term>
167 <para>Use <filename>/sbin/insmod.static</filename> insteed of <command>bsp</command> bulitin insmod.</para>
173 <title>SCSI support</title>
175 If geninitrd detect rootfs on SCSI disk then lookup for "scsi_hostadapter" alias in /etc/modules.conf file and use it to load proper SCSI low-level driver(s).
179 <title>ATA RAID support</title>
181 If geninitrd detect rootfs on ATA RAID then lookup for "ataraid_hostadapter" alias in /etc/modules.conf and use it to load proper ATA RAID low level driver.
183 <para>For eg. if you have Promise FastTrack controler then add "alias ataraid_hostadapter pdcraid" to /etc/modules.conf.</para>
186 <title>Linux 2.6.x support</title>
187 <para>To bulild initrd for Linux 2.6.x kernels you must have module-init-tools and use --with-insmod-static switch or use busybox version that comes in busybox-initrd package.
191 <title>Hardware RAID support</title>
193 geninitrd support following RAID controlers:
205 <term><filename>/etc/sysconfig/geninitrd</filename></term>
207 <para>Configuraton file with default options. Putting proper
208 options there helps in automatic creation of initrd eg. on
215 class="devicefile">/dev/loop*</filename></term>
217 <para>A block loopback device is used to create the image,
218 which makes this script useless on systems without block
219 loopback support available.
224 <term><filename>/etc/modules.conf</filename></term>
226 <para>Specified SCSI modules to be loaded and module options
233 <title>SEE ALSO</title>
235 <refentrytitle>fstab</refentrytitle>
236 <manvolnum>5</manvolnum>
239 <refentrytitle>insmod</refentrytitle>
240 <manvolnum>1</manvolnum>
243 <refentrytitle>grub</refentrytitle>
244 <manvolnum>8</manvolnum>
247 <refentrytitle>lilo</refentrytitle>
248 <manvolnum>8</manvolnum>
251 <refentrytitle>genromfs</refentrytitle>
252 <manvolnum>8</manvolnum>
257 <title>Authors</title>
258 <para><application>geninitrd</application> is based on mkinitrd by
259 Erik Troan <email>ewt(at)redhat.com</email> and contributors:
261 <member>Elliot Lee <email>sopwith(at)cuc.edu</email></member>
262 <member> Miguel de Icaza
263 <email>miguel(at)nuclecu.unam.mx</email></member>
264 <member>Christian 'Dr. Disk' Hechelmann
265 <email>drdisk(at)ds9.au.s.shuttle.de</email></member>
266 <member>Michael K. Johnson
267 <email>johnsonm(at)redhat.com</email></member>
268 <member>Pierre Habraken
269 <email>Pierre.Habraken(at)ujf-grenoble.fr</email></member>
270 <member>Jakub Jelinek
271 <email>jj(at)ultra.linux.cz</email></member>
272 <member>Carlo Arenas Belon
273 <email>carenas(at)chasqui.lared.net.pe</email></member>
276 <para><application>geninitrd</application> is writen by Jacek
277 Konieczny <email>jajcus(at)pld-linux.org</email> and contributors (in
278 alphabetic order): <simplelist>
279 <member>Witold Filipczyk <email>witekfl(at)poczta.onet.pl</email></member>
280 <member>Artur Frysiak <email>wiget(at)pld-linux.org</email></member>
281 <member>Dariusz Karolczak <email>inglod(at)pld-linux.org</email></member>
282 <member>Tomasz KĹ
\82oczko <email>kloczek(at)pld.org.pl</email></member>
283 <member>Arkadiusz MiĹ
\9bkiewicz <email>misiek(at)pld-linux.org</email></member>
284 <member>MichaĹ
\82 Moskal <email>malekith(at)pld-linux.org</email></member>
285 <member>Jan RÄ
\99korajski <email>baggins(at)pld-linux.org</email></member>
286 <member>Sebastian Zagrodzki <email>zagrodzki(at)pld-linux.org</email></member>
287 <member>MichaĹ
\82 Zawalich <email>michuz(at)pld-linux.org</email></member>
290 <para> Manual page for <application>geninitrd</application> is
291 based on mkinitrd.8 by Erik Troan <email>ewt(at)redhat.com</email>
292 and writen by Jacek Konieczny
293 <email>jajcus(at)pld-linux.org</email> and contributors.</para>
296 <!-- vim61: set fileencoding=utf-8 : -->