handle RAID partitions on x86 partition tables
[yaboot.git] / man / yabootconfig.8
1 .\" Hey Emacs! This file is -*- nroff -*- source.
2 .\"
3 .\" yabootconfig generates a simple /etc/yaboot.conf
4 .\" Copyright (C) 2001 Ethan Benson
5 .\"
6 .\" This program is free software; you can redistribute it and/or
7 .\" modify it under the terms of the GNU General Public License
8 .\" as published by the Free Software Foundation; either version 2
9 .\" of the License, or (at your option) any later version.
10 .\"
11 .\" This program is distributed in the hope that it will be useful,
12 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
13 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 .\" GNU General Public License for more details.
15 .\"
16 .\" You should have received a copy of the GNU General Public License          
17 .\" along with this program; if not, write to the Free Software                
18 .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19 .\"
20 .TH YABOOTCONFIG 8 "24 November 2001" "GNU/Linux PowerPC" "System Manager's Manual"
21 .SH NAME
22 .B yabootconfig
23 \- generates a simple /etc/yaboot.conf
24 .SH SYNOPSIS
25 .B yabootconfig
26 .RB [ \ \-t | \-\-chroot\ \\fIdirectory\  ]
27 .RB [ \ \-b | \-\-boot\ \fIdevice\  ]
28 .RB [ \ \-r | \-\-root\ \fIdevice\  ]
29 .RB [ \ \-\-kernel-args\ \\fI"kernel_args"\  ]
30 .RB [ \ \-q | \-\-quiet\  ]
31 .RB [ \ \-\-noinstall\  ]
32 .RB [ \ \-\-debug\  ]
33 .RB [ \ \-h | \-\-help\  ]
34 .RB [ \ \-V | \-\-version\  ]
35 .SH DESCRIPTION
36 This manual page explains 
37 .B yabootconfig
38 the configurator for the  
39 .BR yaboot (8) 
40 boot loader enabling GNU/Linux to be booted by OpenFirmware.
41 Specifically it inspects the running system, generates a working
42 .BR /etc/yaboot.conf (5)
43 and then runs \fBmkofboot\fR(8) to make the system bootable.
44
45 .B yabootconfig
46 requires an 800K bootstrap partition on the same disk as the root
47 partition.  It must be type \*(lqApple_Bootstrap\*(rq for PowerMacs,
48 and type \*(lq0x41 PPC PReP Boot\*(rq for IBM CHRP hardware.
49
50 The \fBbootstrap\fR(8) must not be mounted anywhere on your
51 filesystem, especially not on top of /boot.  \fBYaboot\fR is able to
52 load the kernels from the ext2fs root partition so that is where they
53 should be kept. \fBmkofboot\fR will refuse to operate on the
54 \fBbootstrap\fR(8) partition if it is mounted.
55
56 .B yabootconfig
57 requires \fBofpath\fR(8) in order to get the OpenFirmware device name
58 for the root disk on PowerMacs. 
59 .SH OPTIONS
60 .TP
61 .BR \-t ,\  \-\-chroot\ \fIdirectory
62 Cause \fByabootconfig\fR to work as if \fIdirectory\fR is the /
63 directory.  This is useful when booting from a rescue floppy or CDROM
64 in which case you mount your true root filesystem on /target or /mnt.
65 \fByabootconfig\fR will generate \fI<chroot>/etc/yaboot.conf\fR and
66 pass the \*(lq-C <chroot>/etc/yaboot.conf\*(rq arguments to \fBmkofboot\fR(8).
67 Example: yabootconfig --chroot /target
68 .TP
69 .BR \-r ,\  \-\-root\ \fIdevice
70 Normally \fByabootconfig\fR will automatically determine the root
71 partition by inspecting \fI<chroot>/etc/fstab\fR(5).  This option
72 forces it to use \fIdevice\fR instead of auto-detecting it.  This
73 option is only intended to be used by distribution installers which
74 should already know with absolute certainty what the root partition
75 device is.
76 .TP
77 .BR \-b ,\  \-\-boot\ \fIdevice
78 Normally \fByabootconfig\fR will automatically find your
79 \fBbootstrap\fR partition, this option forces it to use \fIdevice\fR
80 instead of auto-detecting it.  This option is only intended to be used
81 by distribution installers which should already know with absolute
82 certainty what the \fBbootstrap\fR partition device is.  The
83 \fBbootstrap\fR partition is where \fBmkofboot\fR(8) will install the
84 bootloader onto, this device should be that of your \fBbootstrap\fR(8)
85 partition. For example, if your \fBbootstrap\fR partition is located
86 on your first primary IDE drive in the second partition, your device
87 would be: \fI/dev/hda2\fR.  IMPORTANT: The \fBbootstrap\fR partition
88 WILL BE ERASED when \fByabootconfig\fR runs \fBmkofboot\fR(8).
89 .TP
90 .BR \-\-kernel\-args
91 This option allows you to specify additional kernel arguments which
92 will be placed in an \fIappend=\fR configuration variable in
93 \fI/etc/yaboot.conf\fR(5).  You must quote the arguments you supply to this
94 option.  Example: --kernel-args "video=ofonly"
95 .TP
96 .BR \-q ,\  \-\-quiet
97 Normally \fByabootconfig\fR will ask permission and explain what it is
98 about to do before proceeding, this option prevents \fByabootconfig\fR
99 from asking any questions or displaying any informational messages
100 except errors.  This option also prevents \fByabootconfig\fR from
101 interactively asking the user to locate a kernel image if it fails to
102 find one in the standard locations.  This option is only intended to
103 be used by distribution installers which may run \fByabootconfig\fR in
104 the background in order to make the disk bootable after OS installation.
105 .TP
106 .BR \-\-noinstall
107 Normally \fByabootconfig\fR will automatically run \fBmkofboot\fR(8)
108 after it successfully generates a valid
109 \fI<chroot>/etc/yaboot.conf\fR.  This option causes \fByabootconfig\fR
110 to only generate the config file without installing the \fBbootstrap\fR.
111 .TP
112 .BR \-\-debug
113 This option causes \fByabootconfig\fR to output some boring details useful
114 only for debugging \fByabootconfig\fR itself.
115 .TP
116 .BR \-h ,\  \-\-help
117 Print out usage information and exit.
118 .TP
119 .BR \-V ,\  \-\-version
120 Print out the version number and exit.
121 .SH FILES
122 .nf
123 /etc/fstab \- static information about the filesystems
124 .br
125 /etc/yaboot.conf \- bootloader/ybin configuration file
126 .fi
127 .SH AUTHORS
128 .B yabootconfig
129 and this man page was written by Ethan Benson. 
130 .br
131 .B yaboot
132 was written by Benjamin Herrenschmidt.
133 .SH REPORTING BUGS
134 Report bugs to <erbenson@alaska.net>
135 .SH SEE ALSO
136 .BR bootstrap (8),
137 .BR fstab (5),
138 .BR mkofboot (8),
139 .BR ofpath (8),
140 .BR yaboot (8),
141 .BR yaboot.conf (5),