BSD 4_4 release
[unix-history] / usr / src / usr.sbin / config / config.8
index 5f6436b..a7eed52 100644 (file)
-.\" Copyright (c) 1980 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1980, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.
 .\"
-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
-.\"    @(#)config.8    6.4 (Berkeley) 6/24/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
 .\"
-.TH CONFIG 8 "June 24, 1990"
-.UC 4
-.SH NAME
-config \- build system configuration files
-.SH SYNOPSIS
-.B config
-[
-.B \-p
-]
-.I SYSTEM_NAME
-.SH DESCRIPTION
-.PP
-.I Config
-builds a set of system configuration files from a short file which describes
-the sort of system that is being configured.  It also takes as input a file
-which tells
-.I config
-what files are needed to generate a system.
-This can be augmented by a configuration specific set of files
+.\"     @(#)config.8   8.1 (Berkeley) 6/6/93
+.\"
+.Dd June 6, 1993
+.Dt CONFIG 8
+.Os BSD 4
+.Sh NAME
+.Nm config
+.Nd build system configuration files
+.Sh SYNOPSIS
+.Nm config
+.Op Fl p
+.Ar SYSTEM_NAME
+.Sh DESCRIPTION
+.Pp
+.Nm Config
+builds a set of system configuration files from the file
+.Ar SYSTEM_NAME
+which describes
+the system to configure.
+A second file
+tells
+.Nm config
+what files are needed to generate a system and
+can be augmented by configuration specific set of files
 that give alternate files for a specific machine.
-(see the FILES section below)
+(see the
+.Sx FILES
+section below)
+.Pp
+Available option and operand:
+.Pp
+.Bl -tag -width SYSTEM_NAME
+.It Fl p
 If the
-.B \-p
+.Fl p
 option is supplied, 
-.I config
-will configure a system for profiling; c.f.
-.IR kgmon (8)
+.Nm config
+will configure a system for profiling; for example,
+.Xr kgmon 8
 and
-.IR gprof (1).
-.PP
-.I Config
-should be run from the
-.B conf
-subdirectory of the system source (usually /sys/conf).
-Its argument is the name of a system configuration file
+.Xr gprof 1 .
+.It Ar SYSTEM_NAME
+specifies the name of the system configuration file
 containing device specifications, configuration options
 and other system parameters for one system configuration.
-.I Config
-assumes that there is already a directory
-.I "../SYSTEM_NAME"
-created and it places all its output files in there.  
+.El
+.Pp
+.Nm Config
+should be run from the
+.Pa conf
+subdirectory of the system source (usually
+.Pa /sys/conf ) .
+.Nm Config
+assumes the directory
+.Pa ../SYSTEM_NAME
+exists and places all output files there.  
 The output of
-.I config
-consists of a number of files; for the VAX, they are:
-.B ioconf.c
-contains a description
-of what I/O devices are attached to the system,;
-.B ubglue.s
-contains a set of interrupt service routines for devices
-attached to the UNIBUS;
-.B ubvec.s
-contains offsets into a structure used for counting per-device interrupts;
-.B Makefile
-is a file used by
-.IR make (1)
-in building the system; a set of header files contain definitions of
+.Nm config
+consists of a number of files; for the
+.Tn VAX ,
+they are:
+.Pa ioconf.c ,
+a description
+of what I/O devices are attached to the system;
+.Pa ubglue.s ,
+a set of interrupt service routines for devices
+attached to the
+.Tn UNIBUS ;
+.Pa ubvec.s ,
+offsets into a structure used for counting per-device interrupts;
+.Pa Makefile ,
+used by
+.Xr make 1
+in building the system;
+header files,
+definitions of
 the number of various devices that will be compiled into the system;
-and a set of swap configuration files contain definitions for
+swap configuration files,
+definitions for
 the disk areas to be used for swapping, the root file system,
 argument processing, and system dumps.
-.PP
+.Pp
 After running
-.IR config ,
-it is necessary to run ``make depend'' in the directory where the new makefile
+.Nm config ,
+it is necessary to run
+.Dq Li make depend
+in the directory where the new makefile
 was created.
-.I Config
+.Nm Config
 prints a reminder of this when it completes.
-.PP
+.Pp
 If any other error messages are produced by
-.I config,
+.Nm config ,
 the problems in the configuration file should be corrected and
-.I config
+.Nm config
 should be run again.
 Attempts to compile a system that had configuration errors
-are likely to meet with failure.
-.SH FILES
-.nf
-/sys/conf/Makefile.vax generic makefile for the VAX
-/sys/conf/files        list of common files system is built from
-/sys/conf/files.vax    list of VAX specific files
-/sys/conf/devices.vax  name to major device mapping file for the VAX
-/sys/conf/files.ERNIE  list of files specific to ERNIE system
-.fi
-.SH SEE ALSO
-``Building 4.3BSD UNIX System with Config''
-.br
+are likely to fail.
+.Sh FILES
+.Bl -tag -width /sys/conf/Makefile.vax -compact
+.It Pa /sys/conf/Makefile.vax
+generic makefile for the
+.Tn VAX
+.It Pa /sys/conf/files
+list of common files system is built from
+.It Pa /sys/conf/files.vax
+list of
+.Tn VAX
+specific files
+.It Pa /sys/conf/devices.vax
+name to major device mapping file for the
+.Tn VAX
+.It Pa /sys/conf/files. Ns Em ERNIE
+list of files specific to
+.Em ERNIE
+system
+.El
+.Sh SEE ALSO
 The SYNOPSIS portion of each device in section 4.
-.SH BUGS
+.Rs
+.%T "Building 4.3 BSD UNIX System with Config"
+.Re
+.Sh BUGS
 The line numbers reported in error messages are usually off by one.
+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.1 .