usr.sbin/config/config.8

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