xref: /netbsd-src/share/man/man4/options.4 (revision de1dfb1250df962f1ff3a011772cf58e605aed11)
1.\"	$NetBSD: options.4,v 1.247 2004/09/12 13:03:06 wiz Exp $
2.\"
3.\" Copyright (c) 1996
4.\" 	Perry E. Metzger.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
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 the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgment:
16.\"	This product includes software developed for the NetBSD Project
17.\"	by Perry E. Metzger.
18.\" 4. The name of the author may not be used to endorse or promote products
19.\"    derived from this software without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31.\"
32.\"
33.Dd September 4, 2004
34.Os
35.Dt OPTIONS 4
36.Sh NAME
37.Nm options
38.Nd Miscellaneous kernel configuration options
39.Sh SYNOPSIS
40.Cd cinclude ...
41.Cd config ...
42.Cd [no] file-system ...
43.Cd ident ...
44.Cd include ...
45.Cd [no] makeoptions ...
46.Cd maxusers ...
47.Cd [no] options ...
48.Cd [no] pseudo-device ...
49.Sh DESCRIPTION
50This manual page describes a number of miscellaneous kernel
51configuration options that may be specified in a kernel config
52file.
53See
54.Xr config 8
55for information on how to configure and build kernels.
56.Pp
57The
58.Ar no
59form removes a previously specified option.
60.Ss Keywords
61The following keywords are recognized in a kernel configuration file:
62.Bl -ohang
63.It Sy cinclude Xo
64.Qq Ar filename
65.Xc
66Conditionally includes another kernel configuration file whose name is
67.Ar filename ,
68which may be double-quoted and may be an explicit path or relative to
69the kernel source directory.
70Failure to open the named file is ignored.
71.It Sy config Xo
72.Ar exec_name
73.No root on
74.Ar rootdev
75.Op type Ar fstype
76.Op dumps on Ar dumpdev
77.Xc
78Defines a configuration whose kernel executable is named
79.Ar exec_name ,
80normally
81.Dq netbsd ,
82with its root file system of type
83.Ar fstype
84on the device
85.Ar rootdev ,
86and optionally specifying the location of kernel core dumps on the device
87.Ar dumpdev .
88.Ar dev
89or
90.Ar dumpdev
91and
92.Ar fstype
93may be specified as
94.Dq \&? ,
95which is a wild card.
96The root
97.Ar fstype
98and
99.Ar dumpdev
100are optional and assumed to be wild carded if they are not specified.
101.It Ar device_instance Xo
102at
103.Ar attachment
104.Op Ar locators value Op ...
105.Op flags Ar value
106.Xc
107Define an instance of the device driver
108.Ar device_instance
109that attaches to the bus or device named
110.Ar attachment .
111An
112.Ar attachment
113may require additional information on where the device can be found, such
114as an address, channel, function, offset, and/or slot, referred to as
115.Ar locators ,
116whose
117.Ar value
118often may be a wild card,
119.Dq \&? .
120Some device drivers have one or more
121.Ar flags
122that can be adjusted to affect the way they operate.
123.It Sy file-system Xo
124.Ar fs_name Op , Ar fs_name Op ...
125.Xc
126Include support for the file-system
127.Ar fs_name .
128.It Sy ident Xo
129.Qq Ar string
130.Xc
131Sets the kernel identification string to
132.Ar string .
133.It Sy include Xo
134.Qq Ar filename
135.Xc
136Functions the same as
137.Ar cinclude ,
138except failure to open
139.Ar filename
140produces a fatal error.
141.It Sy options Xo
142.Ar option_name Op , Ar option_name=value Op ...
143.Xc
144Specifies (or sets) the option, or comma-separated list of options,
145.Ar option_name .
146Some options expect to be assigned a value, which may be an integer,
147a double-quoted word, a bare word, or an empty string
148.Pq Qq .
149.Pp
150.Em Note :
151Options that are not defined by device definition files are passed to
152the compile process as
153.Fl D
154flags to the C compiler.
155.It Sy makeoptions Xo
156.Ar name=value
157.Xc
158Defines a
159.Xr make 1
160macro
161.Ar name
162with the value
163.Ar value
164in the kernel Makefile.
165.It Sy maxusers Xo
166.Ar integer
167.Xc
168Set the maxusers variable in the kernel.
169.It Sy no Xo
170.Ar keyword Ar name Op Ar arguments Op ...
171.Xc
172For the
173.Xr config 8
174.Ar keywords
175file-system, makeoptions, options, and pseudo-device,
176.Ar no
177removes the file-system, makeoption, options, or pseudo-device,
178.Ar name .
179This is useful when a kernel configuration file includes another which
180has undesired options.
181.Pp
182For example, a local configuration file that wanted the kitchen sink, but
183not COMPAT_09 or bridging, might be:
184.Bd -literal -offset indent
185include "arch/i386/conf/GENERIC"
186no options COMPAT_09
187no pseudo-device bridge
188.Ed
189.It Sy pseudo-device Xo
190.Ar name
191.Op Ar N
192.Xc
193Includes support for the pseudo-device
194.Ar name .
195Some pseudo-devices can have multiple or
196.Ar N
197instances.
198.El
199.Ss Compatibility Options
200.Bl -ohang
201.It Cd options COMPAT_09
202Enable binary compatibility with
203.Nx 0.9 .
204This enables support for
20516-bit user, group, and process IDs (following revisions support
20632-bit identifiers),
207It also allows the use of the deprecated
208.Xr getdomainname 3 ,
209.Xr setdomainname 3 ,
210and
211.Xr uname 3
212syscalls.
213This option also allows using numeric file system identifiers rather
214than strings.
215Post
216.Nx 0.9
217versions use string identifiers.
218.It Cd options COMPAT_10
219Enable binary compatibility with
220.Nx 1.0 .
221This option allows the use of the file system name of
222.Dq ufs
223as an alias for
224.Dq ffs .
225The name
226.Dq ffs
227should be used post 1.0 in
228.Pa /etc/fstab
229and other files.
230It also adds old syscalls for the
231.At V
232shared memory interface.
233This was changed post 1.0 to work on 64-bit architectures.
234This option also enables
235.Dq sgtty
236compatibility, without which programs using the old interface produce
237an
238.Dq inappropriate ioctl
239error, and
240.Pa /dev/io
241only works when this option is set in the kernel,
242see
243.Xr io 4
244on ports that support it.
245.It Cd options COMPAT_11
246Enable binary compatibility with
247.Nx 1.1 .
248This allows binaries running on the i386 port to gain direct access to
249the io ports by opening
250.Pa /dev/io
251read/write.
252This functionality was replaced by
253.Xr i386_iopl 2
254post 1.1.
255On the
256.Tn Atari
257port, the location of the disk label was moved after 1.1.
258When the
259.Em COMPAT_11
260option is set, the kernel will read (pre) 1.1 style disk labels as a
261last resort.
262When a disklabel is re-written, the old style label will be replaced
263with a post 1.1 style label.
264This also enables the
265.Em EXEC_ELF_NOTELESS
266option.
267.It Cd options COMPAT_12
268Enable binary compatibility with
269.Nx 1.2 .
270This allows the use of old syscalls for
271.Fn reboot
272and
273.Fn swapon .
274The syscall numbers were changed post 1.2 to add functionality to the
275.Xr reboot 2
276syscall, and the new
277.Xr swapctl 2
278interface was introduced.
279This also enables the
280.Em EXEC_ELF_NOTELESS
281option.
282.It Cd options COMPAT_13
283Enable binary compatibility with
284.Nx 1.3 .
285This allows the use of old syscalls for
286.Fn sigaltstack ,
287and also enables the old
288.Xr swapctl 2
289command
290.Dv SWAP_STATS
291(now called
292.Dv SWAP_OSTATS ) ,
293which does not include the
294.Fa se_path
295member of
296.Va struct swapent .
297.It Cd options COMPAT_14
298Enable binary compatibility with
299.Nx 1.4 .
300This allows some old
301.Xr ioctl 2
302on
303.Xr wscons 4
304to be performed, and allows the
305.Dv NFSSVC_BIOD
306mode of the
307.Xr nfssvc 2
308system call to be used for compatibility with the deprecated nfsiod program.
309.It Cd options COMPAT_16
310Enable binary compatibility with
311.Nx 1.6 .
312This allows the use of old signal trampoline code which has been deprecated
313with the addition of
314.Xr siginfo 5 .
315.It Cd options COMPAT_43
316Enables compatibility with
317.Bx 4.3 .
318This adds an old syscall for
319.Xr lseek 2 .
320It also adds the ioctls for
321.Dv TIOCGETP
322and
323.Dv TIOCSETP .
324The return values for
325.Xr getpid 2 ,
326.Xr getgid 2 ,
327and
328.Xr getuid 2
329syscalls are modified as well, to return the parent's PID and
330UID as well as the current process's.
331It also enables the deprecated
332.Dv NTTYDISC
333terminal line discipline.
334It also provides backwards compatibility with
335.Dq old
336SIOC[GS]IF{ADDR,DSTADDR,BRDADDR,NETMASK} interface ioctls, including
337binary compatibility with code written before the introduction of the
338sa_len field in sockaddrs.
339It also enables
340support for some older pre
341.Bx 4.4
342socket calls.
343.It Cd options COMPAT_AOUT
344This option is deprecated.
345It was used in the
346.Xr a.out 5
347to
348.Xr elf 5
349transition phase to enable
350.Xr a.out 5
351binaries to find their shared libraries.
352This has been fixed in
353.Xr ld.so 1
354in the meantime.
355The effect is that for
356.Xr a.out 5
357binaries, each name lookup will first search in
358.Pa /emul/aout .
359This causes problems with programs like
360.Xr a.out 5
361shells and emulations that use
362.Xr a.out 5
363(like
364.Tn BSD/OS ) .
365If you use this option you should know what you are doing.
366.It Cd options COMPAT_SVR4
367On those architectures that support it, this enables binary
368compatibility with
369.At V.4
370applications built for the same architecture.
371This currently includes the i386, m68k, and sparc ports.
372.It Cd options COMPAT_LINUX
373On those architectures that support it, this enables binary
374compatibility with Linux ELF and
375.Xr a.out 5
376applications built for the same architecture.
377This currently includes the alpha, arm, i386, m68k, mips, and powerpc
378ports.
379.It Cd options COMPAT_SUNOS
380On those architectures that support it, this enables binary
381compatibility with
382.Tn SunOS 4.1
383applications built for the same architecture.
384This currently includes the sparc, sparc64 and most or all m68k ports.
385Note that the sparc64 requires the
386.Em COMPAT_NETBSD32
387option for 64-bit kernels, in addition to this option.
388.It Cd options COMPAT_ULTRIX
389On those architectures that support it, this enables binary
390compatibility with
391.Tn ULTRIX
392applications built for the same architecture.
393This currently is limited to the pmax.
394The functionality of this option is unknown.
395.It Cd options COMPAT_DARWIN
396On those architectures that support it, this enables binary compatibility with
397.Tn Darwin
398applications built for the same architecture.
399This feature is highly experimental, it requires COMPAT_MACH and
400EXEC_MACHO and it is currently limited to i386 and powerpc ports of
401.Nx .
402.It Cd options COMPAT_FREEBSD
403On those architectures that support it, this enables binary
404compatibility with
405.Fx
406applications built for the same architecture.
407At the moment this is limited to the i386 port.
408.It Cd options COMPAT_HPUX
409On those architectures that support it, this enables binary
410compatibility with
411.Tn HP/UX
412applications built for the same architecture.
413This is limited to the hp300 port, and has some known bugs.
414A limited set of programs do work.
415.It Cd options COMPAT_IBCS2
416On those architectures that support it, this enables binary
417compatibility with iBCS2 or SVR3 applications built for the same architecture.
418This is currently limited to the i386 and vax ports.
419.It Cd options COMPAT_IRIX
420On those architectures that support it, this enables binary
421compatibility with IRIX o32 binaries built for the same architecture.
422This feature is experimental, and it is currently limited to
423the sgimips port.
424.It Cd options COMPAT_MACH
425On those architectures that support it, this enables the emulation of
426Mach kernel traps for binaries built for the same architecture.
427This features is highly experimental and it is currently
428limited to i386 and powerpc ports of
429.Nx .
430.It Cd options COMPAT_OSF1
431On those architectures that support it, this enables binary
432compatibility with
433.Tn Digital
434.Ux
435.Po
436formerly
437.Tn OSF/1
438.Pc
439applications built for the same architecture.
440This is currently limited to the alpha port.
441.It Cd options COMPAT_NOMID
442Enable compatibility with
443.Xr a.out 5
444executables that lack a machine ID.
445This includes
446.Nx 0.8 Ns 's
447ZMAGIC format, and 386BSD and BSDI's
448QMAGIC, NMAGIC, and OMAGIC
449.Xr a.out 5
450formats.
451.It Cd options COMPAT_NETBSD32
452On those architectures that support it, this enables binary
453compatibility with 32-bit applications built for the same architecture.
454This is currently limited to the amd64 and sparc64 ports, and only
455applicable for 64-bit kernels.
456.It Cd options COMPAT_SVR4_32
457On those architectures that support it, this enables binary
458compatibility with 32-bit SVR4 applications built for the same architecture.
459This is currently limited to the sparc64 port, and only applicable for
46064-bit kernels.
461.It Cd options COMPAT_AOUT_M68K
462On m68k architectures which have switched to ELF,
463this enable binary compatibility with
464.Nx Ns Tn /m68k
465.Xr a.out 5
466executables on
467.Nx Ns Tn /m68k
468ELF kernel.
469This handles alignment incompatibility of m68k ABI between
470a.out and ELF which causes the structure padding differences.
471Currently only some system calls which use
472.Va struct stat
473are adjusted and some binaries which use
474.Xr sysctl 3
475to retrieve network details would not work properly.
476.It Cd options EXEC_MACHO
477On those architectures that support it, this adds support for running
478Mach-O executables.
479This is currently limited to the i386 and powerpc ports of
480.Nx .
481.It Cd options EXEC_ELF_NOTELESS
482Run unidentified ELF binaries as
483.Nx
484binaries.
485This might be needed for very old
486.Nx
487ELF binaries on some archs.
488These old binaries didn't contain an appropriate
489.Li .note.netbsd.ident
490section, and thus can't be identified by the kernel as
491.Nx
492binaries otherwise.
493Beware - if this option is on, the kernel would run
494.Em any
495unknown ELF binaries as if they were
496.Nx
497binaries.
498.El
499.Ss Debugging Options
500.Bl -ohang
501.It Cd options DDB
502Compiles in a kernel debugger for diagnosing kernel problems.
503See
504.Xr ddb 4
505for details.
506.Em NOTE :
507not available on all architectures.
508.It Cd options DDB_FROMCONSOLE=integer
509If set to non-zero, DDB may be entered by sending a break on a serial
510console or by a special key sequence on a graphics console.
511A value of "0" ignores console breaks or key sequences.
512If not explicitly specified, the default value is "1".
513Note that this sets the value of the
514.Em ddb.fromconsole
515.Xr sysctl 3
516variable which may be changed at run time -- see
517.Xr sysctl 8
518for details.
519.It Cd options DDB_HISTORY_SIZE=integer
520If this is non-zero, enable history editing in the kernel debugger
521and set the size of the history to this value.
522.It Cd options DDB_ONPANIC
523If set to non-zero, DDB will be entered upon kernel panic.
524The default if not specified is "1".
525Note that this sets the value of the
526.Em ddb.onpanic
527.Xr sysctl 3
528variable which may be changed at run time -- see
529.Xr sysctl 8
530for details.
531.It Cd options DDB_BREAK_CHAR=integer
532This option overrides the using break to enter the kernel debugger
533on the serial console.
534The value given will is the ascii value to be used instead.
535This is currently only supported by the com driver.
536.It Cd options KGDB
537Compiles in a remote kernel debugger stub for diagnosing kernel problems
538using the
539.Dq remote target
540feature of gdb.
541See
542.Xr gdb 1
543for details.
544.Em NOTE :
545not available on all architectures.
546.It Cd options KGDB_DEV
547Device number
548.Po
549as a
550.Dv dev_t
551.Pc
552of kgdb device.
553.It Cd options KGDB_DEVADDR
554Memory address of kgdb device.
555.It Cd options KGDB_DEVMODE
556Permissions of kgdb device.
557.It Cd options KGDB_DEVNAME
558Device name of kgdb device.
559.It Cd options KGDB_DEVRATE
560Baud rate of kgdb device.
561.It Cd makeoptions DEBUG="-g"
562The -g flag causes
563.Pa netbsd.gdb
564to be built in addition to
565.Pa netbsd .
566.Pa netbsd.gdb
567is useful for debugging kernel crash dumps with gdb.
568See
569.Xr gdb 1
570for details.
571This also turns on
572.Em options DEBUG
573(which see).
574.It Cd options DEBUG
575Turns on miscellaneous kernel debugging.
576Since options are turned into preprocessor defines (see above),
577.Em options DEBUG
578is equivalent to doing a
579.Em #define DEBUG
580throughout the kernel.
581Much of the kernel has
582.Em #ifdef DEBUG
583conditionalized debugging code.
584Note that many parts of the kernel (typically device drivers) include their own
585.Em #ifdef XXX_DEBUG
586conditionals instead.
587This option also turns on certain other options,
588which may decrease system performance.
589.It Cd options DIAGNOSTIC
590Adds code to the kernel that does internal consistency checks.
591This code will cause the kernel to panic if corruption of internal data
592structures is detected.
593These checks can decrease performance up to 15%.
594.It Cd options KSTACK_CHECK_MAGIC
595Check kernel stack usage and panic if stack overflow is detected.
596This check is performance sensitive because it scans stack on each context
597switch.
598.It Cd options KTRACE
599Add hooks for the system call tracing facility, which allows users to
600watch the system call invocation behavior of processes.
601See
602.Xr ktrace 1
603for details.
604.It Cd options MSGBUFSIZE=integer
605This option sets the size of the kernel message buffer.
606This buffer holds the kernel output of
607.Fn printf
608when not (yet) read by
609.Xr syslogd 8 .
610This is particularly useful when the system has crashed and you wish to lookup
611the kernel output from just before the crash.
612Also, since the autoconfig output becomes more and more verbose,
613it sometimes happens that the message buffer overflows before
614.Xr syslogd 8
615was able to read it.
616Note that not all systems are capable of obtaining a variable sized message
617buffer.
618There are also some systems on which memory contents are not preserved
619across reboots.
620.It Cd options MALLOCLOG
621Enables an event log for
622.Xr malloc 9 .
623Useful for tracking down
624.Dq Data modified on freelist
625and
626.Dq multiple free
627problems.
628.It Cd options MALLOCLOGSIZE=integer
629Defines the number of entries in the malloc log.
630Default is 100000 entries.
631.It Cd options SYSTRACE
632Add hooks for the system call policy facility.
633See
634.Xr systrace 1
635for details.
636.It Cd options UVMHIST
637Enables the UVM history logs, which create in-memory traces of
638various UVM activities.
639These logs can be displayed be calling
640.Fn uvmhist_dump
641or
642.Fn uvm_hist
643with appropriate arguments from DDB.
644See the kernel source file sys/uvm/uvm_stat.c for details.
645.It Cd options UVMHIST_PRINT
646Prints the UVM history logs on the system console as entries are added.
647Note that the output is
648.Em extremely
649voluminous, so this option is really only useful for debugging
650the very earliest parts of kernel initialization.
651.El
652.Ss File Systems
653.Bl -ohang
654.It Cd file-system FFS
655Includes code implementing the Berkeley Fast File System
656.Em ( FFS ) .
657Most machines need this if they are not running diskless.
658.It Cd file-system EXT2FS
659Includes code implementing the Second Extended File System
660.Em ( EXT2FS ) ,
661revision 0 and revision 1 with the
662.Em filetype
663and
664.Em sparse_super
665options.
666This is the most commonly used file system on the Linux operating system,
667and is provided here for compatibility.
668Some of the specific features of
669.Em EXT2FS
670like the "behavior on errors" are not implemented.
671This file system can't be used with UID or GID greater than 65535.
672See
673.Xr mount_ext2fs 8
674for details.
675.It Cd file-system LFS
676.Em [EXPERIMENTAL]
677Include the Log-structured File System
678.Em ( LFS ) .
679See
680.Xr mount_lfs 8
681and
682.Xr newfs_lfs 8
683for details.
684.It Cd file-system MFS
685Include the Memory File System
686.Em ( MFS ) .
687This file system stores files in swappable memory, and produces
688notable performance improvements when it is used as the file store
689for
690.Pa /tmp
691and similar file systems.
692See
693.Xr mount_mfs 8
694for details.
695.It Cd file-system NFS
696Include the client side of the Network File System
697.Pq Tn NFS
698remote file sharing protocol.
699Although the bulk of the code implementing
700.Tn NFS
701is kernel based, several user level daemons are needed for it to work.
702See
703.Xr mount_nfs 8
704for details.
705.It Cd file-system CD9660
706Includes code for the
707.Tn ISO
7089660 + Rock Ridge file system, which is the standard file system on many
709.Tn CD-ROM
710discs.
711Useful primarily if you have a
712.Tn CD-ROM
713drive.
714See
715.Xr mount_cd9660 8
716for details.
717.It Cd file-system MSDOSFS
718Includes the
719.Tn MS-DOS
720FAT file system, which is reportedly still used
721by unfortunate people who have not heard about
722.Nx .
723Also implements the
724.Tn Windows 95
725extensions to the same, which permit the use of longer, mixed case
726file names.
727See
728.Xr mount_msdos 8
729and
730.Xr fsck_msdos 8
731for details.
732.It Cd file-system NTFS
733.Em [EXPERIMENTAL]
734Includes code for the
735.Tn Microsoft Windows NT
736file system.
737See
738.Xr mount_ntfs 8
739for details.
740.It Cd file-system FDESC
741Includes code for a file system, conventionally mounted on
742.Pa /dev/fd ,
743which permits access to the per-process file descriptor space via
744special files in the file system.
745See
746.Xr mount_fdesc 8
747for details.
748Note that this facility is redundant, and thus unneeded on most
749.Nx
750systems, since the
751.Xr fd 4
752pseudo-device driver already provides identical functionality.
753On most
754.Nx
755systems, instances of
756.Xr fd 4
757are mknoded under
758.Pa /dev/fd/
759and on
760.Pa /dev/stdin ,
761.Pa /dev/stdout ,
762and
763.Pa /dev/stderr .
764.It Cd file-system KERNFS
765Includes code which permits the mounting of a special file system
766(normally mounted on
767.Pa /kern )
768in which files representing various kernel variables and parameters
769may be found.
770See
771.Xr mount_kernfs 8
772for details.
773.It Cd file-system NULLFS
774Includes code for a loopback file system.
775This permits portions of the file hierarchy to be re-mounted in other places.
776The code really exists to provide an example of a stackable file system layer.
777See
778.Xr mount_null 8
779for details.
780.It Cd file-system OVERLAY
781Includes code for a file system filter.
782This permits the overlay file system to intercept all access to an underlying
783file system.
784This file system is intended to serve as an example of a stacking file
785system which has a need to interpose itself between an underlying file
786system and all other access.
787See
788.Xr mount_overlay 8
789for details.
790.It Cd file-system PORTAL
791.Em [EXPERIMENTAL]
792Includes the portal file system.
793This permits interesting tricks like opening
794.Tn TCP
795sockets by opening files in the file system.
796The portal file system is conventionally mounted on
797.Pa /p
798and is partially implemented by a special daemon.
799See
800.Xr mount_portal 8
801for details.
802.It Cd file-system PROCFS
803Includes code for a special file system (conventionally mounted on
804.Pa /proc )
805in which the process space becomes visible in the file system.
806Among
807other things, the memory spaces of processes running on the system are
808visible as files, and signals may be sent to processes by writing to
809.Pa ctl
810files in the procfs namespace.
811See
812.Xr mount_procfs 8
813for details.
814.It Cd file-system UMAPFS
815Includes a loopback file system in which user and group IDs may be
816remapped -- this can be useful when mounting alien file systems with
817different UIDs and GIDs than the local system.
818See
819.Xr mount_umap 8
820for details.
821.It Cd file-system UNION
822.Em [EXPERIMENTAL]
823Includes code for the union file system, which permits directories to
824be mounted on top of each other in such a way that both file systems
825remain visible -- this permits tricks like allowing writing (and the
826deleting of files) on a read-only file system like a
827.Tn CD-ROM
828by mounting a local writable file system on top of the read-only file system.
829See
830.Xr mount_union 8
831for details.
832.It Cd file-system CODA
833.Em [EXPERIMENTAL]
834Includes code for the Coda file system.
835Coda is a distributed file system like NFS and AFS.
836It is freely available, like NFS, but it functions much like AFS in being a
837.Dq stateful
838file system.
839Both Coda and AFS cache files on your local machine to improve performance.
840Then Coda goes a step further than AFS by letting you access the cached
841files when there is no available network, viz. disconnected laptops and
842network outages.
843In Coda, both the client and server are outside the kernel which makes
844them easier to experiment with.
845Coda is available for several UNIX and non-UNIX platforms.
846See http://www.coda.cs.cmu.edu for more details.
847NOTE: You also need to enable the pseudo-device, vcoda, for the Coda
848file system to work.
849.El
850.Ss File System Options
851.Bl -ohang
852.It Cd options NFSSERVER
853Include the server side of the
854.Em NFS
855(Network File System) remote file sharing protocol.
856Although the bulk of the code implementing
857.Em NFS
858is kernel based, several user level daemons are needed for it to
859work.
860See
861.Xr mountd 8
862and
863.Xr nfsd 8
864for details.
865.It Cd options QUOTA
866Enables kernel support for file system quotas.
867See
868.Xr quotaon 8 ,
869.Xr edquota 8 ,
870and
871.Xr quota 1
872for details.
873Note that quotas only work on
874.Dq ffs
875file systems, although
876.Xr rpc.rquotad 8
877permits them to be accessed over
878.Em NFS .
879.It Cd options FFS_EI
880Enable ``Endian-Independent'' FFS support.
881This allows a system to mount an FFS file system created for another
882architecture, at a small performance cost for all FFS file systems.
883See also
884.Xr newfs 8 ,
885.Xr fsck_ffs 8 ,
886.Xr dumpfs 8
887for file system byte order status and manipulation.
888.It Cd options NVNODE=integer
889This option sets the size of the cache used by the name-to-inode translation
890routines, (a.k.a. the
891.Fn namei
892cache, though called by many other names in the kernel source).
893By default, this cache has
894.Dv NPROC
895(set as 20 + 16 * MAXUSERS) * (80 + NPROC / 8) entries.
896A reasonable way to derive a value of
897.Dv NVNODE ,
898should you notice a large number of namei cache misses with a tool such as
899.Xr systat 1 ,
900is to examine your system's current computed value with
901.Xr sysctl 8 ,
902(which calls this parameter "kern.maxvnodes") and to increase this value
903until either the namei cache hit rate improves or it is determined that
904your system does not benefit substantially from an increase in the size of
905the namei cache.
906.It Cd options NAMECACHE_ENTER_REVERSE
907Causes the namei cache to always enter a reverse mapping (vnode -\*[Gt] name)
908as well as a normal one.
909Normally, this is already done for directory vnodes, to speed up the getcwd
910operation.
911This option will cause longer hash chains in the reverse cache, and thus
912slow down getcwd somewhat.
913However, it does make vnode -\*[Gt] path translations possible in some cases.
914For now, only useful if strict /proc/#/maps emulation for Linux binaries is
915required.
916.It Cd options EXT2FS_SYSTEM_FLAGS
917This option changes the behavior of the APPEND and IMMUTABLE flags
918for a file on an
919.Em EXT2FS
920file system.
921Without this option, the superuser or owner of the file can
922set and clear them.
923With this option, only the superuser can set them, and
924they can't be cleared if the securelevel is greater than 0.
925See also
926.Xr chflags 1 .
927.It Cd options NFS_BOOT_BOOTP
928Enable use of the BOOTP protocol (RFCs 951 and 1048) to get configuration
929information if NFS is used to mount the root file system.
930See
931.Xr diskless 8
932for details.
933.It Cd options NFS_BOOT_DHCP
934Same as
935.Dq NFS_BOOT_BOOTP ,
936but use the DHCP extensions to the
937BOOTP protocol (RFC 1541).
938.It Cd options NFS_BOOT_BOOTP_REQFILE
939Specifies the string sent in the bp_file field of the BOOTP / DHCP
940request packet.
941.It Cd options NFS_BOOT_BOOTPARAM
942Enable use of the BOOTPARAM protocol, consisting of RARP and
943BOOTPARAM RPC, to get configuration information if NFS
944is used to mount the root file system.
945See
946.Xr diskless 8
947for details.
948.It Cd options NFS_BOOT_RWSIZE=value
949Set the initial NFS read and write sizes for diskless-boot requests.
950The normal default is 8Kbytes.
951This option provides a way to lower the value (e.g., to 1024 bytes)
952as a workaround for buggy network interface cards or boot PROMs.
953Once booted, the read and write request sizes can be increased by
954remounting the file system.
955See
956.Xr mount_nfs 8
957for details.
958.It Cd options NFS_V2_ONLY
959Reduce the size of the NFS client code by omitting code that's only required
960for NFSv3 and NQNFS support, leaving only that code required to use NFSv2
961servers.
962.El
963.Ss Miscellaneous Options
964.Bl -ohang
965.It Cd options NEW_BUFQ_STRATEGY
966Enable experimental buffer queue strategy for disk I/O.
967It gives higher priority to read requests over write requests, and thereby
968improves the overall system responsiveness considerably under heavy disk
969I/O load.
970.Em NOTE :
971It's not yet proven to be stable, so use it at your own risk.
972.It Cd options LKM
973Enable loadable kernel modules.
974See
975.Xr lkm 4
976for details.
977.Em NOTE :
978not available on all architectures.
979.It Cd options INSECURE
980Hardwires the kernel security level at -1.
981This means that the system
982always runs in secure level 0 mode, even when running multiuser.
983See the manual page for
984.Xr init 8
985for details on the implications of this.
986The kernel secure level may manipulated by the superuser by altering the
987.Em kern.securelevel
988.Xr sysctl 3
989variable (the secure level may only be lowered by a call from process ID 1,
990i.e.
991.Xr init 8 ) .
992See also
993.Xr sysctl 8
994and
995.Xr sysctl 3 .
996.It Cd options MEMORY_DISK_DYNAMIC
997This options makes the
998.Xr md 4
999.Tn RAM
1000disk size dynamically sized.
1001.It Cd options MEMORY_DISK_HOOKS
1002This option allows for some machine dependent functions to be called when
1003the
1004.Xr md 4
1005.Tn RAM
1006disk driver is configured.
1007This can result in automatically loading a
1008.Tn RAM
1009disk from floppy on open (among other things).
1010.It Cd options MEMORY_DISK_IS_ROOT
1011Forces the
1012.Xr md 4
1013.Tn RAM
1014disk to be the root device.
1015This can only be overridden when
1016the kernel is booted in the 'ask-for-root' mode.
1017.It Cd options MEMORY_DISK_ROOT_SIZE=integer
1018Allocates the given number of 512 byte blocks as memory for the
1019.Xr md 4
1020.Tn RAM
1021disk, to be populated with
1022.Xr mdsetimage 8 .
1023.It Cd options MEMORY_DISK_SERVER=0
1024Do not include the interface to a userland memory disk server process.
1025Per default, this options is set to 1, including the support code.
1026Useful for install media kernels.
1027.It Cd options VNODE_OP_NOINLINE
1028Do not inline the
1029.Fn VOP_*
1030calls in the kernel.
1031On i386 GENERIC, this saves 36k of kernel text.
1032Useful for install media kernels, small memory systems and embedded systems.
1033.It Cd options MALLOC_NOINLINE
1034Time critical fixed size memory allocation is performed with
1035.Fn MALLOC
1036and
1037.Fn FREE .
1038Normally these expand to inline code, but with
1039.Em MALLOC_NOINLINE
1040these call the normal
1041.Fn malloc
1042and
1043.Fn free
1044functions.
1045Useful for install media kernels, small memory systems and embedded systems.
1046.It Cd options HZ=integer
1047On ports that support it, set the system clock frequency (see
1048.Xr hz 9 )
1049to the supplied value.
1050Handle with care.
1051.It Cd options NTP
1052Turns on in-kernel precision timekeeping support used by software
1053implementing
1054.Em NTP
1055(Network Time Protocol, RFC 1305).
1056The
1057.Em NTP
1058option adds an in-kernel Phase-Locked Loop (PLL) for normal
1059.Em NTP
1060operation, and a Frequency-Locked Loop (FLL) for intermittently-connected
1061operation.
1062.Xr ntpd 8
1063will employ a user-level PLL when kernel support is unavailable,
1064but the in-kernel version has lower latency and more precision, and
1065so typically keeps much better time.
1066The interface to the kernel
1067.Em NTP
1068support is provided by the
1069.Xr ntp_adjtime 2
1070and
1071.Xr ntp_gettime 2
1072system calls, which are intended for use by
1073.Xr ntpd 8
1074and are enabled by the option.
1075On systems with sub-microsecond resolution timers, or where (HZ / 100000)
1076is not an integer, the
1077.Em NTP
1078option also enables extended-precision arithmetic to keep track of
1079fractional clock ticks at NTP time-format precision.
1080.It Cd options PPS_SYNC
1081This option enables a kernel serial line discipline for receiving time
1082phase signals from an external reference clock such as a radio clock.
1083(The
1084.Em NTP
1085option (which see) must be on if the
1086.Em PPS_SYNC
1087option is used.)
1088Some reference clocks generate a Pulse Per Second (PPS) signal in
1089phase with their time source.
1090The
1091.Em PPS
1092line discipline receives this signal on either the data leads
1093or the DCD control lead of a serial port.
1094.Em NTP
1095uses the PPS signal to discipline the local clock oscillator to a high
1096degree of precision (typically less than 50 microseconds in time and
10970.1 ppm in accuracy).
1098.Em PPS
1099can also generate a serial output pulse when the system receives a PPS
1100interrupt.
1101This can be used to measure the system interrupt latency and thus calibrate
1102.Em NTP
1103to account for it.
1104Using
1105.Em PPS
1106usually requires a
1107gadget box
1108to convert from TTL to RS-232 signal levels.
1109The gadget box and PPS are described in more detail in the HTML documentation
1110for
1111.Xr ntpd 8
1112in
1113.Pa /usr/share/doc/html/ntp .
1114.It Cd options NO_TSC_TIME
1115Don't use TSC microtime, even if available (i386 only).
1116Improves time behavior under VMware.
1117.It Cd options SETUIDSCRIPTS
1118Allows scripts with the setuid bit set to execute as the effective
1119user rather than the real user, just like binary executables.
1120.Pp
1121.Em NOTE :
1122Using this option will also enable
1123.Em options FDSCRIPTS
1124.It Cd options FDSCRIPTS
1125Allows execution of scripts with the execute bit set, but not the
1126read bit, by opening the file and passing the file descriptor to
1127the shell, rather than the filename.
1128.Pp
1129.Em NOTE :
1130Execute only (non-readable) scripts will have
1131.Va argv[0]
1132set to
1133.Pa /dev/fd/* .
1134What this option allows as far as security is
1135concerned, is the ability to safely ensure that the correct script
1136is run by the interpreter, as it is passed as an already open file.
1137.It Cd options PUCCN
1138Enables treating serial ports found on PCI boards
1139.Xr puc 4
1140as potential console devices.
1141The method for choosing such a console device is port dependent.
1142.It Cd options RTC_OFFSET=integer
1143The kernel (and typically the hardware battery backed-up clock on
1144those machines that have one) keeps time in
1145.Em UTC
1146(Universal Coordinated Time, once known as
1147.Em GMT ,
1148or Greenwich Mean Time)
1149and not in the time of the local time zone.
1150The
1151.Em RTC_OFFSET
1152option is used on some ports (such as the i386) to tell the kernel
1153that the hardware clock is offset from
1154.Em UTC
1155by the specified number of minutes.
1156This is typically used when a machine boots several operating
1157systems and one of them wants the hardware clock to run in the
1158local time zone and not in
1159.Em UTC ,
1160e.g.
1161.Em RTC_OFFSET=300
1162means
1163the hardware clock is set to US Eastern Time (300 minutes behind
1164.Em UTC ) ,
1165and not
1166.Em UTC .
1167(Note:
1168.Em RTC_OFFSET
1169is used to initialize a kernel variable named
1170.Va rtc_offset
1171which is the source actually used to determine the clock offset, and
1172which may be accessed via the kern.rtc_offset sysctl variable.
1173See
1174.Xr sysctl 8
1175and
1176.Xr sysctl 3
1177for details.
1178Since the kernel clock is initialized from the hardware clock very
1179early in the boot process, it is not possible to meaningfully change
1180.Va rtc_offset
1181in system initialization scripts.
1182Changing this value currently may only be done at kernel compile
1183time or by patching the kernel and rebooting).
1184.Pp
1185.Em NOTE :
1186Unfortunately, in many cases where the hardware clock
1187is kept in local time, it is adjusted for Daylight Savings
1188Time; this means that attempting to use
1189.Em RTC_OFFSET
1190to let
1191.Nx
1192coexist with such an operating system, like Windows,
1193would necessitate changing
1194.Em RTC_OFFSET
1195twice a year.
1196As such, this solution is imperfect.
1197.It Cd options KMEMSTATS
1198The kernel memory allocator,
1199.Xr malloc 9 ,
1200will keep statistics on its performance if this option is enabled.
1201Unfortunately, this option therefore essentially disables the
1202.Fn MALLOC
1203and
1204.Fn FREE
1205forms of the memory allocator, which are used to enhance the performance
1206of certain critical sections of code in the kernel.
1207This option therefore can lead to a significant decrease in the
1208performance of certain code in the kernel if enabled.
1209Examples of such code include the
1210.Fn namei
1211routine, the
1212.Xr ccd 4
1213driver,
1214the
1215.Xr ncr 4
1216driver,
1217and much of the networking code.
1218.It Cd options MAXUPRC=integer
1219Sets the soft
1220.Dv RLIMIT_NPROC
1221resource limit, which specifies the maximum number of simultaneous
1222processes a user is permitted to run, for process 0;
1223this value is inherited by its child processes.
1224It defaults to
1225.Em CHILD_MAX ,
1226which is currently defined to be 160.
1227Setting
1228.Em MAXUPRC
1229to a value less than
1230.Em CHILD_MAX
1231is not permitted, as this would result in a violation of the semantics of
1232.St -p1003.1-90 .
1233.It Cd options NOFILE=integer
1234Sets the soft
1235.Dv RLIMIT_NOFILE
1236resource limit, which specifies the maximum number of open
1237file descriptors for each process;
1238this value is inherited by its child processes.
1239It defaults to
1240.Em OPEN_MAX ,
1241which is currently defined to be 64.
1242.It Cd options DEFCORENAME=string
1243Sets the default value of the
1244.Em kern.defcorename
1245sysctl variable, otherwise it is set to
1246.Nm %n.core .
1247See
1248.Xr sysctl 8
1249and
1250.Xr sysctl 3
1251for details.
1252.It Cd options RASOPS_CLIPPING
1253Enables clipping within the
1254.Nm rasops
1255raster-console output system.
1256.Em NOTE :
1257only available on architectures that use
1258.Nm rasops
1259for console output.
1260.It Cd options RASOPS_SMALL
1261Removes optimized character writing code from the
1262.Nm rasops
1263raster-console output system.
1264.Em NOTE :
1265only available on architectures that use
1266.Nm rasops
1267for console output.
1268.It Cd options INCLUDE_CONFIG_FILE
1269Embeds the kernel config file used to define the kernel in the kernel
1270binary itself.
1271The embedded data also includes any files directly included by the config
1272file itself, e.g.
1273.Pa GENERIC.local
1274or
1275.Pa std.$MACHINE .
1276The embedded config file can be extracted from the resulting kernel by
1277the following command:
1278.Bd -literal -offset indent
1279strings netbsd | sed -n 's/^_CFG_//p' | unvis
1280.Ed
1281.It Cd options INCLUDE_JUST_CONFIG
1282Similar to the above option, but includes just the actual config file,
1283not any included files.
1284.It Cd options PIPE_SOCKETPAIR
1285Use slower, but smaller socketpair(2)-based pipe implementation instead
1286of default faster, but bigger one.
1287Primarily useful for installation kernels.
1288.It Cd options USERCONF
1289Compiles in the in-kernel device configuration manager.
1290See
1291.Xr userconf 4
1292for details.
1293.It Cd options PERFCTRS
1294Compiles in kernel support for CPU performance-monitoring counters.
1295See
1296.Xr pmc 1
1297for details.
1298.Em NOTE :
1299not available on all architectures.
1300.It Cd options XSERVER
1301Compiles in kernel support for
1302.Tn X11
1303on architectures that still use (or can use) the legacy
1304.Em pccons
1305console drivers rather than
1306.Xr wscons 4 .
1307These include bebox, i386, shark.
1308.It Cd options XSERVER_DDB
1309A supplement to XSERVER that adds support for entering
1310.Xr ddb 4
1311while in
1312.Tn X11 .
1313.El
1314.Ss Networking Options
1315.Bl -ohang
1316.It Cd options GATEWAY
1317Enables
1318.Em IPFORWARDING
1319(which see)
1320and (on most ports) increases the size of
1321.Em NMBCLUSTERS
1322(which see).
1323In general,
1324.Em GATEWAY
1325is used to indicate that a system should act as a router, and
1326.Em IPFORWARDING
1327is not invoked directly.
1328(Note that
1329.Em GATEWAY
1330has no impact on protocols other than
1331.Tn IP ,
1332such as
1333.Tn CLNP
1334or
1335.Tn XNS ) .
1336.Em GATEWAY
1337option also compiles IPv4 fast forwarding code into the kernel.
1338.It Cd options IPFORWARDING=value
1339If
1340.Em value
1341is 1 this enables IP routing behavior.
1342If
1343.Em value
1344is 0 (the default), it disables it.
1345The
1346.Em GATEWAY
1347option sets this to 1 automatically.
1348With this option enabled, the machine will forward IP datagrams destined
1349for other machines between its interfaces.
1350Note that even without this option, the kernel will
1351still forward some packets (such as source routed packets) -- removing
1352.Em GATEWAY
1353and
1354.Em IPFORWARDING
1355is insufficient to stop all routing through a bastion host on a
1356firewall -- source routing is controlled independently.
1357To turn off source routing, use
1358.Em options IPFORWSRCRT=0
1359(which see).
1360Note that IP forwarding may be turned on and off independently of the
1361setting of the
1362.Em IPFORWARDING
1363option through the use of the
1364.Em net.inet.ip.forwarding
1365sysctl variable.
1366If
1367.Em net.inet.ip.forwarding
1368is 1, IP forwarding is on.
1369See
1370.Xr sysctl 8
1371and
1372.Xr sysctl 3
1373for details.
1374.It Cd options IPFORWSRCRT=value
1375If
1376.Em value
1377is set to zero, source routing of IP datagrams is turned off.
1378If
1379.Em value
1380is set to one (the default) or the option is absent, source routed IP
1381datagrams are forwarded by the machine.
1382Note that source routing of IP packets may be turned on and off
1383independently of the setting of the
1384.Em IPFORWSRCRT
1385option through the use of the
1386.Em net.inet.ip.forwsrcrt
1387sysctl variable.
1388If
1389.Em net.inet.ip.forwsrcrt
1390is 1, forwarding of source routed IP datagrams is on.
1391See
1392.Xr sysctl 8
1393and
1394.Xr sysctl 3
1395for details.
1396.It Cd options IFA_STATS
1397Tells the kernel to maintain per-address statistics on bytes sent
1398and received over (currently) internet and appletalk addresses.
1399.\"This can be a fairly expensive operation, so you probably want to
1400.\"keep this disabled.
1401The option is not recommended as it degrades system stability.
1402.It Cd options IFQ_MAXLEN=value
1403Increases the allowed size of the network interface packet queues.
1404The default queue size is 50 packets, and you do not normally need
1405to increase it.
1406.It Cd options MROUTING
1407Includes support for IP multicast routers.
1408You certainly want
1409.Em INET
1410with this.
1411Multicast routing is controlled by the
1412.Xr mrouted 8
1413daemon.
1414.It Cd options PIM
1415Includes support for Protocol Independent Multicast (PIM) routing.
1416You need
1417.Em MROUTING
1418and
1419.Em INET
1420with this.
1421.It Cd options INET
1422Includes support for the
1423.Tn TCP/IP
1424protocol stack.
1425You almost certainly want this.
1426See
1427.Xr inet 4
1428for details.
1429This option is currently required.
1430.It Cd options INET6
1431Includes support for the
1432.Tn IPv6
1433protocol stack.
1434See
1435.Xr inet6 4
1436for details.
1437Unlike
1438.Em INET ,
1439.Em INET6
1440enables multicast routing code as well.
1441This option requires
1442.Em INET
1443at this moment, but it should not.
1444.It Cd options ND6_DEBUG
1445The option sets the default value of net.inet6.icmp6.nd6_debug to 1,
1446for debugging IPv6 neighbor discovery protocol handling.
1447See
1448.Xr sysctl 3
1449for details.
1450.It Cd options IPSEC
1451Includes support for the
1452.Tn IPsec
1453protocol.
1454See
1455.Xr ipsec 4
1456for details.
1457.It Cd options IPSEC_DEBUG
1458Enables debugging code in
1459.Tn IPsec
1460stack.
1461See
1462.Xr ipsec 4
1463for details.
1464.It Cd options IPSEC_ESP
1465Includes support for
1466.Tn IPsec
1467.Tn ESP
1468protocol.
1469See
1470.Xr ipsec 4
1471for details.
1472.It Cd options ALTQ
1473Enabled ALTQ (Alternate Queueing).
1474For simple rate-limiting, use
1475.Xr tbrconfig 8
1476to set up the interface transmission rate.
1477To use queueing disciplines, their appropriate kernel options should also
1478be defined (documented below).
1479Queueing disciplines are managed by
1480.Xr altqd 8 .
1481See
1482.Xr altq 9
1483for details.
1484.It Cd options ALTQ_HFSC
1485Include support for ALTQ-implemented HFSC (Hierarchical Fair Service Curve)
1486module.
1487HFSC supports both link-sharing and guaranteed real-time services.
1488HFSC employs a service curve based QoS model, and its unique feature
1489is an ability to decouple delay and bandwidth allocation.
1490Requires
1491.Em ALTQ_RED
1492to use the RED queueing discipline on HFSC classes, or
1493.Em ALTQ_RIO
1494to use the RIO queueing discipline on HFSC classes.
1495This option assumes
1496.Em ALTQ .
1497.It Cd options ALTQ_PRIQ
1498Include support for ALTQ-implemented PRIQ (Priority Queueing).
1499PRIQ implements a simple priority-based queueing discipline.
1500A higher priority class is always served first.
1501Requires
1502.Em ALTQ_RED
1503to use the RED queueing discipline on HFSC classes, or
1504.Em ALTQ_RIO
1505to use the RIO queueing discipline on HFSC classes.
1506This option assumes
1507.Em ALTQ .
1508.It Cd options ALTQ_WFQ
1509Include support for ALTQ-implemented WFQ (Weighted Fair Queueing).
1510WFQ implements a weighted-round robin scheduler for a set of queues.
1511A weight can be assigned to each queue to give a different proportion
1512of the link capacity.
1513A hash function is used to map a flow to one of a set of queues.
1514This option assumes
1515.Em ALTQ .
1516.It Cd options ALTQ_FIFOQ
1517Include support for ALTQ-implemented FIFO queueing.
1518FIFOQ is a simple drop-tail FIFO (First In, First Out) queueing discipline.
1519This option assumes
1520.Em ALTQ .
1521.It Cd options ALTQ_RIO
1522Include support for ALTQ-implemented RIO (RED with In/Out).
1523The original RIO has 2 sets of RED parameters; one for in-profile
1524packets and the other for out-of-profile packets.
1525At the ingress of the network, profile meters tag packets as IN or
1526OUT based on contracted profiles for customers.
1527Inside the network, IN packets receive preferential treatment by
1528the RIO dropper.
1529ALTQ/RIO has 3 drop precedence levels defined for the Assured Forwarding
1530PHB of DiffServ (RFC 2597).
1531This option assumes
1532.Em ALTQ .
1533.It Cd options ALTQ_BLUE
1534Include support for ALTQ-implemented Blue buffer management.
1535Blue is another active buffer management mechanism.
1536This option assumes
1537.Em ALTQ .
1538.It Cd options ALTQ_FLOWVALVE
1539Include support for ALTQ-implemented Flowvalve.
1540Flowvalve is a simple implementation of a RED penalty box that identifies
1541and punishes misbehaving flows.
1542This option requires
1543.Em ALTQ_RED
1544and assumes
1545.Em ALTQ .
1546.It Cd options ALTQ_CDNR
1547Include support for ALTQ-implemented CDNR (diffserv traffic conditioner)
1548packet marking/manipulation.
1549Traffic conditioners are components to meter, mark, or drop incoming
1550packets according to some rules.
1551As opposed to queueing disciplines, traffic conditioners handle incoming
1552packets at an input interface.
1553This option assumes
1554.Em ALTQ .
1555.It Cd options ALTQ_NOPCC
1556Disables use of processor cycle counter to measure time in ALTQ.
1557This option should be defined for a non-Pentium i386 CPU which does not
1558have TSC, SMP (per-CPU counters are not in sync), or power management
1559which affects processor cycle counter.
1560This option assumes
1561.Em ALTQ .
1562.It Cd options ALTQ_IPSEC
1563Include support for IPsec in IPv4 ALTQ.
1564This option assumes
1565.Em ALTQ .
1566.It Cd options ALTQ_JOBS
1567Undocumented at this time.
1568.It Cd options ALTQ_AFMAP
1569Include support for an undocumented ALTQ feature that is used to map an IP
1570flow to an ATM VC (Virtual Circuit).
1571This option assumes
1572.Em ALTQ .
1573.It Cd options ALTQ_LOCALQ
1574Include support for ALTQ-implemented local queues.
1575Its practical use is undefined.
1576Assumes
1577.Em ALTQ .
1578.It Cd options SUBNETSARELOCAL
1579Sets default value for net.inet.ip.subnetsarelocal variable, which
1580controls whether non-directly-connected subnets of connected networks
1581are considered "local" for purposes of choosing the MSS for a TCP
1582connection.
1583This is mostly present for historic reasons and completely irrelevant if
1584you enable Path MTU discovery.
1585.It Cd options HOSTZEROBROADCAST
1586Sets default value for net.inet.ip.hostzerobroadcast variable, which
1587controls whether the zeroth host address of each connected subnet is
1588also considered a broadcast address.
1589Default value is "1", for compatibility with old systems; if this is
1590set to zero on all hosts on a subnet, you should be able to fit an extra
1591host per subnet on the
1592".0" address.
1593.It Cd options MCLSHIFT=value
1594This option is the base-2 logarithm of the size of mbuf clusters.
1595The
1596.Bx
1597networking stack keeps network packets in a linked
1598list, or chain, of kernel buffer objects called mbufs.
1599The system provides larger mbuf clusters as an optimization for
1600large packets, instead of using long chains for large packets.
1601The mbuf cluster size,
1602or
1603.Em MCLBYTES ,
1604must be a power of two, and is computed as two raised to the power
1605.Em MCLSHIFT .
1606On systems with Ethernet network adaptors,
1607.Em MCLSHIFT
1608is often set to 11, giving 2048-byte mbuf clusters, large enough to
1609hold a 1500-byte
1610.Tn Ethernet
1611frame in a single cluster.
1612Systems with network interfaces supporting larger frame sizes like
1613.Tn ATM ,
1614.Tn FDDI ,
1615or
1616.Tn HIPPI
1617may perform better with
1618.Em MCLSHIFT
1619set to 12 or 13, giving mbuf cluster sizes of 4096 and 8192 bytes,
1620respectively.
1621.It Cd options NS
1622Include support for the
1623.Tn Xerox
1624.Tn XNS
1625protocol stack.
1626See
1627.Xr ns 4
1628for details.
1629.It Cd options ISO,TPIP
1630Include support for the ubiquitous
1631.Tn OSI
1632protocol stack.
1633See
1634.Xr iso 4
1635for details.
1636This option assumes
1637.Em INET .
1638.It Cd options EON
1639Include support for tunneling
1640.Tn OSI
1641protocols over
1642.Tn IP .
1643Known to be broken, or at least very fragile, and undocumented.
1644.It Cd options CCITT,LLC,HDLC
1645Include support for the
1646.Tn CCITT
1647(nee
1648.Tn ITU-TSS )
1649.Tn X.25
1650protocol stack.
1651The state of this code is currently unknown, and probably contains bugs.
1652This option assumes
1653.Em INET .
1654.It Cd options NETATALK
1655Include support for the
1656.Tn AppleTalk
1657protocol stack.
1658The kernel provides provision for the
1659.Em Datagram Delivery Protocol
1660(DDP), providing SOCK_DGRAM support and
1661.Tn AppleTalk
1662routing.
1663This stack is used by the
1664.Em NETATALK
1665package, which adds support for
1666.Tn AppleTalk
1667server services via user libraries and applications.
1668.It Cd options IPNOPRIVPORTS
1669Normally, only root can bind a socket descriptor to a so-called
1670.Dq privileged
1671.Tn TCP
1672port, that is, a port number in the range 0-1023.
1673This option eliminates those checks from the kernel.
1674This can be useful if there is a desire to allow daemons without
1675privileges to bind those ports, e.g., on firewalls.
1676The security tradeoffs in doing this are subtle.
1677This option should only be used by experts.
1678.It Cd options TCP_COMPAT_42
1679.Tn TCP
1680bug compatibility with
1681.Bx 4.2 .
1682In
1683.Bx 4.2 ,
1684.Tn TCP
1685sequence numbers were 32-bit signed values.
1686Modern implementations of TCP use unsigned values.
1687This option clamps the initial sequence number to start in
1688the range 2^31 rather than the full unsigned range of 2^32.
1689Also, under
1690.Bx 4.2 ,
1691keepalive packets must contain at least one byte or else
1692the remote end would not respond.
1693.It Cd options TCP_DEBUG
1694Record the last
1695.Em TCP_NDEBUG
1696TCP packets with SO_DEBUG set, and decode to the console if
1697.Em tcpconsdebug
1698is set.
1699.It Cd options TCP_NDEBUG
1700Number of packets to record for
1701.Em TCP_DEBUG .
1702Defaults to 100.
1703.It Cd options TCP_SENDSPACE=value
1704.It Cd options TCP_RECVSPACE=value
1705These options set the max TCP window size to other sizes than the default.
1706The TCP window sizes can be altered via
1707.Xr sysctl 8
1708as well.
1709.It Cd options TCP_INIT_WIN=value
1710This option sets the initial TCP window size for non-local connections,
1711which is used when the transmission starts.
1712The default size is 1, but if the machine should act more aggressively,
1713the initial size can be set to some other value.
1714The initial TCP window size can be set via
1715.Xr sysctl 8
1716as well.
1717.It Cd options PFIL_HOOKS
1718This option turns on the packet filter interface hooks.
1719See
1720.Xr pfil 9
1721for details.
1722This option assumes
1723.Em INET .
1724.It Cd options IPFILTER_LOG
1725This option, in conjunction with
1726.Em pseudo-device ipfilter ,
1727enables logging of IP packets using ip-filter.
1728.It Cd options IPFILTER_DEFAULT_BLOCK
1729This option sets the default policy of ip-filter.
1730If it is set, ip-filter will block packets by default.
1731.It Cd options BRIDGE_IPF
1732This option causes
1733.Em bridge
1734devices to use the IP and/or IPv6 filtering hooks, forming
1735a link-layer filter that uses protocol-layer rules.
1736This option assumes the presence of
1737.Em pseudo-device ipfilter .
1738.It Cd options MBUFTRACE
1739This option can help track down mbuf leaks.
1740When enabled, mbufs are tagged with the devices and protocols using them,
1741which slightly decreases network performance.
1742This additional information can be viewed with
1743.Xr netstat 1 :
1744.Dl Ic netstat Fl mssv
1745Not all devices or protocols support this option.
1746.El
1747.Ss Sysctl Related Options
1748.Bl -ohang
1749.It Cd options SYSCTL_DISALLOW_CREATE
1750Disallows the creation or deletion of nodes from the sysctl tree, as
1751well as the assigning of descriptions to nodes that lack them, by any
1752process.
1753These operations are still available to kernel sub-systems, including
1754loadable kernel modules.
1755.It Cd options SYSCTL_DISALLOW_KWRITE
1756Prevents processes from adding nodes to the sysctl tree that make
1757existing kernel memory areas writeable.
1758Sections of kernel memory can still be read and new nodes that own
1759their own data may still be be writeable.
1760.It Cd options SYSCTL_DEBUG_SETUP
1761Causes the SYSCTL_SETUP routines to print a brief message when they
1762are invoked.
1763This is merely meant as an aid in determining the order in which
1764sections of the tree are created.
1765.It Cd options SYSCTL_DEBUG_CREATE
1766Prints a message each time
1767.Fn sysctl_create ,
1768the function that adds nodes to the tree, is called.
1769.It Cd options SYSCTL_INCLUDE_DESCR
1770Causes the kernel to include short, human readable descriptions for
1771nodes in the sysctl tree.
1772The descriptions can be retrieved programmatically (see
1773.Xr sysctl 3 ) ,
1774or by the sysctl binary itself (see
1775.Xr sysctl 8 ) .
1776The descriptions are meant to give an indication of the purpose and/or
1777effects of a given node's value, not replace the documentation for the
1778given subsystem as a whole.
1779.El
1780.Ss System V IPC Options
1781.Bl -ohang
1782.It Cd options SYSVMSG
1783Includes support for
1784.At V
1785style message queues.
1786See
1787.Xr msgctl 2 ,
1788.Xr msgget 2 ,
1789.Xr msgrcv 2 ,
1790.Xr msgsnd 2 .
1791.It Cd options SYSVSEM
1792Includes support for
1793.At V
1794style semaphores.
1795See
1796.Xr semctl 2 ,
1797.Xr semget 2 ,
1798.Xr semop 2 .
1799.It Cd options SEMMNI=value
1800Sets the number of
1801.At V
1802style semaphore identifiers.
1803The GENERIC config file for your port will have the default.
1804.It Cd options SEMMNS=value
1805Sets the number of
1806.At V
1807style semaphores in the system.
1808The GENERIC config file for your port will have the default.
1809.It Cd options SEMUME=value
1810Sets the maximum number of undo entries per process for
1811.At V
1812style semaphores.
1813The GENERIC config file for your port will have the default.
1814.It Cd options SEMMNU=value
1815Sets the number of undo structures in the system for
1816.At V
1817style semaphores.
1818The GENERIC config file for your port will have the default.
1819.It Cd options SYSVSHM
1820Includes support for
1821.At V
1822style shared memory.
1823See
1824.Xr shmat 2 ,
1825.Xr shmctl 2 ,
1826.Xr shmdt 2 ,
1827.Xr shmget 2 .
1828.It Cd options SHMMAXPGS=value
1829Sets the maximum number of
1830.At V
1831style shared memory pages that are available through the
1832.Xr shmget 2
1833system call.
1834Default value is 1024 on most ports.
1835See
1836.Pa /usr/include/machine/vmparam.h
1837for the default.
1838.El
1839.Ss VM Related Options
1840.Bl -ohang
1841.It Cd options NMBCLUSTERS=value
1842The number of mbuf clusters the kernel supports.
1843Mbuf clusters are MCLBYTES in size (usually 2k).
1844This is used to compute the size of the kernel VM map
1845.Em mb_map ,
1846which maps mbuf clusters.
1847Default on most ports is 1024 (2048 with
1848.Dq options GATEWAY
1849).
1850See
1851.Pa /usr/include/machine/param.h
1852for exact default information.
1853Increase this value if you get
1854.Dq mclpool limit reached
1855messages.
1856.It Cd options NKMEMPAGES=value
1857.It Cd options NKMEMPAGES_MIN=value
1858.It Cd options NKMEMPAGES_MAX=value
1859Size of kernel VM map
1860.Em kmem_map ,
1861in PAGE_SIZE-sized chunks (the VM page size; this value may be read
1862from the
1863.Xr sysctl 8
1864variable
1865.Em hw.pagesize
1866).
1867This VM map is used to map the kernel malloc arena.
1868The kernel attempts to auto-size this map based on the amount of
1869physical memory in the system.
1870Platform-specific code may place bounds on this computed size,
1871which may be viewed with the
1872.Xr sysctl 8
1873variable
1874.Em vm.nkmempages .
1875See
1876.Pa /usr/include/machine/param.h
1877for the default upper and lower bounds.
1878The related options
1879.Sq NKMEMPAGES_MIN
1880and
1881.Sq NKMEMPAGES_MAX
1882allow the bounds to be overridden in the kernel configuration file.
1883These options are provided in the event the computed value is
1884insufficient resulting in an
1885.Dq out of space in kmem_map
1886panic.
1887.It Cd options SB_MAX=value
1888Sets the max size in bytes that a socket buffer is allowed to occupy.
1889The default is 256k, but sometimes it needs to be increased, for example
1890when using large TCP windows.
1891This option can be changed via
1892.Xr sysctl 8
1893as well.
1894.It Cd options SOMAXKVA=value
1895Sets the maximum size of kernel virtual memory that the socket buffers
1896are allowed to use.
1897The default is 16MB, but in situations where for example large TCP
1898windows are used this value must also be increased.
1899This option can be changed via
1900.Xr sysctl 8
1901as well.
1902.It Cd options BUFCACHE=value
1903Size of the buffer cache as a percentage of total available
1904.Tn RAM .
1905Ignored if BUFPAGES is also specified.
1906.It Cd options NBUF=value
1907Sets the number of buffer headers available, i.e., the number of
1908open files that may have a buffer cache entry.
1909Each buffer header
1910requires MAXBSIZE (machine dependent, but usually 65536) bytes.
1911The default value is machine dependent, but is usually equal to the
1912value of BUFPAGES.
1913If an architecture dependent VM_MAX_KERNEL_BUF constant is defined
1914then NBUF may be reduced at run time so that the storage allocated
1915for buffer headers doesn't exceed that limit.
1916.It Cd options BUFPAGES=value
1917These options set the number of pages available for the buffer cache.
1918Their default value is a machine dependent value, often calculated as
1919between 5% and 10% of total available
1920.Tn RAM .
1921.It Cd options MAXTSIZ=bytes
1922Sets the maximum size limit of a process' text segment.
1923See
1924.Pa /usr/include/machine/vmparam.h
1925for the port-specific default.
1926.It Cd options DFLDSIZ=bytes
1927Sets the default size limit of a process' data segment, the value that
1928will be returned as the soft limit for
1929.Dv RLIMIT_DATA
1930(as returned by
1931.Xr getrlimit 2 ) .
1932See
1933.Pa /usr/include/machine/vmparam.h
1934for the port-specific default.
1935.It Cd options MAXDSIZ=bytes
1936Sets the maximum size limit of a process' data segment, the value that
1937will be returned as the hard limit for
1938.Dv RLIMIT_DATA
1939(as returned by
1940.Xr getrlimit 2 ) .
1941See
1942.Pa /usr/include/machine/vmparam.h
1943for the port-specific default.
1944.It Cd options DFLSSIZ=bytes
1945Sets the default size limit of a process' stack segment, the value that
1946will be returned as the soft limit for
1947.Dv RLIMIT_STACK
1948(as returned by
1949.Xr getrlimit 2 ) .
1950See
1951.Pa /usr/include/machine/vmparam.h
1952for the port-specific default.
1953.It Cd options MAXSSIZ=bytes
1954Sets the maximum size limit of a process' stack segment, the value that
1955will be returned as the hard limit for
1956.Dv RLIMIT_STACK
1957(as returned by
1958.Xr getrlimit 2 ) .
1959See
1960.Pa /usr/include/machine/vmparam.h
1961for the port-specific default.
1962.It Cd options DUMP_ON_PANIC=integer
1963Defaults to one.
1964If set to zero, the kernel will not dump to the dump device when
1965it panics, though dumps can still be forced via
1966.Xr ddb 4
1967with the
1968.Dq sync
1969command.
1970Note that this sets the value of the
1971.Em kern.dump_on_panic
1972.Xr sysctl 3
1973variable which may be changed at run time -- see
1974.Xr sysctl 8
1975for details.
1976.It Cd options USE_TOPDOWN_VM
1977User space memory allocations (as made by
1978.Xr mmap 2 )
1979will be arranged in a
1980.Dq top down
1981fashion instead of the traditional
1982.Dq upwards from MAXDSIZ \+ vm_daddr
1983method.
1984This includes the placement of
1985.Xr ld.so 1 .
1986Arranging memory in this manner allows either (or both of) the heap or
1987.Xr mmap 2
1988allocated space to grow larger than traditionally possible.
1989This option is not available on all ports, but is instead expected to be
1990offered on a port-by-port basis, after which some ports will commit to
1991using it by default.
1992See the files
1993.Pa /usr/include/uvm/uvm_param.h
1994for some implementation details, and
1995.Pa /usr/include/machine/vmparam.h
1996for port specific details including availability.
1997.El
1998.Ss amiga-specific Options
1999.Bl -ohang
2000.It Cd options BB060STUPIDROM
2001When the bootloader (which passes
2002.Tn AmigaOS
2003.Tn ROM
2004information) claims we have a 68060
2005.Tn CPU
2006without
2007.Tn FPU ,
2008go look into the Processor Configuration Register (PCR) to find out.
2009You need this with
2010.Tn Amiga
2011.Tn ROM Ns s
2012up to (at least) V40.xxx (OS3.1),
2013when you boot via the bootblocks and don't have a DraCo.
2014.It Cd options IOBZCLOCK=frequency
2015The IOBlix boards come with two different serial master clocks: older ones
2016use 24 MHz, newer ones use 22.1184 MHz.
2017The driver normally assumes the latter.
2018If your board uses 24 MHz, you can recompile your kernel with
2019options IOBZCLOCK=24000000
2020or patch the kernel variable
2021.Tn iobzclock
2022to the same value.
2023.It Cd options LIMITMEM=value
2024If there, limit the part of the first memory bank used by
2025.Nx
2026to value megabytes.
2027Default is unlimited.
2028.It Cd options NKPTADD=addvalue
2029.It Cd options NKPTADDSHIFT=shiftvalue
2030The
2031.Tn CPU
2032specific
2033.Tn MMU
2034table for the kernel is pre-allocated at kernel startup time.
2035Part of it is scaled with
2036.Va maxproc ,
2037to have enough room to hold the user program
2038.Tn MMU
2039tables; the second part is a fixed amount for the kernel itself.
2040.Pp
2041The third part accounts for the size of the file buffer cache.
2042Its size is either
2043.Dv NKPTADD
2044pages (if defined) or memory size in bytes divided by two to
2045the power of
2046.Dv NKPTADDSHIFT .
2047The default is undefined
2048.Dv NKPTADD
2049and
2050.Dv NKPTADDSHIFT=24 ,
2051allowing for 16 buffers per megabyte of main memory (while
2052a GENERIC kernel allocates about half of that).
2053When you get "can't get KPT page" panics, you should increase
2054.Dv NKPTADD
2055(if defined), or decrease
2056.Dv NKPTADDSHIFT
2057by one.
2058.It Cd options P5PPC68KBOARD
2059Add special support for Phase5 mixed 68k+PPC boards.
2060Currently, this only affects rebooting from
2061.Nx
2062and is only needed on 68040+PPC, not on
206368060+PPC; without this, affected machines will hang after
2064.Nx
2065has shut
2066down and will only restart after a keyboard reset or a power cycle.
2067.El
2068.Ss arm32-specific Options
2069.Bl -ohang
2070.It Cd options FRENCH_KBD
2071Include translation for French keyboards when using
2072.Em pccons
2073on a Shark.
2074.It Cd options FINNISH_KBD
2075Include translation for Finnish keyboards when using
2076.Em pccons
2077on a Shark.
2078.It Cd options GERMAN_KBD
2079Include translation for German keyboards when using
2080.Em pccons
2081on a Shark.
2082.It Cd options NORWEGIAN_KBD
2083Include translation for French keyboards when using
2084.Em pccons
2085on a Shark.
2086.El
2087.Ss atari-specific Options
2088.Bl -ohang
2089.It Cd options DISKLABEL_AHDI
2090Include support for AHDI (native Atari) disklabels.
2091.It Cd options DISKLABEL_NBDA
2092Include support for
2093.Nx Ns Tn /atari
2094labels.
2095If you don't set this option, it will be set automatically.
2096.Nx Ns Tn /atari
2097will not work without it.
2098.It Cd options FALCON_SCSI
2099Include support for the 5380-SCSI configuration as found on the Falcon.
2100.It Cd options RELOC_KERNEL
2101If set, the kernel will relocate itself to TT-RAM, if possible.
2102This will give you a slightly faster system.
2103.Em Beware
2104that on some TT030 systems,
2105the system will frequently dump with MMU-faults with this option enabled.
2106.It Cd options SERCONSOLE
2107Allow the modem1-port to act as the system-console.
2108A carrier should be active on modem1 during system boot to active
2109the console functionality.
2110.It Cd options TT_SCSI
2111Include support for the 5380-SCSI configuration as found on the TT030
2112and Hades.
2113.El
2114.Ss i386-specific Options
2115.Bl -ohang
2116.It Cd options I386_CPU,I486_CPU,I586_CPU,I686_CPU
2117Include support for a particular class of
2118.Tn CPU
2119.Po
2120.Tn i386 ,
2121.Tn i486 ,
2122.Tn Pentium ,
2123or
2124.Tn Pentium Pro
2125.Pc .
2126If the appropriate class for your
2127.Tn CPU
2128is not configured, the kernel will use the highest class available
2129that will work.
2130In general, using the correct
2131.Tn CPU
2132class will result in the best performance.
2133At least one of these options must be present.
2134.It Cd options ENHANCED_SPEEDSTEP
2135Include support for the
2136.Tn Enhanced SpeedStep Technology
2137present in newer
2138.Tn CPU Ns s .
2139.It Cd options EST_FREQ_USERWRITE
2140Allow any user to change the frequency of an
2141.Tn Enhanced SpeedStep Technology
2142capable
2143.Tn CPU .
2144.It Cd options CPURESET_DELAY=value
2145Specifies the time (in millisecond) to wait before doing a hardware reset
2146in the last phase of a reboot.
2147This gives the user a chance to see error messages from the shutdown
2148operations (like NFS unmounts, buffer cache flush, etc ...).
2149Setting this to 0 will disable the delay.
2150Default is 2 seconds.
2151.It Cd options MATH_EMULATE
2152Include the floating point emulator.
2153This is useful only for
2154.Tn CPU Ns s
2155that lack an
2156internal Floating Point Unit
2157.Pq Tn FPU
2158or co-processor.
2159.It Cd options VM86
2160Include support for virtual 8086 mode, used by
2161.Tn DOS
2162emulators and X servers to run BIOS code, e.g., for some VESA routines.
2163.It Cd options USER_LDT
2164Include i386-specific system calls for modifying the local descriptor table,
2165used by Windows emulators.
2166.It Cd options REALBASEMEM=integer
2167Overrides the base memory size passed in from the boot block.
2168(Value given in kilobytes.)
2169Use this option only if the boot block reports the size incorrectly.
2170(Note that some
2171.Tn BIOS Ns es
2172put the extended
2173.Tn BIOS
2174data area at the top of base memory, and therefore report a smaller
2175base memory size to prevent programs overwriting it.
2176This is correct behavior, and you should not use the
2177.Em REALBASEMEM
2178option to access this memory).
2179.It Cd options REALEXTMEM=integer
2180Overrides the extended memory size passed in from the boot block.
2181(Value given in kilobytes.
2182Extended memory does not include the first megabyte.)
2183Use this option only if the boot block reports the size incorrectly.
2184.It Cd options FRENCH_KBD,FINNISH_KBD,GERMAN_KBD,NORWEGIAN_KBD
2185Select a non-US keyboard layout for the
2186.Em pccons
2187console driver.
2188.It Cd options CYRIX_CACHE_WORKS
2189Relevant only to the Cyrix 486DLC CPU.
2190This option is used to turn on the cache in hold-flush mode.
2191It is not turned on by default because it is known to have problems in
2192certain motherboard implementations.
2193.It Cd options CYRIX_CACHE_REALLY_WORKS
2194Relevant only to the Cyrix 486DLC CPU.
2195This option is used to turn on the cache in write-back mode.
2196It is not turned on by default because it is known to have problems in
2197certain motherboard implementations.
2198In order for this option to take effect, option
2199.Em CYRIX_CACHE_WORKS
2200must also be specified.
2201.It Cd options PCIBIOS
2202Enable support for initializing the
2203.Tn PCI
2204bus using information from the
2205.Tn BIOS .
2206See
2207.Xr pcibios 4
2208for details.
2209.It Cd options KSTACK_CHECK_DR0
2210Detect kernel stack overflow using DR0 register.
2211This option uses DR0 register exclusively so you can't use DR0 register for
2212other purpose (e.g., hardware breakpoint) if you turn this on.
2213.It Cd options MTRR
2214Include support for accessing MTRR registers from user-space.
2215See
2216.Xr i386_get_mtrr 2 .
2217.It Cd options BEEP_ONHALT
2218Make the system speaker emit several beeps when it is completely safe to
2219power down the computer after a
2220.Xr halt 8
2221command.
2222Requires
2223.Xr sysbeep 4
2224support.
2225.It Cd options BEEP_ONHALT_COUNT=times
2226Number of times to beep the speaker when
2227.Cd options BEEP_ONHALT
2228is enabled.
2229Defaults to 3.
2230.It Cd options BEEP_ONHALT_PITCH=hz
2231The tone frequency used when
2232.Cd options BEEP_ONHALT
2233option, in hertz.
2234Defaults to 1500.
2235.It Cd options BEEP_ONHALT_PERIOD=msecs
2236The duration of each beep when
2237.Cd options BEEP_ONHALT
2238is enabled, in milliseconds.
2239Defaults to 250.
2240.El
2241.Ss isa-specific Options
2242Options specific to
2243.Xr isa 4
2244busses.
2245.Bl -ohang
2246.It Cd options PCIC_ISA_ALLOC_IOBASE=address, PCIC_ISA_ALLOC_IOSIZE=size
2247Control the section of IO bus space used for PCMCIA bus space mapping.
2248Ideally the probed defaults are satisfactory, however in practice
2249that is not always the case.
2250See
2251.Xr pcmcia 4
2252for details.
2253.It Cd options PCIC_ISA_INTR_ALLOC_MASK=mask
2254Controls the allowable interrupts that may be used for
2255.Tn PCMCIA
2256devices.
2257This mask is a logical-or of power-of-2s of allowable interrupts:
2258.Bd -literal -offset 04n
2259.Em "IRQ Val      IRQ Val      IRQ Val       IRQ Val"
2260 0  0x0001    4  0x0010    8  0x0100    12  0x1000
2261 1  0x0002    5  0x0020    9  0x0200    13  0x2000
2262 2  0x0004    6  0x0040   10  0x0400    14  0x4000
2263 3  0x0008    7  0x0080   11  0x0800    15  0x8000
2264.Ed
2265.El
2266.Ss m68k-specific Options
2267.Bl -ohang
2268.It Cd options FPU_EMULATE
2269Include support for MC68881/MC68882 emulator.
2270.It Cd options FPSP
2271Include support for 68040 floating point.
2272.It Cd options M68020,M68030,M68040,M68060
2273Include support for a specific
2274.Tn CPU ,
2275at least one (the one you are using) should be specified.
2276.It Cd options M060SP
2277Include software support for 68060.
2278This provides emulation of unimplemented
2279integer instructions as well as emulation of unimplemented floating point
2280instructions and data types and software support for floating point traps.
2281.El
2282.Ss powerpc-specific Options
2283.Bl -ohang
2284.It Cd options PMAP_MEMLIMIT=value
2285Limit the amount of memory seen by the kernel to
2286.Ar value
2287bytes (OEA only).
2288.El
2289.Ss sparc-specific Options
2290.Bl -ohang
2291.It Cd options AUDIO_DEBUG
2292Enable simple event debugging of the logging of the
2293.Xr audio 4
2294device.
2295.It Cd options BLINK
2296Enable blinking of LED.
2297Blink rate is full cycle every N seconds for
2298N \*[Lt] then current load average.
2299See
2300.Xr getloadavg 3 .
2301.\" .It Cd options COLORFONT_CACHE
2302.\" What does this do?
2303.It Cd options COUNT_SW_LEFTOVERS
2304Count how many times the sw SCSI device has left 3, 2, 1 and 0 in the
2305sw_3_leftover, sw_2_leftover, sw_1_leftover, and sw_0_leftover
2306variables accessible from
2307.Xr ddb 4 .
2308See
2309.Xr sw 4 .
2310.It Cd options DEBUG_ALIGN
2311Adds debugging messages calls when user-requested alignment fault
2312handling happens.
2313.It Cd options DEBUG_EMUL
2314Adds debugging messages calls for emulated floating point and
2315alignment fixing operations.
2316.It Cd options DEBUG_SVR4
2317Prints registers messages calls for emulated SVR4 getcontext and
2318setcontext operations.
2319See
2320.Em options COMPAT_SVR4 .
2321.It Cd options EXTREME_DEBUG
2322Adds debugging functions callable from
2323.Xr ddb 4 .
2324The debug_pagetables, test_region and print_fe_map
2325functions print information about page tables for the SUN4M
2326platforms only.
2327.It Cd options EXTREME_EXTREME_DEBUG
2328Adds extra info to
2329.Em options EXTREME_DEBUG .
2330.It Cd options FPU_CONTEXT
2331Make
2332.Em options COMPAT_SVR4
2333getcontext and setcontext include floating point registers.
2334.It Cd options MAGMA_DEBUG
2335Adds debugging messages to the
2336.Xr magma 4
2337device.
2338.It Cd options RASTERCONS_FULLSCREEN
2339Use the entire screen for the console.
2340.It Cd options RASTERCONS_SMALLFONT
2341Use the Fixed font on the console, instead of the normal font.
2342.It Cd options SUN4
2343Support sun4 class machines.
2344.It Cd options SUN4C
2345Support sun4c class machines.
2346.It Cd options SUN4M
2347Support sun4m class machines.
2348.It Cd options SUN4_MMU3L
2349.\" XXX ???
2350Enable support for sun4 3-level MMU machines.
2351.It Cd options V9
2352Enable SPARC V9 assembler in
2353.Xr ddb 4 .
2354.El
2355.Ss sparc64-specific Options
2356.Bl -ohang
2357.It Cd options AUDIO_DEBUG
2358Enable simple event debugging of the logging of the
2359.Xr audio 4
2360device.
2361.It Cd options BLINK
2362Enable blinking of LED.
2363Blink rate is full cycle every N seconds for
2364N \*[Lt] then current load average.
2365See
2366.Xr getloadavg 3 .
2367.El
2368.Ss x68k-specific Options
2369.Bl -ohang
2370.It Cd options EXTENDED_MEMORY
2371Include support for extended memory, e.g., TS-6BE16 and 060turbo on-board.
2372.It Cd options JUPITER
2373Include support for Jupiter-X MPU accelerator
2374.It Cd options ZSCONSOLE,ZSCN_SPEED=value
2375Use the built-in serial port as the system-console.
2376Speed is specified in bps, defaults to 9600.
2377.It Cd options ITE_KERNEL_ATTR=value
2378Set the kernel message attribute for ITE.
2379Value, an integer, is a logical or of the following values:
2380.Bl -tag -width 4n -compact -offset indent
2381.It 1
2382color inversed
2383.It 2
2384underlined
2385.It 4
2386bolded
2387.El
2388.El
2389.\" The following requests should be uncommented and used where appropriate.
2390.\" .Sh FILES
2391.\" .Sh EXAMPLES
2392.Sh SEE ALSO
2393.Xr gdb 1 ,
2394.Xr ktrace 1 ,
2395.Xr pmc 1 ,
2396.Xr quota 1 ,
2397.Xr gettimeofday 2 ,
2398.Xr i386_get_mtrr 2 ,
2399.Xr i386_iopl 2 ,
2400.Xr msgctl 2 ,
2401.Xr msgget 2 ,
2402.Xr msgrcv 2 ,
2403.Xr msgsnd 2 ,
2404.Xr ntp_adjtime 2 ,
2405.Xr ntp_gettime 2 ,
2406.Xr semctl 2 ,
2407.Xr semget 2 ,
2408.Xr semop 2 ,
2409.Xr shmat 2 ,
2410.Xr shmctl 2 ,
2411.Xr shmdt 2 ,
2412.Xr shmget 2 ,
2413.Xr sysctl 3 ,
2414.Xr apm 4 ,
2415.Xr ddb 4 ,
2416.Xr inet 4 ,
2417.Xr iso 4 ,
2418.Xr lkm 4 ,
2419.Xr md 4 ,
2420.Xr ns 4 ,
2421.Xr pcibios 4 ,
2422.Xr pcmcia 4 ,
2423.Xr ppp 4 ,
2424.Xr userconf 4 ,
2425.Xr wscons 4 ,
2426.Xr config 8 ,
2427.Xr edquota 8 ,
2428.Xr init 8 ,
2429.Xr mdsetimage 8 ,
2430.Xr mount_cd9660 8 ,
2431.Xr mount_fdesc 8 ,
2432.Xr mount_kernfs 8 ,
2433.Xr mount_lfs 8 ,
2434.Xr mount_mfs 8 ,
2435.Xr mount_msdos 8 ,
2436.Xr mount_nfs 8 ,
2437.Xr mount_ntfs 8 ,
2438.Xr mount_null 8 ,
2439.Xr mount_portal 8 ,
2440.Xr mount_procfs 8 ,
2441.Xr mount_umap 8 ,
2442.Xr mount_union 8 ,
2443.Xr mrouted 8 ,
2444.Xr newfs_lfs 8 ,
2445.Xr ntpd 8 ,
2446.Xr quotaon 8 ,
2447.Xr rpc.rquotad 8 ,
2448.Xr sysctl 8
2449.Sh HISTORY
2450The
2451.Nm
2452man page first appeared in
2453.Nx 1.3 .
2454.Sh BUGS
2455The
2456.Em INET
2457option should not be required.
2458The
2459.Em EON
2460option should be a pseudo-device, and is also very fragile.
2461