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 .\" $DragonFly: src/share/man/man5/Attic/drivers.conf.5,v 1.2 2003/06/17 04:37:00 dillon Exp $
  27 .\"
  28 .Dd March 23, 2002
  29 .Dt DRIVERS.CONF 5
  30 .Os
  31 .Sh NAME
  32 .Nm drivers.conf
  33 .Nd "driver configuration file for boot floppies"
  34 .Sh DESCRIPTION
  35 The file
  36 .Nm
  37 is used during the release build process.
  38 A
  39 .Fx
  40 release includes two installation floppies.
  41 The first floppy image,
  42 .Pa kern.flp ,
  43 contains a statically linked kernel.
  44 The second floppy image,
  45 .Pa mfsroot.flp ,
  46 contains
  47 .Xr sysinstall 8 ,
  48 a collection of essential commands necessary for installation, and
  49 kernel modules to supplement the boot kernel.
  50 Once the system has booted,
  51 the modules present in the
  52 .Pa /stand/modules
  53 directory of the mfsroot floppy will automatically be loaded by
  54 .Xr sysinstall 8 .
  55 .Pp
  56 The
  57 .Pa /usr/src/release/${arch}/drivers.conf
  58 file contains a list of drivers that should be omitted from the boot
  59 kernel and installed as kernel modules on the mfsroot floppy.
  60 Each driver is described on a separate line; fields on each line are
  61 separated by tabs or spaces.
  62 .Pp
  63 The first field,
  64 .Ar driver ,
  65 is the name of the driver in the kernel configuration file.
  66 This is used by
  67 .Pa driver-remove.pl
  68 to remove drivers from the boot floppy kernel configuration
  69 file that are included as modules on the mfsroot floppy.
  70 .Pp
  71 The second field,
  72 .Ar filename ,
  73 is the name of the associated kernel module (without the
  74 .Pa .ko
  75 extension).
  76 .Pp
  77 The third field,
  78 .Ar floppy ,
  79 specifies which floppy disk should include the kernel module.
  80 Currently, only a value of 2 is valid here (representing
  81 .Pa mfsroot.flp ) .
  82 In the future, a third
  83 .Dq "driver floppy"
  84 may be added.
  85 .Pp
  86 The fourth field,
  87 .Ar type ,
  88 specifies the driver category.
  89 This field is currently unused.
  90 .Pp
  91 The fifth field,
  92 .Ar description ,
  93 provides a short description of the device driver.
  94 .Sh FILES
  95 .Bl -tag -compact
  96 .It Pa /usr/src/release/Makefile
  97 .It Pa /usr/src/release/${arch}/drivers.conf
  98 .It Pa /usr/src/release/scripts/driver-copy2.pl
  99 .It Pa /usr/src/release/scripts/driver-remove.pl
 100 .El
 101 .Sh SEE ALSO
 102 .Xr release 7 ,
 103 .Xr kldload 8 ,
 104 .Xr sysinstall 8
 105 .Rs
 106 .%T "FreeBSD Release Engineering"
 107 .%O http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng/
 108 .Re
 109 .Sh HISTORY
 110 The
 111 .Nm
 112 file appeared in
 113 .Fx 4.5 .
 114 .Sh AUTHORS
 115 .An -nosplit
 116 .An HOSOKAWA, Tatsumi Aq hosokawa@FreeBSD.org
 117 originally added support for moving kernel modules to the mfsroot
 118 installer floppy image.
 119 This manual page was written by
 120 .An Murray Stokely Aq murray@FreeBSD.org .