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.5 2008/02/20 12:29:07 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.Bl -ohang 64.It Sy cpu Xo 65.Ar name 66.Xc 67This system is to run on the CPU type 68.Ar name . 69Legal types are 70.Sy I486_CPU 71(i486), 72.Sy I586_CPU 73.Tn ( Pentium ) , 74and 75.Sy I686_CPU 76.Tn ( Pentium Pro ) . 77More than one CPU type specification can appear in a configuration file. 78.It Sy device Xo 79.Ar name 80.Xc 81Configures support for device 82.Ar name . 83.It Sy ident Xo 84.Ar string 85.Xc 86Sets the kernel identification string to 87.Ar string . 88.It Sy machine Xo 89.Ar name 90.Xc 91The system is to run on the machine type 92.Ar name . 93This is a legacy keyword and must be set to 94.Sy i386 . 95.It Sy machine_arch Xo 96.Ar name 97.Xc 98The system is to run on the machine architecture 99.Ar name . 100The only legal architecture is 101.Sy i386 . 102.It Sy makeoptions Xo 103.Ar name=value 104.Xc 105Defines a 106.Xr make 1 107macro 108.Ar name 109with the value 110.Ar value 111in the kernel Makefile. 112.It Sy maxusers Xo 113.Ar integer 114.Xc 115Set the 116.Va maxusers 117variable in the kernel. 118.It Sy options Xo 119.Ar name Ns Bq Ar =value 120.Xc 121Sets the option 122.Ar name . 123Some options expect to be assigned a value, which may be an integer, 124a double-quoted word, a bare word, or an empty string 125.Pq Qq . 126Note that those are eventually handled by the C compiler, so the rules 127of that language apply. 128.\"For more information see the 129.\".Sx OPTIONS 130.\"section. 131.It Sy platform Xo 132.Ar name 133.Xc 134Sets the platform of this kernel to 135.Ar name . 136Legal platforms are 137.Sy pc32 138and 139.Sy vkernel , 140meaning either a 32 bit 141.Tn Intel 142architecture or a virtual kernel. 143.It Sy pseudo-device Xo 144.Ar name 145.Op Ar N 146.Xc 147Includes support for the pseudo-device 148.Ar name . 149Some pseudo-devices can have multiple or 150.Ar N 151instances. 152.El 153.\".Sh OPTIONS 154.Sh FILES 155.Bl -tag -width ".Pa /sys/config/GENERIC" 156.It Pa /sys/config/LINT 157description of kernel configuration options 158.It Pa /sys/config/GENERIC 159default kernel configuration file 160.El 161.Sh SEE ALSO 162.Xr build 7 , 163.Xr vkernel 7 , 164.Xr config 8 165.Sh HISTORY 166The 167.Nm 168manual page first appeared in 169.Dx 1.11 . 170