1 .\" Copyright (c) 1980, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)config.8 8.2 (Berkeley) 4/19/94
36 .Nd build system configuration files
49 utility builds a set of system configuration files from the file
52 the system to configure.
56 what files are needed to generate a system and
57 can be augmented by configuration specific set of files
58 that give alternate files for a specific machine
63 Available options and operands:
64 .Bl -tag -width "SYSTEM_NAME"
70 If the INCLUDE_CONFIG_FILE is present in a configuration file,
71 kernel image will contain full configuration files included
72 literally (preserving comments).
73 This flag is kept for backward compatibility.
77 for any file included by the
80 This option may be specified more than once.
84 as the output directory, instead of the default one.
89 to the directory given.
93 as the source directory, instead of the default one.
95 Print the MACHINE and MACHINE_ARCH values for this
98 Configure a system for debugging.
100 Print kernel configuration file embedded into a kernel
102 This option makes sense only if
103 .Cd "options INCLUDE_CONFIG_FILE"
104 entry was present in your configuration file.
106 Configure a system for profiling; for example,
112 options are supplied,
114 configures a system for high resolution profiling.
116 Specify the name of the system configuration file
117 containing device specifications, configuration options
118 and other system parameters for one system configuration.
123 utility should be run from the
125 subdirectory of the system source (usually
126 .Pa /sys/ Ns Va ARCH Ns Pa /conf ) ,
129 represents one of the architectures supported by
133 utility creates the directory
134 .Pa ../compile/ Ns Ar SYSTEM_NAME
135 or the one given with the
138 as necessary and places all output files there.
141 consists of a number of files; for the
147 in building the system;
150 the number of various devices that will be compiled into the system.
154 utility looks for kernel sources in the directory
156 or the one given with the
162 it is necessary to run
164 in the directory where the new makefile
168 utility prints a reminder of this when it completes.
170 If any other error messages are produced by
172 the problems in the configuration file should be corrected and
175 Attempts to compile a system that had configuration errors
180 kernels are compiled without symbols due to the heavy load on the
181 system when compiling a
184 A debug kernel contains complete symbols for all the source files, and
185 enables an experienced kernel programmer to analyse the cause of a problem.
187 debuggers available prior to
189 were able to find some information
190 from a normal kernel;
192 provides very little support for normal kernels, and a debug kernel is needed
193 for any meaningful analysis.
195 For reasons of history, time and space, building a debug kernel is not the
198 a debug kernel takes up to 30% longer to build and
199 requires about 30 MB of disk storage in the build directory, compared to about 6
200 MB for a non-debug kernel.
201 A debug kernel is about 11 MB in size, compared to
202 about 2 MB for a non-debug kernel.
203 This space is used both in the root file
204 system and at run time in memory.
207 option to build a debug kernel.
210 causes two kernel files to be built in the kernel build directory:
214 is the complete debug kernel.
217 is a copy of the kernel with the debug symbols stripped off.
219 to the normal non-debug kernel.
222 There is currently little sense in installing and booting from a debug kernel,
223 since the only tools available which use the symbols do not run on-line.
225 are therefore two options for installing a debug kernel:
228 .Dq Li "make install"
231 in the root file system.
233 .Dq Li "make install.debug"
236 in the root file system.
239 .Bl -tag -width "/sys/ARCH/compile/SYSTEM_NAME" -compact
240 .It Pa /sys/conf/files
241 list of common files system is built from
242 .It Pa /sys/conf/Makefile . Ns Va ARCH
243 generic makefile for the
245 .It Pa /sys/conf/files . Ns Va ARCH
249 .It Pa /sys/ Ns Va ARCH Ns Pa /compile/ Ns Ar SYSTEM_NAME
250 default kernel build directory for system
260 portion of each device in section 4.
262 .%T "Building 4.3 BSD UNIX System with Config"
273 .Cd "options INCLUDE_CONFIG_FILE"
274 included entire configuration file that used to be embedded in
278 could be used to extract it from a kernel:
279 to extract the configuration information, you had to use
282 .Dl "strings -n 3 kernel | sed -n 's/^___//p'"
284 The line numbers reported in error messages are usually off by one.