2 Subject: reformatted mkrescue manpage
3 Author: Martin Eberhard Schauer <Martin.E.Schauer@gmx.de>
5 Last-Update: 2011-03-07
7 The formatting did not obey the recommendations of man (7) and
11 diff -urN s12/man/mkrescue.8 s13/man/mkrescue.8
12 --- s12/man/mkrescue.8 2010-11-01 17:13:41.000000000 +0100
13 +++ s13/man/mkrescue.8 2011-03-07 21:25:53.000000000 +0100
15 .\" @(#)mkrescue.8 1.0 20011031 jrc
16 .\" This page is part of the LILO package, which is released by
17 .\" the author(s) under a BSD license. See the file COPYING
18 -.\" in the LILO source directory for the License and Disclaimer.
19 +.\" in the LILO source directory for the license and disclaimer.
21 .\" Original version, John Coffman 2001-10-31
22 .\" Updated to version 2.0 & lilo 22.5.4, John Coffman 2003-05-24
24 .\" Updated to version 3.0 & lilo 22.6.1, John Coffman 2004-11-16
26 -.TH MKRESCUE 8 "16 Nov 2004"
27 +.\" Reformatted to better match Linux man-pages conventions
28 +.\" Martin Eberhard Schauer 2011-03-06
30 +.TH MKRESCUE 8 "6 Mar 2011"
33 -mkrescue \- make rescue floppy
34 +mkrescue \- make rescue floppy or CD
38 -.B "/usr/sbin/mkrescue"
39 -\- make a bootable rescue floppy or CD using the default kernel specified
42 +makes a bootable rescue floppy or CD using the default kernel specified in
48 -takes its specification for the kernel from the default image specified in
49 -\fB/etc/lilo.conf\fP. If the actual default is an \fIother=\fP specification,
50 -then use the first \fIimage=\fP specification.
51 -Any associated initial ramdisk (initrd=), and \fIappend=\fP
52 -options will also be used. The root directory will be taken to be the
53 -\fIcurrent\fP root. A bootable floppy or CD-image will be created using LILO version
54 +\fBmkrescue\fP takes its specifation for the kernel from the default image
55 +specified in \fI/etc/lilo.conf\fP.
56 +If the actual default is an \fIother=\fP specification, then use the first
57 +\fIimage=\fP specification.
58 +Any associated initial ramdisk (\fIinitrd=\fP), and \fIappend=\fP options
60 +The root directory will be taken to be the \fIcurrent\fP root.
61 +A bootable floppy or CD-image will be created using LILO version
64 -normally requires no options, unless a CD-image is desired (\fI--iso\fP).
65 +\fBmkrescue\fP normally requires no options, unless a CD-image is desired
72 -.BI "--append <string>"
73 -Override any \fIappend=\fP options taken from the default image. If there is
74 -any doubt about whether the \fIlilo.conf\fP options are correct, then specify
75 -no kernel parameters with: \fB--append ""\fP, the null string.
78 -Provide verbose output of the operation of "mkrescue", pausing to allow
79 -the setting of internal operating parameters to be viewed. "<CR>" must
80 -be hit to proceed from these pauses.
82 -.BI "--device <device>"
83 -Make the floppy on a device other than /dev/fd0. The floppy disk will
84 -always be made to boot on BIOS device code 0x00 (A: drive), without
85 -regard to the drive on which it is created.
88 -Use a faster method of creating the boot floppy. This involves first
89 -creating a file of "\-\-size" 1k blocks (default is 1440)
90 -mounted using a loopback device, creating the bootable floppy,
91 +\fB--append\fP <string>
92 +Override any \fIappend=\fP options taken from the default image.
93 +If there is any doubt about whether the \fIlilo.conf\fP
94 +options are correct, then specify no kernel parameters by providing the
95 +null string (\fB--append ""\fP).
99 +Provide verbose output of the operation of
101 +pausing to allow the setting of internal operating parameters to be viewed.
102 +<CR> must be hit to proceed from these pauses.
105 +\fB--device\fP <device>
106 +Make the floppy on a device other than \fI/dev/fd0\fP.
107 +The floppy disk will always be made to boot on BIOS device code 0x00 (A:
108 +drive), without regard to the drive on which it is created.
112 +Use a faster method of creating the boot floppy.
113 +This involves first creating a file of \fB--size\fP 1k blocks (default
114 +is 1440) mounted using a loopback device, creating the bootable floppy,
115 then copying the entire file to the disk.
118 -.BI "--fs [ ext2 | msdos | minix ]"
119 +\fB--fs\fP [ \fIext2\fP | \fImsdos\fP | \fIminix\fP ]
120 Specify the type of filesystem to create on the drive.
122 -is the default, but "msdos" and "minix" allow slightly more disk sectors
123 -for really big kernels.
124 +\fIext2\fP is the default, but \fImsdos\fP and \fIminix\fP allow
125 +slightly more disk sectors for really big kernels.
130 Print a short usage synopsis, including a list of command options.
133 -.BI "--image <label>"
134 +\fB--image\fP <label>
135 Specifies the label or alias of the particular image from which the
136 -append, initial ramdisk, root, keytable, and kernel information is to be
138 +append, initial ramdisk, root, keytable, and kernel information is to
142 -.BI "--initrd <filepath>" " and " "--kernel <filepath>"
143 +\fB--initrd\fP \fI<filepath>\fP and \fB--kernel\fP \fI<filepath>\fP
144 These options, which must be used together, allow specification of an
145 arbitrary kernel file and initial ramdisk file to be used on the created
146 -boot floppy. Be sure you know what you are doing before you use these
147 -options. If no initial ramdisk is needed with a particular kernel, then you
148 -MUST specify \fB--initrd ""\fP, meaning a null pathname.
150 +Be sure you know what you are doing before you use these options.
151 +If no inital ramdisk is needed with a particular kernel, then you MUST
152 +specify \fB--initrd ""\fP, meaning a null pathname.
155 -.BI "--install [ text | menu ]"
156 +\fB--install\fP [ \fItext\fP | \fImenu\fP ]
157 Allows overriding the default human interface used with the rescue
158 -bootloader (configuration file "install=" option). "text" is the
159 -default on 1.2MB and 1.44MB floppy disks, and "menu" is the default on
160 -2.88MB floppies and HD emulation on CD-R media.
163 -Create an ISO-9660 bootable CD image (El Torito Format) suitable for burning
164 -to a CD-R or CD-RW. The \fB--device\fP specification defaults to the
165 -filename \fB"rescue.iso"\fP, and the \fB--size\fP defaults to 2880. A utility
166 -such as \fIcdrecord\fP may be used to burn the ISO file to a recordable CD
167 -medium. With this ISO option, the
170 +bootloader (configuration file "install=" option). \fItext\fP is the
171 +default on 1.2MB and 1.44MB floppy disks, and \fImenu\fP is the default
172 +on 2.88MB floppies and HD emulation on CD-R media.
176 +Create an ISO-9660 bootable CD image (El Torito Format) suitable for
177 +burning to a CD-R or CD-RW. The \fB--device\fP specification defaults to
178 +the filename \fIrescue.iso\fP, and the \fB--size\fP defaults to 2880.
179 +A utility such as "wodim" may be used to burn the ISO file to a
180 +recordable CD medium.
181 +With this ISO option, the \fB--size\fP \fIHD\fP option is allowed.
186 For faster kernel loading from a floppy, LILO map compaction is normally
187 -enabled. This option will disable map compaction by omitting the
191 -Suppresses creation of a new filesystem on the boot floppy. This option may
195 +This option will disable map compaction by omitting the lilo \fB-c\fP
200 +Suppresses creation of a new filesystem on the boot floppy.
201 +This option may be used ONLY
202 when you know that the floppy you will be writing upon is formatted with the
203 -same filesystem as specified by "\-\-fs XXX" (default is ext2).
204 +same filesystem as specified by \fB--fs\fP \fIXXX\fP (default is \fIext2\fP).
207 -.BI "--root <device>"
208 -Specify the root filesystem for the kernel on the boot floppy. The currently
209 -mounted root is taken as the default specification.
211 -.BI "--size [ 1440 | 1200 | 2880 | HD ]"
212 -The default floppy disk size is \fI1440\fP, meaning a 1.44MB floppy. When \fI--iso\fP
213 -is specified, the default size is \fI2880\fP. Allowed
214 -specifications are 1200, 1440, or 2880, meaning a 1.2MB, 1.44MB or 2.88MB
215 -floppy, respectively. No other floppy disk sizes are supported.
216 +\fB--root\fP \fI<device>\fP
217 +Specify the root filesystem for the kernel on the boot floppy.
218 +The currently mounted root is taken as the default specification.
221 +\fB--size\fP [ \fI1440\fP | \fI1200\fP | \fI2880\fP | \fIHD\fP ]
222 +The default floppy disk size is \fI1440\fP, meaning a 1.44MB floppy.
223 +When \fB--iso\fP is specified, the default size is \fI2880\fP.
224 +Allowed specifications are \fI1200\fP, \fI1440\fP, or \fI2880\fP, meaning
225 +a 1.2MB, 1.44MB or 2.88MB floppy, respectively.
226 +No other floppy disk sizes are supported.
230 -specification, meaning "hard disk", may only be used with the
232 -option, to indicate a 16MB hard disk is to be generated for emulation. This
233 -allows for very large kernel / initial ramdisk combinations on CD-R. The
234 -hard disk image is created using loopback devices
235 -"/dev/loop0" and "/dev/loop1", which
236 -must be free to utilize this size option.
239 -Print the version number of \fImkrescue\fP, then terminate.
241 +The \fIHD\fP specification, meaning "hard disk", may only be used with
242 +the \fB--iso\fP option, to indicate a 16MB hard disk is to be generated
244 +This allows for very large kernel/initial ramdisk combinations on CD-R.
245 +The hard disk image is created using loopback devices \fI/dev/loop0\fP
246 +and \fI/dev/loop1\fP, which must be free to utilize this size option.
250 +Print the version number of \fBmkrescue\fP, then terminate.
253 -lilo(8), lilo.conf(5), mkfs(8), dd(1), mount(8), mkinitrd(8), mkisofs(8),
256 -John Coffman <johninsd@san.rr.com> (3.0)
268 +.\" John Coffman <johninsd@san.rr.com> (3.0)