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. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)config.8 8.2 (Berkeley) 4/19/94
33 .\" $FreeBSD: src/usr.sbin/config/config.8,v 1.21.2.7 2003/04/23 07:32:39 brueffer Exp $
40 .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 ".Ar SYSTEM_NAME"
68 as the output directory, instead of the default one.
73 to the directory given.
75 Configure a system for debugging.
77 Configure a system for profiling; for example,
85 configures a system for high resolution profiling.
87 Remove the old compile directory (see below).
89 Specify the name of the system configuration file
90 containing device specifications, configuration options
91 and other system parameters for one system configuration.
95 should be run from the
97 subdirectory of the system source (usually
100 creates the directory
101 .Pa ../compile/ Ns Ar SYSTEM_NAME
102 or the one given with the
105 as necessary and places all output files there.
106 If the output directory already exists and the
108 flag was specified, it will be removed first.
111 consists of a number of files; for the
116 of what I/O devices are attached to the system;
120 in building the system;
123 the number of various devices that will be compiled into the system.
127 it is necessary to run
129 in the directory where the new makefile
132 If any other error messages are produced by
134 the problems in the configuration file should be corrected and
137 Attempts to compile a system that had configuration errors
141 .Cd "options INCLUDE_CONFIG_FILE"
142 is used in the configuration file the
143 entire input file is embedded in the new kernel.
146 can be used to extract it from a kernel:
147 to extract the configuration information, use the command
149 .Dl "strings -n 3 kernel | sed -n 's/^___//p'"
153 kernels are compiled without symbols due to the heavy load on the
154 system when compiling a
157 A debug kernel contains complete symbols for all the source files, and
158 enables an experienced kernel programmer to analyse the cause of a problem.
160 debuggers available prior to
162 were able to find some information
163 from a normal kernel;
165 provides very little support for normal kernels, and a debug kernel is needed
166 for any meaningful analysis.
168 In order to ease posting bug reports for inexperienced users and
169 make the debugging environment more uniform,
171 installs kernel and modules unstripped.
172 Debug information is not loaded into memory, so the only impact is
173 a growth in root file-system consumption by 60MB.
174 Those wishing to install stripped down kernel and modules can specify two new
175 makeoptions in their kernel config file or when they run the
176 kernel-related targets to make:
177 .Bl -tag -width ".Va INSTALLSTRIPPEDMODULES=1"
178 .It Va INSTALLSTRIPPED=1
179 The installed kernel and modules will be stripped of debug info.
180 .It Va INSTALLSTRIPPEDMODULES=1
181 The installed modules will be stripped of debug info. The kernel will
182 be left with debug info intact.
185 Backup copies of the kernel and modules are automatically stripped of
186 their debug information by
189 .Bl -tag -width ".It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/Makefile" -compact
190 .It Pa /sys/conf/files
191 list of common files system is built from
192 .It Pa /sys/config/ Ns Ar SYSTEM_NAME
193 default location for kernel configuration file
194 .It Pa /sys/config/GENERIC
197 kernel configuration file
198 .It Pa /sys/config/LINT
199 kernel configuration file for checking all the sources,
200 includes description of kernel configuration options
201 .It Pa /sys/config/SOEKRIS
202 kernel configuration file for the
203 .Tn Soekris Engineering net5501
205 .It Pa /sys/config/VKERNEL
208 kernel configuration file
209 .It Pa /sys/config/VKERNEL64
212 kernel configuration file
213 .It Pa /sys/config/X86_64_GENERIC
216 kernel configuration file
217 .It Pa /sys/compile/ Ns Ar SYSTEM_NAME
218 default kernel build directory for system
220 .It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/Makefile
221 generic makefile for the
223 .It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/files
239 portion of each device in section 4.
241 .%T "Building 4.3 BSD UNIX System with Config"
249 The line numbers reported in error messages are usually off by one.