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