1 .\" Copyright (c) 2003 Joseph Koshy
3 .\" Redistribution and use in source and binary forms, with or without
4 .\" modification, are permitted provided that the following conditions
6 .\" 1. Redistributions of source code must retain the above copyright
7 .\" notice, this list of conditions and the following disclaimer.
8 .\" 2. Redistributions in binary form must reproduce the above copyright
9 .\" notice, this list of conditions and the following disclaimer in the
10 .\" documentation and/or other materials provided with the distribution.
12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .Nd kernel configuration file format
33 A kernel configuration file specifies the configuration of a
38 to create a build environment where a kernel may be built using
41 A kernel configuration file comprises a sequence of specification
44 A specification directive starts with a keyword at the beginning
45 of the line and is followed by additional parameters.
47 A specification directive may be terminated by a semicolon
50 Long input lines may be broken into shorter lines by starting the
51 second and subsequent lines with a white space character.
59 A double quote character
61 starts a quoted string.
62 All characters up to the next quote character form the value
66 character may be inserted into a quoted string by
70 Numbers are specified using
76 character starts a comment; all characters from the
78 character till the end of the current line are ignored.
80 Whitespace between tokens is ignored, except inside quoted strings.
81 Whitespace following a comment line is ignored.
82 .Ss Configuration Directives
83 Kernel configuration directives may appear in any order
84 in a kernel configuration file.
85 Directives are processed in order of appearance with subsequent
86 directive lines overriding the effect of prior ones.
88 The list of keywords and their meanings are as follows:
90 .Bl -tag -width indent -compact
91 .\" -------- CPU --------
93 Specify the CPU this kernel will run on.
94 There can be more than one
96 directive in a configuration file.
97 The allowed list of CPU names is architecture specific and is
99 .Pa sys/conf/options. Ns Aq Ar arch .
100 .\" -------- DEVICE --------
102 .It Ic device Ar name Op , Ar name Op ...
103 .It Ic devices Ar name Op , Ar name Op ...
104 Configures the specified devices
105 for inclusion into the kernel image.
106 Devices that are common to all architectures are
109 Devices that are specific to architecture
111 are defined in the file
112 .Pa sys/conf/files. Ns Aq Ar arch .
113 .\" -------- ENV --------
115 .It Ic env Ar filename
116 Specifies a filename containing a kernel environment definition.
118 The kernel will augment this compiled-in environment with the environment
119 prepared for it at boot time by
121 Environment variables specified in the
123 environment will take precedence over environment variables specified in
125 and environment variables specified in the dynamic environment take precedence
128 .Va loader_env.disabled=1
129 may be specified in the static environment to disable the
134 should be done with caution and due consideration for whether or not it supplies
135 environment variables needed for properly booting the system.
137 .Va static_env.disabled=1
138 may be specified in the
140 environment to disable use of the static environment.
141 This option has no effect if specified in any environment after the
143 environment is processed.
144 This option is not usable in conjunction with
145 .Va loader_env.disabled .
147 This directive is useful for setting kernel tunables in
148 embedded environments that do not start from
155 directives will be processed and added to the static environment in reversed
156 order of appearance so that later specified variables properly override earlier
160 the first appearance of a given variable will be the first one seen by the
161 kernel, effectively shadowing any later appearances of the same variable within
163 .\" -------- ENVVAR --------
165 .It Ic envvar Ar setting
166 Specifies an individual environment setting to be added to the kernel's
167 compiled-in environment.
171 Optional quotes are supported in both name and value.
177 directives will be processed and added to the static environment in reversed
178 order of appearance so that later specified variables properly override earlier
180 .\" -------- FILES --------
182 .It Ic files Ar filename
183 Specifies a file containing a list of files specific to that kernel
184 configuration file (a la
185 .Pa files. Ns Aq Ar arch ) .
186 .\" -------- HINTS --------
188 .It Ic hints Ar filename
189 Specifies a file to load a static device configuration specification
193 onwards, the kernel reads the system's device configuration at boot
195 .Xr device.hints 5 ) .
196 This directive configures the kernel to use the static device configuration
200 Hints provided in this static device configuration will be overwritten in the
201 order in which they're encountered.
202 Hints in the compiled-in environment takes precedence over compiled-in hints,
203 and hints in the environment prepared for the kernel by
205 takes precedence over hints in the compiled-in environment.
207 Once the dynamic environment becomes available, all compiled-in hints will be
208 added to the dynamic environment if they do not already have an override in
209 the dynamic environment.
210 The dynamic environment will then be used for all searches of hints.
212 .Va static_hints.disabled=1
213 may be specified in either a compiled-in environment or the
215 environment to disable use of these hints files.
216 This option has no effect if specified in any environment after the
218 environment is processed.
222 must conform to the syntax specified by
224 Multiple hints lines are allowed.
225 The resulting hints will be the files concatenated in reverse order of
226 appearance so that hints in later files properly override hints in earlier
228 .\" -------- IDENT --------
231 Set the kernel name to
235 directive is required.
236 .\" -------- INCLUDE --------
238 .It Ic include Ar filename
239 Read subsequent text from file
241 and return to the current file after
243 is successfully processed.
244 .\" -------- MACHINE --------
246 .It Ic machine Ar arch Op Ar cpuarch
247 Specifies the architecture of the machine the kernel is being
253 .Bl -tag -width ".Cm powerpc" -compact
255 The DEC Alpha architecture.
257 The ARM architecture.
259 The AMD x86-64 architecture.
261 The Intel x86 based PC architecture.
263 The MIPS architecture.
265 The IBM PowerPC architecture.
267 The Sun Sparc64 architecture.
272 is specified, it points
274 to the cpu architecture of the machine.
277 is not specified, it is assumed to be the same as
280 corresponds to MACHINE.
282 corresponds to MACHINE_ARCH.
284 A kernel configuration file may have only one
287 .\" -------- MAKEOPTION --------
289 .It Ic makeoption Ar options
290 .It Ic makeoptions Ar options
293 to the generated makefile.
297 argument is a comma separated list of one or more option
299 Each option specification has the form
301 .D1 Ar MakeVariableName Ns Op = Ns Ar Value
302 .D1 Ar MakeVariableName Ns += Ns Ar Value
304 and results in the appropriate
306 variable definition being inserted into the generated makefile.
307 If only the name of the
309 variable is specified,
311 is assumed to be the empty string.
314 .Bd -literal -offset indent -compact
315 makeoptions MYMAKEOPTION="foo"
316 makeoptions MYMAKEOPTION+="bar"
317 makeoptions MYNULLMAKEOPTION
319 .\" -------- MAXUSERS --------
321 .It Ic maxusers Ar number
322 This optional directive is used to configure the size
323 of some kernel data structures.
326 can be 0 (the default) or an integer greater than or equal to 2.
327 A value of 0 indicates that the kernel should configure
328 its data structures according to the size of available
330 If auto configuration is requested, the kernel will set
331 this tunable to a value between 32 and 384.
335 this tunable can also be set at boot time using
337 .\" -------- NOCPU --------
339 .It Ic nocpu Ar cputype
340 Remove the specified CPU
341 from the list of previously selected CPUs.
342 This directive can be used to cancel the effect of
344 directives in files included using
346 .\" -------- NODEVICE --------
348 .It Ic nodevice Ar name Op , Ar name Op ...
349 .It Ic nodevices Ar name Op , Ar name Op ...
350 Remove the specified devices
351 from the list of previously selected devices.
352 This directive can be used to cancel the effects of
356 directives in files included using
358 .\" -------- NOMAKEOPTION --------
360 .It Ic nomakeoption Ar name
361 .It Ic nomakeoptions Ar name
362 Removes previously defined
366 from the kernel build.
367 This directive can be used to cancel the effects of
369 directives in files included using
371 .\" -------- NOOPTION --------
373 .It Ic nooption Ar name Op , Ar name Op ...
374 .It Ic nooptions Ar name Op , Ar name Op ...
375 Remove the specified kernel options
376 from the list of previously defined options.
377 This directive can be used to cancel the effects of
381 directives in files included using
383 .\" -------- OPTIONS --------
385 .It Ic option Ar optionspec Op , Ar optionspec Op ...
386 .It Ic options Ar optionspec Op , Ar optionspec Op ...
387 Add compile time kernel options to the kernel build.
388 Each option specification has the form
390 .D1 Ar name Ns Op = Ns Ar value
394 is not specified, it is assumed to be
396 Options common to all architectures are specified in
398 .Pa sys/conf/options .
399 Options specific to architecture
401 are specified in the file
402 .Pa sys/conf/options. Ns Aq Ar arch .
403 .\" -------- PROFILE --------
405 .It Ic profile Ar number
406 Enables kernel profiling if
411 is 2 or greater, the kernel is configured for
412 high-resolution profiling.
413 Kernels can also be built for profiling using the
418 .Ss Obsolete Directives
419 The following kernel configuration directives are obsolete.
420 .Bl -tag -width indent
421 .\" -------- CONFIG --------
423 This directive was used to specify the device to be used for the root
427 onwards, this information is passed to a booting kernel by
431 .Bl -tag -width ".Pa sys/conf/Makefile. Ns Ar arch" -compact
432 .It Pa sys/compile/ Ns Ar NAME
433 Compile directory created from a kernel configuration.
434 .It Pa sys/conf/Makefile. Ns Ar arch
436 fragments for architecture
438 .It Pa sys/conf/files
439 Devices common to all architectures.
440 .It Pa sys/conf/files. Ns Ar arch
441 Devices for architecture
443 .It Pa sys/conf/options
444 Options common to all architectures.
445 .It Pa sys/conf/options. Ns Ar arch
446 Options for architecture
458 .%T "Building 4.4BSD Kernels with Config"
459 .%A "Samuel J. Leffler"
460 .%A "Michael J. Karels"
465 utility first appeared in
467 and was subsequently revised in
470 The kernel configuration mechanism changed further in
474 moving toward an architecture supporting dynamic kernel