| 1 | .\" Copyright (c) 1980, 1991 The Regents of the University of California. |
| 2 | .\" 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 | .\" from: @(#)config.8 6.5 (Berkeley) 3/16/91 |
| 33 | .\" $Id: config.8,v 1.6 1993/08/07 07:53:27 cgd Exp $ |
| 34 | .\" |
| 35 | .Dd March 16, 1991 |
| 36 | .Dt CONFIG 8 |
| 37 | .Os BSD 4 |
| 38 | .Sh NAME |
| 39 | .Nm config |
| 40 | .Nd build system configuration files |
| 41 | .Sh SYNOPSIS |
| 42 | .Nm config |
| 43 | .Op Fl gp |
| 44 | .Ar SYSTEM_NAME |
| 45 | .Sh DESCRIPTION |
| 46 | .Pp |
| 47 | .Nm Config |
| 48 | builds a set of system configuration files from the file |
| 49 | .Ar SYSTEM_NAME |
| 50 | which describes |
| 51 | the system to configure. |
| 52 | A second file |
| 53 | tells |
| 54 | .Nm config |
| 55 | what files are needed to generate a system and |
| 56 | can be augmented by configuration specific set of files |
| 57 | that give alternate files for a specific machine. |
| 58 | (see the |
| 59 | .Sx FILES |
| 60 | section below) |
| 61 | .Pp |
| 62 | Available option and operand: |
| 63 | .Pp |
| 64 | .Bl -tag -width SYSTEM_NAME |
| 65 | .It Fl g |
| 66 | If the |
| 67 | .Fl g |
| 68 | option is supplied, |
| 69 | .Nm config |
| 70 | will configure a system for debugging. |
| 71 | .It Fl p |
| 72 | If the |
| 73 | .Fl p |
| 74 | option is supplied, |
| 75 | .Nm config |
| 76 | will configure a system for profiling; for example, |
| 77 | .Xr kgmon 8 |
| 78 | and |
| 79 | .Xr gprof 1 . |
| 80 | |
| 81 | .It Ar SYSTEM_NAME |
| 82 | specifies the name of the system configuration file |
| 83 | containing device specifications, configuration options |
| 84 | and other system parameters for one system configuration. |
| 85 | .El |
| 86 | .Pp |
| 87 | .Nm Config |
| 88 | should be run from the |
| 89 | .Pa conf |
| 90 | subdirectory of the system source (usually |
| 91 | .Pa /sys/ARCH/conf ) . |
| 92 | .Nm Config |
| 93 | assumes the directory |
| 94 | .Pa ../../compile/SYSTEM_NAME |
| 95 | exists and places all output files there. |
| 96 | The output of |
| 97 | .Nm config |
| 98 | consists of a number of files; for the |
| 99 | .Tn i386 , |
| 100 | they are: |
| 101 | .Pa ioconf.c , |
| 102 | a description |
| 103 | of what I/O devices are attached to the system; |
| 104 | .Pa vector.s , |
| 105 | a set of interrupt service routines for devices |
| 106 | attached to the bus plus |
| 107 | offsets into a structure used for counting per-device interrupts; |
| 108 | .Pa Makefile , |
| 109 | used by |
| 110 | .Xr make 1 |
| 111 | in building the system; |
| 112 | header files, |
| 113 | definitions of |
| 114 | the number of various devices that will be compiled into the system; |
| 115 | swap configuration files, |
| 116 | definitions for |
| 117 | the disk areas to be used for swapping, the root file system, |
| 118 | argument processing, and system dumps. |
| 119 | .Pp |
| 120 | After running |
| 121 | .Nm config , |
| 122 | it is necessary to run |
| 123 | .Dq Li make depend |
| 124 | in the directory where the new makefile |
| 125 | was created. |
| 126 | .Nm Config |
| 127 | prints a reminder of this when it completes. |
| 128 | .Pp |
| 129 | If any other error messages are produced by |
| 130 | .Nm config , |
| 131 | the problems in the configuration file should be corrected and |
| 132 | .Nm config |
| 133 | should be run again. |
| 134 | Attempts to compile a system that had configuration errors |
| 135 | are likely to fail. |
| 136 | .Sh FILES |
| 137 | .Bl -tag -width /sys/i386/conf/Makefile.i386 -compact |
| 138 | .It Pa /sys/conf/files |
| 139 | list of common files system is built from |
| 140 | .It Pa /sys/i386/conf/Makefile.i386 |
| 141 | generic makefile for the |
| 142 | .Tn i386 |
| 143 | .It Pa /sys/i386/conf/files.i386 |
| 144 | list of |
| 145 | .Tn i386 |
| 146 | specific files |
| 147 | .It Pa /sys/i386/conf/devices.i386 |
| 148 | name to major device mapping file for the |
| 149 | .Tn i386 |
| 150 | .It Pa /sys/i386/conf/files. Ns Em ERNIE |
| 151 | list of files specific to |
| 152 | .Em ERNIE |
| 153 | system |
| 154 | .El |
| 155 | .Sh SEE ALSO |
| 156 | The SYNOPSIS portion of each device in section 4. |
| 157 | .Rs |
| 158 | .%T "Building 4.3 BSD UNIX System with Config" |
| 159 | .Re |
| 160 | .Sh BUGS |
| 161 | The line numbers reported in error messages are usually off by one. |
| 162 | .Sh HISTORY |
| 163 | The |
| 164 | .Nm |
| 165 | command appeared in |
| 166 | .Bx 4.1 . |