summaryrefslogtreecommitdiff
path: root/mkinitramfs.8
diff options
context:
space:
mode:
authorrbalocca <rbalocca@vyatta.com>2008-10-28 14:49:35 -0700
committerrbalocca <rbalocca@vyatta.com>2008-10-28 14:49:35 -0700
commit3939e96a8830755228bd2bbedb50db6808d36f80 (patch)
tree6c55ccb42447ad90946ee6157dab49e573ec92d2 /mkinitramfs.8
downloadinitramfs-tools-3939e96a8830755228bd2bbedb50db6808d36f80.tar.gz
initramfs-tools-3939e96a8830755228bd2bbedb50db6808d36f80.zip
initramfs-tools-0.92j from mirrrors.kernel.orgdebian/0.92j
Diffstat (limited to 'mkinitramfs.8')
-rw-r--r--mkinitramfs.8135
1 files changed, 135 insertions, 0 deletions
diff --git a/mkinitramfs.8 b/mkinitramfs.8
new file mode 100644
index 0000000..abb3f39
--- /dev/null
+++ b/mkinitramfs.8
@@ -0,0 +1,135 @@
+.TH MKINITRAMFS 8 "2008/08/12" "" "mkinitramfs manual"
+
+.SH NAME
+mkinitramfs \- low-level tool for generating an initramfs image
+
+.SH SYNOPSIS
+.B mkinitramfs
+.RB [ \-d
+.IR confdir ]
+.RB [ \-k ]
+.RB \-o
+.IR outfile
+.RB [ \-r
+.IR root ]
+.RB [ \-v ]
+.RI [ version ]
+
+.B mkinitramfs
+.RB [ \-\-supported-host-version=
+.IR hversion ]
+
+.B mkinitramfs
+.RB [ \-\-supported-target-version=
+.IR tversion ]
+
+.SH DESCRIPTION
+The
+.B mkinitramfs
+script generates an initramfs image.
+The initramfs is a gzipped cpio archive. The archive can be used on a
+different box of the same arch with the corresponding Linux kernel.
+.B mkinitramfs
+is meant for advanced usage. On your local box
+.B update-initramfs
+calls
+.B mkinitramfs
+with the relevant parameters.
+.B update-initramfs
+keeps sha1sum of generated initramfs. It takes care to generate backups
+and eventually runs the bootloader.
+
+At boot time, the kernel unpacks that archive into RAM disk, mounts and
+uses it as initial root file system. All finding of the root device
+happens in this early userspace.
+
+.SH OPTIONS
+.TP
+\fB \-d \fI confdir
+Set an alternate configuration directory.
+
+.TP
+\fB \-k
+Keep the temporary directory used to make the image.
+
+.TP
+\fB \-o \fI outfile
+Write the image to
+.IR outfile .
+
+.TP
+\fB \-r \fI root
+Override the
+.B ROOT
+setting in
+.IR initramfs.conf .
+
+.TP
+\fB \-v
+Set the verbose mode output.
+
+.TP
+\fI version
+Set the kernel version of the initramfs image
+(defaults to the running kernel).
+
+.TP
+\fB\-\-supported-host-version=\fIhversion
+This option queries if mkinitramfs can create ramdisks on a running kernel of version
+.IR hversion .
+
+.TP
+\fB\-\-supported-target-version=\fItversion
+This option queries if mkinitramfs can create ramdisks for kernel version
+.IR tversion .
+
+.SH FILES
+.TP
+.I /etc/initramfs-tools/initramfs.conf
+The default configuration file for the script. See
+.BR initramfs.conf (5)
+for a description of the available configuration parameter.
+
+.TP
+.I /etc/initramfs-tools/modules
+Specified modules will be put in the generated image and loaded when the system boots. The format - one per line - is identical to that of
+.I /etc/modules,
+which is described in
+.BR modules (5).
+
+.TP
+.I /etc/initramfs-tools/conf.d
+The conf.d directory allows to hardcode bootargs at initramfs build time
+via config snippets. This allows to set ROOT or RESUME.
+This is especially useful for bootloaders, which do not pass an root bootarg.
+
+.TP
+.I /etc/initramfs-tools/DSDT.aml
+If this file exists, it will be appended to the initramfs in a way that causes
+it to be loaded by ACPI.
+
+.SH EXAMPLES
+
+Create an initramfs for current running kernel:
+
+.PP
+.B mkinitramfs -o ~/tmp/initramfs-$(uname -r)
+
+Create an initramfs for specific kernel and keep builddirs:
+
+.PP
+.B mkinitramfs -k -o ~/tmp/initramfs-2.6.21-686 2.6.21-686
+
+Debug initramfs creation (check out written logfile)
+.PP
+.B sh -x mkinitramfs -o ~/tmp/initramfs-$(uname -r) 2> ~/tmp/log
+
+.SH AUTHOR
+The initramfs-tools are written by Maximilian Attems <maks@debian.org>,
+Jeff Bailey <jbailey@raspberryginger.com> and numerous others.
+
+.SH SEE ALSO
+.BR
+.IR initramfs.conf (5),
+.IR initramfs-tools (8),
+.IR update-initramfs (8).