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