From c342a49b0fcc789194a713a173cf7aa899ae90f0 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Sat, 12 Jan 2008 08:55:00 +0000 Subject: [PATCH] Use quotes more consistently in formatting macros. --- man4/initrd.4 | 129 +++++++++++++++++++++++++++++++++----------------- 1 file changed, 86 insertions(+), 43 deletions(-) diff --git a/man4/initrd.4 b/man4/initrd.4 index 5c394261e..3d591ff96 100644 --- a/man4/initrd.4 +++ b/man4/initrd.4 @@ -56,11 +56,13 @@ already created, it can be created with the following commands: .PP Also, support for both "RAM disk" and "Initial RAM disk" (e.g. -.BR CONFIG_BLK_DEV_RAM=y " and " CONFIG_BLK_DEV_INITRD=y ) +.BR CONFIG_BLK_DEV_RAM=y +and +.BR CONFIG_BLK_DEV_INITRD=y ) must be compiled directly into the Linux kernel to use -.IR /dev/initrd "." +.IR /dev/initrd . When using -.IR /dev/initrd ", " +.IR /dev/initrd , the RAM disk driver cannot be loaded as a module. .\" .\" @@ -103,10 +105,12 @@ different device. .\" .SS "Boot-up Operation" When booting up with -.BR initrd ", the system boots as follows:" +.BR initrd , +the system boots as follows: .IP 1. 3 The boot loader loads the kernel program and -.IR /dev/initrd "'s contents into memory." +.IR /dev/initrd 's +contents into memory. .IP 2. On kernel startup, the kernel uncompresses and copies the contents of the device @@ -114,7 +118,7 @@ the kernel uncompresses and copies the contents of the device onto device .I /dev/ram0 and then frees the memory used by -.IR /dev/initrd "." +.IR /dev/initrd . .IP 3. The kernel then read-write mounts device .I /dev/ram0 @@ -126,7 +130,9 @@ If the indicated normal root file system is also the initial root file-system ) then the kernel skips to the last step for the usual boot sequence. .IP 5. If the executable file -.IR /linuxrc " is present in the initial root file-system, " /linuxrc +.IR /linuxrc +is present in the initial root file-system, +.I /linuxrc is executed with UID 0. (The file .I /linuxrc @@ -144,27 +150,38 @@ terminates, the normal root file system is mounted. .I /linuxrc exits with any file-systems mounted on the initial root file-system, then the behavior of the kernel is -.BR UNSPECIFIED "." +.BR UNSPECIFIED . See the NOTES section for the current kernel behavior.) .IP 7. If the normal root file has directory -.IR /initrd ", device" +.IR /initrd , +device .I /dev/ram0 is moved from -.IR / " to " /initrd "." +.IR / +to +.IR /initrd . Otherwise if directory -.IR /initrd " does not exist device " /dev/ram0 " is unmounted." +.IR /initrd +does not exist device +.I /dev/ram0 +is unmounted. (When moved from -.IR / " to " /initrd ", " /dev/ram0 +.IR / +to +.IR /initrd , +.I /dev/ram0 is not unmounted and therefore processes can remain running from -.IR /dev/ram0 "." +.IR /dev/ram0 . If directory .I /initrd does not exist on the normal root file-system and any processes remain running from -.IR /dev/ram0 " when " /linuxrc +.IR /dev/ram0 +when +.I /linuxrc exits, the behavior of the kernel is -.BR UNSPECIFIED "." +.BR UNSPECIFIED . See the NOTES section for the current kernel behavior.) .IP 8. The usual boot sequence (e.g. invocation of @@ -175,11 +192,12 @@ is performed on the normal root file system. .\" .SS Options The following boot loader options when used with -.BR initrd ", affect the kernel's boot-up operation:" +.BR initrd , +affect the kernel's boot-up operation: .TP .BI initrd= "filename" Specifies the file to load as the contents of -.IR /dev/initrd "." +.IR /dev/initrd . For .B LOADLIN this is a command line option. @@ -209,11 +227,16 @@ is read-only and can be read only one time after system startup. .TP .BI root= "device-name" Specifies the device to be used as the normal root file system. -.RB "For " LOADLIN +For +.B LOADLIN this is a command line option. -.RB "For " LILO " this is a boot time option or +For +.B LILO +this is a boot time option or can be used as an option line in the -.BR LILO " configuration file " /etc/lilo.config "." +.B LILO +configuration file +.IR /etc/lilo.config . The device specified by the this option must be a mountable device having a suitable root file-system. .\" @@ -228,12 +251,17 @@ or compiled into the kernel file), or the boot loader option setting is used for the normal root file systems. For a NFS-mounted normal root file system, one has to use the -.BR nfs_root_name " and " nfs_root_addrs +.B nfs_root_name +and +.B nfs_root_addrs boot options to give the NFS settings. For more information on NFS-mounted root see the kernel documentation file -.BR nfsroot.txt "." +.BR nfsroot.txt . For more information on setting the root file system also see the -.BR LILO " and " LOADLIN " documentation." +.BR LILO +and +LOADLIN +documentation. .PP It is also possible for the .I /linuxrc @@ -241,24 +269,28 @@ executable to change the normal root device. For .I /linuxrc to change the normal root device, -.IR /proc " must be mounted." +.IR /proc +must be mounted. After mounting -.IR /proc ", " /linuxrc +.IR /proc , +.I /linuxrc changes the normal root device by writing into the proc files -.IR /proc/sys/kernel/real-root-dev ", " -.IR /proc/sys/kernel/nfs-root-name ", and " -.IR /proc/sys/kernel/nfs-root-addrs "." +.IR /proc/sys/kernel/real-root-dev , +.IR /proc/sys/kernel/nfs-root-name , +and +.IR /proc/sys/kernel/nfs-root-addrs . For a physical root device, the root device is changed by having .I /linuxrc write the new root file system device number into -.IR /proc/sys/kernel/real-root-dev "." +.IR /proc/sys/kernel/real-root-dev . For a NFS root file system, the root device is changed by having .I /linuxrc write the NFS setting into files -.IR /proc/sys/kernel/nfs-root-name " and " +.IR /proc/sys/kernel/nfs-root-name +and .I /proc/sys/kernel/nfs-root-addrs and then writing 0xff (e.g. the pseudo-NFS-device number) into file -.IR /proc/sys/kernel/real-root-dev "." +.IR /proc/sys/kernel/real-root-dev . For example, the following shell command line would change the normal root device to .IR /dev/hdb1 : @@ -304,8 +336,11 @@ A possible system installation scenario is as follows: .IP 1. 3 The loader program boots from floppy or other media with a minimal kernel (e.g. support for -.IR /dev/ram ", " /dev/initrd ", and the ext2 file-system) and loads " -.IR /dev/initrd " with a gzipped version of the initial file-system. +.IR /dev/ram , +.IR /dev/initrd , +and the ext2 file-system) and loads +.IR /dev/initrd +with a gzipped version of the initial file-system. .IP 2. The executable .I /linuxrc @@ -327,13 +362,15 @@ creates and populates the root file system. completed system yet.) .IP 5. The executable -.IR /linuxrc " sets " /proc/sys/kernel/real-root-dev, +.IR /linuxrc +sets +.IR /proc/sys/kernel/real-root-dev , unmount -.IR /proc ", " +.IR /proc , the normal root file system and any other file systems it has mounted, and then terminates. -.PP -6. The kernel then mounts the normal root file system. +.IP 6. +The kernel then mounts the normal root file system. .IP 7. Now that the file system is accessible and intact, the boot loader can be installed. @@ -387,21 +424,27 @@ from CD-ROM without the need of any floppies. The distribution could also use a .B LILO boot floppy and then bootstrap a bigger ram disk via -.IR /dev/initrd " from the CD-ROM." +.IR /dev/initrd +from the CD-ROM. .\" .\" .\" .SH NOTES .IP 1. 3 With the current kernel, any file systems that remain mounted when -.IR /dev/ram0 " is moved from " / " to " /initrd +.I /dev/ram0 +is moved from +.I / +to +.I /initrd continue to be accessible. However, the .I /proc/mounts entries are not updated. .IP 2. With the current kernel, if directory -.IR /initrd " does not exist, then " +.I /initrd +does not exist, then .I /dev/ram0 will .B not @@ -409,10 +452,10 @@ be fully unmounted if .I /dev/ram0 is used by any process or has any file-system mounted on it. If -.IR /dev/ram0 " is +.IR /dev/ram0 +is .B not -fully unmounted, " -then +fully unmounted, then .I /dev/ram0 will remain in memory. .IP 3.