Allow yaboot to load relocatable kernel

[yaboot.git] / man / mkofboot.8

diff --git a/man/mkofboot.8 b/man/mkofboot.8
index 09e2a4824f5418d6c0cee743120cfe06069c1142..2139ddb6e4f1dea7163484928cdd8eff7b5d936b 100644 (file)
--- a/man/mkofboot.8
+++ b/man/mkofboot.8
@@ -13,16 +13,16 @@
 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 .\" GNU General Public License for more details.
 .\"
 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 .\" GNU General Public License for more details.
 .\"

-.\" You should have received a copy of the GNU General Public License          
-.\" along with this program; if not, write to the Free Software                
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program; if not, write to the Free Software

 .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 .\"
 .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 .\"

-.TH MKOFBOOT 8 "28 April 2001" "GNU/Linux PowerPC" "System Manager's Manual"
+.TH MKOFBOOT 8 "21 November 2001" "GNU/Linux PowerPC" "System Manager's Manual"

 .SH NAME
 .B mkofboot
 \- format bootstrap partition and install the yaboot boot loader
 .SH SYNOPSIS
 .SH NAME
 .B mkofboot
 \- format bootstrap partition and install the yaboot boot loader
 .SH SYNOPSIS

-.B mkofboot 
+.B mkofboot

 .RB [ \ \-b | \-\-boot\ \fIdevice\  ]
 .RB [ \ \-o | \-\-ofboot\ \fIof-path\  ]
 .RB [ \ \-i | \-\-install\ \fIboot-file\  ]
 .RB [ \ \-b | \-\-boot\ \fIdevice\  ]
 .RB [ \ \-o | \-\-ofboot\ \fIof-path\  ]
 .RB [ \ \-i | \-\-install\ \fIboot-file\  ]


@@ -34,26 +34,20 @@
 .RB [ \ \-\-hide\  ]
 .RB [ \ \-\-protect\  ]
 .RB [ \ \-\-nonvram\  ]
 .RB [ \ \-\-hide\  ]
 .RB [ \ \-\-protect\  ]
 .RB [ \ \-\-nonvram\  ]

