Commit yaboot 1.3.5-pre3
[yaboot.git] / man / yaboot.conf.5
1 .\" Copyright (c) 2001 Ethan Benson <erbenson@alaska.net>
2 .\" Portions of this manual page from silo.conf documentation
3 .\" Copyright (c) 1999 Jakub Jelinek <jakub@redhat.com>
4 .\" Portions of this manual page from lilo.conf documentation
5 .\" Copyright (c) 1992-1998 Werner Almesberger
6 .\" This program is distributed according to the Gnu General Public License.
7 .\" See the file COPYING in the ybin source distribution.
8 .\"
9 .TH YABOOT.CONF 5 "25 October 2001" "GNU/Linux PowerPC" "File Formats"
10 .SH NAME
11 .B yaboot.conf
12 \- Configuration file format used by
13 .BR yaboot (8)
14 and
15 .BR ybin (8).
16 .SH SYNOPSIS
17 .BI "/etc/yaboot.conf"
18 .SH DESCRIPTION
19 The \fByaboot.conf\fP file is a configuration file for \fByaboot\fP
20 which is read during booting, and for \fBybin\fR(8) to generate a boot
21 menu and to properly install \fByaboot\fP onto the \fBbootstrap\fP(8)
22 partition. 
23
24 \fByaboot.conf\fP provides instructions for \fByaboot\fP. This
25 includes which kernels to load and what options to pass to them.
26 \fByaboot\fP reads and parses its configuration file found on the
27 \fBbootstrap\fR(8) partition on PowerMacs, and directly from the root
28 filesystem on IBM PowerPC hardware.  On PowerMacs you must run the
29 \fBybin\fR(8) command each time you modify \fB/etc/yaboot.conf\fR.
30
31 \fByaboot\fP is able to boot kernels even without this configuration file or
32 if this file is crippled or contains syntax errors, but the user has to
33 enter full OpenFirmware names and full path of the images to load and all options
34 required for them manually.
35 .SH "FILE FORMAT"
36 The file consists of comments and variable assignments.
37 .TP
38 Comments
39 Start with a \fI#\fP character, and continue to
40 the end of the line.
41 .TP
42 Flag variables
43 Consist of a single keyword and are followed by whitespace
44 or the end of the file.
45 .TP
46 String variables
47 Consist of the variable name, optional whitespace, a
48 \fI=\fP character, optional whitespace, the value and required
49 newline.  IMPORTANT: \fBybin\fR(8) specific options do not support
50 embedded spaces.  It is important that there be no trailing whitespace
51 at the end of a line.
52 .TP
53 File names
54 Some string variables are expecting file names. A file name format in \fByaboot\fP
55 is:
56
57   [<devicename>][<part>]<absolute_pathname>
58
59   or
60
61   [<devicename>][<part>][\fB[\fP<m>\fB-\fP<n>\fB]\fP]
62
63 The first form refers to a file or directory on some supported filesystem
64 (currently \fIext2\fP, \fIhfs\fP, \fIhfs+\fP or \fIiso9660\fP), the latter
65 refers to a range of 512B blocks on a device. For a device block range,
66 either <devicename>, or <part>, or [<m>-<n>] must be given. 
67
68 Optional <devicename> is the OpenFirmware name of the device the file or range
69 is located on. See below for its syntax. For OpenFirmware the device
70 name must be immediately followed by the \fI:\fP character. The default is
71 the boot device yaboot was booted from, or the value of \fIdevice=\fR
72 in \fB/etc/yaboot.conf\fR.
73
74 Optional <part> is the 1 based partition number on the device. First
75 partition is 1 (e.g. on \fI/dev/sda\fP in Linux is this \fI/dev/sda1\fP).
76 The default is the default partition (the value of the \fIpartition\fP
77 variable in the config file).  Note that on Apple partition tables the
78 first partition is always the partition table itself (/dev/sda1 is the
79 partition table).
80
81 <absolute_pathname> must start with a \fI/\fP character and is the
82 pathname from the root of the filesystem on that device (unless it is the
83 root filesystem this is different to the pathname you will see in GNU/Linux).
84
85 <m> is the first block number (in blocksize 512 bytes) of the range to
86 be loaded and <n> is the last block number plus one.
87 .TP
88 Device name syntax is:
89
90   <fully_qualified_prom_device_name>[\fB:\fP<part_number>]
91
92 where the fully qualified OpenFirmware device name starts with a
93 \fI/\fP character for the root of the OpenFirmware device tree and
94 contains all the nodes from the root in the tree up to the disk device
95 node. If some node contains more than one child node with the same
96 name and the path has to go through such node, a \fI@\fP character
97 followed by hexadecimal address pair is desirable to resolve the
98 ambiguity. Optional partition number is a number that follows the
99 \fI:\fP character \fI1\fP (for first partition) \fI2\fP (for second,
100 partition, etc). OpenFirmware device names might look like:
101
102   /pci@80000000/pci-bridge@d/ADPT,2930CU@2/@0:
103   /pci/@d/mac-io/ata-3@20000/disk@1:
104   /pci/@d/pci-ata@1/ata-4@0/disk@0:
105   /pci/@d/pci-ata@1/ata-4@0/disk@1:
106
107 OpenFirmware device names if specified as part of the file name (see above)
108 should be followed by the \fI:\fP character to separate the device name from
109 the optional Linux partition number, as shown above.  For more information on
110 this topic, consult
111 .BR bootstrap (8).
112
113 OpenFirmware also has some predefined aliases which are used instead
114 of the longer canonical device names.  Standard aliases include:
115
116    hd: - The primary master IDE hard disk.
117    ultra1: - The primary slave IDE hard disk.
118    cd: - The secondary master device (usually CDROM).
119    zip: - The secondary slave device (usually zip drive).
120 .PP
121 Variable names are case sensitive, values of string variables are also
122 case sensitive.
123
124 Blanks and equal signs may only be part of a variable name or a value if
125 they are escaped by a backslash or if the value is embedded in double
126 quotes. An equal sign may not be the only character in a name or value.
127
128 An escaped tab is converted to an escaped blank. An escaped newline is
129 removed from the input stream. An escaped backslash (i.e. two
130 backslashes) is converted to a backslash. Inside quoted strings, only
131 double quotes, backslashes and newlines can be escaped.
132
133 Example:
134
135   # Simple yaboot.conf
136   boot=/dev/hda2
137   device=hd:
138   partition=3
139   magicboot=/usr/local/lib/yaboot/ofboot
140   timeout=50
141   root=/dev/hda3
142   read-only
143   # End of global variables - begin image labels
144   image=/boot/vmlinux
145     label=linux
146   image=/boot/vmlinux.old
147     label=old
148
149 This file contains options for two distinct programs: the
150 \fBybin\fR(8) (and \fBmkofboot\fR(8)) \fBbootstrap\fR(8) installer, and the
151 \fByaboot\fR(8) bootloader, each ignores the other's configuration
152 options.
153
154 The \fBybin\fR/\fBmkofboot\fR options are:
155 .B boot=
156 .B ofboot=
157 .B install=
158 .B magicboot=
159 .B delay=
160 .B bsd=
161 .B macos=
162 .B macosx=
163 .B darwin=
164 .B defaultos=
165 .B usemount
166 .B mntpoint=
167 .B fstype=
168 .B hfstype=
169 .B nobless
170 .B hide
171 .B protect
172 .B nonvram
173 .B enablecdboot
174 .B enablenetboot
175 .B enableofboot
176 .B brokenosx
177
178 The remaining options belong to \fByaboot\fR(8).
179 .SH "GLOBAL OPTIONS"
180 \fB/etc/yaboot.conf\fP begins with a possibly empty global options section.
181 This section contains all variable assignments up to the first \fIimage\fP
182 setting.
183
184 The following global options are recognized:
185 .TP
186 .BI "boot=" boot-device
187 Specifies the \fBbootstrap\fR(8) partition \fBybin\fR(8) will install
188 the boot loader on.  This partition needs to have an HFS or MSDOS
189 filesystem created on it (except on IBM hardware).  \fBybin\fR(8) will
190 not create a filesystem.  If a filesystem is not present run
191 \fBmkofboot\fR(8) instead of \fBybin\fR(8) for the first time. The
192 \fBbootstrap\fR(8) partition must have a partition type of
193 Apple_Bootstrap to prevent MacOS[X] from mounting it.  If MacOS is able
194 to mount the \fBbootstrap\fR(8) partition it will make it unbootable
195 by removing the attributes \fBybin\fR(8) set to make the partition
196 bootable by OpenFirmware.  The \fBbootstrap\fR partition must not be
197 mounted anywhere on your filesystem, \fBybin\fR(8) and
198 \fBmkofboot\fR(8) will refuse to operate on it if it is mounted.  On
199 IBM hardware the \fBbootstrap\fR(8) should be a type 0x41 PReP Boot
200 partition.
201 .TP
202 .BI "ofboot=" of-path
203 This option defines the OpenFirmware device path to the
204 \fBbootstrap\fR(8) partition.  This is needed so the first stage
205 \fIofboot.b\fR loader can be configured properly.  It should include
206 the OpenFirmware path including the partition number (but not a
207 filename). Example: if your bootstrap partition is /dev/hda2 the OF
208 path will likely be hd:2.  As of \fBybin\fR(8) 0.18 you no longer are
209 required to (and should not) specify this option.  If left undefined
210 \fBybin\fR(8) will attempt to figure out the OpenFirmware path
211 automatically using the \fBofpath\fR(8) utility.  You should only need
212 to define this option if \fBofpath\fR(8) fails.
213 .TP
214 .BI "install=" boot-loader
215 Specifies the path to the \fByaboot\fR(8) OpenFirmware executable
216 file.  This file is copied by \fBybin\fR(8) to the \fBbootstrap\fR(8)
217 partition.  The default if this is not specified is
218 \fI/usr/local/lib/yaboot/yaboot\fR or \fI/usr/lib/yaboot/yaboot\fR.
219 .TP
220 .BI "magicboot=" magicboot-script
221 Specifies the path to an OpenFirmware CHRP script that \fBybin\fR(8)
222 will copy to the \fBbootstrap\fR(8) partition.  Such a script contains
223 Forth commands that can allow you to do interesting things such as
224 creating a boot menu to choose between MacOS or GNU/Linux.  Currently
225 you must use a magicboot script do to a bug in OpenFirmware.
226 Eventually a CHRP header could be added to the \fByaboot\fR(8)
227 executable so this can be optional.  When this option is defined the
228 magicboot script will be executed by OF automatically at boot (instead
229 of the \fBinstall\fR file.)  See man \fBbootstrap\fR(8) for more
230 information on this.  As of ybin 0.22 you should set this to
231 /usr/local/lib/yaboot/ofboot which is a autoconfiguring first stage
232 loader for yaboot.  It is capable of presenting a dual boot menu for
233 GNU/Linux, MacOS and MacOSX.  If dual booting is not required or
234 configured it will simply load yaboot directly.  You must specify this
235 for most PowerMacs or they will fail to boot.  You cannot use
236 magicboot scripts with IBM hardware.
237 .TP
238 .BI "default=" name
239 Uses the specified image as the default boot image. If `default' is omitted,
240 the image appearing first in the configuration file is used.
241 .TP
242 .BI "defaultos=" linux|bsd|macos|macosx|darwin
243 Defines the default OS for the first stage multiboot menu to load, by
244 default this is linux, which really means \fByaboot\fR.
245 Valid values are: linux, bsd, macos, macosx, and
246 darwin.  This is only relevant if you have \fIbsd=\fR, \fImacos=\fR,
247 \fImacosx=\fR, or \fIdarwin=\fR options defined.
248 .TP
249 .BI "message=" message_filename
250 Specifies a file containing a message that is displayed before the
251 boot prompt.  You may specify either a plain pathname, in which case
252 the default device and partition will be derived from the
253 \fIdevice=\fR and \fIpartition=\fR lines in the global section of
254 \fByaboot.conf\fR, or you can specify a full OpenFirmware device path.
255 The message file must be plain ASCII text with UNIX newlines.  Note:
256 only the first 2000 bytes of this file will be read.
257 .TP
258 .BI "password=" password
259 Protect booting by a password. The password is given in either
260 cleartext or an md5 hash (of the same format as used in GNU/Linux
261 passwd files)in the configuration file.  Because of that, the
262 configuration file should be only readable by the superuser and the
263 password should differ if possible from other passwords on the system.
264 See
265 .BR chmod (1)
266 to set permissions on
267 .BR yaboot.conf (5).
268 Passwords currently do not affect the multiboot menu entries
269 (\fImacos=\fR, \fImacosx=\fR, etc).
270 .TP
271 .BI "timeout=" tsecs
272 Sets a timeout (in tenths of a second) for keyboard input. If no key is
273 pressed for the specified time, the first image is automatically booted.
274 .TP
275 .BI "delay=" secs
276 Sets a timeout (in seconds) for an OS choice in the first stage
277 \fIofboot\fR loader.  If no key is pressed for the specified time, the
278 default OS defined by \fIdefaultos=\fR (or GNU/Linux) is automatically
279 booted.  If this is left unset, the value of \fItimeout=\fR (converted
280 to seconds) will be used.
281 .TP
282 .BI "init-code=" string
283 Specifies that \fByaboot\fR(8) should call OpenFirmware to
284 execute the string given (a series of forth commands) before printing
285 the boot prompt.
286 .TP
287 .BI "fgcolor=" string
288 Specifies the foreground (text) color used by \fByaboot\fR(8) and the
289 multiboot menu.  Available colors are: black, blue, light-blue, green,
290 light-green, cyan, light-cyan, red, light-red, purple, light-purple,
291 brown, light-gray, dark-gray, yellow, and white.  The default is white.
292 .TP
293 .BI "bgcolor=" string
294 Specifies the background color used by \fByaboot\fR(8) and the
295 mulitboot menu.  Available colors are: black, blue, light-blue, green,
296 light-green, cyan, light-cyan, red, light-red, purple, light-purple,
297 brown, light-gray, dark-gray, yellow, and white.  The default is
298 black.
299 .TP
300 .BI "bsd=" of-path
301 The OpenFirmware or Unix device path to a NetBSD or OpenBSD root
302 partition, this partition must have the BSD kernel located at \fI/bsd\fR.
303 You must also have the BSD bootloader
304 \fIofwboot\fR installed at \fI/usr/local/lib/yaboot/ofwboot\fR,
305 \fBybin\fR(8) will install this onto the \fBbootstrap\fR(8) partition.
306 When you define this option you will be presented with a simple menu at
307 bootup allowing you to hit L to boot GNU/Linux or B to boot BSD (along
308 with other choices if configured).  This will only work if you are
309 using the new \fI/usr/local/lib/yaboot/ofboot\fR script.  When this is
310 set to a unix device node (ie \fI/dev/hda11\fR) then ybin will use the
311 \fBofpath\fR(8) utility to determine the OpenFirmware device path.
312 .TP
313 .BI "macos=" of-path
314 The OpenFirmware or Unix device path to a MacOS 8.* or 9.* boot
315 partition.  When you define this option you will be presented with a
316 simple menu at bootup allowing you to hit L to boot GNU/Linux or M to
317 boot MacOS (along with other choices if configured).  This will only
318 work if you are using the new \fI/usr/local/lib/yaboot/ofboot\fR
319 script.  When this is set to a unix device node (ie \fI/dev/hda11\fR)
320 then ybin will use the \fBofpath\fR(8) utility to determine the
321 OpenFirmware device path.
322 .TP
323 .BI "macosx=" of-path
324 The OpenFirmware or unix device path to a MacOS X boot partition.
325 When you define this option you will be presented with a simple menu
326 at bootup allowing you to hit L to boot GNU/Linux or X to boot MacOSX
327 (along with other choices if configured).  This will only work if you
328 are using the new \fI/usr/local/lib/yaboot/ofboot\fR script.  When
329 this is set to a unix device node (ie \fI/dev/hda11\fR) then ybin will
330 use the \fBofpath\fR(8) utility to determine the OpenFirmware device
331 path.
332 .TP
333 .B "brokenosx"
334 This option causes the menu entry for MacOSX to execute
335 \\System\\Library\\CoreServices\\BootX from the macosx=device instead
336 of the usual \\\\:tbxi.  This is necessary if OSX is installed onto an
337 HFS+ filesystem instead of UFS. When OSX is installed on an HFS+
338 filesystem MacOS will mount and debless the OSX partition.  Add this
339 option if the OSX menu entry breaks after booting MacOS.  You should
340 not use this option if OSX is installed on a UFS filesystem, for UFS
341 installs you specify the OSX bootstrap partition which is protected
342 against MacOS.  This option requires \fImacosx=\fR to be set.  
343 .TP
344 .BI "darwin=" of-path
345 The OpenFirmware or unix device path to a Darwin boot partition.
346 When you define this option you will be presented with a simple menu
347 at bootup allowing you to hit L to boot GNU/Linux or D to boot Darwin
348 (along with other choices if configured).  This will only work if you
349 are using the new \fI/usr/local/lib/yaboot/ofboot\fR script.  When
350 this is set to a unix device node (ie \fI/dev/hda11\fR) then ybin will
351 use the \fBofpath\fR(8) utility to determine the OpenFirmware device
352 path.
353 .TP
354 .B "enablecdboot"
355 This option adds an entry to the multiboot menu to boot from the CDROM drive. 
356 .TP
357 .B "enablenetboot"
358 This option adds an entry to the multiboot menu to boot from the network.
359 .TP
360 .B "enableofboot"
361 This option adds an entry to the multiboot menu to boot into an
362 OpenFirmware prompt.
363 .TP
364 .B "usemount"
365 This option causes \fBybin\fR to use the regular \fBmount\fR(8)
366 utilities to access the filesystem on the \fBbootstrap\fR(8) partition
367 instead of the userspace \fBhfsutils\fR(1).  This is not recommended
368 for HFS filesystems since it is not possible to set all the attributes
369 required for automatic OpenFirmware booting.  If you use this option
370 you will have to modify OpenFirmware's boot-device variable to make
371 your machine bootable (see man \fBbootstrap\fR(8)).  Without this option
372 you can normally reset OpenFirmware to its default configuration and
373 your system will boot automatically into GNU/Linux. (See
374 \fBbootstrap\fR(8) for details) This option is required for MSDOS
375 filesystems.
376 .TP
377 .BI "mntpoint=" /path/to/directory
378 Requires \fIusemount\fR this works exactly like usemount does except it
379 does not mount the \fBbootstrap\fR(8) partition but rather installs the
380 bootloader into the directory defined as the mountpoint.  The pathname
381 MUST be clean, ie no embedded spaces or metacharacters.  The directory
382 may not be more then one subdirectory deep from the root of the
383 partition (not necessarily the unix /).  You must not have a trailing
384 / either.  This option is NOT recommended since it has the same
385 limitations as usemount, your system will not be bootable by
386 OpenFirmware, it will only be manually bootable or bootable if you
387 change the boot-device variable to the direct pathname to the
388 bootloader (which \fBybin\fR(8) will attempt to do).  WARNING: This
389 option is not secure if untrusted users can write to the value of
390 \fImntpoint=\fR, and the filesystem supports links.
391 .TP
392 .BI "fstype=" hfs|msdos|raw
393 Specifies what kind of filesystem is created on the \fBbootstrap\fR(8)
394 partition by \fBmkofboot\fR(8).  It must be either \fIhfs\fR or
395 \fImsdos\fR or \fIraw\fR.  For Apple PowerMacs HFS is the only
396 workable option unless you have partitioned your disk with Intel
397 partition tables. \fBYbin\fR(8) also uses this option to determine how
398 to access the partition properly.  The \fIraw\fR type causes
399 \fBybin\fR(8) or \fBmkofboot\fR(8) to copy the bootloader (value of
400 \fIinstall=\fR) to the \fBbootstrap\fR(8) partition without any
401 filesystem. CAUTION: this will destroy any data or filesystem on the
402 \fBbootstrap\fR(8) partition (value of \fIboot=\fR) if you specify
403 something like \fIboot=/dev/sda\fR you will destroy the partition
404 table and lose ALL data on the disk. The default if omitted, is hfs.
405 .TP
406 .BI "hfstype=" type-code
407 Specifies the four character HFS type code that is given to the boot
408 loader (or magicboot script).  The default is \fItbxi\fR and should
409 not be changed unless you really know what you are doing, OpenFirmware
410 (on PowerMacs) looks for a file of this type to execute as a boot
411 loader so if you change this your system will not boot automatically.
412 This is only meant for users who must use a MacOS boot partition as
413 the bootstrap partition, otherwise the conflict of two \fItbxi\fR
414 files could potentially cause MacOS to fail to boot.  This code is
415 only given to the file intended for OpenFirmware to boot.  This option
416 is ignored on non-HFS filesystems.
417 .TP
418 .B "nobless"
419 This prevents \fBybin\fR(8) from \*(lqblessing\*(rq the root directory of
420 the \fBbootstrap\fR(8) partition.  Blessing the root directory is required
421 for OpenFirmware to boot correctly.  This should only be used when a
422 MacOS boot partition is being used as the \fBbootstrap\fR(8) in which case
423 blessing the root directory would make MacOS unbootable.  If you use
424 this option you must manually configure OpenFirmware to boot
425 \fByaboot\fR(8).  (see \fBbootstrap\fR(8))
426 .TP
427 .B "hide"
428 This causes \fBybin\fR(8) to set the HFS invisible bit on all the boot
429 loader files.  OpenFirmware ignores this bit, but MacOS will not show
430 invisible files in the Finder.  This is useful if the \fBbootstrap\fR(8)
431 partition is MacOS mountable and you want to prevent annoying MacOS
432 lusers from screwing up your GNU/Linux boot loader ;-). This option is
433 ignored for non-HFS filesystems.
434 .TP
435 .B "protect"
436 This causes \fBybin\fR(8) to set the HFS/MSDOS read-only bit on all the boot
437 loader files.  MacOS will not allow a read-only file to be modified or
438 deleted (but does not prevent anyone from removing this bit) This is
439 only useful if the \fBbootstrap\fR(8) partition is MacOS mountable and
440 you want to discourage modification/deletion of the boot loader.
441 .TP
442 .B "nonvram"
443 This option prevents \fBybin\fR(8) from setting the OpenFirmware
444 boot-device variable with \fBnvsetenv\fR(8).
445 .PP
446 In addition to these global options, per-image options \fIappend\fP,
447 \fIdevice\fP, \fIimage\fP, \fIinitrd-prompt\fP, \fIinitrd-size\fP,
448 \fIinitrd\fP, \fIpartition\fP, \fIpause-after\fP, \fIpause-message\fP,
449 \fIramdisk\fP, \fIread-only\fP, \fIread-write\fP, \fIroot\fP and
450 \fIrestricted\fR can be specified in the global section. They are used
451 as defaults if they aren't specified in the configuration sections of
452 the respective kernel images and will be used also for the arbitrary
453 images specified on the input line and not mentioned in the
454 configuration file (unless overridden by input line options).
455 .SH "PER-IMAGE SECTIONS"
456 A per-image section starts with either a line
457
458   \fBimage=\fP\fIfilename\fP
459
460 (for booting from files)
461 From the \fIimage\fP line on until next \fIimage\fP line are variable
462 assignments and flags for this image's section. The following options
463 and flags are recognized:
464 .TP
465 .BI "label=" name
466 The bootloader uses the main file name (without its path) of each image
467 specification to identify that image. A different name can be used by
468 setting the variable `label'.
469 .TP
470 .BI "alias=" name
471 A second name for the same entry can be used by specifying an alias.
472 .TP
473 .BI "partition=" part_no
474 Specifies the default partition number (a digit, hda1 is part_no 1) to
475 be used if some filename does not specify a partition number
476 explicitly.  The kernel images should be located on the root
477 filesystem, thus \fIpartition\fR should usually be set to the root
478 partition number.  For example if the root partition is /dev/hda3 (the
479 third partition), then \fIpartition\fR should be set to
480 \fIpartition=3\fR.
481 .TP
482 .BI "device=" device_name
483 Specifies the default device name to be used if some filename does not
484 specify a device name explicitly. This defaults to the device
485 \fByaboot\fP has been booted from if you don't specify \fIdevice\fP in either
486 the global section or per-image section of the config file.
487 .TP
488 .BI "append=" string
489 Appends the options specified to the parameter line
490 passed to the kernel. This is typically used to
491 specify parameters of hardware that can't be
492 entirely auto-detected or for which probing may be
493 dangerous. Example:
494
495   append = "video=ofonly"
496 .TP
497 .BI "literal=" string
498 Like `append', but removes all other options (e.g. setting of the root
499 device). Because vital options can be removed unintentionally with
500 `literal', this option cannot be set in the global options section.
501 .TP
502 .BI "ramdisk=" size
503 This specifies the size of the optional RAM disk. A value of zero indicates
504 that no RAM disk should be created. If this variable is omitted, the RAM
505 disk size configured into the boot image is used.
506 .TP
507 .BI "read-only"
508 This specifies that the root file system should be mounted read-only.
509 Typically, the system startup procedure re-mounts the root file system
510 read-write later (e.g. after fsck'ing it).
511 .TP
512 .BI "read-write"
513 This specifies that the root file system should be mounted read-write.
514 .TP
515 .BI "root=" root-device
516 This specifies the device that should be mounted as root.
517 .TP
518 .BI "initrd=" filename
519 Specifies the file that will be loaded at boot time as the initial RAM disk.
520 Example:
521
522   initrd=/images/initrd.img
523
524 yaboot will not decompress the initial ramdisk, the Linux kernel will do that.
525 If the initial ramdisk does not fit on one media (usually floppy), you can
526 split it into several pieces and separate the filenames in the list by
527 \fI|\fP characters. In this case, you have to provide a non-zero
528 \fIinitrd-size\fP and, if the images reside on different medias,
529 \fIinitrd-prompt\fP as well.
530 Example (on the first floppy is initrd1.img, on the second initrd2.img
531 always in the root directory and the sum of both image sizes is 1700000
532 bytes):
533
534   initrd=/initrd1.img|/initrd2.img
535   initrd-size=1700000
536   initrd-prompt
537 .TP
538 .BI "initrd-size=" size
539 When more than one initial ramdisk part is specified in the \fIinitrd\fP
540 setting, this option is required to be the sum of sizes of all the images
541 mentioned on that line, in bytes. It is required so that yaboot can reserve
542 space for the image, even though size of some parts has not been determined
543 yet.
544 .TP
545 .BI "initrd-prompt"
546 If more than one initial ramdisk part is specified, wait for user pressing a
547 key between loading the different images, so that the user can exchange
548 media. This flag is needed if some initrd parts reside on the same device,
549 but different removable media. On the other side, if you e.g. load one part
550 from a floppy and the second part from a hard disk, such option is not
551 needed (the question is who'd write something like that into yaboot.conf).
552 .TP
553 .BI "pause-after"
554 If this flag is specified, yaboot will stop after loading the kernel (and
555 initial ramdisks if specified) and ask the user to press a key before
556 continuing.
557 .TP
558 .BI "pause-message=" string
559 If \fIpause-after\fP is specified, this variable specifies the string to
560 print to the user when asking him to press a key. The default is:
561
562   Press ENTER to continue.
563 .TP
564 .BI "sysmap=" filename
565 Specifies the path for the System.map file that goes with the kernel
566 image (\fIimage=\fR).  This is for 2.4 kernels with a kernel debugger only.
567 .TP
568 .BI "single-key"
569 Enables booting the image by hitting a single key when the cursor is at the
570 first character in the input line, without the need to press <ENTER>
571 afterwards. \fIsingle-key\fP requires that either the image's label or its
572 alias (or both) is a single character. If you need to specify parameters for
573 such an image, or if you want to boot some other image which happens to
574 start with the same letter, then you need to start the input line with at
575 least one space which will be removed before processing but will disable
576 this single-key feature.
577 .TP
578 .BI "restricted"
579 Restricted limits the ability to customize command line arguments.
580 \fIrestricted\fR has no effect if \fIpassword=\fR is not specified.
581 A password is only required to boot the image specified in
582 \fB/etc/yaboot.conf\fP if parameters are specified on the command line
583 or if the user enters an image that is not specified in the configuration
584 file at all (arbitrary file load).  For an image not including
585 the \fIrestricted\fR keyword (unless \fIrestricted\fR is in the global
586 section), the password will be required.  If \fIrestricted\fR
587 is in the global section, all boot labels act as above (duh:).
588 .SH EXAMPLES
589 Here is an example \fIyaboot.conf\fR file:
590 .IP
591 .nf
592 boot=/dev/hda2
593 device=hd:
594 root=/dev/hda3
595 partition=3
596 timeout=20
597 install=/usr/local/lib/yaboot/yaboot
598 magicboot=/usr/local/lib/yaboot/ofboot
599 fgcolor=black
600 bgcolor=green
601 default=Linux
602 defaultos=linux
603 password=secret
604
605 image=/boot/vmlinux
606         label=Linux
607         read-only
608         restricted
609
610 image=/boot/vmlinux.old
611         label=linux.old
612         read-only
613
614 macos=hd:9
615 macosx=/dev/hda10
616 .fi
617 .SH NOTES
618 The format defined in this man page will not work with versions of
619 \fByaboot\fR(8) older then 0.6.  The color options only work with
620 yaboot 1.0 and later. 
621 .SH BUGS
622 Some
623 .B yaboot
624 options may not be implemented fully.
625 .SH AUTHORS
626 This man page was derived from \fBsilo.conf\fR(5) written by Jakub
627 Jelinek and the SparcLinux team, and modified for
628 \fByaboot\fR(8)/\fBybin\fR(8) by Ethan Benson.
629 .P
630 \fByaboot\fR(8) was written by Benjamin Herrenschmidt <benh@kernel.crashing.org>.
631 .P
632 \fBybin\fR(8) was written by Ethan Benson <erbenson@alaska.net>.
633 .SH SEE ALSO
634 .BR bootstrap (8),
635 .BR chmod (1),
636 .BR hfsutils (1),
637 .BR mkofboot (8),
638 .BR mount (8),
639 .BR nvsetenv (8),
640 .BR ofpath (8),
641 .BR yaboot (8),
642 .BR ybin (8).