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: src/usr.sbin/config/config.8,v 1.21.2.7 2003/04/23 07:32:39 brueffer Exp $
  30 .\"
  31 .Dd January 5, 2019
  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 gr
  40 .Op Fl d Ar destdir
  41 .Ar SYSTEM_NAME
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 utility builds a set of system configuration files from the file
  46 .Ar SYSTEM_NAME
  47 which describes
  48 the system to configure.
  49 A second file
  50 tells
  51 .Nm
  52 what files are needed to generate a system and
  53 can be augmented by configuration specific set of files
  54 that give alternate files for a specific machine
  55 (see the
  56 .Sx FILES
  57 section below).
  58 .Pp
  59 Available options and operands:
  60 .Bl -tag -width ".Ar SYSTEM_NAME"
  61 .It Fl d Ar destdir
  62 Use
  63 .Ar destdir
  64 as the output directory, instead of the default one.
  65 Note that
  66 .Nm
  67 does not append
  68 .Ar SYSTEM_NAME
  69 to the directory given.
  70 .It Fl g
  71 Configure a system for debugging.
  72 .It Fl r
  73 Remove the old compile directory (see below).
  74 .It Ar SYSTEM_NAME
  75 Specify the name of the system configuration file
  76 containing device specifications, configuration options
  77 and other system parameters for one system configuration.
  78 .El
  79 .Pp
  80 .Nm
  81 should be run from the
  82 .Pa config
  83 subdirectory of the system source (usually
  84 .Pa /sys/config ) .
  85 .Nm
  86 creates the directory
  87 .Pa ../compile/ Ns Ar SYSTEM_NAME
  88 or the one given with the
  89 .Fl d
  90 option
  91 as necessary and places all output files there.
  92 If the output directory already exists and the
  93 .Fl r
  94 flag was specified, it will be removed first.
  95 The output of
  96 .Nm
  97 consists of a number of files; for the
  98 .Tn x86_64
  99 architecture, they are:
 100 .Pa ioconf.c ,
 101 a description
 102 of what I/O devices are attached to the system;
 103 .Pa Makefile ,
 104 used by
 105 .Xr make 1
 106 in building the system;
 107 header files,
 108 definitions of
 109 the number of various devices that will be compiled into the system.
 110 .Pp
 111 After running
 112 .Nm ,
 113 it is necessary to run
 114 .Dq Li make depend
 115 in the directory where the new makefile
 116 was created.
 117 .Pp
 118 If any other error messages are produced by
 119 .Nm ,
 120 the problems in the configuration file should be corrected and
 121 .Nm
 122 should be run again.
 123 Attempts to compile a system that had configuration errors
 124 are likely to fail.
 125 .Pp
 126 If the
 127 .Cd "options INCLUDE_CONFIG_FILE"
 128 is used in the configuration file the
 129 entire input file is embedded in the new kernel.
 130 This means that
 131 .Xr strings 1
 132 can be used to extract it from a kernel:
 133 to extract the configuration information, use the command
 134 .Pp
 135 .Dl "strings -n 3 kernel | sed -n 's/^___//p'"
 136 .Sh DEBUG KERNELS
 137 Traditional
 138 .Bx
 139 kernels are compiled without symbols due to the heavy load on the
 140 system when compiling a
 141 .Dq debug
 142 kernel.
 143 A debug kernel contains complete symbols for all the source files, and
 144 enables an experienced kernel programmer to analyse the cause of a problem.
 145 The
 146 debuggers available prior to
 147 .Bx 4.4 Lite
 148 were able to find some information
 149 from a normal kernel;
 150 .Xr kgdb 1
 151 provides very little support for normal kernels, and a debug kernel is needed
 152 for any meaningful analysis.
 153 .Pp
 154 In order to ease posting bug reports for inexperienced users and
 155 make the debugging environment more uniform,
 156 .Dx
 157 installs kernel and modules unstripped.
 158 Debug information is not loaded into memory, so the only impact is
 159 a growth in root file-system consumption by 60MB.
 160 Those wishing to install stripped down kernel and modules can specify two new
 161 makeoptions in their kernel config file or when they run the
 162 kernel-related targets to make:
 163 .Bl -tag -width ".Va INSTALLSTRIPPEDMODULES=1"
 164 .It Va INSTALLSTRIPPED=1
 165 The installed kernel and modules will be stripped of debug info.
 166 .It Va INSTALLSTRIPPEDMODULES=1
 167 The installed modules will be stripped of debug info. The kernel will
 168 be left with debug info intact.
 169 .El
 170 .Pp
 171 Backup copies of the kernel and modules are automatically stripped of
 172 their debug information by
 173 .Xr objcopy 1 ,
 174 unless
 175 .Va NO_KERNEL_OLD_STRIP
 176 is set in
 177 .Xr make.conf 5 .
 178 .Sh FILES
 179 .Bl -tag -width ".It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/Makefile" -compact
 180 .It Pa /sys/conf/files
 181 list of common files system is built from
 182 .It Pa /sys/config/ Ns Ar SYSTEM_NAME
 183 default location for kernel configuration file
 184 .It Pa /sys/config/LINT64
 185 kernel configuration file for checking all the sources,
 186 includes description of kernel configuration options
 187 .It Pa /sys/config/VKERNEL64
 188 default 64 bit
 189 .Xr vkernel 7
 190 kernel configuration file
 191 .It Pa /sys/config/X86_64_GENERIC
 192 default
 193 .Sy x86_64
 194 kernel configuration file
 195 .It Pa /sys/compile/ Ns Ar SYSTEM_NAME
 196 default kernel build directory for system
 197 .Ar SYSTEM_NAME
 198 .It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/Makefile
 199 generic makefile for the
 200 .Va PLATFORM
 201 .It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/files
 202 list of
 203 .Va PLATFORM
 204 specific files
 205 .El
 206 .Sh SEE ALSO
 207 .Xr gprof 1 ,
 208 .Xr kgdb 1 ,
 209 .Xr make 1 ,
 210 .Xr kernconf 5 ,
 211 .Xr build 7 ,
 212 .Xr vkernel 7
 213 .Pp
 214 The
 215 .Sx SYNOPSIS
 216 portion of each device in section 4.
 217 .Rs
 218 .%T "Building 4.3 BSD UNIX System with Config"
 219 .Re
 220 .Sh HISTORY
 221 The
 222 .Nm
 223 utility appeared in
 224 .Bx 4.1 .
 225 .Sh BUGS
 226 The line numbers reported in error messages are usually off by one.