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