Commit | Line | Data |
---|---|---|
15637ed4 RG |
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 | .\" | |
1419e6d4 | 32 | .\" from: @(#)config.8 6.5 (Berkeley) 3/16/91 |
9f5e3574 | 33 | .\" $Id: config.8,v 1.2 1993/09/26 23:11:06 rgrimes Exp $ |
15637ed4 RG |
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 | |
1419e6d4 | 43 | .Op Fl gp |
15637ed4 RG |
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 | |
1419e6d4 RG |
65 | .It Fl g |
66 | If the | |
67 | .Fl g | |
68 | option is supplied, | |
69 | .Nm config | |
70 | will configure a system for debugging. | |
15637ed4 RG |
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 . | |
1419e6d4 | 80 | |
15637ed4 RG |
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 | |
1419e6d4 | 91 | .Pa /sys/ARCH/conf ) . |
15637ed4 RG |
92 | .Nm Config |
93 | assumes the directory | |
1419e6d4 | 94 | .Pa ../../compile/SYSTEM_NAME |
15637ed4 RG |
95 | exists and places all output files there. |
96 | The output of | |
97 | .Nm config | |
98 | consists of a number of files; for the | |
1419e6d4 | 99 | .Tn i386 , |
15637ed4 RG |
100 | they are: |
101 | .Pa ioconf.c , | |
102 | a description | |
103 | of what I/O devices are attached to the system; | |
1419e6d4 | 104 | .Pa vector.s , |
15637ed4 | 105 | a set of interrupt service routines for devices |
1419e6d4 | 106 | attached to the bus plus |
15637ed4 RG |
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. | |
9f5e3574 PHK |
136 | .Pp |
137 | The entire input file is embedded in the new kernel. This means that | |
138 | .Xr strings 1 | |
139 | can be used to extract it from a kernel. | |
15637ed4 | 140 | .Sh FILES |
1419e6d4 | 141 | .Bl -tag -width /sys/i386/conf/Makefile.i386 -compact |
15637ed4 RG |
142 | .It Pa /sys/conf/files |
143 | list of common files system is built from | |
1419e6d4 RG |
144 | .It Pa /sys/i386/conf/Makefile.i386 |
145 | generic makefile for the | |
146 | .Tn i386 | |
147 | .It Pa /sys/i386/conf/files.i386 | |
15637ed4 | 148 | list of |
1419e6d4 | 149 | .Tn i386 |
15637ed4 | 150 | specific files |
1419e6d4 | 151 | .It Pa /sys/i386/conf/devices.i386 |
15637ed4 | 152 | name to major device mapping file for the |
1419e6d4 RG |
153 | .Tn i386 |
154 | .It Pa /sys/i386/conf/files. Ns Em ERNIE | |
15637ed4 RG |
155 | list of files specific to |
156 | .Em ERNIE | |
157 | system | |
158 | .El | |
159 | .Sh SEE ALSO | |
160 | The SYNOPSIS portion of each device in section 4. | |
161 | .Rs | |
162 | .%T "Building 4.3 BSD UNIX System with Config" | |
163 | .Re | |
164 | .Sh BUGS | |
165 | The line numbers reported in error messages are usually off by one. | |
166 | .Sh HISTORY | |
167 | The | |
168 | .Nm | |
169 | command appeared in | |
170 | .Bx 4.1 . |