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
48 utility builds a set of system configuration files from the file
51 the system to configure.
55 what files are needed to generate a system and
56 can be augmented by configuration specific set of files
57 that give alternate files for a specific machine
62 Available options and operands:
63 .Bl -tag -width ".Ar SYSTEM_NAME"
69 If the INCLUDE_CONFIG_FILE is present in a configuration file,
70 kernel image will contain full configuration files included
71 literally (preserving comments).
72 This flag is kept for backward compatibility.
76 for any file included by the
78 directive. This option may be specified more than once.
82 as the output directory, instead of the default one.
87 to the directory given.
89 Print the MACHINE and MACHINE_ARCH values for this
92 Configure a system for debugging.
94 Print kernel configuration file embedded into a kernel
96 This option makes sense only if
97 .Cd "options INCLUDE_CONFIG_FILE"
98 entry was present in your configuration file.
100 Configure a system for profiling; for example,
106 options are supplied,
108 configures a system for high resolution profiling.
110 Specify the name of the system configuration file
111 containing device specifications, configuration options
112 and other system parameters for one system configuration.
117 utility should be run from the
119 subdirectory of the system source (usually
120 .Pa /sys/ Ns Va ARCH Ns Pa /conf ) ,
123 represents one of the architectures supported by
127 utility creates the directory
128 .Pa ../compile/ Ns Ar SYSTEM_NAME
129 or the one given with the
132 as necessary and places all output files there.
135 consists of a number of files; for the
141 in building the system;
144 the number of various devices that will be compiled into the system.
148 it is necessary to run
150 in the directory where the new makefile
154 utility prints a reminder of this when it completes.
156 If any other error messages are produced by
158 the problems in the configuration file should be corrected and
161 Attempts to compile a system that had configuration errors
166 kernels are compiled without symbols due to the heavy load on the
167 system when compiling a
170 A debug kernel contains complete symbols for all the source files, and
171 enables an experienced kernel programmer to analyse the cause of a problem.
173 debuggers available prior to
175 were able to find some information
176 from a normal kernel;
178 provides very little support for normal kernels, and a debug kernel is needed
179 for any meaningful analysis.
181 For reasons of history, time and space, building a debug kernel is not the
184 a debug kernel takes up to 30% longer to build and
185 requires about 30 MB of disk storage in the build directory, compared to about 6
186 MB for a non-debug kernel.
187 A debug kernel is about 11 MB in size, compared to
188 about 2 MB for a non-debug kernel.
189 This space is used both in the root file
190 system and at run time in memory.
193 option to build a debug kernel.
196 causes two kernel files to be built in the kernel build directory:
200 is the complete debug kernel.
203 is a copy of the kernel with the debug symbols stripped off.
205 to the normal non-debug kernel.
208 There is currently little sense in installing and booting from a debug kernel,
209 since the only tools available which use the symbols do not run on-line.
211 are therefore two options for installing a debug kernel:
214 .Dq Li "make install"
217 in the root file system.
219 .Dq Li "make install.debug"
222 in the root file system.
225 .Bl -tag -width ".Pa /sys/ Ns Va ARCH Ns Pa /compile/ Ns Ar SYSTEM_NAME" -compact
226 .It Pa /sys/conf/files
227 list of common files system is built from
228 .It Pa /sys/conf/Makefile. Ns Va ARCH
229 generic makefile for the
231 .It Pa /sys/conf/files. Ns Va ARCH
235 .It Pa /sys/ Ns Va ARCH Ns Pa /compile/ Ns Ar SYSTEM_NAME
236 default kernel build directory for system
246 portion of each device in section 4.
248 .%T "Building 4.3 BSD UNIX System with Config"
259 .Cd "options INCLUDE_CONFIG_FILE"
260 included entire configuration file that used to be embedded in
264 could be used to extract it from a kernel:
265 to extract the configuration information, you had to use
268 .Dl "strings -n 3 kernel | sed -n 's/^___//p'"
270 The line numbers reported in error messages are usually off by one.