Commit yaboot 1.3.6-pre1
[yaboot.git] / man / yaboot.8
1 .\" Hey Emacs! This file is -*- nroff -*- source.
2 .\"
3 .TH YABOOT 8 "21 November 2001" "GNU/Linux PowerPC" "System Manager's Manual"
4 .SH NAME
5 .B yaboot
6 \- PowerMac OpenFirmware boot loader
7 .SH SYNOPSIS
8 .B Yaboot
9 is an OpenFirmware ELF executable that bootstraps the Linux kernel.
10 .SH DESCRIPTION
11 This manual page explains the \fByaboot\fR OpenFirmware boot loader. 
12
13 .B yaboot
14 is \fInot\fR a Linux or MacOS executable file.  Attempting to execute
15 \fByaboot\fR from a Linux shell will only result in a Segmentation
16 Fault. \fByaboot\fR is meant to be executed only by OpenFirmware.
17
18 .B yaboot
19 is executed from OpenFirmare in the following manner:
20 .I boot hd:2,yaboot
21 where \fIhd:\fR is the OpenFirmware path for the hard disk, and the
22 \fI2\fR is the partition number \fByaboot\fR is located on.  In this
23 example, the hard disk path is actually an OpenFirmware alias which is
24 present on all NewWorld powermacs.  It usually points to the internal
25 ATA hard disk.  If you have a SCSI disk, then you might execute
26 \fByaboot\fR with this command:
27 .I boot /pci@80000000/pci-bridge@d/ADPT,2930CU@2/@1:2,yaboot
28 This path will vary depending on what kind of SCSI host adapter you
29 have. For a more detailed explanation of OpenFirmware's [disgusting]
30 paths, see man \fBbootstrap\fR(8).  On IBM hardware \fByaboot\fR is
31 directly copied to the \fBbootstrap\fR(8) partition raw, without any
32 filesystem.  OpenFirmare will boot from a type 0x41 PReP Boot parition
33 marked bootable, this must contain \fByaboot\fR.  On IBM hardware the
34 config file is read directly from the root filesystem.  On PowerMac
35 hardware it must be present on the \fBbootstrap\fR(8) partition but
36 .BR ybin (8)
37 will take care of that.
38
39 Fortunately you do not normally have to execute \fByaboot\fR manually.
40 If you have partitioned your disk with a \fBbootstrap\fR(8) partition
41 and used \fBybin\fR(8) to install \fByaboot\fR then you will not have
42 to execute \fByaboot\fR yourself.  (If this does not work you can also
43 set the \fIboot-device\fR variable in OpenFirmware to have it boot
44 automatically, see man \fBbootstrap\fR(8).)
45
46 Once \fByaboot\fR has been executed by OpenFirmware it will display a
47 \fIboot:\fR prompt where you may enter a label for a kernel image
48 defined in \fByaboot.conf\fR(5).  If there is no kernel image defined
49 in \fByaboot.conf\fR(5) you can still boot an arbitrary image by
50 specifying its absolute OpenFirmware path, similar to the above
51 commands for executing \fByaboot\fR itself.  Simply omit the \fIboot\fR
52 command and enter only the pathname.  (See EXAMPLES below)
53
54 When booting an image (either as a predefined label or absolute path)
55 any arguments are passed to the image.  For example:
56 .I boot: linux root=/dev/hda3
57 which would pass the argument \fIroot=/dev/hda3\fR to the kernel.
58
59 .B yaboot
60 should preferably be installed on a dedicated \fBbootstrap\fR(8)
61 partition (type Apple_Bootstrap for PowerMacs, type 0x41 PReP Boot for
62 IBM hardware).  This allows the partition to be modified in such a way
63 that OpenFirmare will load \fByaboot\fR or a boot menu automatically
64 with a default OF configuration. If \fByaboot\fR cannot be installed
65 on a \fBbootstrap\fR(8) partition it can be installed on the root of a
66 MacOS boot partition instead.  \fByaboot\fR however should not be
67 installed in a subdirectory of the MacOS filesystem as this is less
68 reliable and more difficult to execute from OpenFirmware.  See the
69 \fBybin\fR(8) man page for more details on installing \fByaboot\fR
70 (\fBybin\fR(8) is a utility for installing \fByaboot\fR with minimal
71 difficulty).
72
73 The \fByaboot.conf\fR(5) file must be next to the yaboot executable on
74 the \fBbootstrap\fR(8) partition.  \fBybin\fR(8) will take care of this.
75
76 OpenFirmware may be accessed by holding down the \fIcommand, option,
77 o, f\fR keys immediately upon power-up.
78
79 OpenFirmware's settings may be reset to default values by holding down
80 the \fIcommand, option, p, r\fR keys while cold booting.
81
82 If you have G4 hardware then your OpenFirmware may already have a
83 graphical boot selector built in.  This selector can be accessed by
84 holding down the option key when booting the machine.  You should see
85 a screen with buttons for each bootable partition.  The current
86 version (included with \fBybin\fR(8) 0.13) of ofboot includes a
87 badge icon, the button with a penguin icon is your \fBbootstrap\fR(8)
88 partition.  Thanks to Nicholas Humfrey for creating the Badge icon.
89
90 The \fBbootstrap\fR(8) need not and
91 .B should not
92 be mounted anywhere on your filesystem, especially not on top of /boot.  \fBYaboot\fR is able
93 to load the kernels from the ext2fs root partition so that is where
94 they should be kept.
95 .SH EXAMPLES
96 boot \fByaboot\fR from internal ATA disk, partition 2:
97
98 .I boot hd:2,yaboot 
99
100 boot \fByaboot\fR from partition 2 of a disk with SCSI ID 2 attached to a
101 Adaptec 2930 SCSI Host adapter (this is on a rev1 blue G3, it may vary
102 on other models): 
103
104 .I boot /pci@80000000/pci-bridge@d/ADPT,2930CU@2/@2:2,yaboot
105
106 boot a kernel image located on partition number 3 of internal ATA
107 disk (from \fByaboot's\fR \fIboot:\fR prompt):
108
109 .I hd:3,/boot/vmlinux
110
111 boot a kernel image located on partition 3 of SCSI disk ID 2 on a
112 Adaptec 2930 Host adapter (from \fByaboot's\fR \fIboot:\fR prompt):
113
114 .I /pci@80000000/pci-bridge@d/ADPT,2930CU@2/@2:3,/vmlinux
115 .SH FILES
116 .nf
117 /etc/yaboot.conf \- boot loader configuration file
118 .fi
119 .SH BUGS
120 OpenFirmware
121 .SH AUTHORS
122 This man page was written by Ethan Benson <erbenson@alaska.net>.
123 .P
124 .B yaboot
125 was written by Benjamin Herrenschmidt <benh@kernel.crashing.org>.
126 .SH REPORTING BUGS
127 Bugs in \fByaboot\fR should be reported to Ethan Benson <erbenson@alaska.net>
128 .SH SEE ALSO
129 .BR bootstrap (8),
130 .BR yaboot.conf (5),
131 .BR ybin (8).