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.Dd June 20, 2015 33.Dt KERNCONF 5 34.Os 35.Sh NAME 36.Nm kernconf 37.Nd kernel configuration file 38.Sh SYNOPSIS 39.Cd cpu ... 40.Cd device ... 41.Cd ident ... 42.Cd machine ... 43.Cd machine-arch ... 44.Cd makeoptions ... 45.Cd maxusers ... 46.Cd options ... 47.Cd platform ... 48.Cd pseudo-device ... 49.Sh DESCRIPTION 50This manual page describes the structure of the kernel configuration file. 51It is processed by 52.Xr config 8 53to create a build environment where a kernel may be built using 54.Xr make 1 . 55See 56.Xr build 7 57for information on how to build kernels. 58.Pp 59Each line starts with a keyword at the beginning of the line and is 60followed by additional parameters. 61Long input lines may be broken into shorter lines by starting the 62second and subsequent lines with a white space character. 63Numbers are specified using 64.Tn C Ns -style 65syntax. 66Blank lines are ignored. 67The 68.Sq # 69character is interpreted as a comment and is ignored along with everything 70that follows it on the same line. 71.Sh KEYWORDS 72The following keywords are recognized in a configuration file: 73.Pp 74.Bl -tag -width indent -compact 75.It Sy cpu Ar name 76This system is to run on the CPU type 77.Ar name . 78Legal types are: 79.Sy HAMMER_CPU 80.Tn ( x86-64 ) . 81More than one CPU type specification can appear in a configuration file. 82.Pp 83.It Sy device Ar name \ 84Oo Sy at Ar bus Oc \ 85Oo Sy port Ar num Oc \ 86Oo Sy irq Ar num Oc \ 87Oo Sy drq Ar num Oc \ 88Oo Sy iomem Ar num Oc \ 89Oo Sy iosiz Ar num Oc \ 90Op Sy flags Ar num 91Configures support for device 92.Ar name . 93Additional parameters may be passed to specify 94.Tn I/O 95configuration settings (most often for 96.Xr isa 4 97devices): 98.Bl -tag -width ".Sy iomem" 99.It Sy at 100specifies a bus to which the device is attached. 101.It Sy port 102specifies the start address of 103.Tn I/O 104ports to be used by the device. 105.It Sy irq 106specifies the number of ports used by the device. 107.It Sy drq 108is the interrupt line number to be used. 109.It Sy iomem 110specifies the physical memory address used by the device. 111.It Sy iosiz 112specifies the physical memory size used by the device. 113.It Sy flags 114sets various flag bits for the device. 115.El 116.Pp 117.It Sy ident Ar string 118Sets the kernel identification string to 119.Ar string . 120.Pp 121.It Sy machine Ar name 122The system is to run on the machine type 123.Ar name . 124This is a legacy keyword, it is normally set to same value as 125.Sy machine_arch . 126.Pp 127.It Sy machine_arch Ar name 128The system is to run on the machine architecture 129.Ar name . 130Currently, the only legal architecture is 131.Sy x86_64 . 132.Pp 133.It Sy makeoptions Ar name Ns Sy = Ns Ar value 134Defines a 135.Xr make 1 136macro 137.Ar name 138with the value 139.Ar value 140in the kernel Makefile. 141.Pp 142.It Sy maxusers Ar integer 143Set the 144.Va maxusers 145variable in the kernel. 146.Pp 147.It Sy options Ar name Ns Op Sy = Ns Ar value 148Sets the option 149.Ar name . 150Some options expect to be assigned a value, which may be an integer, 151a double-quoted word, a bare word, or an empty string 152.Pq Qq . 153Note that those are eventually handled by the C compiler, so the rules 154of that language apply. 155.\"For more information see the 156.\".Sx OPTIONS 157.\"section. 158.Pp 159.It Sy platform Ar name 160Sets the platform of this kernel to 161.Ar name . 162Legal platforms are 163.Sy pc64 164(64 bit 165.Tn AMD 166architecture), 167and 168.Sy vkernel64 169(64 bit virtual kernel). 170.Pp 171.It Sy pseudo-device Ar name Op Ar N 172Includes support for the pseudo-device 173.Ar name . 174Some pseudo-devices can have multiple or 175.Ar N 176instances. 177.El 178.\".Sh OPTIONS 179.Sh FILES 180.Bl -tag -width ".Pa /sys/config/X86_64_GENERIC" 181.It Pa /sys/config/LINT64 182kernel configuration file for checking all the sources, 183includes description of kernel configuration options 184.It Pa /sys/config/VKERNEL64 185default 64 bit 186.Xr vkernel 7 187kernel configuration file 188.It Pa /sys/config/X86_64_GENERIC 189default 190.Sy x86_64 191kernel configuration file 192.El 193.Sh SEE ALSO 194.Xr make 1 , 195.Xr build 7 , 196.Xr vkernel 7 , 197.Xr config 8 198.Sh HISTORY 199The 200.Nm 201manual page first appeared in 202.Dx 1.11 . 203