1.\" Copyright (c) 1980, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 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. 15.\" 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 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)config.8 8.2 (Berkeley) 4/19/94 29.\" $FreeBSD$ 30.\" 31.Dd June 29, 2020 32.Dt CONFIG 8 33.Os 34.Sh NAME 35.Nm config 36.Nd build system configuration files 37.Sh SYNOPSIS 38.Nm 39.Op Fl CVgp 40.Op Fl I Ar path 41.Op Fl d Ar destdir 42.Op Fl s Ar srcdir 43.Ar SYSTEM_NAME 44.Nm 45.Op Fl x Ar kernel 46.Sh DESCRIPTION 47The 48.Nm 49utility builds a set of system configuration files from the file 50.Ar SYSTEM_NAME 51which describes 52the system to configure. 53A second file 54tells 55.Nm 56what files are needed to generate a system and 57can be augmented by configuration specific set of files 58that give alternate files for a specific machine 59(see the 60.Sx FILES 61section below). 62.Pp 63Available options and operands: 64.Bl -tag -width "SYSTEM_NAME" 65.It Fl V 66Print the 67.Nm 68version number. 69.It Fl C 70If the INCLUDE_CONFIG_FILE is present in a configuration file, 71kernel image will contain full configuration files included 72literally (preserving comments). 73This flag is kept for backward compatibility. 74.It Fl I Ar path 75Search in 76.Ar path 77for any file included by the 78.Ic include 79directive. 80This option may be specified more than once. 81.It Fl d Ar destdir 82Use 83.Ar destdir 84as the output directory, instead of the default one. 85Note that 86.Nm 87does not append 88.Ar SYSTEM_NAME 89to the directory given. 90.It Fl s Ar srcdir 91Use 92.Ar srcdir 93as the source directory, instead of the default one. 94.It Fl m 95Print the MACHINE and MACHINE_ARCH values for this 96kernel and exit. 97.It Fl g 98Configure a system for debugging. 99.It Fl x Ar kernel 100Print kernel configuration file embedded into a kernel 101file. 102This option makes sense only if 103.Cd "options INCLUDE_CONFIG_FILE" 104entry was present in your configuration file. 105.It Fl p 106Configure a system for profiling; for example, 107.Xr kgmon 8 108and 109.Xr gprof 1 . 110If two or more 111.Fl p 112options are supplied, 113.Nm 114configures a system for high resolution profiling. 115.It Ar SYSTEM_NAME 116Specify the name of the system configuration file 117containing device specifications, configuration options 118and other system parameters for one system configuration. 119.El 120.Pp 121The 122.Nm 123utility should be run from the 124.Pa conf 125subdirectory of the system source (usually 126.Pa /sys/ Ns Va ARCH Ns Pa /conf ) , 127where 128.Va ARCH 129represents one of the architectures supported by 130.Fx . 131The 132.Nm 133utility creates the directory 134.Pa ../compile/ Ns Ar SYSTEM_NAME 135or the one given with the 136.Fl d 137option 138as necessary and places all output files there. 139The output of 140.Nm 141consists of a number of files; for the 142.Tn i386 , 143they are: 144.Pa Makefile , 145used by 146.Xr make 1 147in building the system; 148header files, 149definitions of 150the number of various devices that will be compiled into the system. 151.Pp 152The 153.Nm 154utility looks for kernel sources in the directory 155.Pa ../.. 156or the one given with the 157.Fl s 158option. 159.Pp 160After running 161.Nm , 162it is necessary to run 163.Dq Li make depend 164in the directory where the new makefile 165was created. 166The 167.Nm 168utility prints a reminder of this when it completes. 169.Pp 170If any other error messages are produced by 171.Nm , 172the problems in the configuration file should be corrected and 173.Nm 174should be run again. 175Attempts to compile a system that had configuration errors 176are likely to fail. 177.Sh DEBUG KERNELS 178Traditional 179.Bx 180kernels are compiled without symbols due to the heavy load on the 181system when compiling a 182.Dq debug 183kernel. 184A debug kernel contains complete symbols for all the source files, and 185enables an experienced kernel programmer to analyse the cause of a problem. 186The 187debuggers available prior to 188.Bx 4.4 Lite 189were able to find some information 190from a normal kernel; 191.Xr gdb 1 192provides very little support for normal kernels, and a debug kernel is needed 193for any meaningful analysis. 194.Pp 195For reasons of history, time and space, building a debug kernel is not the 196default with 197.Fx : 198a debug kernel takes up to 30% longer to build and 199requires about 30 MB of disk storage in the build directory, compared to about 6 200MB for a non-debug kernel. 201A debug kernel is about 11 MB in size, compared to 202about 2 MB for a non-debug kernel. 203This space is used both in the root file 204system and at run time in memory. 205Use the 206.Fl g 207option to build a debug kernel. 208With this option, 209.Nm 210causes two kernel files to be built in the kernel build directory: 211.Bl -bullet 212.It 213.Pa kernel.debug 214is the complete debug kernel. 215.It 216.Pa kernel 217is a copy of the kernel with the debug symbols stripped off. 218This is equivalent 219to the normal non-debug kernel. 220.El 221.Pp 222There is currently little sense in installing and booting from a debug kernel, 223since the only tools available which use the symbols do not run on-line. 224There 225are therefore two options for installing a debug kernel: 226.Bl -bullet 227.It 228.Dq Li "make install" 229installs 230.Pa kernel 231in the root file system. 232.It 233.Dq Li "make install.debug" 234installs 235.Pa kernel.debug 236in the root file system. 237.El 238.Sh FILES 239.Bl -tag -width "/sys/ARCH/compile/SYSTEM_NAME" -compact 240.It Pa /sys/conf/files 241list of common files system is built from 242.It Pa /sys/conf/Makefile . Ns Va ARCH 243generic makefile for the 244.Va ARCH 245.It Pa /sys/conf/files . Ns Va ARCH 246list of 247.Va ARCH 248specific files 249.It Pa /sys/ Ns Va ARCH Ns Pa /compile/ Ns Ar SYSTEM_NAME 250default kernel build directory for system 251.Ar SYSTEM_NAME 252on 253.Va ARCH . 254.El 255.Sh SEE ALSO 256.Xr config 5 257.Pp 258The 259.Sx SYNOPSIS 260portion of each device in section 4. 261.Rs 262.%T "Building 4.3 BSD UNIX System with Config" 263.Re 264.Sh HISTORY 265The 266.Nm 267utility appeared in 268.Bx 4.1 . 269.Pp 270Before support for 271.Fl x 272was introduced, 273.Cd "options INCLUDE_CONFIG_FILE" 274included entire configuration file that used to be embedded in 275the new kernel. 276This meant that 277.Xr strings 1 278could be used to extract it from a kernel: 279to extract the configuration information, you had to use 280the command: 281.Pp 282.Dl "strings -n 3 kernel | sed -n 's/^___//p'" 283.Sh BUGS 284The line numbers reported in error messages are usually off by one. 285