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