]> git.lizzy.rs Git - plan9front.git/blob - sys/man/8/9boot
merge
[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 the
23 .IR plan9.ini (8)
24 file with
25 .IB key = value
26 pairs setting boot parameters. In addition a few command
27 words are recognized that are intended for interactive use:
28 .TP
29 .BI clear [prefix]
30 can be used to remove parameters from the configuration.
31 If a
32 .IR prefix
33 is specified, the first parameter that matches the prefix
34 is removed. If the
35 .IR prefix
36 argument is omitted, the whole configuration will be reset.
37 .TP
38 .B show
39 displays the current configuration in memory.
40 .TP
41 .B wait
42 will return to the console prompt after processing the
43 configuration file preventing automatic boot.
44 .TP
45 .B boot
46 will end the console and attempt booting the kernel.
47 .SS
48 There are many ways to boot a PC so
49 .IR 9boot
50 was split into a number of distinct programs one for each boot
51 method.
52 .SH FAT BOOTING
53 When booting Plan 9 from a harddisk or USB pen drive, a
54 FAT16/32 partition
55 .IR (9fat) 
56 is used to store the kernel and 
57 .IR plan9.ini (8)
58 configuration. Due to size limitations, instead of loading
59 the kernel directly, the bootsector
60 .IR (pbs)
61 of the FAT partition loads
62 a 2nd stage bootloader 
63 .IR (9bootfat)
64 from the root directory of the filesystem.
65 .SH CD-ROM BOOTING
66 Booting from CD-ROM requires only the 
67 .IR 9bootiso
68 bootloader to be included in the ISO-9660 image under
69 .B 386/9bootiso,
70 set as a non-emulation bootblock (see
71 .IR mk9660 (8)).
72 Boot parameters are read from
73 .B cfg/plan9.ini.
74 .SH NETWORK BOOTING
75 With a PXE capable BIOS and network card one can download
76 .IR 9bootpxe
77 and boot the kernel from a TFTP server (see
78 .IR dhcpd (8)
79 and
80 .IR ndb (6)
81 for details). Once started,
82 .IR 9bootpxe
83 will read the file
84 .B /cfg/pxe/$ether
85 or, if this file is not present,
86 .B /cfg/pxe/default
87 from the tftp server, where
88 .B $ether
89 is the MAC address of the client's network card
90 in lower case hex, and uses this as its
91 .IR plan9.ini (8)
92 file.
93 .SH FILES
94 .B /386/pbs
95 .br
96 .B /386/9bootfat
97 .br
98 .B /386/9bootiso
99 .br
100 .B /386/9bootpxe
101 .SH SOURCE
102 .BR /sys/src/boot/pc
103 .SH "SEE ALSO"
104 .IR plan9.ini (8)