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 .\" 4. 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
47 utility builds a set of system configuration files from the file
50 the system to configure.
54 what files are needed to generate a system and
55 can be augmented by configuration specific set of files
56 that give alternate files for a specific machine
61 Available options and operands:
62 .Bl -tag -width ".Ar SYSTEM_NAME"
68 If the INCLUDE_CONFIG_FILE is present in a configuration file,
69 kernel image will contain full configuration files included
70 literally (preserving comments).
71 This flag is kept for backward compatibility.
75 as the output directory, instead of the default one.
80 to the directory given.
82 Print the MACHINE and MACHINE_ARCH values for this
85 Configure a system for debugging.
87 Print kernel configuration file embedded into a kernel
89 This option makes sense only if
90 .Cd "options INCLUDE_CONFIG_FILE"
91 entry was present in your configuration file.
93 Configure a system for profiling; for example,
101 configures a system for high resolution profiling.
103 Specify the name of the system configuration file
104 containing device specifications, configuration options
105 and other system parameters for one system configuration.
110 utility should be run from the
112 subdirectory of the system source (usually
113 .Pa /sys/ Ns Va ARCH Ns Pa /conf ) ,
116 represents one of the architectures supported by
120 utility creates the directory
121 .Pa ../compile/ Ns Ar SYSTEM_NAME
122 or the one given with the
125 as necessary and places all output files there.
128 consists of a number of files; for the
134 in building the system;
137 the number of various devices that will be compiled into the system.
141 it is necessary to run
143 in the directory where the new makefile
147 utility prints a reminder of this when it completes.
149 If any other error messages are produced by
151 the problems in the configuration file should be corrected and
154 Attempts to compile a system that had configuration errors
159 kernels are compiled without symbols due to the heavy load on the
160 system when compiling a
163 A debug kernel contains complete symbols for all the source files, and
164 enables an experienced kernel programmer to analyse the cause of a problem.
166 debuggers available prior to
168 were able to find some information
169 from a normal kernel;
171 provides very little support for normal kernels, and a debug kernel is needed
172 for any meaningful analysis.
174 For reasons of history, time and space, building a debug kernel is not the
177 a debug kernel takes up to 30% longer to build and
178 requires about 30 MB of disk storage in the build directory, compared to about 6
179 MB for a non-debug kernel.
180 A debug kernel is about 11 MB in size, compared to
181 about 2 MB for a non-debug kernel.
182 This space is used both in the root file
183 system and at run time in memory.
186 option to build a debug kernel.
189 causes two kernel files to be built in the kernel build directory:
193 is the complete debug kernel.
196 is a copy of the kernel with the debug symbols stripped off.
198 to the normal non-debug kernel.
201 There is currently little sense in installing and booting from a debug kernel,
202 since the only tools available which use the symbols do not run on-line.
204 are therefore two options for installing a debug kernel:
207 .Dq Li "make install"
210 in the root file system.
212 .Dq Li "make install.debug"
215 in the root file system.
218 .Bl -tag -width ".Pa /sys/ Ns Va ARCH Ns Pa /compile/ Ns Ar SYSTEM_NAME" -compact
219 .It Pa /sys/conf/files
220 list of common files system is built from
221 .It Pa /sys/conf/Makefile. Ns Va ARCH
222 generic makefile for the
224 .It Pa /sys/conf/files. Ns Va ARCH
228 .It Pa /sys/ Ns Va ARCH Ns Pa /compile/ Ns Ar SYSTEM_NAME
229 default kernel build directory for system
239 portion of each device in section 4.
241 .%T "Building 4.3 BSD UNIX System with Config"
252 .Cd "options INCLUDE_CONFIG_FILE"
253 included entire configuration file that used to be embedded in
257 could be used to extract it from a kernel:
258 to extract the configuration information, you had to use
261 .Dl "strings -n 3 kernel | sed -n 's/^___//p'"
263 The line numbers reported in error messages are usually off by one.