xref: /dflybsd-src/share/man/man5/kernconf.5 (revision cb4679fcb5a30fde7da50d8f0580383c790b26e5)
1.\"
2.\" Copyright (c) 2007
3.\"	The DragonFly Project.  All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\"
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in
13.\"    the documentation and/or other materials provided with the
14.\"    distribution.
15.\" 3. Neither the name of The DragonFly Project nor the names of its
16.\"    contributors may be used to endorse or promote products derived
17.\"    from this software without specific, prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" $DragonFly: src/share/man/man5/kernconf.5,v 1.6 2008/05/02 10:46:33 swildner Exp $
33.\"
34.Dd September 13, 2007
35.Os
36.Dt KERNCONF 5
37.Sh NAME
38.Nm kernconf
39.Nd kernel configuration file
40.Sh SYNOPSIS
41.Cd cpu ...
42.Cd device ...
43.Cd ident ...
44.Cd machine ...
45.Cd machine-arch ...
46.Cd makeoptions ...
47.Cd maxusers ...
48.Cd options ...
49.Cd platform ...
50.Cd pseudo-device ...
51.Sh DESCRIPTION
52This manual page describes the structure of the kernel configuration file.
53Blank lines are ignored.
54The
55.Sq #
56character is interpreted as a comment and is ignored along with everything
57that follows it on the same line.
58See
59.Xr config 8
60for information on how to configure and build kernels.
61.Sh KEYWORDS
62The following keywords are recognized in a configuration file:
63.Pp
64.Bl -tag -width indent -compact
65.It Sy cpu Xo
66.Ar name
67.Xc
68This system is to run on the CPU type
69.Ar name .
70Legal types are
71.Sy I486_CPU
72(i486),
73.Sy I586_CPU
74.Tn ( Pentium ) ,
75and
76.Sy I686_CPU
77.Tn ( Pentium Pro ) .
78More than one CPU type specification can appear in a configuration file.
79.Pp
80.It Sy device Xo
81.Ar name
82.Xc
83Configures support for device
84.Ar name .
85.Pp
86.It Sy ident Xo
87.Ar string
88.Xc
89Sets the kernel identification string to
90.Ar string .
91.Pp
92.It Sy machine Xo
93.Ar name
94.Xc
95The system is to run on the machine type
96.Ar name .
97This is a legacy keyword and must be set to
98.Sy i386 .
99.Pp
100.It Sy machine_arch Xo
101.Ar name
102.Xc
103The system is to run on the machine architecture
104.Ar name .
105The only legal architecture is
106.Sy i386 .
107.Pp
108.It Sy makeoptions Xo
109.Ar name=value
110.Xc
111Defines a
112.Xr make 1
113macro
114.Ar name
115with the value
116.Ar value
117in the kernel Makefile.
118.Pp
119.It Sy maxusers Xo
120.Ar integer
121.Xc
122Set the
123.Va maxusers
124variable in the kernel.
125.Pp
126.It Sy options Xo
127.Ar name Ns Bq Ar =value
128.Xc
129Sets the option
130.Ar name .
131Some options expect to be assigned a value, which may be an integer,
132a double-quoted word, a bare word, or an empty string
133.Pq Qq .
134Note that those are eventually handled by the C compiler, so the rules
135of that language apply.
136.\"For more information see the
137.\".Sx OPTIONS
138.\"section.
139.Pp
140.It Sy platform Xo
141.Ar name
142.Xc
143Sets the platform of this kernel to
144.Ar name .
145Legal platforms are
146.Sy pc32
147and
148.Sy vkernel ,
149meaning either a 32 bit
150.Tn Intel
151architecture or a virtual kernel.
152.Pp
153.It Sy pseudo-device Xo
154.Ar name
155.Op Ar N
156.Xc
157Includes support for the pseudo-device
158.Ar name .
159Some pseudo-devices can have multiple or
160.Ar N
161instances.
162.El
163.\".Sh OPTIONS
164.Sh FILES
165.Bl -tag -width ".Pa /sys/config/GENERIC"
166.It Pa /sys/config/LINT
167description of kernel configuration options
168.It Pa /sys/config/GENERIC
169default kernel configuration file
170.El
171.Sh SEE ALSO
172.Xr build 7 ,
173.Xr vkernel 7 ,
174.Xr config 8
175.Sh HISTORY
176The
177.Nm
178manual page first appeared in
179.Dx 1.11 .
180