1 README
2 ======
3
4 Description
5 -----------
6
7 Mkinitramfs is a shell script that will generate a cpio init ram filesystem.
8
9 The script itself simply checks for minimum required kernel capabilities,
10 recursively copies in useful applications and their library dependencies
11 (using ldd), and uses cpio to generate an init ram filesystem.
12
13 Note that this also includes an init script used for booting from the initrd
14 image, into the actual system. It includes support for dm-crypt encrypted root
15 volumes, as well as providing simple debugging capabilities.
16
17
18 Usage
19 -----
20
21 The script, mkinitramfs, creates a new init ram filesystem.
22
23 To use it, simply execute it, with the version of the kernel specified, and it
24 will create the initrd file, written to /boot/initrd-${version}. A
25 corresponding /boot/vmlinuz-${version} and /boot/System.map-${version} is
26 required. This version format is recognized by grub, so grub-mkconfig will
27 detect these files.
28
29 NOTE: This will overwrite the /boot/initrd-${version} file if it exists. If
30 you have something there that you want to keep, be sure to back it up before
31 running mkinitramfs.
32
33
34 Init Arguments
35 --------------
36
37 root
38 ~~~~
39 *values*:
40 - root=/dev/sda3
41 - root=UUID=92b74fd7-6e4f-4a52-ad40-fac874410ca3
42 - root=LABEL=system
43
44 Path to the root device. Supports a dev path, LABEL, and UUID values.
45
46
47 initdebug
48 ~~~~~~~~~
49 *values*: NA
50
51 Enables step-by-step boot mode. Each step requires the user to hit the return
52 key. Note that enabling this will probably make the boot process go very
53 slowly as it requires a user response for every step.
54
55
56 interractive
57 ~~~~~~~~~~~~
58
59 Drops the user into an interractive shell, but before performing the first
60 mount operation, which is where most problems start to occur. This can be
61 useful for implementing new features in the init script, debugging problems,
62 checking the environment, etc.
63
64
65 // vim: set syntax=asciidoc:
|
