A new man page describing the drivers.conf configuration file that

specifies which kernel options should be removed from the boot kernel
(kern.flp) and loaded as modules from the mfsroot.flp.

Reviewed by:	ru, dd

1 files changed, 119 insertions, 0 deletions

diff --git a/share/man/man5/drivers.conf.5 b/share/man/man5/drivers.conf.5
new file mode 100644
index 0000000..bb26c15
--- /dev/null
+++ b/share/man/man5/drivers.conf.5
@@ -0,0 +1,119 @@
+.\" Copyright (c) 2002 Murray Stokely <murray@FreeBSD.org>
+.\" 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.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd March 23, 2002
+.Dt DRIVERS.CONF 5
+.Os
+.Sh NAME
+.Nm drivers.conf
+.Nd "driver configuration file for boot floppies"
+.Sh DESCRIPTION
+The file
+.Nm
+is used during the release build process.
+A
+.Fx
+release includes two installation floppies.
+The first floppy image,
+.Pa kern.flp ,
+contains a statically linked kernel.
+The second floppy image,
+.Pa mfsroot.flp ,
+contains
+.Xr sysinstall 8 ,
+a collection of essential commands necessary for installation, and
+kernel modules to supplement the boot kernel.
+Once the system has booted,
+the modules present in the
+.Pa /stand/modules
+directory of the MFSROOT floppy will automatically be loaded by
+.Xr sysinstall 8 .
+.Pp
+The
+.Pa /usr/src/release/${arch}/drivers.conf
+file contains a list of drivers that should be omitted from the boot
+kernel and installed as kernel modules on the MFSROOT floppy.
+Each driver is described on a separate line; fields on each line are
+separated by tabs or spaces.
+.Pp
+The first field,
+.Ar driver ,
+is the name of the driver in the kernel configuration file.
+This is used by
+.Pa driver-remove.pl
+to remove drivers from the boot floppy kernel configuration
+file that are included as modules on the MFSROOT floppy.
+.Pp
+The second field,
+.Ar filename ,
+is the name of the associated kernel module (without the 
+.Pa .ko
+extension).
+.Pp
+The third field,
+.Ar floppy ,
+specifies which floppy disk should include the kernel module.
+Currently, only a value of 2 is valid here (representing
+.Pa mfsroot.flp ) .
+In the future, a third
+.Dq "driver floppy"
+may be added.
+.Pp
+The fourth field,
+.Ar type ,
+specifies the driver category.
+This field is currently unused.
+.Pp
+The fifth field,
+.Ar description ,
+provides a short description of the device driver.
+.Sh FILES
+.Bl -tag -compact
+.It Pa /usr/src/release/Makefile
+.It Pa /usr/src/release/${arch}/drivers.conf
+.It Pa /usr/src/release/scripts/driver-copy2.pl
+.It Pa /usr/src/release/scripts/driver-remove.pl
+.El
+.Sh SEE ALSO
+.Xr release 7 ,
+.Xr kldload 8 ,
+.Xr sysinstall 8
+.Rs
+.%T "FreeBSD Release Engineering"
+.%O http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng/
+.Re
+.Sh HISTORY
+The
+.Nm
+file appeared in
+.Fx 4.5 .
+.Sh AUTHORS
+.An -nosplit
+.An HOSOKAWA, Tatsumi Aq hosokawa@FreeBSD.org
+originally added support for moving kernel modules to the mfsroot
+installer floppy image.
+This manual page was written by
+.An Murray Stokely Aq murray@FreeBSD.org .