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