share/man/man5/kernconf.5

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