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