3 .\" The DragonFly Project. All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in
13 .\" the documentation and/or other materials provided with the
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\" contributors may be used to endorse or promote products derived
17 .\" from this software without specific, prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 .Nd kernel configuration file
50 This manual page describes the structure of the kernel configuration file.
53 to create a build environment where a kernel may be built using
57 for information on how to build kernels.
59 Each line starts with a keyword at the beginning of the line and is
60 followed by additional parameters.
61 Long input lines may be broken into shorter lines by starting the
62 second and subsequent lines with a white space character.
63 Numbers are specified using
66 Blank lines are ignored.
69 character is interpreted as a comment and is ignored along with everything
70 that follows it on the same line.
72 The following keywords are recognized in a configuration file:
74 .Bl -tag -width indent -compact
76 This system is to run on the CPU type
91 More than one CPU type specification can appear in a configuration file.
93 .It Sy device Ar name \
95 Oo Sy port Ar num Oc \
98 Oo Sy iomem Ar num Oc \
99 Oo Sy iosiz Ar num Oc \
101 Configures support for device
103 Additional parameters may be passed to specify
105 configuration settings (most often for
108 .Bl -tag -width ".Sy iomem"
110 specifies a bus to which the device is attached.
112 specifies the start address of
114 ports to be used by the device.
116 specifies the number of ports used by the device.
118 is the interrupt line number to be used.
120 specifies the physical memory address used by the device.
122 specifies the physical memory size used by the device.
124 sets various flag bits for the device.
127 .It Sy ident Ar string
128 Sets the kernel identification string to
131 .It Sy machine Ar name
132 The system is to run on the machine type
134 This is a legacy keyword, it is normally set to same value as
137 .It Sy machine_arch Ar name
138 The system is to run on the machine architecture
140 The legal architectures are
145 .It Sy makeoptions Ar name Ns Sy = Ns Ar value
152 in the kernel Makefile.
154 .It Sy maxusers Ar integer
157 variable in the kernel.
159 .It Sy options Ar name Ns Op Sy = Ns Ar value
162 Some options expect to be assigned a value, which may be an integer,
163 a double-quoted word, a bare word, or an empty string
165 Note that those are eventually handled by the C compiler, so the rules
166 of that language apply.
167 .\"For more information see the
171 .It Sy platform Ar name
172 Sets the platform of this kernel to
184 (32 bit virtual kernel),
187 (64 bit virtual kernel).
189 .It Sy pseudo-device Ar name Op Ar N
190 Includes support for the pseudo-device
192 Some pseudo-devices can have multiple or
198 .Bl -tag -width ".Pa /sys/config/X86_64_GENERIC"
199 .It Pa /sys/config/GENERIC
202 kernel configuration file
203 .It Pa /sys/config/LINT
204 kernel configuration file for checking all the sources,
205 includes description of kernel configuration options
206 .It Pa /sys/config/SOEKRIS
207 kernel configuration file for the
208 .Tn Soekris Engineering net5501
210 .It Pa /sys/config/VKERNEL
213 kernel configuration file
214 .It Pa /sys/config/VKERNEL64
217 kernel configuration file
218 .It Pa /sys/config/X86_64_GENERIC
221 kernel configuration file
231 manual page first appeared in