kernconf.5: Add info on 64-bit kernels & improve markup

[dragonfly.git] / share / man / man5 / kernconf.5

.\"
.\" Copyright (c) 2007
.\"	The DragonFly Project.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\" 3. Neither the name of The DragonFly Project nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific, prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $DragonFly: src/share/man/man5/kernconf.5,v 1.8 2008/07/16 01:02:07 thomas Exp $
.\"
.Dd September 28, 2009
.Os
.Dt KERNCONF 5
.Sh NAME
.Nm kernconf
.Nd kernel configuration file
.Sh SYNOPSIS
.Cd cpu ...
.Cd device ...
.Cd ident ...
.Cd machine ...
.Cd machine-arch ...
.Cd makeoptions ...
.Cd maxusers ...
.Cd options ...
.Cd platform ...
.Cd pseudo-device ...
.Sh DESCRIPTION
This manual page describes the structure of the kernel configuration file.
It is processed by
.Xr config 8
to create a build environment where a kernel may be built using
.Xr make 1 .
See
.Xr build 7
for information on how to build kernels.
.Pp
Each line starts with a keyword at the beginning of the line and is
followed by additional parameters.
Long input lines may be broken into shorter lines by starting the
second and subsequent lines with a white space character.
Numbers are specified using
.Tn C Ns -style
syntax.
Blank lines are ignored.
The
.Sq #
character is interpreted as a comment and is ignored along with everything
that follows it on the same line.
.Sh KEYWORDS
The following keywords are recognized in a configuration file:
.Pp
.Bl -tag -width indent -compact
.It Sy cpu Xo
.Ar name
.Xc
This system is to run on the CPU type
.Ar name .
Legal types are, for
.Sy i386 :
.Sy I486_CPU
(i486),
.Sy I586_CPU
.Tn ( Pentium ) ,
and
.Sy I686_CPU
.Tn ( Pentium Pro ) ;
for
.Sy amd64 :
.Sy HAMMER_CPU
.Tn ( x86-64 ) .
More than one CPU type specification can appear in a configuration file.
.Pp
.It Sy device Xo
.Ar name
.Op Sy at Ar bus
.Op Sy port Ar num
.Op Sy irq Ar num
.Op Sy drq Ar num
.Op Sy iomem Ar num
.Op Sy iosiz Ar num
.Op Sy flags Ar num
.Xc
Configures support for device
.Ar name .
Additional parameters may be passed to specify
.Tm I/O
configuration settings (most often for
.Xr isa 4
devices):
.Bl -tag -width ".Sy iomem"
.It Sy at
specifies a bus to which the device is attached.
.It Sy port
specifies the start address of
.Tm I/O
ports to be used by the device.
.It Sy irq
specifies the number of ports used by the device.
.It Sy drq
is the interrupt line number to be used.
.It Sy iomem
specifies the physical memory address used by the device.
.It Sy iosiz
specifies the physical memory size used by the device.
.It Sy flags
sets various flag bits for the device.
.El
.Pp
.It Sy ident Xo
.Ar string
.Xc
Sets the kernel identification string to
.Ar string .
.Pp
.It Sy machine Xo
.Ar name
.Xc
The system is to run on the machine type
.Ar name .
This is a legacy keyword, it is normally set to same value as
.Sy machine_arch .
.Pp
.It Sy machine_arch Xo
.Ar name
.Xc
The system is to run on the machine architecture
.Ar name .
The legal architectures are
.Sy i386 ,
and
.Sy amd64 .
.Pp
.It Sy makeoptions Xo
.Ar name Ns Sy = Ns Ar value
.Xc
Defines a
.Xr make 1
macro
.Ar name
with the value
.Ar value
in the kernel Makefile.
.Pp
.It Sy maxusers Xo
.Ar integer
.Xc
Set the
.Va maxusers
variable in the kernel.
.Pp
.It Sy options Xo
.Ar name Ns Op Sy = Ns Ar value
.Xc
Sets the option
.Ar name .
Some options expect to be assigned a value, which may be an integer,
a double-quoted word, a bare word, or an empty string
.Pq Qq .
Note that those are eventually handled by the C compiler, so the rules
of that language apply.
.\"For more information see the
.\".Sx OPTIONS
.\"section.
.Pp
.It Sy platform Xo
.Ar name
.Xc
Sets the platform of this kernel to
.Ar name .
Legal platforms are
.Sy pc32 ,
.Sy pc64 ,
and
.Sy vkernel ,
meaning either a 32 bit
.Tn Intel
architecture, a 64 bit
.Tn AMD
architecture, or a virtual kernel.
.Pp
.It Sy pseudo-device Xo
.Ar name
.Op Ar N
.Xc
Includes support for the pseudo-device
.Ar name .
Some pseudo-devices can have multiple or
.Ar N
instances.
.El
.\".Sh OPTIONS
.Sh FILES
.Bl -tag -width ".Pa /sys/config/AMD64_GENERIC"
.It Pa /sys/config/LINT
description of kernel configuration options
.It Pa /sys/config/AMD64_GENERIC
default
.Sy amd64
kernel configuration file
.It Pa /sys/config/GENERIC
default
.Sy i386
kernel configuration file
.It Pa /sys/config/VKERNEL
default
.Xr vkernel 7
kernel configuration file
.El
.Sh SEE ALSO
.Xr make 1 ,
.Xr build 7 ,
.Xr vkernel 7 ,
.Xr config 8
.Sh HISTORY
The
.Nm
manual page first appeared in
.Dx 1.11 .