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