xref: /netbsd-src/share/man/man4/options.4 (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1.\"	$NetBSD: options.4,v 1.142 2001/07/08 16:19:59 abs 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 August 29, 2000
34.Os
35.Dt OPTIONS 4
36.Sh NAME
37.Nm options
38.Nd Miscellaneous kernel configuration options
39.Sh SYNOPSIS
40.Cd options ...
41.Sh DESCRIPTION
42This manual page describes a number of miscellaneous kernel
43configuration options that may be specified in a kernel config
44file.
45See
46.Xr config 8
47for information on how to configure and build kernels.
48.Em Note :
49Options are passed to the compile process as -D flags to the C
50compiler.
51.Ss Compatibility Options
52.Bl -ohang
53.It Cd options COMPAT_09
54Enable binary compatibility with
55.Nx 0.9 .
56This enables support for
5716-bit user, group, and process ids (following revisions support
5832-bit identifiers),
59It also allows the use of the deprecated
60.Xr getdomainname 3 ,
61.Xr setdomainname 3 ,
62and
63.Xr uname 3
64syscalls.
65This option also allows using numeric filesystem identifiers rather
66than strings.
67Post
68.Nx 0.9
69versions use string identifiers.
70.It Cd options COMPAT_10
71Enable binary compatibility with
72.Nx 1.0 .
73This option allows the use of the filesystem name of
74.Dq ufs
75as an alias for
76.Dq ffs .
77The name
78.Dq ffs
79should be used post 1.0 in
80.Pa /etc/fstab
81and other files.
82It also adds old syscalls for the
83.At V
84shared memory interface.
85This was changed post 1.0 to work on 64-bit architectures.
86This option also enables
87.Dq sgtty
88compatibility, without which programs using the old interface produce
89an
90.Dq inappropriate ioctl
91error, and
92.Pa /dev/io
93only works when this option is set in the kernel,
94see
95.Xr io 4
96on ports that support it.
97.It Cd options COMPAT_11
98Enable binary compatibility with
99.Nx 1.1 .
100This allows binaries running on the i386 port to gain direct access to
101the io ports by opening
102.Pa /dev/io
103read/write.
104This functionality was replaced by
105.Xr i386_iopl 2
106post 1.1.
107On the
108.Tn Atari
109port, the location of the disk label was moved after 1.1.
110When the
111.Em COMPAT_11
112option is set, the kernel will read (pre) 1.1 style disk labels as a
113last resort.
114When a disklabel is re-written, the old style label will be replaced
115with a post 1.1 style label.
116.It Cd options COMPAT_12
117Enable binary compatibility with
118.Nx 1.2 .
119This allows the use of old syscalls for
120.Fn reboot
121and
122.Fn swapon .
123The syscall numbers were changed post 1.2 to add functionality to the
124.Xr reboot 2
125syscall, and the new
126.Xr swapctl 2
127interface was introduced.
128.It Cd options COMPAT_13
129Enable binary compatibility with
130.Nx 1.3 .
131This allows the use of old syscalls for
132.Fn sigaltstack ,
133and also enables the old
134.Xr swapctl 2
135command
136.Dv SWAP_STATS
137(now called
138.Dv SWAP_OSTATS ) ,
139which does not include the
140.Fa se_path
141member of
142.Va struct swapent .
143.It Cd options COMPAT_14
144Enable binary compatibility with
145.Nx 1.4 .
146This allows some old
147.Xr ioctl 2
148on
149.Xr wscons 4
150to be performed, and allows the
151.Dv NFSSVC_BIOD
152mode of the
153.Xr nfssvc 2
154system call to be used for compatibility with the deprecated nfsiod program.
155.It Cd options COMPAT_43
156Enables compatibility with
157.Bx 4.3 .
158This adds an old syscall for
159.Xr lseek 2 .
160It also adds the ioctls for
161.Dv TIOCGETP
162and
163.Dv TIOCSETP .
164The return values for
165.Xr getpid 2 ,
166.Xr getgid 2 ,
167and
168.Xr getuid 2
169syscalls are modified as well, to return the parent's pid and
170uid as well as the current process's.
171It also enables the deprecated
172.Dv NTTYDISC
173terminal line discipline.
174It also provides backwards compatibility with
175.Dq old
176SIOC[GS]IF{ADDR,DSTADDR,BRDADDR,NETMASK} interface ioctls, including
177binary compatibility with code written before the introduction of the
178sa_len field in sockaddrs.
179It also enables
180support for some older pre
181.Bx 4.4
182socket calls.
183.It Cd options COMPAT_SVR4
184On those architectures that support it, this enables binary
185compatibility with
186.At V.4
187applications built for the same architecture.
188This currently includes the i386, m68k and sparc port.
189.It Cd options COMPAT_LINUX
190On those architectures that support it, this enables binary
191compatibility with Linux ELF and
192.Xr a.out 5
193applications built for the same architecture.
194This currently includes the alpha, i386, powerpc, and m68k
195port. COMPAT_LINUX for powerpc is still experimental.
196.It Cd options COMPAT_SUNOS
197On those architectures that support it, this enables binary
198compatibility with
199.Tn SunOS 4.1
200applications built for the same architecture.
201This currently includes the sparc, sparc64 and most or all m68k ports.
202Note that the sparc64 requires the
203.Em COMPAT_NETBSD32
204option for 64-bit kernels, in addition to this option.
205.It Cd options COMPAT_ULTRIX
206On those architectures that support it, this enables binary
207compatibility with
208.Tn Ultrix
209applications built for the same architecture.
210This currently is limited to the pmax.
211The functionality of this option is unknown.
212.It Cd options COMPAT_FREEBSD
213On those architectures that support it, this enables binary
214compatibility with
215.Fx
216applications built for the same architecture.
217At the moment this is limited to the i386 port.
218.It Cd options COMPAT_HPUX
219On those architectures that support it, this enables binary
220compatibility with
221.Tn HP/UX
222applications built for the same architecture.
223This is limited to the hp300 port, and has some known bugs.
224A limited set of programs do work.
225.It Cd options COMPAT_IBCS2
226On those architectures that support it, this enables binary
227compatibility with iBCS2 or SVR3 applications built for the same architecture.
228This is currently limited to the i386 and vax ports.
229.It Cd options COMPAT_OSF1
230On those architectures that support it, this enables binary
231compatibility with
232.Tn Digital
233.Ux
234.Po
235formerly
236.Tn OSF/1
237.Pc
238applications built for the same architecture.
239This is currently limited to the alpha port.
240.It Cd options COMPAT_NOMID
241Enable compatibility with
242.Xr a.out 5
243executables that lack a machine ID.
244This includes
245.Nx 0.8 Ns 's
246ZMAGIC format, and 386BSD and BSDI's
247QMAGIC, NMAGIC, and OMAGIC
248.Xr a.out 5
249formats.
250.It Cd options COMPAT_NETBSD32
251On those architectures that support it, this enables binary
252compatibility with 32-bit applications built for the same architecture.
253This is currently limited to the sparc64 port, and only applicable for
25464-bit kernels.
255.It Cd options COMPAT_SVR4_32
256On those architectures that support it, this enables binary
257compatibility with 32-bit SVR4 applications built for the same architecture.
258This is currently limited to the sparc64 port, and only applicable for
25964-bit kernels.
260.It Cd options COMPAT_AOUT_M68K
261On m68k architectures which have switched to ELF,
262this enable binary compatibility with
263.Nx Ns Tn /m68k
264.Xr a.out 5
265executables on
266.Nx Ns Tn /m68k
267ELF kernel.
268This handles alignment incompatibility of m68k ABI between
269a.out and ELF which causes the structure padding differences.
270Currently only some system calls which use
271.Va struct stat
272are adjusted and some binaries which use
273.Xr sysctl 3
274to retrieve network details would not work properly.
275.El
276.Ss Debugging Options
277.Bl -ohang
278.It Cd options DDB
279Compiles in a kernel debugger for diagnosing kernel problems.
280See
281.Xr ddb 4
282for details.
283.Em NOTE :
284not available on all architectures.
285.It Cd options DDB_FROMCONSOLE=integer
286If set to non-zero, DDB may be entered by sending a break on a serial
287console or by a special key sequence on a graphics console.
288A value of "0" ignores console breaks or key sequences,
289It not explicitly specified, the default value is "1".
290Note that this sets the value of the
291.Em ddb.fromconsole
292.Xr sysctl 3
293variable which may be changed at run time -- see
294.Xr sysctl 8
295for details.
296.It Cd options DDB_HISTORY_SIZE=integer
297If this is non-zero, enable history editing in the kernel debugger
298and set the size of the history to this value.
299.It Cd options DDB_ONPANIC
300If set to non-zero, the DDB will be entered upon kernel panic.
301The default if not specified is "1".
302Note that this sets the value of the
303.Em ddb.onpanic
304.Xr sysctl 3
305variable which may be changed at run time -- see
306.Xr sysctl 8
307for details.
308.It Cd options DDB_BREAK_CHAR=integer
309This option overrides the using break to enter the kernel debugger
310on the serial console.
311The value given will is the ascii value to be used instead.
312This is currently only supported by the com driver.
313.It Cd options KGDB
314Compiles in a remote kernel debugger stub for diagnosing kernel problems
315using the
316.Dq remote target
317feature of gdb.
318See
319.Xr gdb 1
320for details.
321.Em NOTE :
322not available on all architectures.
323.It Cd makeoptions DEBUG="-g"
324The -g flag causes
325.Pa netbsd.gdb
326to be built in addition to
327.Pa netbsd .
328.Pa netbsd.gdb
329is useful for debugging kernel crash dumps with gdb.
330The command
331.Dl gdb -k
332invokes gdb in kernel debugger mode.
333See
334.Xr gdb 1
335for details.
336This also turns on
337.Em options DEBUG
338(which see).
339.It Cd options DEBUG
340Turns on miscellaneous kernel debugging.
341Since options are turned into preprocessor defines (see above),
342.Em options DEBUG
343is equivalent to doing a
344.Em #define DEBUG
345throughout the kernel.
346Much of the kernel has
347.Em #ifdef DEBUG
348conditionalized debugging code.
349Note that many parts of the kernel (typically device drivers) include their own
350.Em #ifdef XXX_DEBUG
351conditionals instead.
352This option also turns on certain other options,
353which may decrease system performance.
354.It Cd options DIAGNOSTIC
355Adds code to the kernel that does internal consistency checks.
356This code will cause the kernel to panic if corruption of internal data
357structures is detected. These checks can decrease performance up to 15%.
358.It Cd options KTRACE
359Add hooks for the system call tracing facility, which allows users to
360watch the system call invocation behavior of processes.
361See
362.Xr ktrace 1
363for details.
364.It Cd options MSGBUFSIZE=integer
365This option sets the size of the kernel message buffer.
366This buffer holds the kernel output of
367.Fn printf
368when not (yet) read by
369.Xr syslogd 8 .
370This is particularly useful when the system has crashed and you wish to lookup
371the kernel output from just before the crash.
372Also, since the autoconfig output becomes more and more verbose,
373it sometimes happens that the message buffer overflows before
374.Xr syslogd 8
375was able to read it.
376Note that not all systems are capable of obtaining a variable sized message
377buffer.
378There are also some systems on which memory contents are not preserved
379across reboots.
380.It Cd options MALLOCLOG
381Enables an event log for
382.Xr malloc 9 .
383Useful for tracking down
384.Dq Data modified on freelist
385and
386.Dq multiple free
387problems.
388.It Cd options MALLOCLOGSIZE=integer
389Defines the number of entries in the malloc log.
390Default is 100000 entries.
391.El
392.Ss File Systems
393.Bl -ohang
394.It Cd file-system FFS
395Includes code implementing the Berkeley Fast File System
396.Em ( FFS ) .
397Most machines need this if they are not running diskless.
398.It Cd file-system EXT2FS
399Includes code implementing the Second Extended File System
400.Em ( EXT2FS )
401, revision 0 and revision 1 with the
402.Em filetype
403and
404.Em sparse_super
405options.  This is the most commonly used file system on the Linux operating
406system, and is provided here for compatibility.
407Some of the specific features of
408.Em EXT2FS
409like the "behavior on errors" are not implemented.
410This file system can't be used with UID or GID greater than 65535.
411See
412.Xr mount_ext2fs 8
413for details.
414.It Cd file-system LFS
415.Em [EXPERIMENTAL]
416Include the Log-structured File System
417.Em ( LFS ) .
418See
419.Xr mount_lfs 8
420and
421.Xr newfs_lfs 8
422for details.
423.It Cd file-system MFS
424Include the Memory File System
425.Em ( MFS ) .
426This file system stores files in swappable memory, and produces
427notable performance improvements when it is used as the file store
428for
429.Pa /tmp
430and similar file systems.
431See
432.Xr mount_mfs 8
433for details.
434.It Cd file-system NFS
435Include the client side of the Network File System
436.Pq Tn NFS
437remote file sharing protocol.
438Although the bulk of the code implementing
439.Tn NFS
440is kernel based, several user level daemons are needed for it to work.
441See
442.Xr mount_nfs 8
443for details.
444.It Cd file-system CD9660
445Includes code for the
446.Tn ISO
4479660 + Rock Ridge file system, which is the standard file system on many
448.Tn CD-ROM
449discs.
450Useful primarily if you have a
451.Tn CD-ROM
452drive.
453See
454.Xr mount_cd9660 8
455for details.
456.It Cd file-system MSDOSFS
457Includes the
458.Tn MS-DOS
459FAT file system, which is reportedly still used
460by unfortunate people who have not heard about
461.Nx .
462Also implements the
463.Tn Windows 95
464extensions to the same, which permit the use of longer, mixed case
465file names.
466See
467.Xr mount_msdos 8
468and
469.Xr fsck_msdos 8
470for details.
471.It Cd file-system NTFS
472[EXPERIMENTAL] Includes code for the
473.Tn Microsoft Windows NT
474file system.
475See
476.Xr mount_ntfs 8
477for details.
478.It Cd file-system FDESC
479Includes code for a file system, conventionally mounted on
480.Pa /dev/fd ,
481which permits access to the per-process file descriptor space via
482special files in the file system.
483See
484.Xr mount_fdesc 8
485for details.
486Note that this facility is redundant, and thus unneeded on most
487.Nx
488systems, since the
489.Xr fd 4
490pseudodevice driver already provides identical functionality.
491On most
492.Nx
493systems, instances of
494.Xr fd 4
495are mknoded under
496.Pa /dev/fd/
497and on
498.Pa /dev/stdin ,
499.Pa /dev/stdout ,
500and
501.Pa /dev/stderr .
502.It Cd file-system KERNFS
503Includes code which permits the mounting of a special file system
504(normally mounted on
505.Pa /kern )
506in which files representing various kernel variables and parameters
507may be found.
508See
509.Xr mount_kernfs 8
510for details.
511.It Cd file-system NULLFS
512Includes code for a loopback file system.
513This permits portions of the file hierarchy to be re-mounted in other places.
514The code really exists to provide an example of a stackable file system layer.
515See
516.Xr mount_null 8
517for details.
518.It Cd file-system OVERLAY
519Includes code for a file system filter.
520This permits the overlay file system to intercept all access to an underlying
521file system. This file system is intended to serve as an example of
522a stacking file system which has a need to interpose itself between an
523underlying file system and all other access.
524See
525.Xr mount_overlay 8
526for details.
527.It Cd file-system PORTAL
528.Em [EXPERIMENTAL]
529Includes the portal filesystem.
530This permits interesting tricks like opening
531.Tn TCP
532sockets by opening files in the file system.
533The portal file system is conventionally mounted on
534.Pa /p
535and is partially implemented by a special daemon.
536See
537.Xr mount_portal 8
538for details.
539.It Cd file-system PROCFS
540Includes code for a special file system (conventionally mounted on
541.Pa /proc )
542in which the process space becomes visible in the file system.
543Among
544other things, the memory spaces of processes running on the system are
545visible as files, and signals may be sent to processes by writing to
546.Pa ctl
547files in the procfs namespace.
548See
549.Xr mount_procfs 8
550for details.
551.It Cd file-system UMAPFS
552Includes a loopback file system in which user and group ids may be
553remapped -- this can be useful when mounting alien file systems with
554different uids and gids than the local system.
555See
556.Xr mount_umap 8
557for details.
558.It Cd file-system UNION
559.Em [EXPERIMENTAL]
560Includes code for the union file system, which permits directories to
561be mounted on top of each other in such a way that both file systems
562remain visible -- this permits tricks like allowing writing (and the
563deleting of files) on a read-only file system like a
564.Tn CD-ROM
565by mounting a local writable file system on top of the read-only file system.
566See
567.Xr mount_union 8
568for details.
569.It Cd file-system CODA
570.Em [EXPERIMENTAL]
571Includes code for the Coda file system.
572Coda is a distributed file system like NFS and AFS.  It is
573freely available, like NFS, but it functions much like AFS in being a
574"stateful" file system.  Both Coda and AFS cache files on your local
575machine to improve performance.  Then Coda goes a step further than AFS
576by letting you access the cached files when there is no available
577network, viz. disconnected laptops and network outages.  In Coda, both
578the client and server are outside the kernel which makes them easier
579to experiment with.  Coda is available for several UNIX and non-UNIX
580platforms.
581See http://www.coda.cs.cmu.edu for more details.
582NOTE: You also need to enable the pseudo-device, vcoda, for the Coda
583filesystem to work.
584.El
585.Ss File System Options
586.Bl -ohang
587.It Cd options NFSSERVER
588Include the server side of the
589.Em NFS
590(Network File System) remote file sharing protocol.
591Although the bulk of the code implementing
592.Em NFS
593is kernel based, several user level daemons are needed for it to
594work.
595See
596.Xr mountd 8
597and
598.Xr nfsd 8
599for details.
600.It Cd options QUOTA
601Enables kernel support for file system quotas.
602See
603.Xr quotaon 8 ,
604.Xr edquota 8 ,
605and
606.Xr quota 1
607for details.
608Note that quotas only work on
609.Dq ffs
610file systems, although
611.Xr rpc.rquotad 8
612permits them to be accessed over
613.Em NFS .
614.It Cd options FFS_EI
615Enable ``Endian-Independent'' FFS support.
616This allows a system to mount an FFS filesystem created for another
617architecture, at a small performance cost for all FFS filesystems.
618See also
619.Xr newfs 8 ,
620.Xr fsck_ffs 8 ,
621.Xr dumpfs 8
622for filesystem byte order status and manipulation.
623.It Cd options NVNODE=integer
624This option sets the size of the cache used by the name-to-inode translation
625routines, (a.k.a. the
626.Fn namei
627cache, though called by many other names in the kernel source).
628By default, this cache has
629.Dv NPROC
630(set as 20 + 16 * MAXUSERS) * (80 + NPROC / 8) entries.
631A reasonable way to derive a value of
632.Dv NVNODE ,
633should you notice a large number of namei cache misses with a tool such as
634.Xr systat 1 ,
635is to examine your system's current computed value with
636.Xr sysctl 8 ,
637(which calls this parameter "kern.maxvnodes") and to increase this value
638until either the namei cache hit rate improves or it is determined that
639your system does not benefit substantially from an increase in the size of
640the namei cache.
641.It Cd options NAMECACHE_ENTER_REVERSE
642Causes the namei cache to always enter a reverse mapping (vnode -> name)
643as well as a normal one. Normally, this is already done for directory
644vnodes, to speed up the getcwd operation. This option will cause
645longer hash chains in the reverse cache, and thus slow down
646getcwd somewhat. However, it does make vnode -> path translations
647possible in some cases. For now, only useful if strict /proc/#/maps
648emulation for Linux binaries is required.
649.It Cd options EXT2FS_SYSTEM_FLAGS
650This option changes the behavior of the APPEND and IMMUTABLE flags
651for a file on an
652.Em EXT2FS
653filesystem.
654Without this option, the superuser or owner of the file can
655set and clear them.
656With this option, only the superuser can set them, and
657they can't be cleared if the securelevel is greater than 0.
658See also
659.Xr chflags 1 .
660.It Cd options NFS_BOOT_BOOTP
661Enable use of the BOOTP protocol (RFC 951, 1048) to get configuration
662information if NFS is used to mount the root file system.
663See
664.Xr diskless 8
665for details.
666.It Cd options NFS_BOOT_DHCP
667Same as
668.Dq NFS_BOOT_BOOTP
669, but use the DHCP extensions to the
670BOOTP protocol (RFC 1541).
671.It Cd options NFS_BOOT_BOOTP_REQFILE
672Specifies the string sent in the bp_file field of the BOOTP / DHCP
673request packet.
674.It Cd options NFS_BOOT_BOOTPARAM
675Enable use of the BOOTPARAM protocol, consisting of RARP and
676BOOTPARAM RPC, to get configuration information if NFS
677is used to mount the root file system.
678See
679.Xr diskless 8
680for details.
681.It Cd options NFS_BOOT_RWSIZE=value
682Set the initial NFS read and write sizes for diskless-boot requests.
683The normal default is 8Kbytes.  This option provides a way to lower
684the value (e.g., to 1024 bytes) as a workaround for buggy network
685interface cards or boot proms. Once booted, the read and write request
686sizes can be increased by remounting the filesystem. See
687.Xr mount_nfs 8
688for details.
689.It Cd options NFS_V2_ONLY
690Reduce the size of the NFS client code by omitting code that's only required
691for NFSv3 and NQNFS support, leaving only that code required to use NFSv2
692servers.
693.El
694.Ss Miscellaneous Options
695.Bl -ohang
696.It Cd options LKM
697Enable loadable kernel modules.
698See
699.Xr lkm 4
700for details.
701.Em NOTE :
702not available on all architectures.
703.It Cd options INSECURE
704Hardwires the kernel security level at -1.
705This means that the system
706always runs in secure level 0 mode, even when running multiuser.
707See the manual page for
708.Xr init 8
709for details on the implications of this.
710The kernel secure level may manipulated by the superuser by altering the
711.Em kern.securelevel
712.Xr sysctl 3
713variable (the secure level may only be lowered by a call from process ID 1,
714i.e.
715.Xr init 8 ) .
716See also
717.Xr sysctl 8
718and
719.Xr sysctl 3 .
720.It Cd options UCONSOLE
721Normally, only the superuser can execute the
722.Dv TIOCCONS
723.Xr ioctl 2 ,
724which redirects console output to a non-console tty.
725See
726.Xr tty 4
727for details.
728This option permits any user to execute the
729.Dv TIOCCONS
730.Xr ioctl 2 .
731This is useful on
732machines such as personal workstations which run
733.Xr X 7
734servers, where one would prefer to permit console output to be
735viewed in a window without requiring a suid root program to do it.
736.It Cd options MEMORY_DISK_HOOKS
737This option allows for some machine dependent functions to be called when
738the
739.Tn RAM
740disk driver is configured.
741This can result in automatically loading a
742.Tn RAM
743disk from floppy on open (among other things).
744.It Cd options MEMORY_DISK_IS_ROOT
745Forces the
746.Tn RAM
747disk to be the root device.
748This can only be overridden when
749the kernel is booted in the 'ask-for-root' mode.
750.It Cd options VNODE_OP_NOINLINE
751Do not inline the VOP_*() calls in the kernel.
752On i386 GENERIC, this saves 36k of kernel text.  Useful
753for install media kernels, small memory systems and embedded systems.
754.It Cd options NTP
755Turns on in-kernel precision timekeeping support used by software
756implementing
757.Em NTP
758(Network Time Protocol, RFC1305).
759The
760.Em NTP
761option adds an in-kernel Phase-Locked Loop (PLL) for normal
762.Em NTP
763operation, and a Frequency-Locked Loop (FLL) for intermittently-connected
764operation.
765.Xr ntpd 8
766will employ a user-level PLL when kernel support is unavailable,
767but the in-kernel version has lower latency and more precision, and
768so typically keeps much better time.
769The interface to the kernel
770.Em NTP
771support is provided by the
772.Xr ntp_adjtime 2
773and
774.Xr ntp_gettime 2
775system calls, which are intended for use by
776.Xr ntpd 8
777and are enabled by the option.
778On systems with sub-microsecond resolution timers, or where (HZ / 100000)
779is not an integer, the
780.Em NTP
781option also enables extended-precision arithmetic to keep track of
782fractional clock ticks at NTP time-format precision.
783.It Cd options PPS_SYNC
784This option enables a kernel serial line discipline for receiving time
785phase signals from an external reference clock such as a radio clock.
786(The
787.Em NTP
788option (which see) must be on if the
789.Em PPS_SYNC
790option is used.)
791Some reference clocks generate a Pulse Per Second (PPS) signal in
792phase with their time source.
793The
794.Em PPS
795line discipline receives this signal on either the data leads
796or the DCD control lead of a serial port.
797.Em NTP
798uses the PPS signal to discipline the local clock oscillator to a high
799degree of precision (typically less than 50 microseconds in time and
8000.1 ppm in accuracy).
801.Em PPS
802can also generate a serial output pulse when the system receives a PPS
803interrupt.
804This can be used to measure the system interrupt latency and thus calibrate
805.Em NTP
806to account for it.
807Using
808.Em PPS
809usually requires a
810gadget box
811to convert from TTL to RS-232 signal levels.
812The gadget box and PPS are described in more detail in the HTML documentation
813shipped with the ntpd distribution.
814.It Cd options SETUIDSCRIPTS
815Allows scripts with the setuid bit set to execute as the effective
816user rather than the real user, just like binary executables.
817.Pp
818.Em NOTE :
819Using this option will also enable
820.Em options FDSCRIPTS
821.It Cd option FDSCRIPTS
822Allows execution of scripts with the execute bit set, but not the
823read bit, by opening the file and passing the file descriptor to
824the shell, rather than the filename.
825.Pp
826.Em NOTE :
827Execute only (non-readable) scripts will have
828.Va argv[0]
829set to
830.Pa /dev/fd/* .
831What this option allows as far as security is
832concerned, is the ability to safely ensure that the correct script
833is run by the interpreter, as it is passed as an already open file.
834.It Cd options PUCCN
835Enables treating serial ports found on PCI boards
836.Xr puc 4
837as potential console devices.  The method for choosing such a console
838device is port dependent.
839.It Cd options RTC_OFFSET=integer
840The kernel (and typically the hardware battery backed-up clock on
841those machines that have one) keeps time in
842.Em UTC
843(Universal Coordinated Time, once known as
844.Em GMT ,
845or Greenwich Mean Time)
846and not in the time of the local time zone.
847The
848.Em RTC_OFFSET
849option is used on some ports (such as the i386) to tell the kernel
850that the hardware clock is offset from
851.Em UTC
852by the specified number of minutes.
853This is typically used when a machine boots several operating
854systems and one of them wants the hardware clock to run in the
855local time zone and not in
856.Em UTC ,
857e.g.
858.Em RTC_OFFSET=300
859means
860the hardware clock is set to US Eastern Time (300 minutes behind
861.Em UTC ) ,
862and not
863.Em UTC .
864(Note:
865.Em RTC_OFFSET
866is used to initialize a kernel variable named
867.Va rtc_offset
868which is the source actually used to determine the clock offset, and
869which may be accessed via the kern.rtc_offset sysctl variable.
870See
871.Xr sysctl 8
872and
873.Xr sysctl 3
874for details.
875Since the kernel clock is initialized from the hardware clock very
876early in the boot process, it is not possible to meaningfully change
877.Va rtc_offset
878in system initialization scripts.
879Changing this value currently may only be done at kernel compile
880time or by patching the kernel and rebooting).
881.Pp
882.Em NOTE :
883Unfortunately, in many cases where the hardware clock
884is kept in local time, it is adjusted for Daylight Savings
885Time; this means that attempting to use
886.Em RTC_OFFSET
887to let
888.Nx
889coexist with such an operating system, like Windows,
890would necessitate changing
891.Em RTC_OFFSET
892twice a year. As such, this solution is imperfect.
893.It Cd options KMEMSTATS
894The kernel memory allocator,
895.Xr malloc 9 ,
896will keep statistics on its performance if this option is enabled.
897Unfortunately, this option therefore essentially disables the
898.Fn MALLOC
899and
900.Fn FREE
901forms of the memory allocator, which are used to enhance the performance
902of certain critical sections of code in the kernel.
903This option therefore can lead to a significant decrease in the
904performance of certain code in the kernel if enabled.
905Examples of such code include the
906.Fn namei
907routine, the
908.Xr ccd 4
909driver,
910the
911.Xr ncr 4
912driver,
913and much of the networking code.
914.It Cd options MAXUPRC=integer
915Sets the
916.Em RLIMIT_NPROC
917resource limit, which specifies the maximum number of simultaneous
918processes a user is permitted to run, for process 0;
919this value is inherited by its child processes.
920It defaults to
921.Em CHILD_MAX ,
922which is currently defined to be 160.
923Setting
924.Em MAXUPRC
925to a value less than
926.Em CHILD_MAX
927is not permitted, as this would result in a violation of the semantics of
928.St -p1003.1-90 .
929.It Cd options DEFCORENAME=string
930Sets the default value of the
931.Em kern.defcorename
932sysctl variable, otherwise it is set to
933.Nm %n.core .
934See
935.Xr sysctl 8
936and
937.Xr sysctl 3
938for details.
939.It Cd options RASOPS_CLIPPING
940Enables clipping within the
941.Nm rasops
942raster-console output system.
943.Em NOTE :
944only available on architectures that use
945.Nm rasops
946for console output.
947.It Cd options RASOPS_SMALL
948Removes optimized character writing code from the
949.Nm rasops
950raster-console output system.
951.Em NOTE :
952only available on architectures that use
953.Nm rasops
954for console output.
955.El
956.Ss Networking Options
957.Bl -ohang
958.It Cd options GATEWAY
959Enables
960.Em IPFORWARDING
961(which see)
962and (on most ports) increases the size of
963.Em NMBCLUSTERS
964(which see).
965In general,
966.Em GATEWAY
967is used to indicate that a system should act as a router, and
968.Em IPFORWARDING
969is not invoked directly.
970(Note that
971.Em GATEWAY
972has no impact on protocols other than
973.Tn IP ,
974such as
975.Tn CLNP
976or
977.Tn XNS ) .
978.It Cd options IPFORWARDING=value
979If
980.Em value
981is 1 this enables IP routing behavior. If
982.Em value
983is 0 (the default), it disables it. The
984.Em GATEWAY
985option sets this to 1 automatically.
986With this option enabled, the machine will forward IP datagrams destined
987for other machines between its interfaces.
988Note that even without this option, the kernel will
989still forward some packets (such as source routed packets) -- removing
990.Em GATEWAY
991and
992.Em IPFORWARDING
993is insufficient to stop all routing through a bastion host on a
994firewall -- source routing is controlled independently.
995To turn off source routing, use
996.Em options IPFORWSRCRT=0
997(which see).
998Note that IP forwarding may be turned on and off independently of the
999setting of the
1000.Em IPFORWARDING
1001option through the use of the
1002.Em net.inet.ip.forwarding
1003sysctl variable.
1004If
1005.Em net.inet.ip.forwarding
1006is 1, IP forwarding is on.
1007See
1008.Xr sysctl 8
1009and
1010.Xr sysctl 3
1011for details.
1012.It Cd options IPFORWSRCRT=value
1013If
1014.Em value
1015is set to zero, source routing of IP datagrams is turned off.
1016If
1017.Em value
1018is set to one (the default) or the option is absent, source routed IP
1019datagrams are forwarded by the machine.
1020Note that source routing of IP packets may be turned on and off
1021independently of the setting of the
1022.Em IPFORWSRCRT
1023option through the use of the
1024.Em net.inet.ip.forwsrcrt
1025sysctl variable.
1026If
1027.Em net.inet.ip.forwsrcrt
1028is 1, forwarding of source routed IP datagrams is on.
1029See
1030.Xr sysctl 8
1031and
1032.Xr sysctl 3
1033for details.
1034.It Cd options IFA_STATS
1035Tells the kernel to maintain per-address statistics on bytes sent
1036and received over (currently) internet and appletalk addresses.
1037.\"This can be a fairly expensive operation, so you probably want to
1038.\"keep this disabled.
1039The option is not recommended as it degrades system stability.
1040.It Cd options MROUTING
1041Includes support for IP multicast routers.
1042You certainly want
1043.Em INET
1044with this.
1045Multicast routing is controlled by the
1046.Xr mrouted 8
1047daemon.
1048.It Cd options INET
1049Includes support for the
1050.Tn TCP/IP
1051protocol stack.
1052You almost certainly want this.
1053See
1054.Xr inet 4
1055for details.
1056This option is currently required.
1057.It Cd options INET6
1058Includes support for the
1059.Tn IPv6
1060protocol stack.
1061See
1062.Xr inet6 4
1063for details.
1064Unlike
1065.Em INET ,
1066.Em INET6
1067enables multicast routing code as well.
1068This option requires
1069.Em INET
1070at this moment, but it should not.
1071.It Cd options ND6_DEBUG
1072The option sets the default value of net.inet6.icmp6.nd6_debug to 1,
1073for debugging IPv6 neighbor discovery protocol handling.
1074See
1075.Xr sysctl 3
1076for details.
1077.It Cd options IPSEC
1078Includes support for the
1079.Tn IPsec
1080protocol.
1081See
1082.Xr ipsec 4
1083for details.
1084.Em IPSEC
1085will enable
1086secret key management part,
1087policy management part,
1088.Tn AH
1089and
1090.Tn IPComp .
1091Kernel binary will not be subject to export control in most of countries,
1092even if compiled with
1093.Em IPSEC .
1094For example, it should be okay to export it from within the United States
1095to the outside.
1096.Em INET6
1097and
1098.Em IPSEC
1099are orthogonal so you can get IPv4-only kernel with IPsec support,
1100IPv4/v6 dual support kernel without IPsec, and so forth.
1101This option requires
1102.Em INET
1103at this moment, but it should not.
1104.It Cd options IPSEC_DEBUG
1105Enables debugging code in
1106.Tn IPsec
1107stack.
1108This option assumes
1109.Em IPSEC .
1110.It Cd options IPSEC_ESP
1111Includes support for
1112.Tn IPsec
1113.Tn ESP
1114protocol.
1115See
1116.Xr ipsec 4
1117for details.
1118.Em IPSEC_ESP
1119will enable source code that is subject to export control in some countries
1120.Pq including the United States ,
1121and compiled kernel binary will be subject to certain restriction.
1122This option assumes
1123.Em IPSEC .
1124.It Cd options SUBNETSARELOCAL
1125Sets default value for net.inet.ip.subnetsarelocal variable, which
1126controls whether non-directly-connected subnets of connected networks
1127are considered "local" for purposes of choosing the MSS for a TCP
1128connection.  This is mostly present for historic reasons and
1129completely irrelevant if you enable Path MTU discovery.
1130.It Cd options HOSTZEROBROADCAST
1131Sets default value for net.inet.ip.hostzerobroadcast variable, which
1132controls whether the zeroth host address of each connected subnet is
1133also considered a broadcast address.  Default value is "1", for
1134compatibility with old systems; if this is set to zero on all hosts on
1135a subnet, you should be able to fit an extra host per subnet on the
1136".0" address.
1137.It Cd options MCLSHIFT=value
1138This option is the base-2 logarithm of the size of mbuf clusters.
1139The
1140.Bx
1141networking stack keeps network packets in a linked
1142list, or chain, of kernel buffer objects called mbufs.
1143The system provides larger mbuf clusters as an optimization for
1144large packets, instead of using long chains for large packets.
1145The mbuf cluster size,
1146or
1147.Em MCLBYTES ,
1148must be a power of two, and is computed as two raised to the power
1149.Em MCLSHIFT .
1150On systems with Ethernet network adaptors,
1151.Em MCLSHIFT
1152is often set to 11, giving 2048-byte mbuf clusters, large enough to
1153hold a 1500-byte
1154.Tn Ethernet
1155frame in a single cluster.
1156Systems with network interfaces supporting larger frame sizes like
1157.Tn ATM ,
1158.Tn FDDI ,
1159or
1160.Tn HIPPI
1161may perform better with
1162.Em MCLSHIFT
1163set to 12 or 13, giving mbuf cluster sizes of 4096 and 8192 bytes,
1164respectively.
1165.It Cd options NS
1166Include support for the
1167.Tn Xerox
1168.Tn XNS
1169protocol stack.
1170See
1171.Xr ns 4
1172for details.
1173.It Cd options ISO,TPIP
1174Include support for the ubiquitous
1175.Tn OSI
1176protocol stack.
1177See
1178.Xr iso 4
1179for details.
1180This option assumes
1181.Em INET .
1182.It Cd options EON
1183Include support for tunneling
1184.Tn OSI
1185protocols over
1186.Tn IP .
1187Known to be broken, or at least very fragile, and undocumented.
1188.It Cd options CCITT,LLC,HDLC
1189Include support for the
1190.Tn CCITT
1191(nee
1192.Tn ITU-TSS )
1193.Tn X.25
1194protocol stack.
1195The state of this code is currently unknown, and probably contains bugs.
1196This option assumes
1197.Em INET .
1198.It Cd options NETATALK
1199Include support for the
1200.Tn AppleTalk
1201protocol stack.
1202The kernel provides provision for the
1203.Em Datagram Delivery Protocol
1204(DDP), providing SOCK_DGRAM support and
1205.Tn AppleTalk
1206routing.
1207This stack is used by the
1208.Em NETATALK
1209package, which adds support for
1210.Tn AppleTalk
1211server services via user libraries and applications.
1212.It Cd options IPNOPRIVPORTS
1213Normally, only root can bind a socket descriptor to a so-called
1214.Dq privileged
1215.Tn TCP
1216port, that is, a port number in the range 0-1023.
1217This option eliminates those checks from the kernel.
1218This can be useful if there is a desire to allow daemons without
1219privileges to bind those ports, e.g. on firewalls.
1220The security tradeoffs in doing this are subtle.
1221This option should only be used by experts.
1222.It Cd options TCP_COMPAT_42
1223.Tn TCP
1224bug compatibility with
1225.Bx 4.2 .
1226In
1227.Bx 4.2 ,
1228.Tn TCP
1229sequence numbers were 32-bit signed values.
1230Modern implementations of TCP use unsigned values.
1231This option clamps the initial sequence number to start in
1232the range 2^31 rather than the full unsigned range of 2^32.
1233Also, under
1234.Bx 4.2 ,
1235keepalive packets must contain at least one byte or else
1236the remote end would not respond.
1237.It Cd options TCP_DEBUG
1238Record the last
1239.Em TCP_NDEBUG
1240TCP packets with SO_DEBUG set, and decode to the console if
1241.Em tcpconsdebug
1242is set.
1243.It Cd options TCP_NDEBUG
1244Number of packets to record for
1245.Em TCP_DEBUG .
1246Defaults to 100.
1247.It Cd options PFIL_HOOKS
1248This option turns on the packet filter interface hooks.
1249See
1250.Xr pfil 9
1251for details.
1252This option assumes
1253.Em INET .
1254.It Cd options IPFILTER_LOG
1255This option, in conjunction with
1256.Em pseudo-device ipfilter ,
1257enables logging of IP packets using ip-filter.
1258.It Cd options IPFILTER_DEFAULT_BLOCK
1259This option sets the default policy of ip-filter.
1260If it is set, ip-filter will block packets by default.
1261.It Cd options PPP_BSDCOMP
1262Enable support for BSD-compress
1263.Pq Sq bsdcomp
1264compression in ppp.
1265.It Cd options PPP_DEFLATE
1266Enable support for deflate
1267compression in ppp.
1268.It Cd options PPP_FILTER
1269This option turns on
1270.Xr pcap 3
1271based filtering for ppp connections.
1272This option is used by
1273.Xr pppd 8
1274which needs to be compiled with
1275.Em PPP_FILTER
1276defined (the current default).
1277.El
1278.Ss System V IPC Options
1279.Bl -ohang
1280.It Cd options SYSVMSG
1281Includes support for
1282.At V
1283style message queues.
1284See
1285.Xr msgctl 2 ,
1286.Xr msgget 2 ,
1287.Xr msgrcv 2 ,
1288.Xr msgsnd 2 .
1289.It Cd options SYSVSEM
1290Includes support for
1291.At V
1292style semaphores.
1293See
1294.Xr semctl 2 ,
1295.Xr semget 2 ,
1296.Xr semop 2 .
1297.It Cd options SEMMNI=value
1298Sets the number of
1299.At V
1300style semaphore identifiers.  The GENERIC config file for your port
1301will have the default.
1302.It Cd options SEMMNS=value
1303Sets the number of
1304.At V
1305style semaphores in the system.  The GENERIC config file for your port
1306will have the default.
1307.It Cd options SEMUME=value
1308Sets the maximum number of undo entries per process for
1309.At V
1310style semaphores.  The GENERIC config file for your port
1311will have the default.
1312.It Cd options SEMMNU=value
1313Sets the number of undo structures in the system for
1314.At V
1315style semaphores.  The GENERIC config file for your port
1316will have the default.
1317.It Cd options SYSVSHM
1318Includes support for
1319.At V
1320style shared memory.
1321See
1322.Xr shmat 2 ,
1323.Xr shmctl 2 ,
1324.Xr shmdt 2 ,
1325.Xr shmget 2 .
1326.It Cd options SHMMAXPGS=value
1327Sets the maximum number of
1328.At V
1329style shared memory pages that are available through the
1330.Xr shmget 2
1331system call.
1332Default value is 1024 on most ports.
1333See
1334.Pa /usr/include/machine/vmparam.h
1335for the default.
1336.El
1337.Ss VM Related Options
1338.Bl -ohang
1339.It Cd options NMBCLUSTERS=value
1340The number of mbuf clusters the kernel supports.  Mbuf clusters are
1341MCLBYTES in size (usually 2k).  This is used to compute the size of
1342the kernel VM map
1343.Em mb_map ,
1344which maps mbuf clusters.
1345Default on most ports is 256 (512 with
1346.Dq options GATEWAY
1347).
1348See
1349.Pa /usr/include/machine/param.h
1350for exact default information.
1351Increase this value if you get
1352.Dq mb_map full
1353messages.
1354.It Cd options NKMEMPAGES=value
1355.It Cd options NKMEMPAGES_MIN=value
1356.It Cd options NKMEMPAGES_MAX=value
1357Size of kernel VM map
1358.Em kmem_map ,
1359in PAGE_SIZE-sized chunks (the VM page size; this value may be read
1360from the
1361.Xr sysctl 8
1362variable
1363.Em hw.pagesize
1364).
1365This VM map is used to map the kernel malloc arena.
1366The kernel attempts to auto-size this map based on the amount of
1367physical memory in the system.  Platform-specific code may place
1368bounds on this computed size, which may be viewed with the
1369.Xr sysctl 8
1370variable
1371.Em vm.nkmempages .
1372See
1373.Pa /usr/include/machine/param.h
1374for the default upper and lower bounds.
1375The related options
1376.Sq NKMEMPAGES_MIN
1377and
1378.Sq NKMEMPAGES_MAX
1379allow the bounds to be overridden in the kernel configuration file.
1380These options are provided in the event the computed value is
1381insufficient resulting in an
1382.Dq out of space in kmem_map
1383panic.
1384.It Cd options BUFCACHE=value
1385Size of the buffer cache as a percentage of total available
1386.Tn RAM .
1387Ignored if BUFPAGES is also specified.
1388.It Cd options NBUF=value
1389.It Cd options BUFPAGES=value
1390These options set the number of pages available for the buffer cache.
1391Their default value is a machine dependent value, often calculated as
1392between 5% and 10% of total available
1393.Tn RAM .
1394.El
1395.Ss amiga-specific Options
1396.Bl -ohang
1397.It Cd options BB060STUPIDROM
1398When the bootloader (which passes
1399.Tn AmigaOS
1400.Tn ROM
1401information) claims we have a 68060
1402.Tn CPU
1403without
1404.Tn FPU ,
1405go look into the Processor Configuration Register (PCR) to find out.
1406You need this with
1407.Tn Amiga
1408.Tn ROM Ns s
1409up to (at least) V40.xxx (OS3.1),
1410when you boot via the bootblocks and don't have a DraCo.
1411.It Cd options IOBZCLOCK=frequency
1412The IOBlix boards come with two different serial master clocks: older ones
1413use 24 MHz, newer ones use 22.1184 MHz. The driver normally assumes the latter.
1414If your board uses 24 MHz, you can recompile your kernel with
1415options IOBZCLOCK=24000000
1416or patch the kernel variable
1417.Tn iobzclock
1418to the same value.
1419.It Cd options LIMITMEM=value
1420If there, limit the part of the first memory bank used by
1421.Nx
1422to value megabytes.
1423Default is unlimited.
1424.It Cd options NKPTADD=addvalue
1425.It Cd options NKPTADDSHIFT=shiftvalue
1426The
1427.Tn CPU
1428specific
1429.Tn MMU
1430table for the kernel is pre-allocated at kernel startup time.
1431Part of it is scaled with
1432.Va maxproc ,
1433to have enough room to hold the user program
1434.Tn MMU
1435tables; the second part is a fixed amount for the kernel itself.
1436.Pp
1437The third part accounts for the size of the file buffer cache.
1438Its size is either
1439.Dv NKPTADD
1440pages (if defined) or memory size in bytes divided by two to
1441the power of
1442.Dv NKPTADDSHIFT .
1443The default is undefined
1444.Dv NKPTADD
1445and
1446.Dv NKPTADDSHIFT=24 ,
1447allowing for 16 buffers per megabyte of main memory (while
1448a GENERIC kernel allocates about half of that).
1449When you get "can't get KPT page" panics, you should increase
1450.Dv NKPTADD
1451(if defined), or decrease
1452.Dv NKPTADDSHIFT
1453by one.
1454.It Cd options P5PPC68KBOARD
1455Add special support for Phase5 mixed 68k+PPC boards. Currently, this only
1456affects rebooting from
1457.Nx
1458and is only needed on 68040+PPC, not on
145968060+PPC; without this, affected machines will hang after
1460.Nx
1461has shut
1462down and will only restart after a keyboard reset or a power cycle.
1463.El
1464.Ss arm32-specific Options
1465.Bl -ohang
1466.It Cd options FRENCH_KEYBOARD
1467Include translation for French keyboards when using
1468.Xr pccons 4
1469on a Shark.
1470.It Cd options FINNISH_KEYBOARD
1471Include translation for Finnish keyboards when using
1472.Xr pccons 4
1473on a Shark.
1474.It Cd options GERMAN_KEYBOARD
1475Include translation for German keyboards when using
1476.Xr pccons 4
1477on a Shark.
1478.It Cd options NORWEGIAN_KEYBOARD
1479Include translation for French keyboards when using
1480.Xr pccons 4
1481on a Shark.
1482.El
1483.Ss atari-specific Options
1484.Bl -ohang
1485.It Cd options DISKLABEL_AHDI
1486Include support for AHDI (native Atari) disklabels.
1487.It Cd options DISKLABEL_NBDA
1488Include support for
1489.Nx Ns Tn /atari
1490labels.
1491If you don't set this option, it will be set automatically.
1492.Nx Ns Tn /atari
1493will not work without it.
1494.It Cd options FALCON_SCSI
1495Include support for the 5380-SCSI configuration as found on the Falcon.
1496.It Cd options RELOC_KERNEL
1497If set, the kernel will relocate itself to TT-RAM, if possible.
1498This will give you a slightly faster system.
1499.Em Beware
1500that on some TT030 systems,
1501the system will frequently dump with MMU-faults with this option enabled.
1502.It Cd options SERCONSOLE
1503Allow the modem1-port to act as the system-console.
1504A carrier should be active on modem1 during system boot to active
1505the console functionality.
1506.It Cd options TT_SCSI
1507Include support for the 5380-SCSI configuration as found on the TT030
1508and Hades.
1509.El
1510.Ss i386-specific Options
1511.Bl -ohang
1512.It Cd options I386_CPU,I486_CPU,I586_CPU,I686_CPU
1513Include support for a particular class of
1514.Tn CPU
1515.Po
1516.Tn i386 ,
1517.Tn i486 ,
1518.Tn Pentium ,
1519or
1520.Tn Pentium Pro
1521.Pc .
1522If the appropriate class for your
1523.Tn CPU
1524is not configured, the kernel will use the highest class available
1525that will work.
1526In general, using the correct
1527.Tn CPU
1528class will result in the best performance.
1529At least one of these options must be present.
1530.It Cd options CPURESET_DELAY=value
1531specifies the time (in millisecond) to wait before doing a hardware reset
1532in the last phase of a reboot. This gives the user a chance to see error
1533messages from the shutdown operations (like NFS unmounts, buffer cache flush,
1534etc ...). Setting this to 0 will disable the delay. Default is 2 seconds.
1535.It Cd options MATH_EMULATE
1536Include the floating point emulator.
1537This is useful only for
1538.Tn CPU Ns s
1539that lack an
1540internal Floating Point Unit
1541.Pq Tn FPU
1542or co-processor.
1543.It Cd options VM86
1544Include support for virtual 8086 mode, used by
1545.Tn DOS
1546emulators and X servers to run BIOS code, e.g. for some VESA routines.
1547.It Cd options USER_LDT
1548Include i386-specific system calls for modifying the local descriptor table,
1549used by Windows emulators.
1550.It Cd options REALBASEMEM=integer
1551Overrides the base memory size passed in from the boot block.
1552(Value given in kilobytes.)
1553Use this option only if the boot block reports the size incorrectly.
1554(Note that some
1555.Tn BIOS Ns es
1556put the extended
1557.Tn BIOS
1558data area at the top of base memory, and therefore report a smaller
1559base memory size to prevent programs overwriting it.
1560This is correct behavior, and you should not use the
1561.Em REALBASEMEM
1562option to access this memory).
1563.It Cd options REALEXTMEM=integer
1564Overrides the extended memory size passed in from the boot block.
1565(Value given in kilobytes. Extended memory does not include the first megabyte.)
1566Use this option only if the boot block reports the size incorrectly.
1567.It Cd options FRENCH_KBD,FINNISH_KBD,GERMAN_KBD,NORWEGIAN_KBD
1568Select a non-US keyboard layout for the
1569.Em pccons
1570console driver.
1571.It Cd options CYRIX_CACHE_WORKS
1572Relevant only to the Cyrix 486DLC cpu. This option is used to turn on
1573the cache in hold-flush mode. It is not turned on by default because it
1574is known to have problems in certain motherboard implementations.
1575.It Cd options CYRIX_CACHE_REALLY_WORKS
1576Relevant only to the Cyrix 486DLC cpu. This option is used to turn on
1577the cache in write-back mode. It is not turned on by default because it
1578is known to have problems in certain motherboard implementations. In order
1579for this option to take effect, option
1580.Em CYRIX_CACHE_WORKS
1581must also be specified.
1582.It Cd options PCIBIOS
1583Enable support for initializing the
1584.Tn PCI
1585bus using information from the
1586.Tn BIOS .
1587See
1588.Xr pcibios 4
1589for details.
1590.El
1591.Ss isa-specific Options
1592Options specific to
1593.Xr isa 4
1594busses.
1595.Bl -ohang
1596.It Cd options PCIC_ISA_ALLOC_IOBASE=address, PCIC_ISA_ALLOC_IOSIZE=size
1597Control the section of IO bus space used for PCMCIA bus space mapping.
1598Ideally the probed defaults are satisfactory, however in practice
1599that is not always the case. See
1600.Xr pcmcia 4
1601for details.
1602.It Cd options PCIC_ISA_INTR_ALLOC_MASK=mask
1603Controls the allowable interrupts that may be used for
1604.Tn PCMCIA
1605devices. This mask is a logical-or of power-of-2s of allowable
1606interrupts:
1607.Bd -literal -offset 04n
1608.Em "IRQ Val      IRQ Val      IRQ Val       IRQ Val"
1609 0  0x0001    4  0x0010    8  0x0100    12  0x1000
1610 1  0x0002    5  0x0020    9  0x0200    13  0x2000
1611 2  0x0004    6  0x0040   10  0x0400    14  0x4000
1612 3  0x0008    7  0x0080   11  0x0800    15  0x8000
1613.Ed
1614.El
1615.Ss m68k-specific Options
1616.Bl -ohang
1617.It Cd options FPU_EMULATE
1618Include support for MC68881/MC68882 emulator.
1619.It Cd options FPSP
1620Include support for 68040 floating point.
1621.It Cd options M68020,M68030,M68040,M68060
1622Include support for a specific
1623.Tn CPU ,
1624at least one (the one you are using) should be specified.
1625.It Cd options M060SP
1626Include software support for 68060.
1627This provides emulation of unimplemented
1628integer instructions as well as emulation of unimplemented floating point
1629instructions and data types and software support for floating point traps.
1630.El
1631.Ss sparc-specific Options
1632.Bl -ohang
1633.It Cd options AUDIO_DEBUG
1634Enable simple event debugging of the logging of the
1635.Xr audio 4
1636device.
1637.It Cd options BLINK
1638Enable blinking of LED.  Blink rate is full cycle every N seconds for
1639N < then current load average.  See
1640.Xr getloadavg 3 .
1641.\" .It Cd options COLORFONT_CACHE
1642.\" this is totally fucked up.. what does this do?
1643.It Cd options COUNT_SW_LEFTOVERS
1644Count how many times the sw SCSI device has left 3, 2, 1 and 0 in the
1645sw_3_leftover, sw_2_leftover, sw_1_leftover, and sw_0_leftover
1646variables accessible from
1647.Xr ddb 4 .
1648See
1649.Xr sw 4 .
1650.It Cd options DEBUG_ALIGN
1651Adds debugging messages calls when user-requested alignment fault
1652handling happens.
1653.It Cd options DEBUG_EMUL
1654Adds debugging messages calls for emulated floating point and
1655alignment fixing operations.
1656.It Cd options DEBUG_SVR4
1657Prints registers messages calls for emulated SVR4 getcontext and
1658setcontext operations.  See
1659.Em options COMPAT_SVR4 .
1660.It Cd options EXTREME_DEBUG
1661Adds debugging functions callable from
1662.Xr ddb 4 .  The debug_pagetables, test_region and print_fe_map
1663functions print information about page tables for the SUN4M
1664platforms only.
1665.It Cd options EXTREME_EXTREME_DEBUG
1666Adds extra info to
1667.Em options EXTREME_DEBUG .
1668.It Cd options FPU_CONTEXT
1669Make
1670.Em options COMPAT_SVR4
1671getcontext and setcontext include floating point registers.
1672.It Cd options MAGMA_DEBUG
1673Adds debugging messages to the
1674.Xr magma 4
1675device.
1676.It Cd options RASTERCONS_FULLSCREEN
1677Use the entire screen for the console.
1678.It Cd options RASTERCONS_SMALLFONT
1679Use a the fixed font on the console, instead of the normal font.
1680.It Cd options SUN4
1681Support sun4 class machines.
1682.It Cd options SUN4C
1683Support sun4c class machines.
1684.It Cd options SUN4M
1685Support sun4m class machines.
1686.It Cd options SUN4_MMU3L
1687.\" XXX ???
1688Enable support for sun4 3-level MMU machines.
1689.It Cd options V9
1690Enable SPARC V9 assembler in
1691.Xr ddb 4 .
1692.El
1693.Ss x68k-specific Options
1694.Bl -ohang
1695.It Cd options EXTENDED_MEMORY
1696Include support for extended memory e.g. TS-6BE16 and 060turbo on-board.
1697.It Cd options JUPITER
1698Include support for Jupiter-X MPU accelerator
1699.It Cd options ZSCONSOLE,ZSCN_SPEED=value
1700Use the built-in serial port as the system-console.
1701Speed is specified in bps, defaults to 9600.
1702.It Cd options ITE_KERNEL_ATTR=value
1703Set the kernel message attribute for ITE.
1704Value, an integer, is a logical or of the following values:
1705.Bl -tag -width 4n -compact -offset indent
1706.It 1
1707color inversed
1708.It 2
1709underlined
1710.It 4
1711bolded
1712.El
1713.El
1714.\" The following requests should be uncommented and used where appropriate.
1715.\" .Sh FILES
1716.\" .Sh EXAMPLES
1717.Sh SEE ALSO
1718.Xr gdb 1 ,
1719.Xr ktrace 1 ,
1720.Xr quota 1 ,
1721.Xr gettimeofday 2 ,
1722.Xr i386_iopl 2 ,
1723.Xr msgctl 2 ,
1724.Xr msgget 2 ,
1725.Xr msgrcv 2 ,
1726.Xr msgsnd 2 ,
1727.Xr ntp_adjtime 2 ,
1728.Xr ntp_gettime 2 ,
1729.Xr semctl 2 ,
1730.Xr semget 2 ,
1731.Xr semop 2 ,
1732.Xr shmat 2 ,
1733.Xr shmctl 2 ,
1734.Xr shmdt 2 ,
1735.Xr shmget 2 ,
1736.Xr sysctl 3 ,
1737.Xr apm 4 ,
1738.Xr ddb 4 ,
1739.Xr inet 4 ,
1740.Xr iso 4 ,
1741.Xr lkm 4 ,
1742.Xr ns 4 ,
1743.Xr pcibios 4 ,
1744.Xr pcmcia 4 ,
1745.Xr config 8 ,
1746.Xr edquota 8 ,
1747.Xr init 8 ,
1748.Xr mount_cd9660 8 ,
1749.Xr mount_fdesc 8 ,
1750.Xr mount_kernfs 8 ,
1751.Xr mount_lfs 8 ,
1752.Xr mount_mfs 8 ,
1753.Xr mount_msdos 8 ,
1754.Xr mount_nfs 8 ,
1755.Xr mount_ntfs 8 ,
1756.Xr mount_null 8 ,
1757.Xr mount_portal 8 ,
1758.Xr mount_procfs 8 ,
1759.Xr mount_umap 8 ,
1760.Xr mount_union 8 ,
1761.Xr mrouted 8 ,
1762.Xr newfs_lfs 8 ,
1763.Xr quotaon 8 ,
1764.Xr rpc.rquotad 8 ,
1765.Xr sysctl 8 ,
1766.Xr ntpd 8
1767.Sh HISTORY
1768The
1769.Nm
1770man page first appeared in
1771.Nx 1.3 .
1772.Sh BUGS
1773The
1774.Em INET
1775and the
1776.Em VNODEPAGER
1777options should not be required.
1778The
1779.Em EON
1780option should be a pseudo-device, and is also very fragile.
1781