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