]> git.lizzy.rs Git - plan9front.git/blob - sys/man/8/9boot
9boot: add wait word
[plan9front.git] / sys / man / 8 / 9boot
1 .TH 9BOOT 8
2 .SH NAME
3 9bootfat, 9bootiso, 9bootpxe \- PC bootloader for FAT, ISO and PXE network booting
4 .SH SYNOPSIS
5 Started by PC BIOS or chainloaded by partition bootsector
6 .SH DESCRIPTION
7 9boot is the bootloader used on PCs to start the Plan 9 kernel.
8 Its task is to read and parse the
9 .IR plan9.ini (8)
10 configuration file, gather some basic system information like
11 the amount of usable system memory, do some basic system
12 initialization and load the kernel from the boot media into memory.
13
14 After reading the configuration, the loader will automatically 
15 attempt to boot the kernel that was specified by the
16 .B bootfile=
17 parameter. If there is no such parameter, a key
18 gets pressed on the keyboard or the kernel file was not
19 found then the loader enters the interactive
20 boot console.
21
22 The syntax of the boot console is the same as in
23 the
24 .IR plan9.ini (8)
25 file.
26 .BR
27 The word
28 .B clear
29 [
30 .I prefix
31 ]
32 can be used to remove parameters from the current configuration.
33 If a
34 .IR prefix
35 is specified, the first parameter that matches the prefix
36 is removed. If the
37 .IR prefix
38 argument is omitted, the whole configuration will be reset.
39 If the word
40 .B wait
41 appears in the configuration then
42 .IR 9boot
43 will return to the console prompt after processing the file.
44
45 The word
46 .B boot
47 will end the console and resume booting the kernel.
48
49 There are many ways to boot a PC so
50 .IR 9boot
51 was split into a number of distinct programs one for each boot
52 method.
53 .SH FAT BOOTING
54 When booting Plan 9 from a harddisk or USB pen drive, a
55 FAT16/32 partition
56 .IR (9fat) 
57 is used to store the kernel and 
58 .IR plan9.ini (8)
59 configuration. Due to size limitations, instead of loading
60 the kernel directly, the bootsector
61 .IR (pbs)
62 of the FAT partition loads
63 a 2nd stage bootloader 
64 .IR (9bootfat)
65 from the root directory of the filesystem.
66 .SH CD-ROM BOOTING
67 Booting from CD-ROM requires only the 
68 .IR 9bootiso
69 bootloader to be included in the ISO-9660 image under
70 .B 386/9bootiso,
71 set as a non-emulation bootblock (see
72 .IR mk9660 (8)).
73 Boot parameters are read from
74 .B cfg/plan9.ini.
75 .SH NETWORK BOOTING
76 With a PXE capable BIOS and network card one can download
77 .IR 9bootpxe
78 and boot the kernel from a TFTP server (see
79 .IR dhcpd (8)
80 and
81 .IR ndb (6)
82 for details). Once started,
83 .IR 9bootpxe
84 will read the file
85 .B /cfg/pxe/$ether
86 from the tftp server, where
87 .B $ether
88 is the MAC address of the client's network card
89 in lower case hex, and use this as its
90 .IR plan9.ini (8)
91 file.
92 .SH FILES
93 .B /386/pbs
94 .br
95 .B /386/9bootfat
96 .br
97 .B /386/9bootiso
98 .br
99 .B /386/9bootpxe
100 .SH SOURCE
101 .BR /sys/src/boot/pc
102 .SH "SEE ALSO"
103 .IR plan9.ini (8)