The patch from Scott Moser moves the "search-for-prom_claim'able" routine that
[yaboot.git] / doc / README.ofboot
1 This is a new OpenFirmware CHRP script designed to be automatically
2 configured by ybin.  It is more robust then previous CHRP scripts, it
3 includes the following capabilities:
4
5 * Multibooting GNU/Linux, MacOS 8.* or 9.* MacOSX, Darwin, direct from
6 * CDROM, Network and into an OpenFirmware prompt.
7
8 * Presenting a real menu of OS choices.
9
10 * Automatic configuration by ybin.  This script should NOT be edited
11   by the user.  It should also not be used without ybin, its not
12   directly useable by OpenFirmware.
13
14 * Configurable colors.  (see the yaboot.conf(5) man page).
15
16 The multiboot menu is only presented when an extra OS is defined in
17 /etc/yaboot.conf, otherwise this script loads yaboot without any user
18 interaction.
19
20 To enable a multi boot menu add bsd=ofpath and/or macos=ofpath and/or
21 macosx=ofpath, and/or darwin=ofpath where ofpath is the OpenFirmware
22 device path to the MacOS or MacOSX boot partition.  Example:
23 macos=hd:10 you can also specify a unix device node, ie: /dev/hda5,
24 and ybin will translate it automatically using ofpath.
25
26 This script when presenting a dual boot menu will wait for a defined
27 number of seconds before automatically booting the default OS.  Both
28 this delay and the default OS can be configured in /etc/yaboot.conf.
29
30 The delay is configured by adding delay=seconds.  Unlike timeout this
31 is in seconds rather then 10ths of seconds.  This option has no effect
32 on the yaboot boot: prompt timeout.  If delay= is not set, ybin will
33 translate the value of timeout= to seconds and use that.
34
35 The default OS is configured by adding defaultos=macos.  There is only
36 four values that are acceptable: linux, bsd, macos, macosx and darwin.  The
37 default is linux.  This should not be confused with yaboot's
38 `default=' variable.
39
40 The name and letter used to load MacOS or MacOSX (M and X
41 respectively) cannot be be configured.  (others are D for Darwin, C
42 for CDROM, N for network, and O for OpenFirmware)
43
44 The Forth code in this script was written by Chris Emerson and iNOUE Koich!.
45
46 This script has only been formally tested on a Rev 1 Blue G3, a G4,
47 and an ibook, please report any incompatibilities.