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. 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. 19.\" 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 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)config.8 8.2 (Berkeley) 4/19/94 33.\" $FreeBSD$ 34.\" 35.Dd April 19, 1994 36.Dt CONFIG 8 37.Os BSD 4 38.Sh NAME 39.Nm config 40.Nd build system configuration files 41.Sh SYNOPSIS 42.Nm config 43.Op Fl gpr 44.Op Fl d Ar destdir 45.Ar SYSTEM_NAME 46.Sh DESCRIPTION 47This is the old version of the 48.Nm 49program. 50It understands the old autoconfiguration scheme 51used on the HP300, i386, DECstation, and derivative platforms. 52The new version of config is used with the 53SPARC platform. 54Only the version of 55.Nm 56applicable to the architecture that you are running 57will be installed on your machine. 58.Pp 59.Nm Config 60builds a set of system configuration files from the file 61.Ar SYSTEM_NAME 62which describes 63the system to configure. 64A second file 65tells 66.Nm 67what files are needed to generate a system and 68can be augmented by configuration specific set of files 69that give alternate files for a specific machine 70(see the 71.Sx FILES 72section below). 73.Pp 74Available options and operands: 75.Bl -tag -width SYSTEM_NAME 76.It Fl d Ar destdir 77Use 78.Ar destdir 79as the output directory, instead of the default one. Note 80that config does not append 81.Ar SYSTEM_NAME 82to the directory given. 83.It Fl g 84Configure a system for debugging. 85.It Fl p 86Configure a system for profiling; for example, 87.Xr kgmon 8 88and 89.Xr gprof 1 . 90If two or more 91.Fl p 92options are supplied, 93.Nm 94configures a system for high resolution profiling. 95.It Fl r 96Remove the old compile directory (see below). 97.It Ar SYSTEM_NAME 98Specify the name of the system configuration file 99containing device specifications, configuration options 100and other system parameters for one system configuration. 101.El 102.Pp 103.Nm Config 104should be run from the 105.Pa conf 106subdirectory of the system source (usually 107.Pa /sys/ARCH/conf ) , 108where 109.Pa ARCH 110represents one of the architectures supported by FreeBSD. 111.Nm Config 112creates the directory 113.Pa ../../compile/SYSTEM_NAME 114or the one given with the 115.Fl d 116option 117as necessary and places all output files there. 118If the output directory already exists and the 119.Fl r 120flag was specified, it will be removed first. 121The output of 122.Nm 123consists of a number of files; for the 124.Tn i386 , 125they are: 126.Pa ioconf.c , 127a description 128of what I/O devices are attached to the system; 129.Pa Makefile , 130used by 131.Xr make 1 132in building the system; 133header files, 134definitions of 135the number of various devices that will be compiled into the system. 136.Pp 137After running 138.Nm Ns , 139it is necessary to run 140.Dq Li make depend 141in the directory where the new makefile 142was created. 143.Nm Config 144prints a reminder of this when it completes. 145.Pp 146If any other error messages are produced by 147.Nm Ns , 148the problems in the configuration file should be corrected and 149.Nm 150should be run again. 151Attempts to compile a system that had configuration errors 152are likely to fail. 153.Pp 154If the option "INCLUDE_CONFIG_FILE" is used in the configuration file the 155entire input file is embedded in the new kernel. This means that 156.Xr strings 1 157can be used to extract it from a kernel: 158to extract the configuration information, use the command 159.Bd -literal 160strings kernel | grep ___ 161.Ed 162.Sh DEBUG KERNELS 163Traditional BSD kernels compiled without symbols due to the heavy load on the 164system when compiling a 165.if n "debug" 166.if t ``debug'' 167kernel. A debug kernel contains complete symbols for all the source files, and 168enables an experienced kernel programmer to analyse the cause of a problem. The 169debuggers available prior to 4.4BSD-Lite were able to find some information 170from a normal kernel; 171.Xr gdb 1 172provides very little support for normal kernels, and a debug kernel is needed 173for any meaningful analysis. 174.Pp 175For reasons of history, time and space, building a debug kernel is not the 176default with FreeBSD: a debug kernel takes up to 30% longer to build and 177requires about 30 MB of disk storage in the build directory, compared to about 6 178MB for a non-debug kernel. A debug kernel is about 11 MB in size, compared to 179about 2 MB for a non-debug kernel. This space is used both in the root file 180system and at run time in memory. Use the 181.Fl g 182option to build a debug kernel. With this option, 183.Nm 184causes two kernel files to be built in the kernel build directory: 185.Bl -bullet 186.It 187.Nm kernel.debug 188is the complete debug kernel. 189.It 190.Nm kernel 191is a copy of the kernel with the debug symbols stripped off. This is equivalent 192to the normal non-debug kernel. 193.El 194.Pp 195There is currently little sense in installing and booting from a debug kernel, 196since the only tools available which use the symbols do not run on-line. There 197are therefore two options for installing a debug kernel: 198.Bl -bullet 199.It 200.Nm make 201.Ar install 202installs 203.Nm kernel 204in the root file system. 205.It 206.Nm make 207.Ar install.debug 208installs 209.Nm kernel.debug 210in the root file system. 211.El 212.Sh FILES 213.Bl -tag -width /sys/i386/conf/Makefile.i386 -compact 214.It Pa /sys/conf/files 215list of common files system is built from 216.It Pa /sys/i386/conf/Makefile.i386 217generic makefile for the 218.Tn i386 219.It Pa /sys/i386/conf/files.i386 220list of 221.Tn i386 222specific files 223.It Pa /sys/i386/conf/files. Ns Em ERNIE 224list of files specific to 225.Em ERNIE 226system 227.It Pa /sys/compile/SYSTEM_NAME 228default kernel build directory for system 229.Pa SYSTEM_NAME . 230.El 231.Sh SEE ALSO 232The 233.Sx SYNOPSIS 234portion of each device in section 4. 235.Rs 236.%T "Building 4.3 BSD UNIX System with Config" 237.Re 238.Sh BUGS 239The line numbers reported in error messages are usually off by one. 240.Sh HISTORY 241The 242.Nm 243command appeared in 244.Bx 4.1 . 245