geninitrd.8

   1 .TH MKINITRD 8 "Thu Nov 14 2000"
   2 .UC 4
   3 .SH NAME
   4 mkinitrd \- creates initial ramdisk images for preloading modules
   5 .SH SYNOPSIS
   6 \fBmkinitrd\fR [-fv] [--with=\fImodule\fR] [--preload=\fImodule\fR]
   7 [--omit-scsi-modules] [--omit-raid-modules]
   8 [--omit-ide-modules] [--version] [--fstab=\fIfstab\fR]
   9 [--fs=rom|ext2|cram] \fIimage\fR \fIkernel-version\fR
  10 .SH DESCRIPTION
  11 \fBmkinitrd\fR creates filesystem images which are suitable for use
  12 as Linux initial ramdisk (initrd) images. Such images are often
  13 used for preloading the block device modules (such as IDE, SCSI or RAID)
  14 which are needed to access the root filesystem. \fBmkinitrd\fR
  15 automatically loads all \fIscsi_hostadapter\fR entries in
  16 \fI/etc/conf.modules\fR when it finds that root fs is mounted on SCSI device,
  17 which makes it simple to build and use kernels using modular SCSI devices.
  18 It will also load IDE and RAID modules when needed.
  19
  20 Any module options specified in \fI/etc/conf.modules\fR are passed
  21 to the modules as they are loaded by the initial ramdisk.
  22
  23 If the root filesystem is modular, initrd will automatically add the
  24 filesystem's modules to the initrd image.
  25
  26 If the root device is on a loop device (such as /dev/loop0), \fBmkinitrd\fR
  27 will attempt to build an initrd which sets up the loopback file properly.
  28 To do this, the fstab must contain a comment of the form:
  29
  30 # LOOP0: /dev/hda1 vfat /linux/rootfs
  31
  32 LOOP0 must be the name of the loop device which needs to be configured, in
  33 all capital lettes. The parameters after the color are the device which
  34 contains the filesystem with the loopback image on it, the filesystem which
  35 is on the device, and the full path to the loopback image.
  36
  37 .SH OPTIONS
  38 .TP
  39 \fB-f\fR
  40 Allows \fBmkinitrd\fR to overwrite an existing image file.
  41
  42 .TP
  43 \fB-\-fstab=\fR\fIfstab\fR
  44 Use \fIfstab\fR to automatically determine what type of filesystem the
  45 root device is on. Normally, \fB/etc/fstab\fR is used.
  46
  47 .TP
  48 \fB-\-ifneeded
  49 Only builds the image if their are modules that need to be loaded at boot
  50 time.
  51
  52 .TP
  53 \fB-\-omit-scsi-modules
  54 Do not load any scsi modules, including 'scsi_mod' and 'sd_mod'
  55 modules, even if they seem to be needed.
  56
  57 .TP
  58 \fB-\-omit-ide-modules
  59 Do not load any ide modules, including 'ide-mod' and 'ide-disk-mod'
  60 modules, even if they seem to be needed.
  61
  62 .TP
  63 \fB-\-omit-raid-modules
  64 Do not load any raid modules, even if /etc/fstab and /etc/raidtab expect them.
  65
  66 .TP
  67 \fB-\-preload=\fR\fImodule\fR
  68 Load the module \fImodule\fR in the initial ramdisk image. The module gets
  69 loaded before any SCSI modules which are specified in \fI/etc/conf.modules\fR.
  70 This option may be used as many times as necessary.
  71
  72 .TP
  73 \fB-v\fR
  74 Prints out verbose information while creating the image (normally
  75 the \fBmkinitrd\fR runs silently).
  76
  77 .TP
  78 \fB-\-version\fR
  79 Prints the version of \fBmkinitrd\fR that's being used and then exits.
  80
  81 .TP
  82 \fB-\-with=\fR\fImodule\fR
  83 Load the modules \fImodule\fR in the initial ramdisk image. The module
  84 gets loaded after any SCSI modules which are specified in
  85 \fI/etc/conf.modules\fR. This option may be used as many times as
  86 necessary.
  87
  88 .TP
  89 \fB-\-fs=\fBext2\fR|\fBrom\fR|\fBcram\fR
  90 Filesystem type to be used for the image. Only selected filesystem
  91 should always be compiled into kernel.
  92
  93 .SH FILES
  94 .PD 0
  95 .TP 20
  96 \fI/etc/sysconfig/mkinitrd\fR
  97 Configuraton file with default options. Putting proper options there
  98 helps automatic creation of initrd eg. on kernel upgrade
  99
 100 .TP 20
 101 \fI/dev/loop*\fR
 102 A block loopback device is used to create the image, which makes this
 103 script useless on systems without block loopback support available.
 104
 105 .TP 20
 106 \fI/etc/conf.modules\fR
 107 Specified SCSI modules to be loaded and module options to be used.
 108 .PD
 109 .SH "SEE ALSO"
 110 .BR fstab (5),
 111 .BR insmod (1),
 112 .BR kerneld (8),
 113 .BR lilo (8)
 114
 115 .SH AUTHOR
 116 .nf
 117 Erik Troan <ewt@redhat.com>
 118 .fi