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