1.\" $NetBSD: options.4,v 1.270 2005/03/27 16:28:55 peter 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 March 27, 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. 854.Em NOTE : 855You also need to enable the pseudo-device, vcoda, for the Coda 856file system to work. 857.It Cd file-system SMBFS 858.Em [EXPERIMENTAL] 859Includes code for the SMB/CIFS file system. 860See 861.Xr mount_smbfs 8 862for details. 863.Em NOTE : 864You also need to enable the pseudo-device, nsmb, for the SMB 865file system to work. 866.El 867.Ss File System Options 868.Bl -ohang 869.It Cd options NFSSERVER 870Include the server side of the 871.Em NFS 872(Network File System) remote file sharing protocol. 873Although the bulk of the code implementing 874.Em NFS 875is kernel based, several user level daemons are needed for it to 876work. 877See 878.Xr mountd 8 879and 880.Xr nfsd 8 881for details. 882.It Cd options QUOTA 883Enables kernel support for file system quotas. 884See 885.Xr quotaon 8 , 886.Xr edquota 8 , 887and 888.Xr quota 1 889for details. 890Note that quotas only work on 891.Dq ffs 892file systems, although 893.Xr rpc.rquotad 8 894permits them to be accessed over 895.Em NFS . 896.It Cd options FFS_EI 897Enable ``Endian-Independent'' FFS support. 898This allows a system to mount an FFS file system created for another 899architecture, at a small performance cost for all FFS file systems. 900See also 901.Xr newfs 8 , 902.Xr fsck_ffs 8 , 903.Xr dumpfs 8 904for file system byte order status and manipulation. 905.It Cd options NVNODE=integer 906This option sets the size of the cache used by the name-to-inode translation 907routines, (a.k.a. the 908.Fn namei 909cache, though called by many other names in the kernel source). 910By default, this cache has 911.Dv NPROC 912(set as 20 + 16 * MAXUSERS) * (80 + NPROC / 8) entries. 913A reasonable way to derive a value of 914.Dv NVNODE , 915should you notice a large number of namei cache misses with a tool such as 916.Xr systat 1 , 917is to examine your system's current computed value with 918.Xr sysctl 8 , 919(which calls this parameter "kern.maxvnodes") and to increase this value 920until either the namei cache hit rate improves or it is determined that 921your system does not benefit substantially from an increase in the size of 922the namei cache. 923.It Cd options NAMECACHE_ENTER_REVERSE 924Causes the namei cache to always enter a reverse mapping (vnode -\*[Gt] name) 925as well as a normal one. 926Normally, this is already done for directory vnodes, to speed up the getcwd 927operation. 928This option will cause longer hash chains in the reverse cache, and thus 929slow down getcwd somewhat. 930However, it does make vnode -\*[Gt] path translations possible in some cases. 931For now, only useful if strict /proc/#/maps emulation for Linux binaries is 932required. 933.It Cd options EXT2FS_SYSTEM_FLAGS 934This option changes the behavior of the APPEND and IMMUTABLE flags 935for a file on an 936.Em EXT2FS 937file system. 938Without this option, the superuser or owner of the file can 939set and clear them. 940With this option, only the superuser can set them, and 941they can't be cleared if the securelevel is greater than 0. 942See also 943.Xr chflags 1 . 944.It Cd options NFS_BOOT_BOOTP 945Enable use of the BOOTP protocol (RFCs 951 and 1048) to get configuration 946information if NFS is used to mount the root file system. 947See 948.Xr diskless 8 949for details. 950.It Cd options NFS_BOOT_DHCP 951Same as 952.Dq NFS_BOOT_BOOTP , 953but use the DHCP extensions to the 954BOOTP protocol (RFC 1541). 955.It Cd options NFS_BOOT_BOOTP_REQFILE 956Specifies the string sent in the bp_file field of the BOOTP / DHCP 957request packet. 958.It Cd options NFS_BOOT_BOOTPARAM 959Enable use of the BOOTPARAM protocol, consisting of RARP and 960BOOTPARAM RPC, to get configuration information if NFS 961is used to mount the root file system. 962See 963.Xr diskless 8 964for details. 965.It Cd options NFS_BOOT_RWSIZE=value 966Set the initial NFS read and write sizes for diskless-boot requests. 967The normal default is 8Kbytes. 968This option provides a way to lower the value (e.g., to 1024 bytes) 969as a workaround for buggy network interface cards or boot PROMs. 970Once booted, the read and write request sizes can be increased by 971remounting the file system. 972See 973.Xr mount_nfs 8 974for details. 975.It Cd options NFS_V2_ONLY 976Reduce the size of the NFS client code by omitting code that's only required 977for NFSv3 and NQNFS support, leaving only that code required to use NFSv2 978servers. 979.It Cd options SOFTDEP 980Enable kernel support for soft-dependencies in FFS filesystems. 981Softdep improves write performance by aggregating and properly 982ordering disk metadata writes, achieving near-asynchronous write 983performance while maintaining the filesystem consistency of 984synchronous writes. 985Soft-dependencies are enabled on a per-mount basis. 986See 987.Xr mount 8 988for details. 989.It Cd options UFS_DIRHASH 990Increase lookup performance by maintaining in-core hash tables 991for large directories. 992.El 993.Ss Miscellaneous Options 994.Bl -ohang 995.It Cd options NEW_BUFQ_STRATEGY 996Enable experimental buffer queue strategy for disk I/O. 997In the default strategy, outstanding disk requests are ordered by 998sector number and sent to the disk, regardless of whether the 999operation is a read or write; this option gives priority to issuing 1000read requests over write requests. 1001Although requests may therefore be issued out of sector-order, causing 1002more seeks and thus lower overall throughput, interactive system 1003responsiveness under heavy disk I/O load may be improved, as processes 1004blocking on disk reads are serviced sooner (file writes typically 1005don't cause applications to block). 1006The performance effect varies greatly depending on the hardware, drive 1007firmware, filesystem configuration, workload, and desired performance 1008trade-off. 1009Systems using drive write-cache (most modern IDE disks, by default) 1010are unlikely to benefit and may well suffer; such disks acknowledge 1011writes very quickly, and optimise them internally according to 1012physical layout. 1013Giving these disks as many requests to work with as possible (the 1014standard strategy) will typically produce the best results, especially 1015if the drive has a large cache; the drive will silently complete 1016writes from cache as it seeks for reads. 1017Disks that support a large number of concurrent tagged requests (SCSI 1018disks and many hardware RAID controllers) expose this internal 1019scheduling with tagged responses, and don't block for reads; such 1020disks may not see a noticable difference with either strategy. 1021However, if IDE disks are run with write-cache disabled for safety, 1022writes are not acknowledged until actually completed, and only one 1023request can be outstanding; a large number of small writes in one 1024locality can keep the disk busy, starving reads elsewhere on the disk. 1025Such systems are likely to see the most benefit from this option. 1026Finally, the performance interaction of this option with ffs soft 1027dependencies can be subtle, as that mechanism can drastically alter 1028the workload for filesystem metadata writes. 1029.It Cd options LKM 1030Enable loadable kernel modules. 1031See 1032.Xr lkm 4 1033for details. 1034.Em NOTE : 1035not available on all architectures. 1036.It Cd options INSECURE 1037Hardwires the kernel security level at -1. 1038This means that the system 1039always runs in secure level 0 mode, even when running multiuser. 1040See the manual page for 1041.Xr init 8 1042for details on the implications of this. 1043The kernel secure level may manipulated by the superuser by altering the 1044.Em kern.securelevel 1045.Xr sysctl 3 1046variable (the secure level may only be lowered by a call from process ID 1, 1047i.e. 1048.Xr init 8 ) . 1049See also 1050.Xr sysctl 8 1051and 1052.Xr sysctl 3 . 1053.It Cd options MEMORY_DISK_DYNAMIC 1054This options makes the 1055.Xr md 4 1056.Tn RAM 1057disk size dynamically sized. 1058.It Cd options MEMORY_DISK_HOOKS 1059This option allows for some machine dependent functions to be called when 1060the 1061.Xr md 4 1062.Tn RAM 1063disk driver is configured. 1064This can result in automatically loading a 1065.Tn RAM 1066disk from floppy on open (among other things). 1067.It Cd options MEMORY_DISK_IS_ROOT 1068Forces the 1069.Xr md 4 1070.Tn RAM 1071disk to be the root device. 1072This can only be overridden when 1073the kernel is booted in the 'ask-for-root' mode. 1074.It Cd options MEMORY_DISK_ROOT_SIZE=integer 1075Allocates the given number of 512 byte blocks as memory for the 1076.Xr md 4 1077.Tn RAM 1078disk, to be populated with 1079.Xr mdsetimage 8 . 1080.It Cd options MEMORY_DISK_SERVER=0 1081Do not include the interface to a userland memory disk server process. 1082Per default, this options is set to 1, including the support code. 1083Useful for install media kernels. 1084.It Cd options VNODE_OP_NOINLINE 1085Do not inline the 1086.Fn VOP_* 1087calls in the kernel. 1088On i386 GENERIC, this saves 36k of kernel text. 1089Useful for install media kernels, small memory systems and embedded systems. 1090.It Cd options MALLOC_NOINLINE 1091Time critical fixed size memory allocation is performed with 1092.Fn MALLOC 1093and 1094.Fn FREE . 1095Normally these expand to inline code, but with 1096.Em MALLOC_NOINLINE 1097these call the normal 1098.Fn malloc 1099and 1100.Fn free 1101functions. 1102Useful for install media kernels, small memory systems and embedded systems. 1103.It Cd options HZ=integer 1104On ports that support it, set the system clock frequency (see 1105.Xr hz 9 ) 1106to the supplied value. 1107Handle with care. 1108.It Cd options NTP 1109Turns on in-kernel precision timekeeping support used by software 1110implementing 1111.Em NTP 1112(Network Time Protocol, RFC 1305). 1113The 1114.Em NTP 1115option adds an in-kernel Phase-Locked Loop (PLL) for normal 1116.Em NTP 1117operation, and a Frequency-Locked Loop (FLL) for intermittently-connected 1118operation. 1119.Xr ntpd 8 1120will employ a user-level PLL when kernel support is unavailable, 1121but the in-kernel version has lower latency and more precision, and 1122so typically keeps much better time. 1123The interface to the kernel 1124.Em NTP 1125support is provided by the 1126.Xr ntp_adjtime 2 1127and 1128.Xr ntp_gettime 2 1129system calls, which are intended for use by 1130.Xr ntpd 8 1131and are enabled by the option. 1132On systems with sub-microsecond resolution timers, or where (HZ / 100000) 1133is not an integer, the 1134.Em NTP 1135option also enables extended-precision arithmetic to keep track of 1136fractional clock ticks at NTP time-format precision. 1137.It Cd options PPS_SYNC 1138This option enables a kernel serial line discipline for receiving time 1139phase signals from an external reference clock such as a radio clock. 1140(The 1141.Em NTP 1142option (which see) must be on if the 1143.Em PPS_SYNC 1144option is used.) 1145Some reference clocks generate a Pulse Per Second (PPS) signal in 1146phase with their time source. 1147The 1148.Em PPS 1149line discipline receives this signal on either the data leads 1150or the DCD control lead of a serial port. 1151.Em NTP 1152uses the PPS signal to discipline the local clock oscillator to a high 1153degree of precision (typically less than 50 microseconds in time and 11540.1 ppm in accuracy). 1155.Em PPS 1156can also generate a serial output pulse when the system receives a PPS 1157interrupt. 1158This can be used to measure the system interrupt latency and thus calibrate 1159.Em NTP 1160to account for it. 1161Using 1162.Em PPS 1163usually requires a 1164gadget box 1165to convert from TTL to RS-232 signal levels. 1166The gadget box and PPS are described in more detail in the HTML documentation 1167for 1168.Xr ntpd 8 1169in 1170.Pa /usr/share/doc/html/ntp . 1171.It Cd options NO_TSC_TIME 1172Don't use TSC microtime, even if available (i386 only). 1173Improves time behavior under VMware. 1174.It Cd options SETUIDSCRIPTS 1175Allows scripts with the setuid bit set to execute as the effective 1176user rather than the real user, just like binary executables. 1177.Pp 1178.Em NOTE : 1179Using this option will also enable 1180.Em options FDSCRIPTS 1181.It Cd options FDSCRIPTS 1182Allows execution of scripts with the execute bit set, but not the 1183read bit, by opening the file and passing the file descriptor to 1184the shell, rather than the filename. 1185.Pp 1186.Em NOTE : 1187Execute only (non-readable) scripts will have 1188.Va argv[0] 1189set to 1190.Pa /dev/fd/* . 1191What this option allows as far as security is 1192concerned, is the ability to safely ensure that the correct script 1193is run by the interpreter, as it is passed as an already open file. 1194.It Cd options PUCCN 1195Enables treating serial ports found on PCI boards 1196.Xr puc 4 1197as potential console devices. 1198The method for choosing such a console device is port dependent. 1199.It Cd options RTC_OFFSET=integer 1200The kernel (and typically the hardware battery backed-up clock on 1201those machines that have one) keeps time in 1202.Em UTC 1203(Universal Coordinated Time, once known as 1204.Em GMT , 1205or Greenwich Mean Time) 1206and not in the time of the local time zone. 1207The 1208.Em RTC_OFFSET 1209option is used on some ports (such as the i386) to tell the kernel 1210that the hardware clock is offset from 1211.Em UTC 1212by the specified number of minutes. 1213This is typically used when a machine boots several operating 1214systems and one of them wants the hardware clock to run in the 1215local time zone and not in 1216.Em UTC , 1217e.g. 1218.Em RTC_OFFSET=300 1219means 1220the hardware clock is set to US Eastern Time (300 minutes behind 1221.Em UTC ) , 1222and not 1223.Em UTC . 1224(Note: 1225.Em RTC_OFFSET 1226is used to initialize a kernel variable named 1227.Va rtc_offset 1228which is the source actually used to determine the clock offset, and 1229which may be accessed via the kern.rtc_offset sysctl variable. 1230See 1231.Xr sysctl 8 1232and 1233.Xr sysctl 3 1234for details. 1235Since the kernel clock is initialized from the hardware clock very 1236early in the boot process, it is not possible to meaningfully change 1237.Va rtc_offset 1238in system initialization scripts. 1239Changing this value currently may only be done at kernel compile 1240time or by patching the kernel and rebooting). 1241.Pp 1242.Em NOTE : 1243Unfortunately, in many cases where the hardware clock 1244is kept in local time, it is adjusted for Daylight Savings 1245Time; this means that attempting to use 1246.Em RTC_OFFSET 1247to let 1248.Nx 1249coexist with such an operating system, like Windows, 1250would necessitate changing 1251.Em RTC_OFFSET 1252twice a year. 1253As such, this solution is imperfect. 1254.It Cd options KMEMSTATS 1255The kernel memory allocator, 1256.Xr malloc 9 , 1257will keep statistics on its performance if this option is enabled. 1258Unfortunately, this option therefore essentially disables the 1259.Fn MALLOC 1260and 1261.Fn FREE 1262forms of the memory allocator, which are used to enhance the performance 1263of certain critical sections of code in the kernel. 1264This option therefore can lead to a significant decrease in the 1265performance of certain code in the kernel if enabled. 1266Examples of such code include the 1267.Fn namei 1268routine, the 1269.Xr ccd 4 1270driver, 1271the 1272.Xr ncr 4 1273driver, 1274and much of the networking code. 1275.It Cd options MAXUPRC=integer 1276Sets the soft 1277.Dv RLIMIT_NPROC 1278resource limit, which specifies the maximum number of simultaneous 1279processes a user is permitted to run, for process 0; 1280this value is inherited by its child processes. 1281It defaults to 1282.Em CHILD_MAX , 1283which is currently defined to be 160. 1284Setting 1285.Em MAXUPRC 1286to a value less than 1287.Em CHILD_MAX 1288is not permitted, as this would result in a violation of the semantics of 1289.St -p1003.1-90 . 1290.It Cd options NOFILE=integer 1291Sets the soft 1292.Dv RLIMIT_NOFILE 1293resource limit, which specifies the maximum number of open 1294file descriptors for each process; 1295this value is inherited by its child processes. 1296It defaults to 1297.Em OPEN_MAX , 1298which is currently defined to be 64. 1299.It Cd options DEFCORENAME=string 1300Sets the default value of the 1301.Em kern.defcorename 1302sysctl variable, otherwise it is set to 1303.Nm %n.core . 1304See 1305.Xr sysctl 8 1306and 1307.Xr sysctl 3 1308for details. 1309.It Cd options RASOPS_CLIPPING 1310Enables clipping within the 1311.Nm rasops 1312raster-console output system. 1313.Em NOTE : 1314only available on architectures that use 1315.Nm rasops 1316for console output. 1317.It Cd options RASOPS_SMALL 1318Removes optimized character writing code from the 1319.Nm rasops 1320raster-console output system. 1321.Em NOTE : 1322only available on architectures that use 1323.Nm rasops 1324for console output. 1325.It Cd options INCLUDE_CONFIG_FILE 1326Embeds the kernel config file used to define the kernel in the kernel 1327binary itself. 1328The embedded data also includes any files directly included by the config 1329file itself, e.g. 1330.Pa GENERIC.local 1331or 1332.Pa std.$MACHINE . 1333The embedded config file can be extracted from the resulting kernel with 1334.Xr config 8 1335.Fl x , 1336or by the following command: 1337.Bd -literal -offset indent 1338strings netbsd | sed -n 's/^_CFG_//p' | unvis 1339.Ed 1340.It Cd options INCLUDE_JUST_CONFIG 1341Similar to the above option, but includes just the actual config file, 1342not any included files. 1343.It Cd options PIPE_SOCKETPAIR 1344Use slower, but smaller socketpair(2)-based pipe implementation instead 1345of default faster, but bigger one. 1346Primarily useful for installation kernels. 1347.It Cd options USERCONF 1348Compiles in the in-kernel device configuration manager. 1349See 1350.Xr userconf 4 1351for details. 1352.It Cd options PERFCTRS 1353Compiles in kernel support for CPU performance-monitoring counters. 1354See 1355.Xr pmc 1 1356for details. 1357.Em NOTE : 1358not available on all architectures. 1359.It Cd options XSERVER 1360Compiles in kernel support for 1361.Tn X11 1362on architectures that still use (or can use) the legacy 1363.Em pccons 1364console drivers rather than 1365.Xr wscons 4 . 1366These include bebox, i386, shark. 1367.It Cd options XSERVER_DDB 1368A supplement to XSERVER that adds support for entering 1369.Xr ddb 4 1370while in 1371.Tn X11 . 1372.El 1373.Ss Networking Options 1374.Bl -ohang 1375.It Cd options GATEWAY 1376Enables 1377.Em IPFORWARDING 1378(which see) 1379and (on most ports) increases the size of 1380.Em NMBCLUSTERS 1381(which see). 1382In general, 1383.Em GATEWAY 1384is used to indicate that a system should act as a router, and 1385.Em IPFORWARDING 1386is not invoked directly. 1387(Note that 1388.Em GATEWAY 1389has no impact on protocols other than 1390.Tn IP , 1391such as 1392.Tn CLNP 1393or 1394.Tn XNS ) . 1395.Em GATEWAY 1396option also compiles IPv4 fast forwarding code into the kernel. 1397.It Cd options IPFORWARDING=value 1398If 1399.Em value 1400is 1 this enables IP routing behavior. 1401If 1402.Em value 1403is 0 (the default), it disables it. 1404The 1405.Em GATEWAY 1406option sets this to 1 automatically. 1407With this option enabled, the machine will forward IP datagrams destined 1408for other machines between its interfaces. 1409Note that even without this option, the kernel will 1410still forward some packets (such as source routed packets) -- removing 1411.Em GATEWAY 1412and 1413.Em IPFORWARDING 1414is insufficient to stop all routing through a bastion host on a 1415firewall -- source routing is controlled independently. 1416To turn off source routing, use 1417.Em options IPFORWSRCRT=0 1418(which see). 1419Note that IP forwarding may be turned on and off independently of the 1420setting of the 1421.Em IPFORWARDING 1422option through the use of the 1423.Em net.inet.ip.forwarding 1424sysctl variable. 1425If 1426.Em net.inet.ip.forwarding 1427is 1, IP forwarding is on. 1428See 1429.Xr sysctl 8 1430and 1431.Xr sysctl 3 1432for details. 1433.It Cd options IPFORWSRCRT=value 1434If 1435.Em value 1436is set to zero, source routing of IP datagrams is turned off. 1437If 1438.Em value 1439is set to one (the default) or the option is absent, source routed IP 1440datagrams are forwarded by the machine. 1441Note that source routing of IP packets may be turned on and off 1442independently of the setting of the 1443.Em IPFORWSRCRT 1444option through the use of the 1445.Em net.inet.ip.forwsrcrt 1446sysctl variable. 1447If 1448.Em net.inet.ip.forwsrcrt 1449is 1, forwarding of source routed IP datagrams is on. 1450See 1451.Xr sysctl 8 1452and 1453.Xr sysctl 3 1454for details. 1455.It Cd options IFA_STATS 1456Tells the kernel to maintain per-address statistics on bytes sent 1457and received over (currently) internet and appletalk addresses. 1458.\"This can be a fairly expensive operation, so you probably want to 1459.\"keep this disabled. 1460The option is not recommended as it degrades system stability. 1461.It Cd options IFQ_MAXLEN=value 1462Increases the allowed size of the network interface packet queues. 1463The default queue size is 50 packets, and you do not normally need 1464to increase it. 1465.It Cd options MROUTING 1466Includes support for IP multicast routers. 1467You certainly want 1468.Em INET 1469with this. 1470Multicast routing is controlled by the 1471.Xr mrouted 8 1472daemon. 1473.It Cd options PIM 1474Includes support for Protocol Independent Multicast (PIM) routing. 1475You need 1476.Em MROUTING 1477and 1478.Em INET 1479with this. 1480.It Cd options INET 1481Includes support for the 1482.Tn TCP/IP 1483protocol stack. 1484You almost certainly want this. 1485See 1486.Xr inet 4 1487for details. 1488.It Cd options INET6 1489Includes support for the 1490.Tn IPv6 1491protocol stack. 1492See 1493.Xr inet6 4 1494for details. 1495Unlike 1496.Em INET , 1497.Em INET6 1498enables multicast routing code as well. 1499This option requires 1500.Em INET 1501at this moment, but it should not. 1502.It Cd options ND6_DEBUG 1503The option sets the default value of net.inet6.icmp6.nd6_debug to 1, 1504for debugging IPv6 neighbor discovery protocol handling. 1505See 1506.Xr sysctl 3 1507for details. 1508.It Cd options IPSEC 1509Includes support for the 1510.Tn IPsec 1511protocol. 1512See 1513.Xr ipsec 4 1514for details. 1515.It Cd options IPSEC_DEBUG 1516Enables debugging code in 1517.Tn IPsec 1518stack. 1519See 1520.Xr ipsec 4 1521for details. 1522.It Cd options IPSEC_ESP 1523Includes support for 1524.Tn IPsec 1525.Tn ESP 1526protocol. 1527See 1528.Xr ipsec 4 1529for details. 1530.It Cd options IPSEC_NAT_T 1531Includes support for 1532.Tn IPsec 1533Network Address Translator traversal (NAT-T), as described in RFCs 3947 1534and 3948. 1535This feature might be patent-encumbered in some countries. 1536.It Cd options ALTQ 1537Enabled ALTQ (Alternate Queueing). 1538For simple rate-limiting, use 1539.Xr tbrconfig 8 1540to set up the interface transmission rate. 1541To use queueing disciplines, their appropriate kernel options should also 1542be defined (documented below). 1543Queueing disciplines are managed by 1544.Xr altqd 8 . 1545See 1546.Xr altq 9 1547for details. 1548.It Cd options ALTQ_HFSC 1549Include support for ALTQ-implemented HFSC (Hierarchical Fair Service Curve) 1550module. 1551HFSC supports both link-sharing and guaranteed real-time services. 1552HFSC employs a service curve based QoS model, and its unique feature 1553is an ability to decouple delay and bandwidth allocation. 1554Requires 1555.Em ALTQ_RED 1556to use the RED queueing discipline on HFSC classes, or 1557.Em ALTQ_RIO 1558to use the RIO queueing discipline on HFSC classes. 1559This option assumes 1560.Em ALTQ . 1561.It Cd options ALTQ_PRIQ 1562Include support for ALTQ-implemented PRIQ (Priority Queueing). 1563PRIQ implements a simple priority-based queueing discipline. 1564A higher priority class is always served first. 1565Requires 1566.Em ALTQ_RED 1567to use the RED queueing discipline on HFSC classes, or 1568.Em ALTQ_RIO 1569to use the RIO queueing discipline on HFSC classes. 1570This option assumes 1571.Em ALTQ . 1572.It Cd options ALTQ_WFQ 1573Include support for ALTQ-implemented WFQ (Weighted Fair Queueing). 1574WFQ implements a weighted-round robin scheduler for a set of queues. 1575A weight can be assigned to each queue to give a different proportion 1576of the link capacity. 1577A hash function is used to map a flow to one of a set of queues. 1578This option assumes 1579.Em ALTQ . 1580.It Cd options ALTQ_FIFOQ 1581Include support for ALTQ-implemented FIFO queueing. 1582FIFOQ is a simple drop-tail FIFO (First In, First Out) queueing discipline. 1583This option assumes 1584.Em ALTQ . 1585.It Cd options ALTQ_RIO 1586Include support for ALTQ-implemented RIO (RED with In/Out). 1587The original RIO has 2 sets of RED parameters; one for in-profile 1588packets and the other for out-of-profile packets. 1589At the ingress of the network, profile meters tag packets as IN or 1590OUT based on contracted profiles for customers. 1591Inside the network, IN packets receive preferential treatment by 1592the RIO dropper. 1593ALTQ/RIO has 3 drop precedence levels defined for the Assured Forwarding 1594PHB of DiffServ (RFC 2597). 1595This option assumes 1596.Em ALTQ . 1597.It Cd options ALTQ_BLUE 1598Include support for ALTQ-implemented Blue buffer management. 1599Blue is another active buffer management mechanism. 1600This option assumes 1601.Em ALTQ . 1602.It Cd options ALTQ_FLOWVALVE 1603Include support for ALTQ-implemented Flowvalve. 1604Flowvalve is a simple implementation of a RED penalty box that identifies 1605and punishes misbehaving flows. 1606This option requires 1607.Em ALTQ_RED 1608and assumes 1609.Em ALTQ . 1610.It Cd options ALTQ_CDNR 1611Include support for ALTQ-implemented CDNR (diffserv traffic conditioner) 1612packet marking/manipulation. 1613Traffic conditioners are components to meter, mark, or drop incoming 1614packets according to some rules. 1615As opposed to queueing disciplines, traffic conditioners handle incoming 1616packets at an input interface. 1617This option assumes 1618.Em ALTQ . 1619.It Cd options ALTQ_NOPCC 1620Disables use of processor cycle counter to measure time in ALTQ. 1621This option should be defined for a non-Pentium i386 CPU which does not 1622have TSC, SMP (per-CPU counters are not in sync), or power management 1623which affects processor cycle counter. 1624This option assumes 1625.Em ALTQ . 1626.It Cd options ALTQ_IPSEC 1627Include support for IPsec in IPv4 ALTQ. 1628This option assumes 1629.Em ALTQ . 1630.It Cd options ALTQ_JOBS 1631Undocumented at this time. 1632.It Cd options ALTQ_AFMAP 1633Include support for an undocumented ALTQ feature that is used to map an IP 1634flow to an ATM VC (Virtual Circuit). 1635This option assumes 1636.Em ALTQ . 1637.It Cd options ALTQ_LOCALQ 1638Include support for ALTQ-implemented local queues. 1639Its practical use is undefined. 1640Assumes 1641.Em ALTQ . 1642.It Cd options SUBNETSARELOCAL 1643Sets default value for net.inet.ip.subnetsarelocal variable, which 1644controls whether non-directly-connected subnets of connected networks 1645are considered "local" for purposes of choosing the MSS for a TCP 1646connection. 1647This is mostly present for historic reasons and completely irrelevant if 1648you enable Path MTU discovery. 1649.It Cd options HOSTZEROBROADCAST 1650Sets default value for net.inet.ip.hostzerobroadcast variable, which 1651controls whether the zeroth host address of each connected subnet is 1652also considered a broadcast address. 1653Default value is "1", for compatibility with old systems; if this is 1654set to zero on all hosts on a subnet, you should be able to fit an extra 1655host per subnet on the 1656".0" address. 1657.It Cd options MCLSHIFT=value 1658This option is the base-2 logarithm of the size of mbuf clusters. 1659The 1660.Bx 1661networking stack keeps network packets in a linked 1662list, or chain, of kernel buffer objects called mbufs. 1663The system provides larger mbuf clusters as an optimization for 1664large packets, instead of using long chains for large packets. 1665The mbuf cluster size, 1666or 1667.Em MCLBYTES , 1668must be a power of two, and is computed as two raised to the power 1669.Em MCLSHIFT . 1670On systems with Ethernet network adaptors, 1671.Em MCLSHIFT 1672is often set to 11, giving 2048-byte mbuf clusters, large enough to 1673hold a 1500-byte 1674.Tn Ethernet 1675frame in a single cluster. 1676Systems with network interfaces supporting larger frame sizes like 1677.Tn ATM , 1678.Tn FDDI , 1679or 1680.Tn HIPPI 1681may perform better with 1682.Em MCLSHIFT 1683set to 12 or 13, giving mbuf cluster sizes of 4096 and 8192 bytes, 1684respectively. 1685.It Cd options NS 1686Include support for the 1687.Tn Xerox 1688.Tn XNS 1689protocol stack. 1690See 1691.Xr ns 4 1692for details. 1693.It Cd options ISO,TPIP 1694Include support for the ubiquitous 1695.Tn OSI 1696protocol stack. 1697See 1698.Xr iso 4 1699for details. 1700This option assumes 1701.Em INET . 1702.It Cd options EON 1703Include support for tunneling 1704.Tn OSI 1705protocols over 1706.Tn IP . 1707Known to be broken, or at least very fragile, and undocumented. 1708.It Cd options CCITT,LLC,HDLC 1709Include support for the 1710.Tn CCITT 1711(nee 1712.Tn ITU-TSS ) 1713.Tn X.25 1714protocol stack. 1715The state of this code is currently unknown, and probably contains bugs. 1716This option assumes 1717.Em INET . 1718.It Cd options NETATALK 1719Include support for the 1720.Tn AppleTalk 1721protocol stack. 1722The kernel provides provision for the 1723.Em Datagram Delivery Protocol 1724(DDP), providing SOCK_DGRAM support and 1725.Tn AppleTalk 1726routing. 1727This stack is used by the 1728.Em NETATALK 1729package, which adds support for 1730.Tn AppleTalk 1731server services via user libraries and applications. 1732.It Cd options IPNOPRIVPORTS 1733Normally, only root can bind a socket descriptor to a so-called 1734.Dq privileged 1735.Tn TCP 1736port, that is, a port number in the range 0-1023. 1737This option eliminates those checks from the kernel. 1738This can be useful if there is a desire to allow daemons without 1739privileges to bind those ports, e.g., on firewalls. 1740The security tradeoffs in doing this are subtle. 1741This option should only be used by experts. 1742.It Cd options TCP_COMPAT_42 1743.Tn TCP 1744bug compatibility with 1745.Bx 4.2 . 1746In 1747.Bx 4.2 , 1748.Tn TCP 1749sequence numbers were 32-bit signed values. 1750Modern implementations of TCP use unsigned values. 1751This option clamps the initial sequence number to start in 1752the range 2^31 rather than the full unsigned range of 2^32. 1753Also, under 1754.Bx 4.2 , 1755keepalive packets must contain at least one byte or else 1756the remote end would not respond. 1757.It Cd options TCP_DEBUG 1758Record the last 1759.Em TCP_NDEBUG 1760TCP packets with SO_DEBUG set, and decode to the console if 1761.Em tcpconsdebug 1762is set. 1763.It Cd options TCP_NDEBUG 1764Number of packets to record for 1765.Em TCP_DEBUG . 1766Defaults to 100. 1767.It Cd options TCP_SENDSPACE=value 1768.It Cd options TCP_RECVSPACE=value 1769These options set the max TCP window size to other sizes than the default. 1770The TCP window sizes can be altered via 1771.Xr sysctl 8 1772as well. 1773.It Cd options TCP_INIT_WIN=value 1774This option sets the initial TCP window size for non-local connections, 1775which is used when the transmission starts. 1776The default size is 1, but if the machine should act more aggressively, 1777the initial size can be set to some other value. 1778The initial TCP window size can be set via 1779.Xr sysctl 8 1780as well. 1781.It Cd options PFIL_HOOKS 1782This option turns on the packet filter interface hooks. 1783See 1784.Xr pfil 9 1785for details. 1786This option assumes 1787.Em INET . 1788.It Cd options IPFILTER_LOG 1789This option, in conjunction with 1790.Em pseudo-device ipfilter , 1791enables logging of IP packets using ip-filter. 1792.It Cd options IPFILTER_DEFAULT_BLOCK 1793This option sets the default policy of ip-filter. 1794If it is set, ip-filter will block packets by default. 1795.It Cd options BRIDGE_IPF 1796This option causes 1797.Em bridge 1798devices to use the IP and/or IPv6 filtering hooks, forming 1799a link-layer filter that uses protocol-layer rules. 1800This option assumes the presence of 1801.Em pseudo-device ipfilter . 1802.It Cd options MBUFTRACE 1803This option can help track down mbuf leaks. 1804When enabled, mbufs are tagged with the devices and protocols using them, 1805which slightly decreases network performance. 1806This additional information can be viewed with 1807.Xr netstat 1 : 1808.Dl Ic netstat Fl mssv 1809Not all devices or protocols support this option. 1810.El 1811.Ss Sysctl Related Options 1812.Bl -ohang 1813.It Cd options SYSCTL_DISALLOW_CREATE 1814Disallows the creation or deletion of nodes from the sysctl tree, as 1815well as the assigning of descriptions to nodes that lack them, by any 1816process. 1817These operations are still available to kernel sub-systems, including 1818loadable kernel modules. 1819.It Cd options SYSCTL_DISALLOW_KWRITE 1820Prevents processes from adding nodes to the sysctl tree that make 1821existing kernel memory areas writeable. 1822Sections of kernel memory can still be read and new nodes that own 1823their own data may still be writeable. 1824.It Cd options SYSCTL_DEBUG_SETUP 1825Causes the SYSCTL_SETUP routines to print a brief message when they 1826are invoked. 1827This is merely meant as an aid in determining the order in which 1828sections of the tree are created. 1829.It Cd options SYSCTL_DEBUG_CREATE 1830Prints a message each time 1831.Fn sysctl_create , 1832the function that adds nodes to the tree, is called. 1833.It Cd options SYSCTL_INCLUDE_DESCR 1834Causes the kernel to include short, human readable descriptions for 1835nodes in the sysctl tree. 1836The descriptions can be retrieved programmatically (see 1837.Xr sysctl 3 ) , 1838or by the sysctl binary itself (see 1839.Xr sysctl 8 ) . 1840The descriptions are meant to give an indication of the purpose and/or 1841effects of a given node's value, not replace the documentation for the 1842given subsystem as a whole. 1843.El 1844.Ss System V IPC Options 1845.Bl -ohang 1846.It Cd options SYSVMSG 1847Includes support for 1848.At V 1849style message queues. 1850See 1851.Xr msgctl 2 , 1852.Xr msgget 2 , 1853.Xr msgrcv 2 , 1854.Xr msgsnd 2 . 1855.It Cd options SYSVSEM 1856Includes support for 1857.At V 1858style semaphores. 1859See 1860.Xr semctl 2 , 1861.Xr semget 2 , 1862.Xr semop 2 . 1863.It Cd options SEMMNI=value 1864Sets the number of 1865.At V 1866style semaphore identifiers. 1867The GENERIC config file for your port will have the default. 1868.It Cd options SEMMNS=value 1869Sets the number of 1870.At V 1871style semaphores in the system. 1872The GENERIC config file for your port will have the default. 1873.It Cd options SEMUME=value 1874Sets the maximum number of undo entries per process for 1875.At V 1876style semaphores. 1877The GENERIC config file for your port will have the default. 1878.It Cd options SEMMNU=value 1879Sets the number of undo structures in the system for 1880.At V 1881style semaphores. 1882The GENERIC config file for your port will have the default. 1883.It Cd options SYSVSHM 1884Includes support for 1885.At V 1886style shared memory. 1887See 1888.Xr shmat 2 , 1889.Xr shmctl 2 , 1890.Xr shmdt 2 , 1891.Xr shmget 2 . 1892.It Cd options SHMMAXPGS=value 1893Sets the maximum number of 1894.At V 1895style shared memory pages that are available through the 1896.Xr shmget 2 1897system call. 1898Default value is 1024 on most ports. 1899See 1900.Pa /usr/include/machine/vmparam.h 1901for the default. 1902.El 1903.Ss VM Related Options 1904.Bl -ohang 1905.It Cd options NMBCLUSTERS=value 1906The number of mbuf clusters the kernel supports. 1907Mbuf clusters are MCLBYTES in size (usually 2k). 1908This is used to compute the size of the kernel VM map 1909.Em mb_map , 1910which maps mbuf clusters. 1911Default on most ports is 1024 (2048 with 1912.Dq options GATEWAY 1913). 1914See 1915.Pa /usr/include/machine/param.h 1916for exact default information. 1917Increase this value if you get 1918.Dq mclpool limit reached 1919messages. 1920.It Cd options NKMEMPAGES=value 1921.It Cd options NKMEMPAGES_MIN=value 1922.It Cd options NKMEMPAGES_MAX=value 1923Size of kernel VM map 1924.Em kmem_map , 1925in PAGE_SIZE-sized chunks (the VM page size; this value may be read 1926from the 1927.Xr sysctl 8 1928variable 1929.Em hw.pagesize 1930). 1931This VM map is used to map the kernel malloc arena. 1932The kernel attempts to auto-size this map based on the amount of 1933physical memory in the system. 1934Platform-specific code may place bounds on this computed size, 1935which may be viewed with the 1936.Xr sysctl 8 1937variable 1938.Em vm.nkmempages . 1939See 1940.Pa /usr/include/machine/param.h 1941for the default upper and lower bounds. 1942The related options 1943.Sq NKMEMPAGES_MIN 1944and 1945.Sq NKMEMPAGES_MAX 1946allow the bounds to be overridden in the kernel configuration file. 1947These options are provided in the event the computed value is 1948insufficient resulting in an 1949.Dq out of space in kmem_map 1950panic. 1951.It Cd options SB_MAX=value 1952Sets the max size in bytes that a socket buffer is allowed to occupy. 1953The default is 256k, but sometimes it needs to be increased, for example 1954when using large TCP windows. 1955This option can be changed via 1956.Xr sysctl 8 1957as well. 1958.It Cd options SOMAXKVA=value 1959Sets the maximum size of kernel virtual memory that the socket buffers 1960are allowed to use. 1961The default is 16MB, but in situations where for example large TCP 1962windows are used this value must also be increased. 1963This option can be changed via 1964.Xr sysctl 8 1965as well. 1966.It Cd options BUFCACHE=value 1967Size of the buffer cache as a percentage of total available 1968.Tn RAM . 1969Ignored if BUFPAGES is also specified. 1970.It Cd options NBUF=value 1971Sets the number of buffer headers available, i.e., the number of 1972open files that may have a buffer cache entry. 1973Each buffer header 1974requires MAXBSIZE (machine dependent, but usually 65536) bytes. 1975The default value is machine dependent, but is usually equal to the 1976value of BUFPAGES. 1977If an architecture dependent VM_MAX_KERNEL_BUF constant is defined 1978then NBUF may be reduced at run time so that the storage allocated 1979for buffer headers doesn't exceed that limit. 1980.It Cd options BUFPAGES=value 1981These options set the number of pages available for the buffer cache. 1982Their default value is a machine dependent value, often calculated as 1983between 5% and 10% of total available 1984.Tn RAM . 1985.It Cd options MAXTSIZ=bytes 1986Sets the maximum size limit of a process' text segment. 1987See 1988.Pa /usr/include/machine/vmparam.h 1989for the port-specific default. 1990.It Cd options DFLDSIZ=bytes 1991Sets the default size limit of a process' data segment, the value that 1992will be returned as the soft limit for 1993.Dv RLIMIT_DATA 1994(as returned by 1995.Xr getrlimit 2 ) . 1996See 1997.Pa /usr/include/machine/vmparam.h 1998for the port-specific default. 1999.It Cd options MAXDSIZ=bytes 2000Sets the maximum size limit of a process' data segment, the value that 2001will be returned as the hard limit for 2002.Dv RLIMIT_DATA 2003(as returned by 2004.Xr getrlimit 2 ) . 2005See 2006.Pa /usr/include/machine/vmparam.h 2007for the port-specific default. 2008.It Cd options DFLSSIZ=bytes 2009Sets the default size limit of a process' stack segment, the value that 2010will be returned as the soft limit for 2011.Dv RLIMIT_STACK 2012(as returned by 2013.Xr getrlimit 2 ) . 2014See 2015.Pa /usr/include/machine/vmparam.h 2016for the port-specific default. 2017.It Cd options MAXSSIZ=bytes 2018Sets the maximum size limit of a process' stack segment, the value that 2019will be returned as the hard limit for 2020.Dv RLIMIT_STACK 2021(as returned by 2022.Xr getrlimit 2 ) . 2023See 2024.Pa /usr/include/machine/vmparam.h 2025for the port-specific default. 2026.It Cd options DUMP_ON_PANIC=integer 2027Defaults to one. 2028If set to zero, the kernel will not dump to the dump device when 2029it panics, though dumps can still be forced via 2030.Xr ddb 4 2031with the 2032.Dq sync 2033command. 2034Note that this sets the value of the 2035.Em kern.dump_on_panic 2036.Xr sysctl 3 2037variable which may be changed at run time -- see 2038.Xr sysctl 8 2039for details. 2040.It Cd options USE_TOPDOWN_VM 2041User space memory allocations (as made by 2042.Xr mmap 2 ) 2043will be arranged in a 2044.Dq top down 2045fashion instead of the traditional 2046.Dq upwards from MAXDSIZ \+ vm_daddr 2047method. 2048This includes the placement of 2049.Xr ld.so 1 . 2050Arranging memory in this manner allows either (or both of) the heap or 2051.Xr mmap 2 2052allocated space to grow larger than traditionally possible. 2053This option is not available on all ports, but is instead expected to be 2054offered on a port-by-port basis, after which some ports will commit to 2055using it by default. 2056See the files 2057.Pa /usr/include/uvm/uvm_param.h 2058for some implementation details, and 2059.Pa /usr/include/machine/vmparam.h 2060for port specific details including availability. 2061.El 2062.Ss amiga-specific Options 2063.Bl -ohang 2064.It Cd options BB060STUPIDROM 2065When the bootloader (which passes 2066.Tn AmigaOS 2067.Tn ROM 2068information) claims we have a 68060 2069.Tn CPU 2070without 2071.Tn FPU , 2072go look into the Processor Configuration Register (PCR) to find out. 2073You need this with 2074.Tn Amiga 2075.Tn ROM Ns s 2076up to (at least) V40.xxx (OS3.1), 2077when you boot via the bootblocks and don't have a DraCo. 2078.It Cd options IOBZCLOCK=frequency 2079The IOBlix boards come with two different serial master clocks: older ones 2080use 24 MHz, newer ones use 22.1184 MHz. 2081The driver normally assumes the latter. 2082If your board uses 24 MHz, you can recompile your kernel with 2083options IOBZCLOCK=24000000 2084or patch the kernel variable 2085.Tn iobzclock 2086to the same value. 2087.It Cd options LIMITMEM=value 2088If there, limit the part of the first memory bank used by 2089.Nx 2090to value megabytes. 2091Default is unlimited. 2092.It Cd options NKPTADD=addvalue 2093.It Cd options NKPTADDSHIFT=shiftvalue 2094The 2095.Tn CPU 2096specific 2097.Tn MMU 2098table for the kernel is pre-allocated at kernel startup time. 2099Part of it is scaled with 2100.Va maxproc , 2101to have enough room to hold the user program 2102.Tn MMU 2103tables; the second part is a fixed amount for the kernel itself. 2104.Pp 2105The third part accounts for the size of the file buffer cache. 2106Its size is either 2107.Dv NKPTADD 2108pages (if defined) or memory size in bytes divided by two to 2109the power of 2110.Dv NKPTADDSHIFT . 2111The default is undefined 2112.Dv NKPTADD 2113and 2114.Dv NKPTADDSHIFT=24 , 2115allowing for 16 buffers per megabyte of main memory (while 2116a GENERIC kernel allocates about half of that). 2117When you get "can't get KPT page" panics, you should increase 2118.Dv NKPTADD 2119(if defined), or decrease 2120.Dv NKPTADDSHIFT 2121by one. 2122.It Cd options P5PPC68KBOARD 2123Add special support for Phase5 mixed 68k+PPC boards. 2124Currently, this only affects rebooting from 2125.Nx 2126and is only needed on 68040+PPC, not on 212768060+PPC; without this, affected machines will hang after 2128.Nx 2129has shut 2130down and will only restart after a keyboard reset or a power cycle. 2131.El 2132.Ss arm32-specific Options 2133.Bl -ohang 2134.It Cd options FRENCH_KBD 2135Include translation for French keyboards when using 2136.Em pccons 2137on a Shark. 2138.It Cd options FINNISH_KBD 2139Include translation for Finnish keyboards when using 2140.Em pccons 2141on a Shark. 2142.It Cd options GERMAN_KBD 2143Include translation for German keyboards when using 2144.Em pccons 2145on a Shark. 2146.It Cd options NORWEGIAN_KBD 2147Include translation for French keyboards when using 2148.Em pccons 2149on a Shark. 2150.El 2151.Ss atari-specific Options 2152.Bl -ohang 2153.It Cd options DISKLABEL_AHDI 2154Include support for AHDI (native Atari) disklabels. 2155.It Cd options DISKLABEL_NBDA 2156Include support for 2157.Nx Ns Tn /atari 2158labels. 2159If you don't set this option, it will be set automatically. 2160.Nx Ns Tn /atari 2161will not work without it. 2162.It Cd options FALCON_SCSI 2163Include support for the 5380-SCSI configuration as found on the Falcon. 2164.It Cd options RELOC_KERNEL 2165If set, the kernel will relocate itself to TT-RAM, if possible. 2166This will give you a slightly faster system. 2167.Em Beware 2168that on some TT030 systems, 2169the system will frequently dump with MMU-faults with this option enabled. 2170.It Cd options SERCONSOLE 2171Allow the modem1-port to act as the system-console. 2172A carrier should be active on modem1 during system boot to active 2173the console functionality. 2174.It Cd options TT_SCSI 2175Include support for the 5380-SCSI configuration as found on the TT030 2176and Hades. 2177.El 2178.Ss i386-specific Options 2179.Bl -ohang 2180.It Cd options I386_CPU,I486_CPU,I586_CPU,I686_CPU 2181Include support for a particular class of 2182.Tn CPU 2183.Po 2184.Tn i386 , 2185.Tn i486 , 2186.Tn Pentium , 2187or 2188.Tn Pentium Pro 2189.Pc . 2190If the appropriate class for your 2191.Tn CPU 2192is not configured, the kernel will use the highest class available 2193that will work. 2194In general, using the correct 2195.Tn CPU 2196class will result in the best performance. 2197At least one of these options must be present. 2198.It Cd options ENHANCED_SPEEDSTEP 2199Include support for the 2200.Tn Enhanced SpeedStep Technology 2201present in newer 2202.Tn CPU Ns s . 2203.It Cd options EST_FREQ_USERWRITE 2204Allow any user to change the frequency of an 2205.Tn Enhanced SpeedStep Technology 2206capable 2207.Tn CPU . 2208.It Cd options CPURESET_DELAY=value 2209Specifies the time (in millisecond) to wait before doing a hardware reset 2210in the last phase of a reboot. 2211This gives the user a chance to see error messages from the shutdown 2212operations (like NFS unmounts, buffer cache flush, etc ...). 2213Setting this to 0 will disable the delay. 2214Default is 2 seconds. 2215.It Cd options MATH_EMULATE 2216Include the floating point emulator. 2217This is useful only for 2218.Tn CPU Ns s 2219that lack an 2220internal Floating Point Unit 2221.Pq Tn FPU 2222or co-processor. 2223.It Cd options VM86 2224Include support for virtual 8086 mode, used by 2225.Tn DOS 2226emulators and X servers to run BIOS code, e.g., for some VESA routines. 2227.It Cd options USER_LDT 2228Include i386-specific system calls for modifying the local descriptor table, 2229used by Windows emulators. 2230.It Cd options REALBASEMEM=integer 2231Overrides the base memory size passed in from the boot block. 2232(Value given in kilobytes.) 2233Use this option only if the boot block reports the size incorrectly. 2234(Note that some 2235.Tn BIOS Ns es 2236put the extended 2237.Tn BIOS 2238data area at the top of base memory, and therefore report a smaller 2239base memory size to prevent programs overwriting it. 2240This is correct behavior, and you should not use the 2241.Em REALBASEMEM 2242option to access this memory). 2243.It Cd options REALEXTMEM=integer 2244Overrides the extended memory size passed in from the boot block. 2245(Value given in kilobytes. 2246Extended memory does not include the first megabyte.) 2247Use this option only if the boot block reports the size incorrectly. 2248.It Cd options FRENCH_KBD,FINNISH_KBD,GERMAN_KBD,NORWEGIAN_KBD 2249Select a non-US keyboard layout for the 2250.Em pccons 2251console driver. 2252.It Cd options CYRIX_CACHE_WORKS 2253Relevant only to the Cyrix 486DLC CPU. 2254This option is used to turn on the cache in hold-flush mode. 2255It is not turned on by default because it is known to have problems in 2256certain motherboard implementations. 2257.It Cd options CYRIX_CACHE_REALLY_WORKS 2258Relevant only to the Cyrix 486DLC CPU. 2259This option is used to turn on the cache in write-back mode. 2260It is not turned on by default because it is known to have problems in 2261certain motherboard implementations. 2262In order for this option to take effect, option 2263.Em CYRIX_CACHE_WORKS 2264must also be specified. 2265.It Cd options PCIBIOS 2266Enable support for initializing the 2267.Tn PCI 2268bus using information from the 2269.Tn BIOS . 2270See 2271.Xr pcibios 4 2272for details. 2273.It Cd options KSTACK_CHECK_DR0 2274Detect kernel stack overflow using DR0 register. 2275This option uses DR0 register exclusively so you can't use DR0 register for 2276other purpose (e.g., hardware breakpoint) if you turn this on. 2277.It Cd options MTRR 2278Include support for accessing MTRR registers from user-space. 2279See 2280.Xr i386_get_mtrr 2 . 2281.It Cd options BEEP_ONHALT 2282Make the system speaker emit several beeps when it is completely safe to 2283power down the computer after a 2284.Xr halt 8 2285command. 2286Requires 2287.Xr sysbeep 4 2288support. 2289.It Cd options BEEP_ONHALT_COUNT=times 2290Number of times to beep the speaker when 2291.Cd options BEEP_ONHALT 2292is enabled. 2293Defaults to 3. 2294.It Cd options BEEP_ONHALT_PITCH=hz 2295The tone frequency used when 2296.Cd options BEEP_ONHALT 2297option, in hertz. 2298Defaults to 1500. 2299.It Cd options BEEP_ONHALT_PERIOD=msecs 2300The duration of each beep when 2301.Cd options BEEP_ONHALT 2302is enabled, in milliseconds. 2303Defaults to 250. 2304.El 2305.Ss isa-specific Options 2306Options specific to 2307.Xr isa 4 2308busses. 2309.Bl -ohang 2310.It Cd options PCIC_ISA_ALLOC_IOBASE=address, PCIC_ISA_ALLOC_IOSIZE=size 2311Control the section of IO bus space used for PCMCIA bus space mapping. 2312Ideally the probed defaults are satisfactory, however in practice 2313that is not always the case. 2314See 2315.Xr pcmcia 4 2316for details. 2317.It Cd options PCIC_ISA_INTR_ALLOC_MASK=mask 2318Controls the allowable interrupts that may be used for 2319.Tn PCMCIA 2320devices. 2321This mask is a logical-or of power-of-2s of allowable interrupts: 2322.Bd -literal -offset 04n 2323.Em "IRQ Val IRQ Val IRQ Val IRQ Val" 2324 0 0x0001 4 0x0010 8 0x0100 12 0x1000 2325 1 0x0002 5 0x0020 9 0x0200 13 0x2000 2326 2 0x0004 6 0x0040 10 0x0400 14 0x4000 2327 3 0x0008 7 0x0080 11 0x0800 15 0x8000 2328.Ed 2329.El 2330.Ss m68k-specific Options 2331.Bl -ohang 2332.It Cd options FPU_EMULATE 2333Include support for MC68881/MC68882 emulator. 2334.It Cd options FPSP 2335Include support for 68040 floating point. 2336.It Cd options M68020,M68030,M68040,M68060 2337Include support for a specific 2338.Tn CPU , 2339at least one (the one you are using) should be specified. 2340.It Cd options M060SP 2341Include software support for 68060. 2342This provides emulation of unimplemented 2343integer instructions as well as emulation of unimplemented floating point 2344instructions and data types and software support for floating point traps. 2345.El 2346.Ss powerpc-specific Options 2347.Bl -ohang 2348.It Cd options PMAP_MEMLIMIT=value 2349Limit the amount of memory seen by the kernel to 2350.Ar value 2351bytes (OEA only). 2352.El 2353.Ss sparc-specific Options 2354.Bl -ohang 2355.It Cd options AUDIO_DEBUG 2356Enable simple event debugging of the logging of the 2357.Xr audio 4 2358device. 2359.It Cd options BLINK 2360Enable blinking of LED. 2361Blink rate is full cycle every N seconds for 2362N \*[Lt] then current load average. 2363See 2364.Xr getloadavg 3 . 2365.\" .It Cd options COLORFONT_CACHE 2366.\" What does this do? 2367.It Cd options COUNT_SW_LEFTOVERS 2368Count how many times the sw SCSI device has left 3, 2, 1 and 0 in the 2369sw_3_leftover, sw_2_leftover, sw_1_leftover, and sw_0_leftover 2370variables accessible from 2371.Xr ddb 4 . 2372See 2373.Xr sw 4 . 2374.It Cd options DEBUG_ALIGN 2375Adds debugging messages calls when user-requested alignment fault 2376handling happens. 2377.It Cd options DEBUG_EMUL 2378Adds debugging messages calls for emulated floating point and 2379alignment fixing operations. 2380.It Cd options DEBUG_SVR4 2381Prints registers messages calls for emulated SVR4 getcontext and 2382setcontext operations. 2383See 2384.Em options COMPAT_SVR4 . 2385.It Cd options EXTREME_DEBUG 2386Adds debugging functions callable from 2387.Xr ddb 4 . 2388The debug_pagetables, test_region and print_fe_map 2389functions print information about page tables for the SUN4M 2390platforms only. 2391.It Cd options EXTREME_EXTREME_DEBUG 2392Adds extra info to 2393.Em options EXTREME_DEBUG . 2394.It Cd options FPU_CONTEXT 2395Make 2396.Em options COMPAT_SVR4 2397getcontext and setcontext include floating point registers. 2398.It Cd options MAGMA_DEBUG 2399Adds debugging messages to the 2400.Xr magma 4 2401device. 2402.It Cd options RASTERCONS_FULLSCREEN 2403Use the entire screen for the console. 2404.It Cd options RASTERCONS_SMALLFONT 2405Use the Fixed font on the console, instead of the normal font. 2406.It Cd options SUN4 2407Support sun4 class machines. 2408.It Cd options SUN4C 2409Support sun4c class machines. 2410.It Cd options SUN4M 2411Support sun4m class machines. 2412.It Cd options SUN4_MMU3L 2413.\" XXX ??? 2414Enable support for sun4 3-level MMU machines. 2415.It Cd options V9 2416Enable SPARC V9 assembler in 2417.Xr ddb 4 . 2418.El 2419.Ss sparc64-specific Options 2420.Bl -ohang 2421.It Cd options AUDIO_DEBUG 2422Enable simple event debugging of the logging of the 2423.Xr audio 4 2424device. 2425.It Cd options BLINK 2426Enable blinking of LED. 2427Blink rate is full cycle every N seconds for 2428N \*[Lt] then current load average. 2429See 2430.Xr getloadavg 3 . 2431.El 2432.Ss x68k-specific Options 2433.Bl -ohang 2434.It Cd options EXTENDED_MEMORY 2435Include support for extended memory, e.g., TS-6BE16 and 060turbo on-board. 2436.It Cd options JUPITER 2437Include support for Jupiter-X MPU accelerator 2438.It Cd options ZSCONSOLE,ZSCN_SPEED=value 2439Use the built-in serial port as the system-console. 2440Speed is specified in bps, defaults to 9600. 2441.It Cd options ITE_KERNEL_ATTR=value 2442Set the kernel message attribute for ITE. 2443Value, an integer, is a logical or of the following values: 2444.Bl -tag -width 4n -compact -offset indent 2445.It 1 2446color inversed 2447.It 2 2448underlined 2449.It 4 2450bolded 2451.El 2452.El 2453.\" The following requests should be uncommented and used where appropriate. 2454.\" .Sh FILES 2455.\" .Sh EXAMPLES 2456.Sh SEE ALSO 2457.Xr gdb 1 , 2458.Xr ktrace 1 , 2459.Xr pmc 1 , 2460.Xr quota 1 , 2461.Xr gettimeofday 2 , 2462.Xr i386_get_mtrr 2 , 2463.Xr i386_iopl 2 , 2464.Xr msgctl 2 , 2465.Xr msgget 2 , 2466.Xr msgrcv 2 , 2467.Xr msgsnd 2 , 2468.Xr ntp_adjtime 2 , 2469.Xr ntp_gettime 2 , 2470.Xr semctl 2 , 2471.Xr semget 2 , 2472.Xr semop 2 , 2473.Xr shmat 2 , 2474.Xr shmctl 2 , 2475.Xr shmdt 2 , 2476.Xr shmget 2 , 2477.Xr sysctl 3 , 2478.Xr apm 4 , 2479.Xr ddb 4 , 2480.Xr inet 4 , 2481.Xr iso 4 , 2482.Xr lkm 4 , 2483.Xr md 4 , 2484.Xr ns 4 , 2485.Xr pcibios 4 , 2486.Xr pcmcia 4 , 2487.Xr ppp 4 , 2488.Xr userconf 4 , 2489.Xr wscons 4 , 2490.Xr config 8 , 2491.Xr edquota 8 , 2492.Xr init 8 , 2493.Xr mdsetimage 8 , 2494.Xr mount_cd9660 8 , 2495.Xr mount_fdesc 8 , 2496.Xr mount_kernfs 8 , 2497.Xr mount_lfs 8 , 2498.Xr mount_mfs 8 , 2499.Xr mount_msdos 8 , 2500.Xr mount_nfs 8 , 2501.Xr mount_ntfs 8 , 2502.Xr mount_null 8 , 2503.Xr mount_portal 8 , 2504.Xr mount_procfs 8 , 2505.Xr mount_umap 8 , 2506.Xr mount_union 8 , 2507.Xr mrouted 8 , 2508.Xr newfs_lfs 8 , 2509.Xr ntpd 8 , 2510.Xr quotaon 8 , 2511.Xr rpc.rquotad 8 , 2512.Xr sysctl 8 2513.Sh HISTORY 2514The 2515.Nm 2516man page first appeared in 2517.Nx 1.3 . 2518.Sh BUGS 2519The 2520.Em EON 2521option should be a pseudo-device, and is also very fragile. 2522