Commit yaboot 1.3.3
[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 "25 September 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 [ \ \-q | \-\-quiet\  ]
30 .RB [ \ \-\-noinstall\  ]
31 .RB [ \ \-\-debug\  ]
32 .RB [ \ \-h | \-\-help\  ]
33 .RB [ \ \-V | \-\-version\  ]
34 .SH DESCRIPTION
35 This manual page explains 
36 .B yabootconfig
37 the configurator for the  
38 .BR yaboot (8) 
39 boot loader enabling GNU/Linux to be booted by OpenFirmware.
40 Specifically it inspects the running system, generates a working
41 .BR /etc/yaboot.conf (5)
42 and then runs \fBmkofboot\fR(8) to make the system bootable.
43
44 .B yabootconfig
45 requires an 800K bootstrap partition on the same disk as the root
46 partition.  It must be type \*(lqApple_Bootstrap\*(rq for PowerMacs,
47 and type \*(lq0x41 PPC PReP Boot\*(rq for IBM CHRP hardware.
48
49 The \fBbootstrap\fR(8) must not be mounted anywhere on your
50 filesystem, especially not on top of /boot.  \fBYaboot\fR is able to
51 load the kernels from the ext2fs root partition so that is where they
52 should be kept. \fBmkofboot\fR will refuse to operate on the
53 \fBbootstrap\fR(8) partition if it is mounted.
54
55 .B yabootconfig
56 requires \fBofpath\fR(8) in order to get the OpenFirmware device name
57 for the root disk on PowerMacs. 
58 .SH OPTIONS
59 .TP
60 .BR \-t ,\  \-\-chroot\ \fIdirectory
61 Cause \fByabootconfig\fR to work as if \fIdirectory\fR is the /
62 directory.  This is useful when booting from a rescue floppy or CDROM
63 in which case you mount your true root filesystem on /target or /mnt.
64 \fByabootconfig\fR will generate \fI<chroot>/etc/yaboot.conf\fR and
65 pass the \*(lq-C <chroot>/etc/yaboot.conf\*(rq arguments to \fBmkofboot\fR(8).
66 Example: yabootconfig --chroot /target
67 .TP
68 .BR \-r ,\  \-\-root\ \fIdevice
69 Normally \fByabootconfig\fR will automatically determine the root
70 partition by inspecting \fI<chroot>/etc/fstab\fR(5).  This option
71 forces it to use \fIdevice\fR instead of auto-detecting it.  This
72 option is only intended to be used by distribution installers which
73 should already know with absolute certainty what the root partition
74 device is.
75 .TP
76 .BR \-b ,\  \-\-boot\ \fIdevice
77 Normally \fByabootconfig\fR will automatically find your
78 \fBbootstrap\fR partition, this option forces it to use \fIdevice\fR
79 instead of auto-detecting it.  This option is only intended to be used
80 by distribution installers which should already know with absolute
81 certainty what the \fBbootstrap\fR partition device is.  The
82 \fBbootstrap\fR partition is where \fBmkofboot\fR(8) will install the
83 bootloader onto, this device should be that of your \fBbootstrap\fR(8)
84 partition. For example, if your \fBbootstrap\fR partition is located
85 on your first primary IDE drive in the second partition, your device
86 would be: \fI/dev/hda2\fR.  IMPORTANT: The \fBbootstrap\fR partition
87 WILL BE ERASED when \fByabootconfig\fR runs \fBmkofboot\fR(8).
88 .TP
89 .BR \-\-kernel\-args
90 This option allows you to specify additional kernel arguments which
91 will be placed in an \fIappend=\fR configuration variable in
92 \fI/etc/yaboot.conf\fR(5).  You must quote the arguments you supply to this
93 option.  Example: --kernel-args "video=ofonly"
94 .TP
95 .BR \-q ,\  \-\-quiet
96 Normally \fByabootconfig\fR will ask permission and explain what it is
97 about to do before proceeding, this option prevents \fByabootconfig\fR
98 from asking any questions or displaying any informational messages
99 except errors.  This option also prevents \fByabootconfig\fR from
100 interactively asking the user to locate a kernel image if it fails to
101 find one in the standard locations.  This option is only intended to
102 be used by distribution installers which may run \fByabootconfig\fR in
103 the background in order to make the disk bootable after OS installation.
104 .TP
105 .BR \-\-noinstall
106 Normally \fByabootconfig\fR will automatically run \fBmkofboot\fR(8)
107 after it successfully generates a valid
108 \fI<chroot>/etc/yaboot.conf\fR.  This option causes \fByabootconfig\fR
109 to only generate the config file without installing the \fBbootstrap\fR.
110 .TP
111 .BR \-\-debug
112 This option causes \fByabootconfig\fR to output some boring details useful
113 only for debugging \fByabootconfig\fR itself.
114 .TP
115 .BR \-h ,\  \-\-help
116 Print out usage information and exit.
117 .TP
118 .BR \-V ,\  \-\-version
119 Print out the version number and exit.
120 .SH FILES
121 .nf
122 /etc/fstab \- static information about the filesystems
123 .br
124 /etc/yaboot.conf \- bootloader/ybin configuration file
125 .fi
126 .SH AUTHORS
127 .B yabootconfig
128 and this man page was written by Ethan Benson. 
129 .br
130 .B yaboot
131 was written by Benjamin Herrenschmidt.
132 .SH REPORTING BUGS
133 Report bugs to <erbenson@alaska.net>
134 .br
135 Report bugs in \fByaboot\fR(8) to <benh@kernel.crashing.org>
136 .SH SEE ALSO
137 .BR bootstrap (8),
138 .BR fstab (5),
139 .BR mkofboot (8),
140 .BR ofpath (8),
141 .BR yaboot (8),
142 .BR yaboot.conf (5),