kernconf.5,config.8: minor cleanup
authorThomas Nikolajsen <thomas@dragonflybsd.org>
Sat, 14 Nov 2009 14:59:45 +0000 (15:59 +0100)
committerThomas Nikolajsen <thomas@dragonflybsd.org>
Sat, 14 Nov 2009 16:14:53 +0000 (17:14 +0100)
 * sort FILES section

 * add X86_64_GENERIC to config.8 & mention that GENERIC is i386 specific

 * mandoc(1) clean kerconf.5 by removing .Xo / .Xc & other minor things

share/man/man5/kernconf.5
usr.sbin/config/config.8

index e0ac48a..f05a1d2 100644 (file)
@@ -31,9 +31,9 @@
 .\"
 .\" $DragonFly: src/share/man/man5/kernconf.5,v 1.8 2008/07/16 01:02:07 thomas Exp $
 .\"
-.Dd September 28, 2009
-.Os
+.Dd November 14, 2009
 .Dt KERNCONF 5
+.Os
 .Sh NAME
 .Nm kernconf
 .Nd kernel configuration file
@@ -74,9 +74,7 @@ that follows it on the same line.
 The following keywords are recognized in a configuration file:
 .Pp
 .Bl -tag -width indent -compact
-.It Sy cpu Xo
-.Ar name
-.Xc
+.It Sy cpu Ar name
 This system is to run on the CPU type
 .Ar name .
 Legal types are, for
@@ -94,20 +92,18 @@ for
 .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
+.It Sy device Ar name \
+Oo Sy at Ar bus Oc \
+Oo Sy port Ar num Oc \
+Oo Sy irq Ar num Oc \
+Oo Sy drq Ar num Oc \
+Oo Sy iomem Ar num Oc \
+Oo Sy iosiz Ar num Oc \
+Op Sy flags Ar num
 Configures support for device
 .Ar name .
 Additional parameters may be passed to specify
-.Tm I/O
+.Tn I/O
 configuration settings (most often for
 .Xr isa 4
 devices):
@@ -116,7 +112,7 @@ devices):
 specifies a bus to which the device is attached.
 .It Sy port
 specifies the start address of
-.Tm I/O
+.Tn I/O
 ports to be used by the device.
 .It Sy irq
 specifies the number of ports used by the device.
@@ -130,23 +126,17 @@ specifies the physical memory size used by the device.
 sets various flag bits for the device.
 .El
 .Pp
-.It Sy ident Xo
-.Ar string
-.Xc
+.It Sy ident Ar string
 Sets the kernel identification string to
 .Ar string .
 .Pp
-.It Sy machine Xo
-.Ar name
-.Xc
+.It Sy machine Ar name
 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
+.It Sy machine_arch Ar name
 The system is to run on the machine architecture
 .Ar name .
 The legal architectures are
@@ -154,9 +144,7 @@ The legal architectures are
 and
 .Sy x86_64 .
 .Pp
-.It Sy makeoptions Xo
-.Ar name Ns Sy = Ns Ar value
-.Xc
+.It Sy makeoptions Ar name Ns Sy = Ns Ar value
 Defines a
 .Xr make 1
 macro
@@ -165,16 +153,12 @@ with the value
 .Ar value
 in the kernel Makefile.
 .Pp
-.It Sy maxusers Xo
-.Ar integer
-.Xc
+.It Sy maxusers Ar integer
 Set the
 .Va maxusers
 variable in the kernel.
 .Pp
-.It Sy options Xo
-.Ar name Ns Op Sy = Ns Ar value
-.Xc
+.It Sy options Ar name Ns Op Sy = Ns Ar value
 Sets the option
 .Ar name .
 Some options expect to be assigned a value, which may be an integer,
@@ -186,9 +170,7 @@ of that language apply.
 .\".Sx OPTIONS
 .\"section.
 .Pp
-.It Sy platform Xo
-.Ar name
-.Xc
+.It Sy platform Ar name
 Sets the platform of this kernel to
 .Ar name .
 Legal platforms are
@@ -202,10 +184,7 @@ architecture, a 64 bit
 .Tn AMD
 architecture, or a virtual kernel.
 .Pp
-.It Sy pseudo-device Xo
-.Ar name
-.Op Ar N
-.Xc
+.It Sy pseudo-device Ar name Op Ar N
 Includes support for the pseudo-device
 .Ar name .
 Some pseudo-devices can have multiple or
@@ -215,20 +194,21 @@ instances.
 .\".Sh OPTIONS
 .Sh FILES
 .Bl -tag -width ".Pa /sys/config/X86_64_GENERIC"
-.It Pa /sys/config/LINT
-description of kernel configuration options
-.It Pa /sys/config/X86_64_GENERIC
-default
-.Sy x86_64
-kernel configuration file
 .It Pa /sys/config/GENERIC
 default
 .Sy i386
 kernel configuration file
+.It Pa /sys/config/LINT
+kernel configuration file for checking all the sources,
+includes description of kernel configuration options
 .It Pa /sys/config/VKERNEL
 default
 .Xr vkernel 7
 kernel configuration file
+.It Pa /sys/config/X86_64_GENERIC
+default
+.Sy x86_64
+kernel configuration file
 .El
 .Sh SEE ALSO
 .Xr make 1 ,
index 56d11a0..c24d852 100644 (file)
@@ -33,7 +33,7 @@
 .\" $FreeBSD: src/usr.sbin/config/config.8,v 1.21.2.7 2003/04/23 07:32:39 brueffer Exp $
 .\" $DragonFly: src/usr.sbin/config/config.8,v 1.10 2008/07/10 00:46:57 thomas Exp $
 .\"
-.Dd July 4, 2001
+.Dd November 14, 2009
 .Dt CONFIG 8
 .Os
 .Sh NAME
@@ -190,31 +190,42 @@ their debug information by
 .Bl -tag -width ".It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/Makefile" -compact
 .It Pa /sys/conf/files
 list of common files system is built from
-.It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/Makefile
-generic makefile for the
-.Va PLATFORM
-.It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/files
-list of
-.Va PLATFORM
-specific files
 .It Pa /sys/config/ Ns Ar SYSTEM_NAME
 default location for kernel configuration file
 .It Pa /sys/config/GENERIC
-default kernel configuration file
+default
+.Sy i386
+kernel configuration file
+.It Pa /sys/config/LINT
+kernel configuration file for checking all the sources,
+includes description of kernel configuration options
 .It Pa /sys/config/VKERNEL
 default
 .Xr vkernel 7
 kernel configuration file
-.It Pa /sys/config/LINT
-kernel configuration file for checking all the sources
+.It Pa /sys/config/X86_64_GENERIC
+default
+.Sy x86_64
+kernel configuration file
 .It Pa /sys/compile/ Ns Ar SYSTEM_NAME
 default kernel build directory for system
-.Ar SYSTEM_NAME .
+.Ar SYSTEM_NAME
+.It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/Makefile
+generic makefile for the
+.Va PLATFORM
+.It Pa /sys/platform/ Ns Va PLATFORM Ns Pa /conf/files
+list of
+.Va PLATFORM
+specific files
 .El
 .Sh SEE ALSO
+.Xr gprof 1 ,
+.Xr kgdb 1 ,
+.Xr make 1 ,
 .Xr kernconf 5 ,
 .Xr build 7 ,
-.Xr vkernel 7
+.Xr vkernel 7 ,
+.Xr kgmon 8
 .Pp
 The
 .Sx SYNOPSIS