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 Configure a system for debugging.
84 Print kernel configuration file embedded into a kernel
86 This option makes sense only if
87 .Cd "options INCLUDE_CONFIG_FILE"
88 entry was present in your configuration file.
90 Configure a system for profiling; for example,
98 configures a system for high resolution profiling.
100 Specify the name of the system configuration file
101 containing device specifications, configuration options
102 and other system parameters for one system configuration.
107 utility should be run from the
109 subdirectory of the system source (usually
110 .Pa /sys/ Ns Va ARCH Ns Pa /conf ) ,
113 represents one of the architectures supported by
117 utility creates the directory
118 .Pa ../compile/ Ns Ar SYSTEM_NAME
119 or the one given with the
122 as necessary and places all output files there.
125 consists of a number of files; for the
131 in building the system;
134 the number of various devices that will be compiled into the system.
138 it is necessary to run
140 in the directory where the new makefile
144 utility prints a reminder of this when it completes.
146 If any other error messages are produced by
148 the problems in the configuration file should be corrected and
151 Attempts to compile a system that had configuration errors
156 kernels are compiled without symbols due to the heavy load on the
157 system when compiling a
160 A debug kernel contains complete symbols for all the source files, and
161 enables an experienced kernel programmer to analyse the cause of a problem.
163 debuggers available prior to
165 were able to find some information
166 from a normal kernel;
168 provides very little support for normal kernels, and a debug kernel is needed
169 for any meaningful analysis.
171 For reasons of history, time and space, building a debug kernel is not the
174 a debug kernel takes up to 30% longer to build and
175 requires about 30 MB of disk storage in the build directory, compared to about 6
176 MB for a non-debug kernel.
177 A debug kernel is about 11 MB in size, compared to
178 about 2 MB for a non-debug kernel.
179 This space is used both in the root file
180 system and at run time in memory.
183 option to build a debug kernel.
186 causes two kernel files to be built in the kernel build directory:
190 is the complete debug kernel.
193 is a copy of the kernel with the debug symbols stripped off.
195 to the normal non-debug kernel.
198 There is currently little sense in installing and booting from a debug kernel,
199 since the only tools available which use the symbols do not run on-line.
201 are therefore two options for installing a debug kernel:
204 .Dq Li "make install"
207 in the root file system.
209 .Dq Li "make install.debug"
212 in the root file system.
215 .Bl -tag -width ".Pa /sys/ Ns Va ARCH Ns Pa /compile/ Ns Ar SYSTEM_NAME" -compact
216 .It Pa /sys/conf/files
217 list of common files system is built from
218 .It Pa /sys/conf/Makefile. Ns Va ARCH
219 generic makefile for the
221 .It Pa /sys/conf/files. Ns Va ARCH
225 .It Pa /sys/ Ns Va ARCH Ns Pa /compile/ Ns Ar SYSTEM_NAME
226 default kernel build directory for system
236 portion of each device in section 4.
238 .%T "Building 4.3 BSD UNIX System with Config"
249 .Cd "options INCLUDE_CONFIG_FILE"
250 included entire configuration file that used to be embedded in
254 could be used to extract it from a kernel:
255 to extract the configuration information, you had to use
258 .Dl "strings -n 3 kernel | sed -n 's/^___//p'"
260 The line numbers reported in error messages are usually off by one.