Remove extra .Cm
[dragonfly.git] / share / man / man5 / kernel.conf.5
1 .\"
2 .\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/share/man/man5/kernel.conf.5,v 1.1.2.2 2003/05/24 20:45:28 hmp Exp $
27 .\" $DragonFly: src/share/man/man5/kernel.conf.5,v 1.3 2005/08/01 01:49:17 swildner Exp $
28 .\"
29 .Dd May 23, 2003
30 .Dt KERNEL.CONF 5
31 .Os
32 .Sh NAME
33 .Nm kernel.conf
34 .Nd configuration for legacy devices
35 .Sh DESCRIPTION
36 The
37 .Nm
38 file contains configuration entries created by the USERCONFIG mechanism.
39 This is typically used to force I/O port, memory and IRQ settings for
40 legacy ISA devices on the i386 platform.
41 It is typically created during first-time system installation by
42 .Xr kget 8 .
43 .Pp
44 The file
45 .Pa /boot/loader.conf
46 must contain this line for the
47 .Nm
48 script to be loaded:
49 .Pp
50 .Dl userconfig_script_load="YES"
51 .Pp
52 The file
53 .Pa /boot/defaults/loader.conf
54 contains the following two lines:
55 .Pp
56 .Dl userconfig_script_name="/boot/kernel.conf"
57 .Dl userconfig_script_type="userconfig_script"
58 .Pp
59 The kernel must be compiled with the following option:
60 .Pp
61 .Dl options USERCONFIG
62 .Pp
63 This option is normally present in the GENERIC kernel.
64 .Sh SYNTAX
65 Device names must contain both the name of the driver and the instance
66 number, for example, ed0.
67 .Pp
68 .Bl -tag -width "iom <device> <address>" -compact
69 .It Sy di <device>
70 Disable the given device.
71 .It Sy en <device>
72 Enable the given device.
73 .It Sy po <device> <port>
74 Set the beginning of the device's allocated port range.
75 .It Sy ir <device> <irq>
76 Set the device's interrupt request line.
77 .It Sy dr <device> <dma>
78 Set the device's dma channel.
79 .It Sy iom <device> <address>
80 Set the beginning of the device's allocated memory window.
81 .It Sy ios <device> <size>
82 Set the size of the device's allocated memory window.
83 .It Sy f <device> <flags>
84 Set arbitrary flags for the device.
85 .It Sy q
86 End the configuration file.
87 .El
88 .Sh SEE ALSO
89 .Xr loader.conf 5
90 .Xr boot 8 ,
91 .Xr kget 8 ,
92 .Xr loader 8 ,
93 .Sh HISTORY
94 The
95 .Nm
96 mechanism has been deprecated in
97 .Fx 5.0 .
98 .Sh AUTHORS
99 This man page was written by
100 .An Bruce M Simpson Aq bms@spc.org .