]>
Commit | Line | Data |
---|---|---|
94e606e8 | 1 | <?xml version="1.0" encoding="utf-8"?> |
5f15bc30 AF |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" |
3 | "file:///usr/share/sgml/docbook/xml-dtd-4.1.2/docbookx.dtd"> | |
4 | ||
5 | <refentry> | |
6 | <refmeta> | |
7 | <refentrytitle>geninitrd</refentrytitle> | |
8 | <manvolnum>8</manvolnum> | |
9 | <refmiscinfo class="software">PLD</refmiscinfo> | |
cefa3e84 | 10 | <refmiscinfo class="date">$Date: 2002/09/27 15:19:55 $</refmiscinfo> |
5f15bc30 AF |
11 | </refmeta> |
12 | <refnamediv> | |
13 | <refname>geninitrd</refname> | |
14 | <refpurpose> | |
94e606e8 | 15 | creates initial ramdisk images for preloading modules |
5f15bc30 AF |
16 | </refpurpose> |
17 | </refnamediv> | |
18 | <refsynopsisdiv> | |
19 | <cmdsynopsis> | |
20 | <command>geninitrd</command> | |
21 | <arg>-f</arg> | |
22 | <arg>-v</arg> | |
23 | <arg rep="repeat">--with=module</arg> | |
24 | <arg rep="repeat">--preload=module</arg> | |
25 | <arg>--fstab=fstab</arg> | |
26 | <arg>--raidtab=raidtab</arg> | |
27 | <arg>--modules-conf=modules.conf</arg> | |
28 | <arg>--fs=rom|ext2|cram</arg> | |
29 | <arg choice="req">image</arg> | |
30 | <arg choice="req">kernel-version</arg> | |
31 | </cmdsynopsis> | |
32 | <cmdsynopsis> | |
33 | <command>geninitrd</command> | |
34 | <arg>--version</arg> | |
35 | </cmdsynopsis> | |
36 | </refsynopsisdiv> | |
37 | ||
38 | <refsect1> | |
39 | <title>Description</title> | |
40 | <para> | |
94e606e8 AF |
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> | |
5f15bc30 | 51 | <para>Any module options specified in |
94e606e8 AF |
52 | <filename>/etc/modules.conf</filename> are passed to the modules |
53 | as they are loaded by the initial ramdisk. </para> | |
5f15bc30 | 54 | <para>If the root filesystem is modular, initrd will automatically |
94e606e8 | 55 | add the filesystem's modules to the initrd image.</para> |
5f15bc30 | 56 | |
94e606e8 AF |
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: | |
61 | <literal> | |
62 | # LOOP0: /dev/hda1 vfat /linux/rootfs | |
63 | </literal> | |
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. | |
68 | </para> --> | |
5f15bc30 AF |
69 | </refsect1> |
70 | <refsect1> | |
71 | <title>Options</title> | |
72 | ||
73 | <variablelist> | |
74 | <varlistentry> | |
75 | <term>-f</term> | |
76 | <listitem> | |
94e606e8 AF |
77 | <para>Allows <application>geninitrd</application> to |
78 | overwrite an existing image file.</para> | |
5f15bc30 AF |
79 | </listitem> |
80 | </varlistentry> | |
81 | <varlistentry> | |
82 | <term>--fstab=<filename>fstab</filename></term> | |
83 | <listitem> | |
94e606e8 AF |
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> | |
5f15bc30 AF |
87 | </listitem> |
88 | </varlistentry> | |
89 | <varlistentry> | |
90 | <term>--raidtab=<filename>raidtab</filename></term> | |
91 | <listitem> | |
94e606e8 AF |
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> | |
95 | </listitem> | |
96 | </varlistentry> | |
97 | <varlistentry> | |
98 | <term>--ifneeded</term> | |
99 | <listitem> | |
100 | <para>Only builds the image if their are modules that need | |
101 | to be loaded at boot time.</para> | |
102 | </listitem> | |
103 | </varlistentry> | |
104 | <varlistentry> | |
105 | <term>--image-version</term> | |
106 | <listitem> | |
107 | <para>Append kernel version to initrd name.</para> | |
108 | </listitem> | |
109 | </varlistentry> | |
110 | <varlistentry> | |
111 | <term>--nocompress</term> | |
112 | <listitem> | |
113 | <para>Don't compress initrd.</para> | |
114 | </listitem> | |
115 | </varlistentry> | |
116 | <!-- varlistentry> | |
ce06b4ae | 117 | <term>-(hack)-no-bsp</term> |
94e606e8 AF |
118 | <listitem> |
119 | <para>Don't use Braindamaged Script Processor (/bin/bsp) and use /bin/trash instead.</para> | |
120 | </listitem> | |
121 | </varlistentry --> | |
122 | <varlistentry> | |
123 | <term>--preload=<filename>module</filename></term> | |
124 | <listitem> | |
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. | |
130 | </para> | |
131 | </listitem> | |
132 | </varlistentry> | |
133 | <varlistentry> | |
134 | <term>--with=<filename>module</filename></term> | |
135 | <listitem> | |
136 | <para>Alias to --preload.</para> | |
137 | </listitem> | |
138 | </varlistentry> | |
139 | <varlistentry> | |
140 | <term>-v</term> | |
141 | <listitem> | |
142 | <para>Prints out verbose information while creating the | |
143 | image (normally the <application>geninitrd</application> | |
144 | runs silently). | |
145 | </para> | |
146 | </listitem> | |
147 | </varlistentry> | |
148 | <varlistentry> | |
149 | <term>--version</term> | |
150 | <listitem> | |
151 | <para>Prints the version of | |
152 | <application>geninitrd</application> that's being used and | |
153 | then exits.</para> | |
154 | </listitem> | |
155 | </varlistentry> | |
156 | <varlistentry> | |
157 | <term>--initrdfs=<filename>ext2|rom|cram</filename></term> | |
158 | <listitem> | |
159 | <para>Filesystem type to be used for the image. Only | |
160 | selected filesystem should always be compiled into | |
161 | kernel.</para> | |
5f15bc30 AF |
162 | </listitem> |
163 | </varlistentry> | |
164 | </variablelist> | |
b204a355 AF |
165 | </refsect1> |
166 | <refsect1> | |
167 | <title>SCSI support</title> | |
168 | <para> | |
169 | 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). | |
170 | </para> | |
171 | </refsect1> | |
172 | <refsect1> | |
173 | <title>ATA RAID support</title> | |
174 | <para> | |
175 | 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. | |
176 | </para> | |
177 | <para>For eg. if you have Promise FastTrack controler then add "alias ataraid_hostadapter pdcraid" to /etc/modules.conf.</para> | |
178 | </refsect1> | |
1f808447 | 179 | <!-- refsect1> |
b204a355 AF |
180 | <title>Hardware RAID support</title> |
181 | <para> | |
182 | geninitrd support following RAID controlers: | |
183 | <itemizedlist> | |
184 | <listitem> | |
185 | <para></para> | |
186 | </listitem> | |
187 | </itemizedlist> | |
188 | </para> | |
1f808447 | 189 | </refsect1 --> |
94e606e8 AF |
190 | <refsect1> |
191 | <title>FILES</title> | |
192 | <variablelist> | |
193 | <varlistentry> | |
194 | <term><filename>/etc/sysconfig/geninitrd</filename></term> | |
195 | <listitem> | |
196 | <para>Configuraton file with default options. Putting proper | |
197 | options there helps in automatic creation of initrd eg. on | |
198 | kernel upgrade. | |
199 | </para> | |
200 | </listitem> | |
201 | </varlistentry> | |
202 | <varlistentry> | |
203 | <term><filename | |
204 | class="devicefile">/dev/loop*</filename></term> | |
205 | <listitem> | |
206 | <para>A block loopback device is used to create the image, | |
207 | which makes this script useless on systems without block | |
208 | loopback support available. | |
209 | </para> | |
210 | </listitem> | |
211 | </varlistentry> | |
212 | <varlistentry> | |
213 | <term><filename>/etc/modules.conf</filename></term> | |
214 | <listitem> | |
215 | <para>Specified SCSI modules to be loaded and module options | |
216 | to be used.</para> | |
217 | </listitem> | |
218 | </varlistentry> | |
219 | </variablelist> | |
220 | </refsect1> | |
221 | <refsect1> | |
222 | <title>SEE ALSO</title> | |
223 | <para><citerefentry> | |
224 | <refentrytitle>fstab</refentrytitle> | |
225 | <manvolnum>5</manvolnum> | |
226 | </citerefentry> | |
227 | <citerefentry> | |
228 | <refentrytitle>insmod</refentrytitle> | |
229 | <manvolnum>1</manvolnum> | |
230 | </citerefentry> | |
231 | <citerefentry> | |
232 | <refentrytitle>grub</refentrytitle> | |
233 | <manvolnum>8</manvolnum> | |
234 | </citerefentry> | |
235 | <citerefentry> | |
236 | <refentrytitle>lilo</refentrytitle> | |
237 | <manvolnum>8</manvolnum> | |
238 | </citerefentry> | |
239 | <citerefentry> | |
240 | <refentrytitle>genromfs</refentrytitle> | |
241 | <manvolnum>8</manvolnum> | |
242 | </citerefentry> | |
243 | </para> | |
244 | </refsect1> | |
5f15bc30 AF |
245 | <refsect1> |
246 | <title>Authors</title> | |
94e606e8 AF |
247 | <para><application>geninitrd</application> is based on mkinitrd by |
248 | Erik Troan <email>ewt@redhat.com</email> and contributors: | |
249 | <simplelist> | |
250 | <member>Elliot Lee <email>sopwith@cuc.edu</email></member> | |
251 | <member> Miguel de Icaza | |
252 | <email>miguel@nuclecu.unam.mx</email></member> | |
253 | <member>Christian 'Dr. Disk' Hechelmann | |
254 | <email>drdisk@ds9.au.s.shuttle.de</email></member> | |
255 | <member>Michael K. Johnson | |
256 | <email>johnsonm@redhat.com</email></member> | |
5c16e874 AF |
257 | <member>Pierre Habraken |
258 | <email>Pierre.Habraken@ujf-grenoble.fr</email></member> | |
94e606e8 AF |
259 | <member>Jakub Jelinek |
260 | <email>jj@ultra.linux.cz</email></member> | |
261 | <member>Carlo Arenas Belon | |
262 | <email>carenas@chasqui.lared.net.pe</email></member> | |
263 | </simplelist> | |
264 | </para> | |
5f15bc30 | 265 | <para><application>geninird</application> is writen by Jacek |
94e606e8 AF |
266 | Konieczny <email>jajcus@pld.org.pl</email> and contributors (in |
267 | alphabetic order): <simplelist> | |
cefa3e84 | 268 | <member>Witold Filipczyk <email>witekfl@poczta.onet.pl</email></member> |
5f15bc30 AF |
269 | <member>Artur Frysiak <email>wiget@pld.org.pl</email></member> |
270 | <member>Dariusz Karolczak | |
94e606e8 AF |
271 | <email>inglod@pld.org.pl</email></member> |
272 | <member>Tomasz Kłoczko | |
273 | <email>kloczek@pld.org.pl</email></member> | |
274 | <member>Arkadiusz Miśkiewicz | |
275 | <email>misiek@pld.org.pl</email></member> | |
276 | <member>Michał Moskal | |
277 | <email>malekith@pld.org.pl</email></member> | |
278 | <member>Jan Rękorajski | |
279 | <email>baggins@pld.org.pl</email></member> | |
5f15bc30 | 280 | <member>Sebastian Zagrodzki |
94e606e8 AF |
281 | <email>zagrodzki@pld.org.pl</email></member> |
282 | <member>Michał Zawalich | |
283 | <email>michuz@pld.org.pl</email></member> | |
5f15bc30 | 284 | </simplelist> |
94e606e8 AF |
285 | </para> |
286 | <para> Manual page for <application>geninitrd</application> is | |
287 | based on mkinitrd.8 by Erik Troan <email>ewt@redhat.com</email> | |
288 | and writen by Jacek Konieczny | |
289 | <email>jajcus@pld.org.pl</email>and contributors.</para> | |
5f15bc30 AF |
290 | </refsect1> |
291 | </refentry> | |
cefa3e84 | 292 | <!-- vim61: set fileencoding=utf-8 : --> |