-.RB [ \ \-\-device\ \fIOF-dev\  ]
-.RB [ \ \-\-partition\ \fIroot-part-#\  ]
-.RB [ \ \-\-timeout\ \fItimeout\  ]
-.RB [ \ \-\-image\ \fIkernel\  ]
-.RB [ \ \-\-label\ \fIlabel\  ]
-.RB [ \ \-\-root\ \fIroot-dev\  ]

 .RB [ \ \-\-force\  ]
 .RB [ \ \-v | \-\-verbose\  ]
 .RB [ \ \-\-debug\  ]
 .RB [ \ \-h | \-\-help\  ]
 .RB [ \ \-V | \-\-version\  ]
 .SH DESCRIPTION
 .RB [ \ \-\-force\  ]
 .RB [ \ \-v | \-\-verbose\  ]
 .RB [ \ \-\-debug\  ]
 .RB [ \ \-h | \-\-help\  ]
 .RB [ \ \-V | \-\-version\  ]
 .SH DESCRIPTION

-This manual page explains 
+This manual page explains

 .B mkofboot
 .B mkofboot

-the initial installer for the  
-.BR yaboot (8) 
+the initial installer for the
+.BR yaboot (8)

 boot loader enabling GNU/Linux to be booted by OpenFirmware.
 
 .B mkofboot
 boot loader enabling GNU/Linux to be booted by OpenFirmware.
 
 .B mkofboot

-does exactly the same thing as 
+does exactly the same thing as

 .BR ybin (8)
 except that it erases and creates a new filesystem (specified by
 \-\-filesystem) on the \fBbootstrap\fR(8) partition before copying the
 .BR ybin (8)
 except that it erases and creates a new filesystem (specified by
 \-\-filesystem) on the \fBbootstrap\fR(8) partition before copying the


@@ -72,12 +66,12 @@ NOTE:
 uses the exact same command line options as
 .BR ybin (8)
 so if you have already read the \fBybin\fR(8) man page you can skip this
 uses the exact same command line options as
 .BR ybin (8)
 so if you have already read the \fBybin\fR(8) man page you can skip this

-section. 
+section.

 .TP
 .BR \-b ,\  \-\-boot\ \fIdevice
 Install the boot loader onto the specified device.  This device should
 be that of your \fBbootstrap\fR(8) partition. For example, if your
 .TP
 .BR \-b ,\  \-\-boot\ \fIdevice
 Install the boot loader onto the specified device.  This device should
 be that of your \fBbootstrap\fR(8) partition. For example, if your

-\fBbootstrap\fR partition is located on your first primary IDE drive in the 
+\fBbootstrap\fR partition is located on your first primary IDE drive in the

 second partition, your device would be: \fI/dev/hda2\fR.
 .TP
 .BR \-o ,\  \-\-ofboot\ \fIof-path
 second partition, your device would be: \fI/dev/hda2\fR.
 .TP
 .BR \-o ,\  \-\-ofboot\ \fIof-path


@@ -151,38 +145,6 @@ HFS and MSDOS filesystems.
 Prevent \fBmkofboot\fR from setting the OpenFirmware boot-device
 variable with \fBnvsetenv\fR(8).
 .TP
 Prevent \fBmkofboot\fR from setting the OpenFirmware boot-device
 variable with \fBnvsetenv\fR(8).
 .TP

-.BR \-\-device\ \fIopenfirmware-dev-path
-This option is used for auto-generation of a \fByaboot.conf\fR(5).  This
-specifies the OpenFirmware device of the disk the system will boot
-from.  The default is \*(lqhd:\*(rq.
-.TP
-.BR \-\-partition\ \fIroot-partition-number
-This option is used for auto-generation of a \fByaboot.conf\fR(5).  This
-specifies the partition number of the root filesystem.  Mac partition
-tables are considered a partition themselves, so the first real
-partition will be 2, usually the \fBbootstrap\fR(8) partition, followed
-by the root partition, number 3.
-.TP
-.BR \-\-timeout\ \fItimeout
-This option is used for auto-generation of a \fByaboot.conf\fR(5).  This
-specifies the timeout value in tenths of a second.  The timeout is how
-long \fByaboot\fR(8) will wait before booting the default (first listed)
-image.
-.TP
-.BR \-\-image\ \fIkernel-image
-This option is used for auto-generation of a \fByaboot.conf\fR(5).  This
-specifies the path to the default kernel to be booted.
-.TP
-.BR \-\-label\ \fIlabel
-This option is used for auto-generation of a \fByaboot.conf\fR(5).  This
-specifies the label used to boot the above kernel image.  The default
-is Linux.
-.TP
-.BR \-\-root\ \fIroot-device
-This option is used for auto-generation of a \fByaboot.conf\fR(5).  This
-specifies the Linux device of the root partition.  This is passed to
-the kernel at boot time.  The default is \fI/dev/hda3\fR.
-.TP

 .BR \-v ,\  \-\-verbose
 This option causes \fBmkofboot\fR to be more verbose as it proceeds.
 .TP
 .BR \-v ,\  \-\-verbose
 This option causes \fBmkofboot\fR to be more verbose as it proceeds.
 .TP


@@ -210,10 +172,9 @@ Print out the version number and exit.
 .br
 The temporary directory \fBmkofboot\fR will use.
 .SH SECURITY
 .br
 The temporary directory \fBmkofboot\fR will use.
 .SH SECURITY

-The \fByaboot.conf\fR(5) auto generation requires a temporary file, this
-file is created with
+Temporary files are created with

 .BR mktemp (1)
 .BR mktemp (1)

-it is important that your system use a secure 
+it is important that your system use a secure

 .BR mktemp (1)
 program otherwise \fBmkofboot\fR will be vulnerable to race conditions.
 The Debian mktemp is derived from OpenBSD and thus should be secure.
 .BR mktemp (1)
 program otherwise \fBmkofboot\fR will be vulnerable to race conditions.
 The Debian mktemp is derived from OpenBSD and thus should be secure.


@@ -229,14 +190,12 @@ should be able to take care of OpenFirmware variables as needed on IBM
 hardware.
 .SH AUTHORS
 .BR mkofboot (8)
 hardware.
 .SH AUTHORS
 .BR mkofboot (8)

-, and this man page written by Ethan Benson. 
+, and this man page written by Ethan Benson.

 .br
 .BR yaboot (8)
 was written by Benjamin Herrenschmidt.
 .SH REPORTING BUGS
 Report bugs to <erbenson@alaska.net>
 .br
 .BR yaboot (8)
 was written by Benjamin Herrenschmidt.
 .SH REPORTING BUGS
 Report bugs to <erbenson@alaska.net>

-.br
-Report bugs in \fByaboot\fR(8) to <benh@kernel.crashing.org>

 .SH SEE ALSO
 .BR bootstrap (8),
 .BR hfsutils (1),
 .SH SEE ALSO
 .BR bootstrap (8),
 .BR hfsutils (1),