xref: /netbsd-src/share/man/man4/options.4 (revision 27578b9aac214cc7796ead81dcc5427e79d5f2a0)
1.\"	$NetBSD: options.4,v 1.146 2001/09/04 04:21:35 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, 2001
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.
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 HZ=integer
755On ports that support it, set the system clock frequency (see
756.Xr hz 9 )
757to the supplied value. Handle with care.
758.It Cd options NTP
759Turns on in-kernel precision timekeeping support used by software
760implementing
761.Em NTP
762(Network Time Protocol, RFC1305).
763The
764.Em NTP
765option adds an in-kernel Phase-Locked Loop (PLL) for normal
766.Em NTP
767operation, and a Frequency-Locked Loop (FLL) for intermittently-connected
768operation.
769.Xr ntpd 8
770will employ a user-level PLL when kernel support is unavailable,
771but the in-kernel version has lower latency and more precision, and
772so typically keeps much better time.
773The interface to the kernel
774.Em NTP
775support is provided by the
776.Xr ntp_adjtime 2
777and
778.Xr ntp_gettime 2
779system calls, which are intended for use by
780.Xr ntpd 8
781and are enabled by the option.
782On systems with sub-microsecond resolution timers, or where (HZ / 100000)
783is not an integer, the
784.Em NTP
785option also enables extended-precision arithmetic to keep track of
786fractional clock ticks at NTP time-format precision.
787.It Cd options PPS_SYNC
788This option enables a kernel serial line discipline for receiving time
789phase signals from an external reference clock such as a radio clock.
790(The
791.Em NTP
792option (which see) must be on if the
793.Em PPS_SYNC
794option is used.)
795Some reference clocks generate a Pulse Per Second (PPS) signal in
796phase with their time source.
797The
798.Em PPS
799line discipline receives this signal on either the data leads
800or the DCD control lead of a serial port.
801.Em NTP
802uses the PPS signal to discipline the local clock oscillator to a high
803degree of precision (typically less than 50 microseconds in time and
8040.1 ppm in accuracy).
805.Em PPS
806can also generate a serial output pulse when the system receives a PPS
807interrupt.
808This can be used to measure the system interrupt latency and thus calibrate
809.Em NTP
810to account for it.
811Using
812.Em PPS
813usually requires a
814gadget box
815to convert from TTL to RS-232 signal levels.
816The gadget box and PPS are described in more detail in the HTML documentation
817for
818.Xr ntpd 8
819in
820.Pa /usr/share/doc/html/ntp .
821.It Cd options SETUIDSCRIPTS
822Allows scripts with the setuid bit set to execute as the effective
823user rather than the real user, just like binary executables.
824.Pp
825.Em NOTE :
826Using this option will also enable
827.Em options FDSCRIPTS
828.It Cd option FDSCRIPTS
829Allows execution of scripts with the execute bit set, but not the
830read bit, by opening the file and passing the file descriptor to
831the shell, rather than the filename.
832.Pp
833.Em NOTE :
834Execute only (non-readable) scripts will have
835.Va argv[0]
836set to
837.Pa /dev/fd/* .
838What this option allows as far as security is
839concerned, is the ability to safely ensure that the correct script
840is run by the interpreter, as it is passed as an already open file.
841.It Cd options PUCCN
842Enables treating serial ports found on PCI boards
843.Xr puc 4
844as potential console devices.  The method for choosing such a console
845device is port dependent.
846.It Cd options RTC_OFFSET=integer
847The kernel (and typically the hardware battery backed-up clock on
848those machines that have one) keeps time in
849.Em UTC
850(Universal Coordinated Time, once known as
851.Em GMT ,
852or Greenwich Mean Time)
853and not in the time of the local time zone.
854The
855.Em RTC_OFFSET
856option is used on some ports (such as the i386) to tell the kernel
857that the hardware clock is offset from
858.Em UTC
859by the specified number of minutes.
860This is typically used when a machine boots several operating
861systems and one of them wants the hardware clock to run in the
862local time zone and not in
863.Em UTC ,
864e.g.
865.Em RTC_OFFSET=300
866means
867the hardware clock is set to US Eastern Time (300 minutes behind
868.Em UTC ) ,
869and not
870.Em UTC .
871(Note:
872.Em RTC_OFFSET
873is used to initialize a kernel variable named
874.Va rtc_offset
875which is the source actually used to determine the clock offset, and
876which may be accessed via the kern.rtc_offset sysctl variable.
877See
878.Xr sysctl 8
879and
880.Xr sysctl 3
881for details.
882Since the kernel clock is initialized from the hardware clock very
883early in the boot process, it is not possible to meaningfully change
884.Va rtc_offset
885in system initialization scripts.
886Changing this value currently may only be done at kernel compile
887time or by patching the kernel and rebooting).
888.Pp
889.Em NOTE :
890Unfortunately, in many cases where the hardware clock
891is kept in local time, it is adjusted for Daylight Savings
892Time; this means that attempting to use
893.Em RTC_OFFSET
894to let
895.Nx
896coexist with such an operating system, like Windows,
897would necessitate changing
898.Em RTC_OFFSET
899twice a year. As such, this solution is imperfect.
900.It Cd options KMEMSTATS
901The kernel memory allocator,
902.Xr malloc 9 ,
903will keep statistics on its performance if this option is enabled.
904Unfortunately, this option therefore essentially disables the
905.Fn MALLOC
906and
907.Fn FREE
908forms of the memory allocator, which are used to enhance the performance
909of certain critical sections of code in the kernel.
910This option therefore can lead to a significant decrease in the
911performance of certain code in the kernel if enabled.
912Examples of such code include the
913.Fn namei
914routine, the
915.Xr ccd 4
916driver,
917the
918.Xr ncr 4
919driver,
920and much of the networking code.
921.It Cd options MAXUPRC=integer
922Sets the
923.Em RLIMIT_NPROC
924resource limit, which specifies the maximum number of simultaneous
925processes a user is permitted to run, for process 0;
926this value is inherited by its child processes.
927It defaults to
928.Em CHILD_MAX ,
929which is currently defined to be 160.
930Setting
931.Em MAXUPRC
932to a value less than
933.Em CHILD_MAX
934is not permitted, as this would result in a violation of the semantics of
935.St -p1003.1-90 .
936.It Cd options DEFCORENAME=string
937Sets the default value of the
938.Em kern.defcorename
939sysctl variable, otherwise it is set to
940.Nm %n.core .
941See
942.Xr sysctl 8
943and
944.Xr sysctl 3
945for details.
946.It Cd options RASOPS_CLIPPING
947Enables clipping within the
948.Nm rasops
949raster-console output system.
950.Em NOTE :
951only available on architectures that use
952.Nm rasops
953for console output.
954.It Cd options RASOPS_SMALL
955Removes optimized character writing code from the
956.Nm rasops
957raster-console output system.
958.Em NOTE :
959only available on architectures that use
960.Nm rasops
961for console output.
962.El
963.Ss Networking Options
964.Bl -ohang
965.It Cd options GATEWAY
966Enables
967.Em IPFORWARDING
968(which see)
969and (on most ports) increases the size of
970.Em NMBCLUSTERS
971(which see).
972In general,
973.Em GATEWAY
974is used to indicate that a system should act as a router, and
975.Em IPFORWARDING
976is not invoked directly.
977(Note that
978.Em GATEWAY
979has no impact on protocols other than
980.Tn IP ,
981such as
982.Tn CLNP
983or
984.Tn XNS ) .
985.It Cd options IPFORWARDING=value
986If
987.Em value
988is 1 this enables IP routing behavior. If
989.Em value
990is 0 (the default), it disables it. The
991.Em GATEWAY
992option sets this to 1 automatically.
993With this option enabled, the machine will forward IP datagrams destined
994for other machines between its interfaces.
995Note that even without this option, the kernel will
996still forward some packets (such as source routed packets) -- removing
997.Em GATEWAY
998and
999.Em IPFORWARDING
1000is insufficient to stop all routing through a bastion host on a
1001firewall -- source routing is controlled independently.
1002To turn off source routing, use
1003.Em options IPFORWSRCRT=0
1004(which see).
1005Note that IP forwarding may be turned on and off independently of the
1006setting of the
1007.Em IPFORWARDING
1008option through the use of the
1009.Em net.inet.ip.forwarding
1010sysctl variable.
1011If
1012.Em net.inet.ip.forwarding
1013is 1, IP forwarding is on.
1014See
1015.Xr sysctl 8
1016and
1017.Xr sysctl 3
1018for details.
1019.It Cd options IPFORWSRCRT=value
1020If
1021.Em value
1022is set to zero, source routing of IP datagrams is turned off.
1023If
1024.Em value
1025is set to one (the default) or the option is absent, source routed IP
1026datagrams are forwarded by the machine.
1027Note that source routing of IP packets may be turned on and off
1028independently of the setting of the
1029.Em IPFORWSRCRT
1030option through the use of the
1031.Em net.inet.ip.forwsrcrt
1032sysctl variable.
1033If
1034.Em net.inet.ip.forwsrcrt
1035is 1, forwarding of source routed IP datagrams is on.
1036See
1037.Xr sysctl 8
1038and
1039.Xr sysctl 3
1040for details.
1041.It Cd options IFA_STATS
1042Tells the kernel to maintain per-address statistics on bytes sent
1043and received over (currently) internet and appletalk addresses.
1044.\"This can be a fairly expensive operation, so you probably want to
1045.\"keep this disabled.
1046The option is not recommended as it degrades system stability.
1047.It Cd options MROUTING
1048Includes support for IP multicast routers.
1049You certainly want
1050.Em INET
1051with this.
1052Multicast routing is controlled by the
1053.Xr mrouted 8
1054daemon.
1055.It Cd options INET
1056Includes support for the
1057.Tn TCP/IP
1058protocol stack.
1059You almost certainly want this.
1060See
1061.Xr inet 4
1062for details.
1063This option is currently required.
1064.It Cd options INET6
1065Includes support for the
1066.Tn IPv6
1067protocol stack.
1068See
1069.Xr inet6 4
1070for details.
1071Unlike
1072.Em INET ,
1073.Em INET6
1074enables multicast routing code as well.
1075This option requires
1076.Em INET
1077at this moment, but it should not.
1078.It Cd options ND6_DEBUG
1079The option sets the default value of net.inet6.icmp6.nd6_debug to 1,
1080for debugging IPv6 neighbor discovery protocol handling.
1081See
1082.Xr sysctl 3
1083for details.
1084.It Cd options IPSEC
1085Includes support for the
1086.Tn IPsec
1087protocol.
1088See
1089.Xr ipsec 4
1090for details.
1091.Em IPSEC
1092will enable
1093secret key management part,
1094policy management part,
1095.Tn AH
1096and
1097.Tn IPComp .
1098Kernel binary will not be subject to export control in most of countries,
1099even if compiled with
1100.Em IPSEC .
1101For example, it should be okay to export it from within the United States
1102to the outside.
1103.Em INET6
1104and
1105.Em IPSEC
1106are orthogonal so you can get IPv4-only kernel with IPsec support,
1107IPv4/v6 dual support kernel without IPsec, and so forth.
1108This option requires
1109.Em INET
1110at this moment, but it should not.
1111.It Cd options IPSEC_DEBUG
1112Enables debugging code in
1113.Tn IPsec
1114stack.
1115This option assumes
1116.Em IPSEC .
1117.It Cd options IPSEC_ESP
1118Includes support for
1119.Tn IPsec
1120.Tn ESP
1121protocol.
1122See
1123.Xr ipsec 4
1124for details.
1125.Em IPSEC_ESP
1126will enable source code that is subject to export control in some countries
1127.Pq including the United States ,
1128and compiled kernel binary will be subject to certain restriction.
1129This option assumes
1130.Em IPSEC .
1131.It Cd options SUBNETSARELOCAL
1132Sets default value for net.inet.ip.subnetsarelocal variable, which
1133controls whether non-directly-connected subnets of connected networks
1134are considered "local" for purposes of choosing the MSS for a TCP
1135connection.  This is mostly present for historic reasons and
1136completely irrelevant if you enable Path MTU discovery.
1137.It Cd options HOSTZEROBROADCAST
1138Sets default value for net.inet.ip.hostzerobroadcast variable, which
1139controls whether the zeroth host address of each connected subnet is
1140also considered a broadcast address.  Default value is "1", for
1141compatibility with old systems; if this is set to zero on all hosts on
1142a subnet, you should be able to fit an extra host per subnet on the
1143".0" address.
1144.It Cd options MCLSHIFT=value
1145This option is the base-2 logarithm of the size of mbuf clusters.
1146The
1147.Bx
1148networking stack keeps network packets in a linked
1149list, or chain, of kernel buffer objects called mbufs.
1150The system provides larger mbuf clusters as an optimization for
1151large packets, instead of using long chains for large packets.
1152The mbuf cluster size,
1153or
1154.Em MCLBYTES ,
1155must be a power of two, and is computed as two raised to the power
1156.Em MCLSHIFT .
1157On systems with Ethernet network adaptors,
1158.Em MCLSHIFT
1159is often set to 11, giving 2048-byte mbuf clusters, large enough to
1160hold a 1500-byte
1161.Tn Ethernet
1162frame in a single cluster.
1163Systems with network interfaces supporting larger frame sizes like
1164.Tn ATM ,
1165.Tn FDDI ,
1166or
1167.Tn HIPPI
1168may perform better with
1169.Em MCLSHIFT
1170set to 12 or 13, giving mbuf cluster sizes of 4096 and 8192 bytes,
1171respectively.
1172.It Cd options NS
1173Include support for the
1174.Tn Xerox
1175.Tn XNS
1176protocol stack.
1177See
1178.Xr ns 4
1179for details.
1180.It Cd options ISO,TPIP
1181Include support for the ubiquitous
1182.Tn OSI
1183protocol stack.
1184See
1185.Xr iso 4
1186for details.
1187This option assumes
1188.Em INET .
1189.It Cd options EON
1190Include support for tunneling
1191.Tn OSI
1192protocols over
1193.Tn IP .
1194Known to be broken, or at least very fragile, and undocumented.
1195.It Cd options CCITT,LLC,HDLC
1196Include support for the
1197.Tn CCITT
1198(nee
1199.Tn ITU-TSS )
1200.Tn X.25
1201protocol stack.
1202The state of this code is currently unknown, and probably contains bugs.
1203This option assumes
1204.Em INET .
1205.It Cd options NETATALK
1206Include support for the
1207.Tn AppleTalk
1208protocol stack.
1209The kernel provides provision for the
1210.Em Datagram Delivery Protocol
1211(DDP), providing SOCK_DGRAM support and
1212.Tn AppleTalk
1213routing.
1214This stack is used by the
1215.Em NETATALK
1216package, which adds support for
1217.Tn AppleTalk
1218server services via user libraries and applications.
1219.It Cd options IPNOPRIVPORTS
1220Normally, only root can bind a socket descriptor to a so-called
1221.Dq privileged
1222.Tn TCP
1223port, that is, a port number in the range 0-1023.
1224This option eliminates those checks from the kernel.
1225This can be useful if there is a desire to allow daemons without
1226privileges to bind those ports, e.g. on firewalls.
1227The security tradeoffs in doing this are subtle.
1228This option should only be used by experts.
1229.It Cd options TCP_COMPAT_42
1230.Tn TCP
1231bug compatibility with
1232.Bx 4.2 .
1233In
1234.Bx 4.2 ,
1235.Tn TCP
1236sequence numbers were 32-bit signed values.
1237Modern implementations of TCP use unsigned values.
1238This option clamps the initial sequence number to start in
1239the range 2^31 rather than the full unsigned range of 2^32.
1240Also, under
1241.Bx 4.2 ,
1242keepalive packets must contain at least one byte or else
1243the remote end would not respond.
1244.It Cd options TCP_DEBUG
1245Record the last
1246.Em TCP_NDEBUG
1247TCP packets with SO_DEBUG set, and decode to the console if
1248.Em tcpconsdebug
1249is set.
1250.It Cd options TCP_NDEBUG
1251Number of packets to record for
1252.Em TCP_DEBUG .
1253Defaults to 100.
1254.It Cd options PFIL_HOOKS
1255This option turns on the packet filter interface hooks.
1256See
1257.Xr pfil 9
1258for details.
1259This option assumes
1260.Em INET .
1261.It Cd options IPFILTER_LOG
1262This option, in conjunction with
1263.Em pseudo-device ipfilter ,
1264enables logging of IP packets using ip-filter.
1265.It Cd options IPFILTER_DEFAULT_BLOCK
1266This option sets the default policy of ip-filter.
1267If it is set, ip-filter will block packets by default.
1268.It Cd options PPP_BSDCOMP
1269Enable support for BSD-compress
1270.Pq Sq bsdcomp
1271compression in ppp.
1272.It Cd options PPP_DEFLATE
1273Enable support for deflate
1274compression in ppp.
1275.It Cd options PPP_FILTER
1276This option turns on
1277.Xr pcap 3
1278based filtering for ppp connections.
1279This option is used by
1280.Xr pppd 8
1281which needs to be compiled with
1282.Em PPP_FILTER
1283defined (the current default).
1284.El
1285.Ss System V IPC Options
1286.Bl -ohang
1287.It Cd options SYSVMSG
1288Includes support for
1289.At V
1290style message queues.
1291See
1292.Xr msgctl 2 ,
1293.Xr msgget 2 ,
1294.Xr msgrcv 2 ,
1295.Xr msgsnd 2 .
1296.It Cd options SYSVSEM
1297Includes support for
1298.At V
1299style semaphores.
1300See
1301.Xr semctl 2 ,
1302.Xr semget 2 ,
1303.Xr semop 2 .
1304.It Cd options SEMMNI=value
1305Sets the number of
1306.At V
1307style semaphore identifiers.  The GENERIC config file for your port
1308will have the default.
1309.It Cd options SEMMNS=value
1310Sets the number of
1311.At V
1312style semaphores in the system.  The GENERIC config file for your port
1313will have the default.
1314.It Cd options SEMUME=value
1315Sets the maximum number of undo entries per process for
1316.At V
1317style semaphores.  The GENERIC config file for your port
1318will have the default.
1319.It Cd options SEMMNU=value
1320Sets the number of undo structures in the system for
1321.At V
1322style semaphores.  The GENERIC config file for your port
1323will have the default.
1324.It Cd options SYSVSHM
1325Includes support for
1326.At V
1327style shared memory.
1328See
1329.Xr shmat 2 ,
1330.Xr shmctl 2 ,
1331.Xr shmdt 2 ,
1332.Xr shmget 2 .
1333.It Cd options SHMMAXPGS=value
1334Sets the maximum number of
1335.At V
1336style shared memory pages that are available through the
1337.Xr shmget 2
1338system call.
1339Default value is 1024 on most ports.
1340See
1341.Pa /usr/include/machine/vmparam.h
1342for the default.
1343.El
1344.Ss VM Related Options
1345.Bl -ohang
1346.It Cd options NMBCLUSTERS=value
1347The number of mbuf clusters the kernel supports.  Mbuf clusters are
1348MCLBYTES in size (usually 2k).  This is used to compute the size of
1349the kernel VM map
1350.Em mb_map ,
1351which maps mbuf clusters.
1352Default on most ports is 256 (512 with
1353.Dq options GATEWAY
1354).
1355See
1356.Pa /usr/include/machine/param.h
1357for exact default information.
1358Increase this value if you get
1359.Dq mb_map full
1360messages.
1361.It Cd options NKMEMPAGES=value
1362.It Cd options NKMEMPAGES_MIN=value
1363.It Cd options NKMEMPAGES_MAX=value
1364Size of kernel VM map
1365.Em kmem_map ,
1366in PAGE_SIZE-sized chunks (the VM page size; this value may be read
1367from the
1368.Xr sysctl 8
1369variable
1370.Em hw.pagesize
1371).
1372This VM map is used to map the kernel malloc arena.
1373The kernel attempts to auto-size this map based on the amount of
1374physical memory in the system.  Platform-specific code may place
1375bounds on this computed size, which may be viewed with the
1376.Xr sysctl 8
1377variable
1378.Em vm.nkmempages .
1379See
1380.Pa /usr/include/machine/param.h
1381for the default upper and lower bounds.
1382The related options
1383.Sq NKMEMPAGES_MIN
1384and
1385.Sq NKMEMPAGES_MAX
1386allow the bounds to be overridden in the kernel configuration file.
1387These options are provided in the event the computed value is
1388insufficient resulting in an
1389.Dq out of space in kmem_map
1390panic.
1391.It Cd options BUFCACHE=value
1392Size of the buffer cache as a percentage of total available
1393.Tn RAM .
1394Ignored if BUFPAGES is also specified.
1395.It Cd options NBUF=value
1396.It Cd options BUFPAGES=value
1397These options set the number of pages available for the buffer cache.
1398Their default value is a machine dependent value, often calculated as
1399between 5% and 10% of total available
1400.Tn RAM .
1401.El
1402.Ss amiga-specific Options
1403.Bl -ohang
1404.It Cd options BB060STUPIDROM
1405When the bootloader (which passes
1406.Tn AmigaOS
1407.Tn ROM
1408information) claims we have a 68060
1409.Tn CPU
1410without
1411.Tn FPU ,
1412go look into the Processor Configuration Register (PCR) to find out.
1413You need this with
1414.Tn Amiga
1415.Tn ROM Ns s
1416up to (at least) V40.xxx (OS3.1),
1417when you boot via the bootblocks and don't have a DraCo.
1418.It Cd options IOBZCLOCK=frequency
1419The IOBlix boards come with two different serial master clocks: older ones
1420use 24 MHz, newer ones use 22.1184 MHz. The driver normally assumes the latter.
1421If your board uses 24 MHz, you can recompile your kernel with
1422options IOBZCLOCK=24000000
1423or patch the kernel variable
1424.Tn iobzclock
1425to the same value.
1426.It Cd options LIMITMEM=value
1427If there, limit the part of the first memory bank used by
1428.Nx
1429to value megabytes.
1430Default is unlimited.
1431.It Cd options NKPTADD=addvalue
1432.It Cd options NKPTADDSHIFT=shiftvalue
1433The
1434.Tn CPU
1435specific
1436.Tn MMU
1437table for the kernel is pre-allocated at kernel startup time.
1438Part of it is scaled with
1439.Va maxproc ,
1440to have enough room to hold the user program
1441.Tn MMU
1442tables; the second part is a fixed amount for the kernel itself.
1443.Pp
1444The third part accounts for the size of the file buffer cache.
1445Its size is either
1446.Dv NKPTADD
1447pages (if defined) or memory size in bytes divided by two to
1448the power of
1449.Dv NKPTADDSHIFT .
1450The default is undefined
1451.Dv NKPTADD
1452and
1453.Dv NKPTADDSHIFT=24 ,
1454allowing for 16 buffers per megabyte of main memory (while
1455a GENERIC kernel allocates about half of that).
1456When you get "can't get KPT page" panics, you should increase
1457.Dv NKPTADD
1458(if defined), or decrease
1459.Dv NKPTADDSHIFT
1460by one.
1461.It Cd options P5PPC68KBOARD
1462Add special support for Phase5 mixed 68k+PPC boards. Currently, this only
1463affects rebooting from
1464.Nx
1465and is only needed on 68040+PPC, not on
146668060+PPC; without this, affected machines will hang after
1467.Nx
1468has shut
1469down and will only restart after a keyboard reset or a power cycle.
1470.El
1471.Ss arm32-specific Options
1472.Bl -ohang
1473.It Cd options FRENCH_KEYBOARD
1474Include translation for French keyboards when using
1475.Xr pccons 4
1476on a Shark.
1477.It Cd options FINNISH_KEYBOARD
1478Include translation for Finnish keyboards when using
1479.Xr pccons 4
1480on a Shark.
1481.It Cd options GERMAN_KEYBOARD
1482Include translation for German keyboards when using
1483.Xr pccons 4
1484on a Shark.
1485.It Cd options NORWEGIAN_KEYBOARD
1486Include translation for French keyboards when using
1487.Xr pccons 4
1488on a Shark.
1489.El
1490.Ss atari-specific Options
1491.Bl -ohang
1492.It Cd options DISKLABEL_AHDI
1493Include support for AHDI (native Atari) disklabels.
1494.It Cd options DISKLABEL_NBDA
1495Include support for
1496.Nx Ns Tn /atari
1497labels.
1498If you don't set this option, it will be set automatically.
1499.Nx Ns Tn /atari
1500will not work without it.
1501.It Cd options FALCON_SCSI
1502Include support for the 5380-SCSI configuration as found on the Falcon.
1503.It Cd options RELOC_KERNEL
1504If set, the kernel will relocate itself to TT-RAM, if possible.
1505This will give you a slightly faster system.
1506.Em Beware
1507that on some TT030 systems,
1508the system will frequently dump with MMU-faults with this option enabled.
1509.It Cd options SERCONSOLE
1510Allow the modem1-port to act as the system-console.
1511A carrier should be active on modem1 during system boot to active
1512the console functionality.
1513.It Cd options TT_SCSI
1514Include support for the 5380-SCSI configuration as found on the TT030
1515and Hades.
1516.El
1517.Ss i386-specific Options
1518.Bl -ohang
1519.It Cd options I386_CPU,I486_CPU,I586_CPU,I686_CPU
1520Include support for a particular class of
1521.Tn CPU
1522.Po
1523.Tn i386 ,
1524.Tn i486 ,
1525.Tn Pentium ,
1526or
1527.Tn Pentium Pro
1528.Pc .
1529If the appropriate class for your
1530.Tn CPU
1531is not configured, the kernel will use the highest class available
1532that will work.
1533In general, using the correct
1534.Tn CPU
1535class will result in the best performance.
1536At least one of these options must be present.
1537.It Cd options CPURESET_DELAY=value
1538specifies the time (in millisecond) to wait before doing a hardware reset
1539in the last phase of a reboot. This gives the user a chance to see error
1540messages from the shutdown operations (like NFS unmounts, buffer cache flush,
1541etc ...). Setting this to 0 will disable the delay. Default is 2 seconds.
1542.It Cd options MATH_EMULATE
1543Include the floating point emulator.
1544This is useful only for
1545.Tn CPU Ns s
1546that lack an
1547internal Floating Point Unit
1548.Pq Tn FPU
1549or co-processor.
1550.It Cd options VM86
1551Include support for virtual 8086 mode, used by
1552.Tn DOS
1553emulators and X servers to run BIOS code, e.g. for some VESA routines.
1554.It Cd options USER_LDT
1555Include i386-specific system calls for modifying the local descriptor table,
1556used by Windows emulators.
1557.It Cd options REALBASEMEM=integer
1558Overrides the base memory size passed in from the boot block.
1559(Value given in kilobytes.)
1560Use this option only if the boot block reports the size incorrectly.
1561(Note that some
1562.Tn BIOS Ns es
1563put the extended
1564.Tn BIOS
1565data area at the top of base memory, and therefore report a smaller
1566base memory size to prevent programs overwriting it.
1567This is correct behavior, and you should not use the
1568.Em REALBASEMEM
1569option to access this memory).
1570.It Cd options REALEXTMEM=integer
1571Overrides the extended memory size passed in from the boot block.
1572(Value given in kilobytes. Extended memory does not include the first megabyte.)
1573Use this option only if the boot block reports the size incorrectly.
1574.It Cd options FRENCH_KBD,FINNISH_KBD,GERMAN_KBD,NORWEGIAN_KBD
1575Select a non-US keyboard layout for the
1576.Em pccons
1577console driver.
1578.It Cd options CYRIX_CACHE_WORKS
1579Relevant only to the Cyrix 486DLC cpu. This option is used to turn on
1580the cache in hold-flush mode. It is not turned on by default because it
1581is known to have problems in certain motherboard implementations.
1582.It Cd options CYRIX_CACHE_REALLY_WORKS
1583Relevant only to the Cyrix 486DLC cpu. This option is used to turn on
1584the cache in write-back mode. It is not turned on by default because it
1585is known to have problems in certain motherboard implementations. In order
1586for this option to take effect, option
1587.Em CYRIX_CACHE_WORKS
1588must also be specified.
1589.It Cd options PCIBIOS
1590Enable support for initializing the
1591.Tn PCI
1592bus using information from the
1593.Tn BIOS .
1594See
1595.Xr pcibios 4
1596for details.
1597.El
1598.Ss isa-specific Options
1599Options specific to
1600.Xr isa 4
1601busses.
1602.Bl -ohang
1603.It Cd options PCIC_ISA_ALLOC_IOBASE=address, PCIC_ISA_ALLOC_IOSIZE=size
1604Control the section of IO bus space used for PCMCIA bus space mapping.
1605Ideally the probed defaults are satisfactory, however in practice
1606that is not always the case. See
1607.Xr pcmcia 4
1608for details.
1609.It Cd options PCIC_ISA_INTR_ALLOC_MASK=mask
1610Controls the allowable interrupts that may be used for
1611.Tn PCMCIA
1612devices. This mask is a logical-or of power-of-2s of allowable
1613interrupts:
1614.Bd -literal -offset 04n
1615.Em "IRQ Val      IRQ Val      IRQ Val       IRQ Val"
1616 0  0x0001    4  0x0010    8  0x0100    12  0x1000
1617 1  0x0002    5  0x0020    9  0x0200    13  0x2000
1618 2  0x0004    6  0x0040   10  0x0400    14  0x4000
1619 3  0x0008    7  0x0080   11  0x0800    15  0x8000
1620.Ed
1621.El
1622.Ss m68k-specific Options
1623.Bl -ohang
1624.It Cd options FPU_EMULATE
1625Include support for MC68881/MC68882 emulator.
1626.It Cd options FPSP
1627Include support for 68040 floating point.
1628.It Cd options M68020,M68030,M68040,M68060
1629Include support for a specific
1630.Tn CPU ,
1631at least one (the one you are using) should be specified.
1632.It Cd options M060SP
1633Include software support for 68060.
1634This provides emulation of unimplemented
1635integer instructions as well as emulation of unimplemented floating point
1636instructions and data types and software support for floating point traps.
1637.El
1638.Ss sparc-specific Options
1639.Bl -ohang
1640.It Cd options AUDIO_DEBUG
1641Enable simple event debugging of the logging of the
1642.Xr audio 4
1643device.
1644.It Cd options BLINK
1645Enable blinking of LED.  Blink rate is full cycle every N seconds for
1646N < then current load average.  See
1647.Xr getloadavg 3 .
1648.\" .It Cd options COLORFONT_CACHE
1649.\" this is totally fucked up.. what does this do?
1650.It Cd options COUNT_SW_LEFTOVERS
1651Count how many times the sw SCSI device has left 3, 2, 1 and 0 in the
1652sw_3_leftover, sw_2_leftover, sw_1_leftover, and sw_0_leftover
1653variables accessible from
1654.Xr ddb 4 .
1655See
1656.Xr sw 4 .
1657.It Cd options DEBUG_ALIGN
1658Adds debugging messages calls when user-requested alignment fault
1659handling happens.
1660.It Cd options DEBUG_EMUL
1661Adds debugging messages calls for emulated floating point and
1662alignment fixing operations.
1663.It Cd options DEBUG_SVR4
1664Prints registers messages calls for emulated SVR4 getcontext and
1665setcontext operations.  See
1666.Em options COMPAT_SVR4 .
1667.It Cd options EXTREME_DEBUG
1668Adds debugging functions callable from
1669.Xr ddb 4 .  The debug_pagetables, test_region and print_fe_map
1670functions print information about page tables for the SUN4M
1671platforms only.
1672.It Cd options EXTREME_EXTREME_DEBUG
1673Adds extra info to
1674.Em options EXTREME_DEBUG .
1675.It Cd options FPU_CONTEXT
1676Make
1677.Em options COMPAT_SVR4
1678getcontext and setcontext include floating point registers.
1679.It Cd options MAGMA_DEBUG
1680Adds debugging messages to the
1681.Xr magma 4
1682device.
1683.It Cd options RASTERCONS_FULLSCREEN
1684Use the entire screen for the console.
1685.It Cd options RASTERCONS_SMALLFONT
1686Use a the fixed font on the console, instead of the normal font.
1687.It Cd options SUN4
1688Support sun4 class machines.
1689.It Cd options SUN4C
1690Support sun4c class machines.
1691.It Cd options SUN4M
1692Support sun4m class machines.
1693.It Cd options SUN4_MMU3L
1694.\" XXX ???
1695Enable support for sun4 3-level MMU machines.
1696.It Cd options V9
1697Enable SPARC V9 assembler in
1698.Xr ddb 4 .
1699.El
1700.Ss x68k-specific Options
1701.Bl -ohang
1702.It Cd options EXTENDED_MEMORY
1703Include support for extended memory e.g. TS-6BE16 and 060turbo on-board.
1704.It Cd options JUPITER
1705Include support for Jupiter-X MPU accelerator
1706.It Cd options ZSCONSOLE,ZSCN_SPEED=value
1707Use the built-in serial port as the system-console.
1708Speed is specified in bps, defaults to 9600.
1709.It Cd options ITE_KERNEL_ATTR=value
1710Set the kernel message attribute for ITE.
1711Value, an integer, is a logical or of the following values:
1712.Bl -tag -width 4n -compact -offset indent
1713.It 1
1714color inversed
1715.It 2
1716underlined
1717.It 4
1718bolded
1719.El
1720.El
1721.\" The following requests should be uncommented and used where appropriate.
1722.\" .Sh FILES
1723.\" .Sh EXAMPLES
1724.Sh SEE ALSO
1725.Xr gdb 1 ,
1726.Xr ktrace 1 ,
1727.Xr quota 1 ,
1728.Xr gettimeofday 2 ,
1729.Xr i386_iopl 2 ,
1730.Xr msgctl 2 ,
1731.Xr msgget 2 ,
1732.Xr msgrcv 2 ,
1733.Xr msgsnd 2 ,
1734.Xr ntp_adjtime 2 ,
1735.Xr ntp_gettime 2 ,
1736.Xr semctl 2 ,
1737.Xr semget 2 ,
1738.Xr semop 2 ,
1739.Xr shmat 2 ,
1740.Xr shmctl 2 ,
1741.Xr shmdt 2 ,
1742.Xr shmget 2 ,
1743.Xr sysctl 3 ,
1744.Xr apm 4 ,
1745.Xr ddb 4 ,
1746.Xr inet 4 ,
1747.Xr iso 4 ,
1748.Xr lkm 4 ,
1749.Xr ns 4 ,
1750.Xr pcibios 4 ,
1751.Xr pcmcia 4 ,
1752.Xr config 8 ,
1753.Xr edquota 8 ,
1754.Xr init 8 ,
1755.Xr mount_cd9660 8 ,
1756.Xr mount_fdesc 8 ,
1757.Xr mount_kernfs 8 ,
1758.Xr mount_lfs 8 ,
1759.Xr mount_mfs 8 ,
1760.Xr mount_msdos 8 ,
1761.Xr mount_nfs 8 ,
1762.Xr mount_ntfs 8 ,
1763.Xr mount_null 8 ,
1764.Xr mount_portal 8 ,
1765.Xr mount_procfs 8 ,
1766.Xr mount_umap 8 ,
1767.Xr mount_union 8 ,
1768.Xr mrouted 8 ,
1769.Xr newfs_lfs 8 ,
1770.Xr quotaon 8 ,
1771.Xr rpc.rquotad 8 ,
1772.Xr sysctl 8 ,
1773.Xr ntpd 8
1774.Sh HISTORY
1775The
1776.Nm
1777man page first appeared in
1778.Nx 1.3 .
1779.Sh BUGS
1780The
1781.Em INET
1782and the
1783.Em VNODEPAGER
1784options should not be required.
1785The
1786.Em EON
1787option should be a pseudo-device, and is also very fragile.
1788