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