[src/uebayasi-xip]: src/share/man/man4 Document options XIP.

[uebayasi <uebayasi%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/66bebd25bfb2
branches:  uebayasi-xip
changeset: 751757:66bebd25bfb2
user:      uebayasi <uebayasi%NetBSD.org@localhost>
date:      Thu Jul 29 09:47:40 2010 +0000

description:
Document options XIP.

diffstat:

 share/man/man4/options.4 |  2843 ++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 2843 insertions(+), 0 deletions(-)

diffs (truncated from 2847 to 300 lines):

diff -r 4c93ec208dee -r 66bebd25bfb2 share/man/man4/options.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/options.4  Thu Jul 29 09:47:40 2010 +0000
@@ -0,0 +1,2843 @@
+.\"    $NetBSD: options.4,v 1.388.2.2 2010/07/29 09:47:40 uebayasi Exp $
+.\"
+.\" Copyright (c) 1996
+.\"    Perry E. Metzger.  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. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgment:
+.\"    This product includes software developed for the NetBSD Project
+.\"    by Perry E. Metzger.
+.\" 4. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
+.\"
+.\"
+.Dd July 27, 2010
+.Dt OPTIONS 4
+.Os
+.Sh NAME
+.Nm options
+.Nd Miscellaneous kernel configuration options
+.Sh SYNOPSIS
+.Cd cinclude ...
+.Cd config ...
+.Cd [no] file-system ...
+.Cd ident ...
+.Cd include ...
+.Cd [no] makeoptions ...
+.Cd maxusers ...
+.Cd [no] options ...
+.Cd [no] pseudo-device ...
+.Sh DESCRIPTION
+This manual page describes a number of miscellaneous kernel
+configuration options that may be specified in a kernel config
+file.
+See
+.Xr config 1
+and
+.Xr config 5
+for information on how to configure and build kernels.
+.Pp
+The
+.Ar no
+form removes a previously specified option.
+.Ss Keywords
+The following keywords are recognized in a kernel configuration file:
+.Bl -ohang
+.It Sy cinclude Qq Ar filename
+Conditionally includes another kernel configuration file whose name is
+.Ar filename ,
+which may be double-quoted and may be an explicit path or relative to
+the kernel source directory.
+Failure to open the named file is ignored.
+.It Sy config Ar exec_name No root on Ar rootdev Oo type Ar fstype Oc \
+Oo dumps on Ar dumpdev Oc
+Defines a configuration whose kernel executable is named
+.Ar exec_name ,
+normally
+.Dq netbsd ,
+with its root file system of type
+.Ar fstype
+on the device
+.Ar rootdev ,
+and optionally specifying the location of kernel core dumps on the device
+.Ar dumpdev .
+.Ar dev
+or
+.Ar dumpdev
+and
+.Ar fstype
+may be specified as
+.Dq \&? ,
+which is a wild card.
+The root
+.Ar fstype
+and
+.Ar dumpdev
+are optional and assumed to be wild carded if they are not specified.
+.It Ar device_instance No at Ar attachment \
+Oo Ar locators value Oo ... Oc Oc Oo flags Ar value Oc
+Define an instance of the device driver
+.Ar device_instance
+that attaches to the bus or device named
+.Ar attachment .
+An
+.Ar attachment
+may require additional information on where the device can be found, such
+as an address, channel, function, offset, and/or slot, referred to as
+.Ar locators ,
+whose
+.Ar value
+often may be a wild card,
+.Dq \&? .
+Some device drivers have one or more
+.Ar flags
+that can be adjusted to affect the way they operate.
+.It Sy file-system Ar fs_name Op , Ar fs_name Op ...
+Include support for the file-system
+.Ar fs_name .
+.It Sy ident Qq Ar string
+Sets the kernel identification string to
+.Ar string .
+.It Sy include Qq Ar filename
+Functions the same as
+.Ar cinclude ,
+except failure to open
+.Ar filename
+produces a fatal error.
+.It Sy options Ar option_name Op , Ar option_name=value Op ...
+Specifies (or sets) the option, or comma-separated list of options,
+.Ar option_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.
+.Pp
+.Em Note :
+Options that are not defined by device definition files are passed to
+the compile process as
+.Fl D
+flags to the C compiler.
+.It Sy makeoptions Ar name=value
+Defines a
+.Xr make 1
+macro
+.Ar name
+with the value
+.Ar value
+in the kernel Makefile.
+.It Sy maxusers Ar integer
+Set the maxusers variable in the kernel.
+.It Sy no Ar keyword Ar name Op Ar arguments Op ...
+For the
+.Xr config 1
+.Ar keywords
+file-system, makeoptions, options, and pseudo-device,
+.Ar no
+removes the file-system, makeoption, options, or pseudo-device,
+.Ar name .
+This is useful when a kernel configuration file includes another which
+has undesired options.
+.Pp
+For example, a local configuration file that wanted the kitchen sink, but
+not COMPAT_09 or bridging, might be:
+.Bd -literal -offset indent
+include "arch/i386/conf/GENERIC"
+no options COMPAT_09
+no pseudo-device bridge
+.Ed
+.It Sy pseudo-device Ar name Op Ar N
+Includes support for the pseudo-device
+.Ar name .
+Some pseudo-devices can have multiple or
+.Ar N
+instances.
+.El
+.Ss Compatibility Options
+.Bl -ohang
+.It Cd options COMPAT_09
+Enable binary compatibility with
+.Nx 0.9 .
+This enables support for
+16-bit user, group, and process IDs (following revisions support
+32-bit identifiers).
+It also allows the use of the deprecated
+.Xr getdomainname 3 ,
+.Xr setdomainname 3 ,
+and
+.Xr uname 3
+syscalls.
+This option also allows using numeric file system identifiers rather
+than strings.
+Post
+.Nx 0.9
+versions use string identifiers.
+.It Cd options COMPAT_10
+Enable binary compatibility with
+.Nx 1.0 .
+This option allows the use of the file system name of
+.Dq ufs
+as an alias for
+.Dq ffs .
+The name
+.Dq ffs
+should be used post 1.0 in
+.Pa /etc/fstab
+and other files.
+It also adds old syscalls for the
+.At V
+shared memory interface.
+This was changed post 1.0 to work on 64-bit architectures.
+This option also enables
+.Dq sgtty
+compatibility, without which programs using the old interface produce
+an
+.Dq inappropriate ioctl
+error, and
+.Pa /dev/io
+only works when this option is set in the kernel,
+see
+.Xr io 4
+on ports that support it.
+.It Cd options COMPAT_11
+Enable binary compatibility with
+.Nx 1.1 .
+This allows binaries running on the i386 port to gain direct access to
+the io ports by opening
+.Pa /dev/io
+read/write.
+This functionality was replaced by
+.Xr i386_iopl 2
+post 1.1.
+On the
+.Tn Atari
+port, the location of the disk label was moved after 1.1.
+When the
+.Em COMPAT_11
+option is set, the kernel will read (pre) 1.1 style disk labels as a
+last resort.
+When a disk label is re-written, the old style label will be replaced
+with a post 1.1 style label.
+This also enables the
+.Em EXEC_ELF_NOTELESS
+option.
+.It Cd options COMPAT_12
+Enable binary compatibility with
+.Nx 1.2 .
+This allows the use of old syscalls for
+.Fn reboot
+and
+.Fn swapon .
+The syscall numbers were changed post 1.2 to add functionality to the
+.Xr reboot 2
+syscall, and the new
+.Xr swapctl 2
+interface was introduced.
+This also enables the
+.Em EXEC_ELF_NOTELESS
+option.
+.It Cd options COMPAT_13
+Enable binary compatibility with
+.Nx 1.3 .
+This allows the use of old syscalls for
+.Fn sigaltstack ,
+and also enables the old
+.Xr swapctl 2
+command
+.Dv SWAP_STATS
+(now called
+.Dv SWAP_OSTATS ) ,
+which does not include the
+.Fa se_path
+member of
+.Va struct swapent .
+.It Cd options COMPAT_14
+Enable binary compatibility with
+.Nx 1.4 .
+This allows some old
+.Xr ioctl 2
+on
+.Xr wscons 4
+to be performed, and allows the
+.Dv NFSSVC_BIOD
+mode of the
+.Xr nfssvc 2
+system call to be used for compatibility with the deprecated nfsiod program.
+.It Cd options COMPAT_15
+Enable binary compatibility with
+.Nx 1.5 .
+Since there were no API changes from
+.Nx 1.5
+and
+.Nx 1.6 ,
+this option does nothing.
+.It Cd options COMPAT_16
+Enable binary compatibility with
+.Nx 1.6 .
+This allows the use of old signal trampoline code which has been deprecated