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 April 9, 2021
  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 Ar SYSTEM_NAME
 106 Specify the name of the system configuration file
 107 containing device specifications, configuration options
 108 and other system parameters for one system configuration.
 109 .El
 110 .Pp
 111 The
 112 .Nm
 113 utility should be run from the
 114 .Pa conf
 115 subdirectory of the system source (usually
 116 .Pa /sys/ Ns Va ARCH Ns Pa /conf ) ,
 117 where
 118 .Va ARCH
 119 represents one of the architectures supported by
 120 .Fx .
 121 The
 122 .Nm
 123 utility creates the directory
 124 .Pa ../compile/ Ns Ar SYSTEM_NAME
 125 or the one given with the
 126 .Fl d
 127 option
 128 as necessary and places all output files there.
 129 The output of
 130 .Nm
 131 consists of a number of files; for the
 132 .Tn i386 ,
 133 they are:
 134 .Pa Makefile ,
 135 used by
 136 .Xr make 1
 137 in building the system;
 138 header files,
 139 definitions of
 140 the number of various devices that will be compiled into the system.
 141 .Pp
 142 The
 143 .Nm
 144 utility looks for kernel sources in the directory
 145 .Pa ../..
 146 or the one given with the
 147 .Fl s
 148 option.
 149 .Pp
 150 After running
 151 .Nm ,
 152 it is necessary to run
 153 .Dq Li make depend
 154 in the directory where the new makefile
 155 was created.
 156 The
 157 .Nm
 158 utility prints a reminder of this when it completes.
 159 .Pp
 160 If any other error messages are produced by
 161 .Nm ,
 162 the problems in the configuration file should be corrected and
 163 .Nm
 164 should be run again.
 165 Attempts to compile a system that had configuration errors
 166 are likely to fail.
 167 .Sh DEBUG KERNELS
 168 Traditional
 169 .Bx
 170 kernels are compiled without symbols due to the heavy load on the
 171 system when compiling a
 172 .Dq debug
 173 kernel.
 174 A debug kernel contains complete symbols for all the source files, and
 175 enables an experienced kernel programmer to analyse the cause of a problem.
 176 The
 177 debuggers available prior to
 178 .Bx 4.4 Lite
 179 were able to find some information
 180 from a normal kernel;
 181 .Xr gdb 1
 182 provides very little support for normal kernels, and a debug kernel is needed
 183 for any meaningful analysis.
 184 .Pp
 185 For reasons of history, time and space, building a debug kernel is not the
 186 default with
 187 .Fx :
 188 a debug kernel takes up to 30% longer to build and
 189 requires about 30 MB of disk storage in the build directory, compared to about 6
 190 MB for a non-debug kernel.
 191 A debug kernel is about 11 MB in size, compared to
 192 about 2 MB for a non-debug kernel.
 193 This space is used both in the root file
 194 system and at run time in memory.
 195 Use the
 196 .Fl g
 197 option to build a debug kernel.
 198 With this option,
 199 .Nm
 200 causes two kernel files to be built in the kernel build directory:
 201 .Bl -bullet
 202 .It
 203 .Pa kernel.debug
 204 is the complete debug kernel.
 205 .It
 206 .Pa kernel
 207 is a copy of the kernel with the debug symbols stripped off.
 208 This is equivalent
 209 to the normal non-debug kernel.
 210 .El
 211 .Pp
 212 There is currently little sense in installing and booting from a debug kernel,
 213 since the only tools available which use the symbols do not run on-line.
 214 There
 215 are therefore two options for installing a debug kernel:
 216 .Bl -bullet
 217 .It
 218 .Dq Li "make install"
 219 installs
 220 .Pa kernel
 221 in the root file system.
 222 .It
 223 .Dq Li "make install.debug"
 224 installs
 225 .Pa kernel.debug
 226 in the root file system.
 227 .El
 228 .Sh FILES
 229 .Bl -tag -width "/sys/ARCH/compile/SYSTEM_NAME" -compact
 230 .It Pa /sys/conf/files
 231 list of common files system is built from
 232 .It Pa /sys/conf/Makefile . Ns Va ARCH
 233 generic makefile for the
 234 .Va ARCH
 235 .It Pa /sys/conf/files . Ns Va ARCH
 236 list of
 237 .Va ARCH
 238 specific files
 239 .It Pa /sys/ Ns Va ARCH Ns Pa /compile/ Ns Ar SYSTEM_NAME
 240 default kernel build directory for system
 241 .Ar SYSTEM_NAME
 242 on
 243 .Va ARCH .
 244 .El
 245 .Sh SEE ALSO
 246 .Xr config 5
 247 .Pp
 248 The
 249 .Sx SYNOPSIS
 250 portion of each device in section 4.
 251 .Rs
 252 .\" 4.4BSD SMM:2
 253 .%A S. J. Leffler
 254 .%A M. J. Karels
 255 .%T "Building 4.3 BSD UNIX System with Config"
 256 .%B 4.4BSD System Manager's Manual (SMM)
 257 .Re
 258 .Sh HISTORY
 259 The
 260 .Nm
 261 utility appeared in
 262 .Bx 4.1 .
 263 .Pp
 264 Before support for
 265 .Fl x
 266 was introduced,
 267 .Cd "options INCLUDE_CONFIG_FILE"
 268 included entire configuration file that used to be embedded in
 269 the new kernel.
 270 This meant that
 271 .Xr strings 1
 272 could be used to extract it from a kernel:
 273 to extract the configuration information, you had to use
 274 the command:
 275 .Pp
 276 .Dl "strings -n 3 kernel | sed -n 's/^___//p'"
 277 .Sh BUGS
 278 The line numbers reported in error messages are usually off by one.