8e36327ec730dd041bbfef352115ae7e7c9110bc
[rrq/maintain_lilo.git] / man / mkrescue.8
1 '\" t
2 .\" @(#)mkrescue.8 1.0 20011031 jrc
3 .\" This page is part of the LILO package, which is released by
4 .\" the author(s) under a BSD license.  See the file COPYING
5 .\" in the LILO source directory for the License and Disclaimer.
6 .\"
7 .\" Original version, John Coffman 2001-10-31
8 .\" Updated to version 2.0 & lilo 22.5.4, John Coffman 2003-05-24
9 .\"
10 .\" Updated to version 3.0 & lilo 22.6.1, John Coffman 2004-11-16
11 .\"
12 .TH MKRESCUE 8 "16 Nov 2004"
13 .SH NAME
14 mkrescue \- make rescue floppy
15 .SH SYNOPSIS
16 .LP
17 .B "/usr/sbin/mkrescue"
18 \- make a bootable rescue floppy or CD using the default kernel specified
19 in \fIlilo.conf\fP.
20 .SH DESCRIPTION
21 .LP
22 .B mkrescue
23 takes its specification for the kernel from the default image specified in
24 \fB/etc/lilo.conf\fP.  If the actual default is an \fIother=\fP specification,
25 then use the first \fIimage=\fP specification.
26 Any associated initial ramdisk (initrd=), and \fIappend=\fP
27 options will also be used.  The root directory will be taken to be the
28 \fIcurrent\fP root.  A bootable floppy or CD-image will be created using LILO version
29 22.5.5 or later.
30 .B mkrescue
31 normally requires no options, unless a CD-image is desired (\fI--iso\fP).
32 .SH OPTIONS
33 .LP
34 .TP
35 .BI "--append <string>"
36 Override any \fIappend=\fP options taken from the default image.  If there is
37 any doubt about whether the \fIlilo.conf\fP options are correct, then specify
38 no kernel parameters with:  \fB--append ""\fP, the null string.
39 .TP
40 .BI "--debug"
41 Provide verbose output of the operation of "mkrescue", pausing to allow
42 the setting of internal operating parameters to be viewed.  "<CR>" must
43 be hit to proceed from these pauses.
44 .TP
45 .BI "--device <device>"
46 Make the floppy on a device other than /dev/fd0.  The floppy disk will
47 always be made to boot on BIOS device code 0x00 (A: drive), without
48 regard to the drive on which it is created.
49 .TP
50 .BI "--fast"
51 Use a faster method of creating the boot floppy.  This involves first
52 creating a file of "\-\-size" 1k blocks (default is 1440)
53 mounted using a loopback device, creating the bootable floppy,
54 then copying the entire file to the disk.
55 .TP
56 .BI "--fs [ ext2 | msdos | minix ]"
57 Specify the type of filesystem to create on the drive.
58 .B ext2
59 is the default, but "msdos" and "minix" allow slightly more disk sectors
60 for really big kernels.
61 .TP
62 .BI "--help"
63 Print a short usage synopsis, including a list of command options.
64 .TP
65 .BI "--image <label>"
66 Specifies the label or alias of the particular image from which the
67 append, initial ramdisk, root, keytable, and kernel information is to be 
68 taken.
69 .TP
70 .BI "--initrd <filepath>" "  and  " "--kernel <filepath>"
71 These options, which must be used together, allow specification of an
72 arbitrary kernel file and initial ramdisk file to be used on the created
73 boot floppy.  Be sure you know what you are doing before you use these
74 options.  If no initial ramdisk is needed with a particular kernel, then you
75 MUST specify \fB--initrd ""\fP, meaning a null pathname.
76 .TP
77 .BI "--install [ text | menu ]"
78 Allows overriding the default human interface used with the rescue
79 bootloader (configuration file "install=" option). "text" is the
80 default on 1.2MB and 1.44MB floppy disks, and "menu" is the default on
81 2.88MB floppies and HD emulation on CD-R media.
82 .TP
83 .BI "--iso"
84 Create an ISO-9660 bootable CD image (El Torito Format) suitable for burning
85 to a CD-R or CD-RW.  The \fB--device\fP specification defaults to the
86 filename \fB"rescue.iso"\fP, and the \fB--size\fP defaults to 2880.  A utility
87 such as \fIcdrecord\fP may be used to burn the ISO file to a recordable CD
88 medium.  With this ISO option, the
89 .B "--size HD"
90 option is allowed.
91 .TP
92 .BI "--nocompact"
93 For faster kernel loading from a floppy, LILO map compaction is normally
94 enabled. This option will disable map compaction by omitting the
95 lilo "\-c" switch.
96 .TP
97 .BI "--noformat"
98 Suppresses creation of a new filesystem on the boot floppy. This option may
99 be used
100 .B only
101 when you know that the floppy you will be writing upon is formatted with the
102 same filesystem as specified by "\-\-fs XXX" (default is ext2).
103 .TP
104 .BI "--root <device>"
105 Specify the root filesystem for the kernel on the boot floppy. The currently
106 mounted root is taken as the default specification.
107 .TP
108 .BI "--size [ 1440 | 1200 | 2880 | HD ]"
109 The default floppy disk size is \fI1440\fP, meaning a 1.44MB floppy. When \fI--iso\fP 
110 is specified, the default size is \fI2880\fP.  Allowed
111 specifications are 1200, 1440, or 2880, meaning a 1.2MB, 1.44MB or 2.88MB
112 floppy, respectively.  No other floppy disk sizes are supported.
113 .sp
114 The
115 .I HD
116 specification, meaning "hard disk", may only be used with the
117 .B "--iso"
118 option, to indicate a 16MB hard disk is to be generated for emulation.  This
119 allows for very large kernel / initial ramdisk combinations on CD-R.  The
120 hard disk image is created using loopback devices
121 "/dev/loop0" and "/dev/loop1", which
122 must be free to utilize this size option.
123 .TP
124 .BI "--version"
125 Print the version number of \fImkrescue\fP, then terminate.
126 .TE
127 .SH "SEE ALSO"
128 lilo(8), lilo.conf(5), mkfs(8), dd(1), mount(8), mkinitrd(8), mkisofs(8),
129 cdrecord(1).
130 .SH "AUTHOR"
131 John Coffman <johninsd@san.rr.com> (3.0)