share/man/man5/drivers.conf.5

   1 .\" Copyright (c) 2002 Murray Stokely <murray@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man5/drivers.conf.5,v 1.3.2.1 2002/04/02 09:12:57 murray Exp $
  26 .\"
  27 .Dd March 23, 2002
  28 .Dt DRIVERS.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm drivers.conf
  32 .Nd "driver configuration file for boot floppies"
  33 .Sh DESCRIPTION
  34 The file
  35 .Nm
  36 is used during the release build process.
  37 A
  38 .Fx
  39 release includes two installation floppies.
  40 The first floppy image,
  41 .Pa kern.flp ,
  42 contains a statically linked kernel.
  43 The second floppy image,
  44 .Pa mfsroot.flp ,
  45 contains
  46 .Xr sysinstall 8 ,
  47 a collection of essential commands necessary for installation, and
  48 kernel modules to supplement the boot kernel.
  49 Once the system has booted,
  50 the modules present in the
  51 .Pa /stand/modules
  52 directory of the mfsroot floppy will automatically be loaded by
  53 .Xr sysinstall 8 .
  54 .Pp
  55 The
  56 .Pa /usr/src/release/${arch}/drivers.conf
  57 file contains a list of drivers that should be omitted from the boot
  58 kernel and installed as kernel modules on the mfsroot floppy.
  59 Each driver is described on a separate line; fields on each line are
  60 separated by tabs or spaces.
  61 .Pp
  62 The first field,
  63 .Ar driver ,
  64 is the name of the driver in the kernel configuration file.
  65 This is used by
  66 .Pa driver-remove.pl
  67 to remove drivers from the boot floppy kernel configuration
  68 file that are included as modules on the mfsroot floppy.
  69 .Pp
  70 The second field,
  71 .Ar filename ,
  72 is the name of the associated kernel module (without the
  73 .Pa .ko
  74 extension).
  75 .Pp
  76 The third field,
  77 .Ar floppy ,
  78 specifies which floppy disk should include the kernel module.
  79 Currently, only a value of 2 is valid here (representing
  80 .Pa mfsroot.flp ) .
  81 In the future, a third
  82 .Dq "driver floppy"
  83 may be added.
  84 .Pp
  85 The fourth field,
  86 .Ar type ,
  87 specifies the driver category.
  88 This field is currently unused.
  89 .Pp
  90 The fifth field,
  91 .Ar description ,
  92 provides a short description of the device driver.
  93 .Sh FILES
  94 .Bl -tag -compact
  95 .It Pa /usr/src/release/Makefile
  96 .It Pa /usr/src/release/${arch}/drivers.conf
  97 .It Pa /usr/src/release/scripts/driver-copy2.pl
  98 .It Pa /usr/src/release/scripts/driver-remove.pl
  99 .El
 100 .Sh SEE ALSO
 101 .Xr release 7 ,
 102 .Xr kldload 8 ,
 103 .Xr sysinstall 8
 104 .Rs
 105 .%T "FreeBSD Release Engineering"
 106 .%O http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng/
 107 .Re
 108 .Sh HISTORY
 109 The
 110 .Nm
 111 file appeared in
 112 .Fx 4.5 .
 113 .Sh AUTHORS
 114 .An -nosplit
 115 .An HOSOKAWA, Tatsumi Aq hosokawa@FreeBSD.org
 116 originally added support for moving kernel modules to the mfsroot
 117 installer floppy image.
 118 This manual page was written by
 119 .An Murray Stokely Aq murray@FreeBSD.org .