From nobody  Sun Nov  8 15:29:11 1998
Received: (from nobody@localhost)
          by hub.freebsd.org (8.8.8/8.8.8) id PAA06625;
          Sun, 8 Nov 1998 15:29:11 -0800 (PST)
          (envelope-from nobody)
Message-Id: <199811082329.PAA06625@hub.freebsd.org>
Date: Sun, 8 Nov 1998 15:29:11 -0800 (PST)
From: rv@fore.com
To: freebsd-gnats-submit@freebsd.org
Subject: boot.config.8 man page
X-Send-Pr-Version: www-1.0

>Number:         8610
>Category:       docs
>Synopsis:       boot.config.8 man page
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Sun Nov  8 15:30:01 PST 1998
>Closed-Date:    Fri Jan 8 11:50:47 PST 1999
>Last-Modified:  Fri Jan  8 11:51:37 PST 1999
>Originator:     Rajesh Vaidheeswarran
>Release:        FreeBSD-3.0
>Organization:
>Environment:
FreeBSD freebsd.eng.fore.com 3.0-CURRENT FreeBSD 3.0-CURRENT #0: Sat Nov  7 16:30:15 EST 1998     bash@freebsd.eng.fore.com:/usr/src/sys/compile/FB30  i386

>Description:
Having gone through the pains of booting an ELF kernel, I realized
that a man page for boot.config would have helped.

Hence, I created one to help other users who might be in the 
same situation.

If this man page suffices, then please add it to the system man
pages.

boot.config.8
>How-To-Repeat:

>Fix:
.\"  Copyright (c) 1998
.\"     The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"     This product includes software developed by the University of
.\"     California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\" 
.\" $Id: boot.config.8,v 1.1 1998/11/08 17:23:25 rv Exp $
.\"
.Dd Nov 8, 1998
.Dt BOOT.CONFIG 8
.Os 
.Sh NAME
.Nm boot.config
.Nd     
system bootstrap configuration file.
.Sh DESCRIPTION
.Sy Customizing system boot configuration.
Normally, the system will reboot itself at power-up or after crashes.
An automatic consistency check of the file systems will be performed,
and unless this fails, the system will resume multi-user operations.
.Pp 
The    
.Nm    
file can be used to set commonly used options that
are passed to the
.Xr boot 8
program.
For detailed description of the boot flags check
.Xr boot 8 
manual page.
.Pp
.Sy Booting an ELF kernel.
FreeBSD 3.0 and above ship with a three stage boot loader that can be 
used to load an 'ELF' kernel, for example, that cannot be recognized
by the
.Xr boot 8
program.

By defining /boot/loader as the program to boot, the loader will then
take over the boot process and load the default kernel /kernel, with
flags specified by /kernel.config.
.Sh FILES
.Bl -tag -width /kernel.old.config -compact
.It Pa /boot.help
help messages
.It Pa /boot.config
parameters for the boot loader (optional)
.It Pa /boot/loader
Second stage boot loader.
.It Pa /kernel 
default kernel
.It Pa /kernel.config
parameters for default kernel (optional)
.It Pa /kernel.old
typical non-default kernel (optional)
.It Pa /kernel.old.config
parameters for non-default kernel (optional)
.\" .It Pa /boot
.\" system bootstrap
.El
.Sh SEE ALSO
.Xr boot 8 ,
.Xr reboot 8 ,
.Xr shutdown 8
.Sh BUGS
If you find any, please report it to the FreeBSD team using the
.Xr send-pr 1
program or its WEB-based equivalent,
http://www.freebsd.org/send-pr.html.
.Sh HISTORY
.Nm
first appeared in FreeBSD 3.0

>Release-Note:
>Audit-Trail:

From: "Jordan K. Hubbard" <jkh@time.cdrom.com>
To: rv@fore.com
Cc: freebsd-gnats-submit@FreeBSD.ORG
Subject: Re: docs/8610: boot.config.8 man page 
Date: Sun, 08 Nov 1998 15:59:28 -0800

 > Having gone through the pains of booting an ELF kernel, I realized
 > that a man page for boot.config would have helped.
 
 Actually, the latest boot blocks do the right thing most clearly
 when /boot.config has been completely removed - disklabel the latest
 boot1/boot2 to your drive and check it out! :)
 
 > By defining /boot/loader as the program to boot, the loader will then
 > take over the boot process and load the default kernel /kernel, with
 > flags specified by /kernel.config.
 
 Not necessary if /boot.config does not exist at all.  I think perhaps
 the man page needs to be updated a little in light of the current
 defaults when boot.config is absent altogether, but it's definitely
 a good start!
 
 - Jordan

From: Rajesh Vaidheeswarran <rv@fore.com>
To: "Jordan K. Hubbard" <jkh@time.cdrom.com>
Cc: rv@fore.com, freebsd-gnats-submit@freebsd.org
Subject: Re: docs/8610: boot.config.8 man page 
Date: Sun, 08 Nov 1998 19:25:48 -0500

 Oh..  didn't realize that. sorry. So, if I 
 disklabel -b /boot/boot1 -s /boot/boot2 
 and reboot, my machine would actually recognise the
 ELF kernel? Cool.
 
 If so, what is the need for /boot/loader anymore? And, 
 what is the need for boot.config.8 at all?
 
 Also, I would like to know what kernel.config does so that
 I can document it.
 
 rv
 
  -- using MH template repl.format --
 In a previous message, "Jordan K. Hubbard" writes:
 
 > > Having gone through the pains of booting an ELF kernel, I realized
 > > that a man page for boot.config would have helped.
 > 
 > Actually, the latest boot blocks do the right thing most clearly
 > when /boot.config has been completely removed - disklabel the latest
 > boot1/boot2 to your drive and check it out! :)
 > 
 > > By defining /boot/loader as the program to boot, the loader will then
 > > take over the boot process and load the default kernel /kernel, with
 > > flags specified by /kernel.config.
 > 
 > Not necessary if /boot.config does not exist at all.  I think perhaps
 > the man page needs to be updated a little in light of the current
 > defaults when boot.config is absent altogether, but it's definitely
 > a good start!
 > 
 > - Jordan
State-Changed-From-To: open->feedback 
State-Changed-By: billf 
State-Changed-When: Mon Dec 28 19:17:45 PST 1998 
State-Changed-Why:  
Would you like to update your submitted man page to reflect jkh's comments? 
Would you like me to close this completely? 
State-Changed-From-To: feedback->closed 
State-Changed-By: billf 
State-Changed-When: Fri Jan 8 11:50:47 PST 1999 
State-Changed-Why:  
Closed by request of originator. 

The state of the man page in question is too dynamic right now for 
the originator to update it. 
>Unformatted:
