xref: /freebsd/usr.sbin/boot0cfg/boot0cfg.8 (revision 94942af266ac119ede0ca836f9aa5a5ac0582938)
1.\" Copyright (c) 1999 Robert Nordier
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
17.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
18.\" OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
19.\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
20.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
22.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
23.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd February 21, 1999
28.Dt BOOT0CFG 8
29.Os
30.Sh NAME
31.Nm boot0cfg
32.Nd boot manager installation/configuration utility
33.Sh SYNOPSIS
34.Nm
35.Op Fl Bv
36.Op Fl b Ar boot0
37.Op Fl d Ar drive
38.Op Fl f Ar file
39.Op Fl m Ar mask
40.Op Fl o Ar options
41.Op Fl s Ar slice
42.Op Fl t Ar ticks
43.Ar disk
44.Sh DESCRIPTION
45The
46.Fx
47.Sq boot0
48boot manager permits the operator to select from which disk and
49slice an i386 machine (PC) is booted.
50.Pp
51Note that what are referred to here as
52.Dq slices
53are typically called
54.Dq partitions
55in
56.No non- Ns Bx
57documentation relating to the PC.
58Typically, only non-removable disks are sliced.
59.Pp
60The
61.Nm
62utility optionally installs the
63.Sq boot0
64boot manager on the specified
65.Ar disk ;
66and allows various operational parameters to be configured.
67.Pp
68On PCs, a boot manager typically occupies sector 0 of a disk, which is
69known as the Master Boot Record (MBR).
70The MBR contains both code (to which control is passed by the PC BIOS)
71and data (an embedded table of defined slices).
72.Pp
73The options are:
74.Bl -tag -width indent
75.It Fl B
76Install the
77.Sq boot0
78boot manager.
79This option causes MBR code to be replaced, without
80affecting the embedded slice table.
81.It Fl b Ar boot0
82Specify which
83.Sq boot0
84image to use.
85The default is
86.Pa /boot/boot0
87which will use the video card as output, alternatively
88.Pa /boot/boot0sio
89can be used for output to the COM1 port.
90(Be aware that nothing will be output to the COM1 port unless the
91modem signals DSR and CTS are active.)
92Use
93.Pa /boot/mbr
94to revert to non-interactive boot manager.
95.It Fl d Ar drive
96Specify the drive number used by the PC BIOS in referencing the drive
97which contains the specified
98.Ar disk .
99Typically this will be 0x80 for the first hard drive, 0x81 for the
100second hard drive, and so on; however any integer between 0 and 0xff
101is acceptable here.
102.It Fl f Ar file
103Specify that a backup copy of the preexisting MBR should be written to
104.Ar file .
105This file is created if it does not exist, and replaced if it does.
106.It Fl m Ar mask
107Specify slices to be enabled/disabled, where
108.Ar mask
109is an integer between 0 (no slices enabled) and 0xf (all four slices
110enabled).
111.It Fl o Ar options
112A comma-separated string of any of the following options may be
113specified (with
114.Dq no
115prepended as necessary):
116.Bl -tag -width indent
117.It packet
118Use the disk packet (BIOS INT 0x13 extensions) interface,
119as opposed to the legacy (CHS) interface, when doing disk I/O.
120This allows booting above cylinder 1023, but requires specific
121BIOS support.
122The default is
123.Sq packet .
124.It setdrv
125Forces the drive containing the disk to be referenced using drive
126number definable by means of the -d option.
127The default is
128.Sq nosetdrv .
129.It update
130Allow the MBR to be updated by the boot manager.
131(The MBR may be updated to flag slices as
132.Sq active ,
133and to save slice selection information.)
134This is the default; a
135.Sq noupdate
136option causes the MBR to be treated as read-only.
137.El
138.It Fl s Ar slice
139Set the default boot selection to
140.Ar slice .
141Values between 1 and 4 refer to slices; a value of 5 refers to the
142option of booting from a second disk.
143.It Fl t Ar ticks
144Set the timeout value to
145.Ar ticks .
146(There are approximately 18.2 ticks per second.)
147.It Fl v
148Verbose: display information about the slices defined, etc.
149.El
150.Sh FILES
151.Bl -tag -width /boot/boot0sio -compact
152.It Pa /boot/boot0
153The default
154.Sq boot0
155image
156.It Pa /boot/boot0sio
157Image for serial consoles (COM1,9600,8,N,1,MODEM)
158.It Pa /boot/mbr
159Non-interactive boot MBR image
160.El
161.Sh EXIT STATUS
162.Ex -std
163.Sh EXAMPLES
164To boot slice 2 on the next boot:
165.Pp
166.Dl "boot0cfg -s 2 ad0"
167.Pp
168To enable just slices 1 and 2 in the menu:
169.Pp
170.Dl "boot0cfg -m 0x3 ad0"
171.Pp
172To go back to non-interactive booting:
173.Pp
174.Dl "boot0cfg -B -b /boot/mbr ad0"
175.Pp
176.Sh SEE ALSO
177.Xr geom 4 ,
178.Xr boot 8 ,
179.Xr fdisk 8
180.Sh AUTHORS
181.An Robert Nordier Aq rnordier@FreeBSD.org .
182.Sh BUGS
183Protection mechanisms in the
184.Xr geom 4
185subsystem might prevent
186.Nm
187from being able to update the MBR on a mounted disk.
188Instructions for temporarily disabling these protection mechanisms
189can be found in the
190.Xr geom 4
191manpage.
192.Pp
193Use of the
194.Sq packet
195option may cause
196.Sq boot0
197to fail, depending on the nature of BIOS support.
198.Pp
199Use of the
200.Sq setdrv
201option with an incorrect -d operand may cause the MBR to be written
202to the wrong disk.
203Be careful!
204