Module Name: src Committed By: wiz Date: Wed Sep 13 08:24:24 UTC 2017
Modified Files: src/share/man/man4: options.4 Log Message: Remove Tn. To generate a diff of this commit: cvs rdiff -u -r1.471 -r1.472 src/share/man/man4/options.4 Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files.
Modified files: Index: src/share/man/man4/options.4 diff -u src/share/man/man4/options.4:1.471 src/share/man/man4/options.4:1.472 --- src/share/man/man4/options.4:1.471 Wed Sep 13 00:34:48 2017 +++ src/share/man/man4/options.4 Wed Sep 13 08:24:23 2017 @@ -1,4 +1,4 @@ -.\" $NetBSD: options.4,v 1.471 2017/09/13 00:34:48 mrg Exp $ +.\" $NetBSD: options.4,v 1.472 2017/09/13 08:24:23 wiz Exp $ .\" .\" Copyright (c) 1996 .\" Perry E. Metzger. All rights reserved. @@ -241,9 +241,7 @@ read/write. This functionality was replaced by .Xr i386_iopl 2 post 1.1. -On the -.Tn Atari -port, the location of the disk label was moved after 1.1. +On the Atari port, the location of the disk label was moved after 1.1. When the .Em COMPAT_11 option is set, the kernel will read (pre) 1.1 style disk labels as a @@ -381,7 +379,7 @@ and types as 32 bit, and all the associated kernel interface changes. It also enables old .Xr gpio 4 -and +and .Xr rnd 4 interfaces. .It Cd options COMPAT_60 @@ -432,18 +430,14 @@ compatibility with 32 bit Linux binaries For now this is limited to running i386 ELF Linux binaries on amd64. .It Cd options COMPAT_SUNOS On those architectures that support it, this enables binary -compatibility with -.Tn SunOS 4.1 -applications built for the same architecture. +compatibility with SunOS 4.1 applications built for the same architecture. This currently includes the sparc, sparc64 and most or all m68k ports. Note that the sparc64 requires the .Em COMPAT_NETBSD32 option for 64-bit kernels, in addition to this option. .It Cd options COMPAT_ULTRIX On those architectures that support it, this enables binary -compatibility with -.Tn ULTRIX -applications built for the same architecture. +compatibility with ULTRIX applications built for the same architecture. This currently is limited to the pmax. The functionality of this option is unknown. .It Cd options COMPAT_FREEBSD @@ -458,13 +452,9 @@ compatibility with iBCS2 or SVR3 applica This is currently limited to the i386 and vax ports. .It Cd options COMPAT_OSF1 On those architectures that support it, this enables binary -compatibility with -.Tn Digital +compatibility with Digital .Ux -.Po -formerly -.Tn OSF/1 -.Pc +(formerly OSF/1) applications built for the same architecture. This is currently limited to the alpha port. .It Cd options COMPAT_NOMID @@ -490,10 +480,10 @@ This is currently limited to the sparc64 .It Cd options COMPAT_AOUT_M68K On m68k architectures which have switched to ELF, this enables binary compatibility with -.Nx Ns Tn /m68k +.Nx Ns /m68k .Xr a.out 5 executables on -.Nx Ns Tn /m68k +.Nx Ns /m68k ELF kernels. This handles alignment incompatibility of m68k ABI between a.out and ELF which causes the structure padding differences. @@ -828,37 +818,26 @@ See .Xr mount_mfs 8 for details. .It Cd file-system NFS -Include the client side of the Network File System -.Pq Tn NFS +Include the client side of the Network File System (NFS) remote file sharing protocol. -Although the bulk of the code implementing -.Tn NFS +Although the bulk of the code implementing NFS is kernel based, several user level daemons are needed for it to work. See .Xr mount_nfs 8 for details. .It Cd file-system CD9660 -Includes code for the -.Tn ISO -9660 + Rock Ridge file system, which is the standard file system on many -.Tn CD-ROM -discs. -Useful primarily if you have a -.Tn CD-ROM -drive. +Includes code for the ISO 9660 + Rock Ridge file system, which is +the standard file system on many CD-ROM discs. +Useful primarily if you have a CD-ROM drive. See .Xr mount_cd9660 8 for details. .It Cd file-system MSDOSFS -Includes the -.Tn MS-DOS -FAT file system, which is reportedly still used +Includes the MS-DOS FAT file system, which is reportedly still used by unfortunate people who have not heard about .Nx . -Also implements the -.Tn Windows 95 -extensions to the same, which permit the use of longer, mixed case -file names. +Also implements the Windows 95 extensions to the same, which permit +the use of longer, mixed case file names. See .Xr mount_msdos 8 and @@ -866,9 +845,7 @@ and for details. .It Cd file-system NTFS .Bq Em EXPERIMENTAL -Includes code for the -.Tn Microsoft Windows NT -file system. +Includes code for the Microsoft Windows NT file system. See .Xr mount_ntfs 8 for details. @@ -957,9 +934,9 @@ for details. Includes code for the union file system, which permits directories to be mounted on top of each other in such a way that both file systems remain visible -- this permits tricks like allowing writing (and the -deleting of files) on a read-only file system like a -.Tn CD-ROM -by mounting a local writable file system on top of the read-only file system. +deleting of files) on a read-only file system like a CD-ROM by +mounting a local writable file system on top of the read-only file +system. See .Xr mount_union 8 for details. @@ -1292,31 +1269,26 @@ Support cpu microcode loading via .It Cd options MEMORY_DISK_DYNAMIC This option makes the .Xr md 4 -.Tn RAM -disk size dynamically sized. +RAM disk size dynamically sized. It is incompatible with .Xr mdsetimage 8 . .It Cd options MEMORY_DISK_HOOKS This option allows for some machine dependent functions to be called when the .Xr md 4 -.Tn RAM -disk driver is configured. -This can result in automatically loading a -.Tn RAM -disk from floppy on open (among other things). +RAM disk driver is configured. +This can result in automatically loading a RAM disk from floppy on +open (among other things). .It Cd options MEMORY_DISK_IS_ROOT Forces the .Xr md 4 -.Tn RAM -disk to be the root device. +RAM disk to be the root device. This can only be overridden when the kernel is booted in the 'ask-for-root' mode. .It Cd options MEMORY_DISK_ROOT_SIZE=integer Allocates the given number of 512 byte blocks as memory for the .Xr md 4 -.Tn RAM -disk, to be populated with +RAM disk, to be populated with .Xr mdsetimage 8 . .It Cd options MEMORY_DISK_SERVER=0 Do not include the interface to a userland memory disk server process. @@ -1368,13 +1340,10 @@ See .Pa sys/kern/subr_spldebug.c . .It Cd options TFTPROOT Download the root memory disk through TFTP at root mount time. -This enables the use of a root -.Tn RAM -disk without requiring it to be embedded in the kernel using +This enables the use of a root RAM disk without requiring it to be +embedded in the kernel using .Xr mdsetimage 8 . -The -.Tn RAM -disk name is obtained using DHCP's filename parameter. +The RAM disk name is obtained using DHCP's filename parameter. This option requires .Em MEMORY_DISK_HOOKS , .Em MEMORY_DISK_DYNAMIC , @@ -1447,11 +1416,7 @@ to account for it. Using .Em PPS usually requires a gadget box -to convert from -.Tn TTL -to -.Tn RS-232 -signal levels. +to convert from TTL to RS-232 signal levels. The gadget box and PPS are described in more detail in the HTML documentation for .Xr ntpd 8 @@ -1682,8 +1647,7 @@ Useful for systems where the cycle count .It Cd options XSERVER_DDB A supplement to XSERVER that adds support for entering .Xr ddb 4 -while in -.Tn X11 . +while in X11. .It Cd options FILEASSOC Support for .Xr fileassoc 9 . @@ -1712,10 +1676,7 @@ is used to indicate that a system should is not invoked directly. (Note that .Em GATEWAY -has no impact on protocols other than -.Tn IP , -such as -.Tn CLNP ) . +has no impact on protocols other than IP, such as CLNP). .Em GATEWAY option also compiles IPv4 and IPv6 fast forwarding code into the kernel. .It Cd options ICMPPRINTFS @@ -1817,17 +1778,13 @@ with this. Software using this can be found e.g. in .Pa pkgsrc/net/xorp . .It Cd options INET -Includes support for the -.Tn TCP/IP -protocol stack. +Includes support for the TCP/IP protocol stack. You almost certainly want this. See .Xr inet 4 for details. .It Cd options INET6 -Includes support for the -.Tn IPv6 -protocol stack. +Includes support for the IPv6 protocol stack. See .Xr inet6 4 for details. @@ -1845,9 +1802,7 @@ See .Xr sysctl 3 for details. .It Cd options IPSEC -Includes support for the -.Tn IPsec -protocol, using the implementation derived from +Includes support for the IPsec protocol, using the implementation derived from .Ox , relying on .Xr opencrypto 9 @@ -1856,18 +1811,14 @@ See .Xr fast_ipsec 4 for details. .It Cd options IPSEC_DEBUG -Enables debugging code in -.Tn IPsec -stack. +Enables debugging code in IPsec stack. See .Xr ipsec 4 for details. The .Cd IPSEC -option includes support for -.Tn IPsec -Network Address Translator traversal (NAT-T), as described in RFCs 3947 -and 3948. +option includes support for IPsec Network Address Translator traversal +(NAT-T), as described in RFCs 3947 and 3948. This feature might be patent-encumbered in some countries. .It Cd options ALTQ Enabled ALTQ (Alternate Queueing). @@ -2009,44 +1960,30 @@ must be a power of two, and is computed On systems with Ethernet network adapters, .Em MCLSHIFT is often set to 11, giving 2048-byte mbuf clusters, large enough to -hold a 1500-byte -.Tn Ethernet -frame in a single cluster. +hold a 1500-byte Ethernet frame in a single cluster. Systems with network interfaces supporting larger frame sizes like -.Tn ATM , -.Tn FDDI , -or -.Tn HIPPI -may perform better with +ATM, FDDI, or HIPPI may perform better with .Em MCLSHIFT set to 12 or 13, giving mbuf cluster sizes of 4096 and 8192 bytes, respectively. .It Cd options NETATALK -Include support for the -.Tn AppleTalk -protocol stack. +Include support for the AppleTalk protocol stack. The kernel provides provision for the .Em Datagram Delivery Protocol -(DDP), providing SOCK_DGRAM support and -.Tn AppleTalk -routing. +(DDP), providing SOCK_DGRAM support and AppleTalk routing. This stack is used by the .Em NETATALK -package, which adds support for -.Tn AppleTalk -server services via user libraries and applications. +package, which adds support for AppleTalk server services via user +libraries and applications. .It Cd options BLUETOOTH -Include support for the -.Tn Bluetooth -protocol stack. +Include support for the Bluetooth protocol stack. See .Xr bluetooth 4 for details. .It Cd options IPNOPRIVPORTS Normally, only root can bind a socket descriptor to a so-called .Dq privileged -.Tn TCP -port, that is, a port number in the range 0-1023. +TCP port, that is, a port number in the range 0-1023. This option eliminates those checks from the kernel. This can be useful if there is a desire to allow daemons without privileges to bind those ports, e.g., on firewalls. @@ -2264,8 +2201,7 @@ This option can be changed via .Xr sysctl 8 as well. .It Cd options BUFCACHE=value -Size of the buffer cache as a percentage of total available -.Tn RAM . +Size of the buffer cache as a percentage of total available RAM. Ignored if BUFPAGES is also specified. .It Cd options NBUF=value Sets the number of buffer headers available, i.e., the number of @@ -2277,8 +2213,7 @@ value of BUFPAGES. .It Cd options BUFPAGES=value These options set the number of pages available for the buffer cache. Their default value is a machine dependent value, often calculated as -between 5% and 10% of total available -.Tn RAM . +between 5% and 10% of total available RAM. .It Cd options MAXTSIZ=bytes Sets the maximum size limit of a process' text segment. See @@ -2467,18 +2402,10 @@ The flag can be changed at runtime by .Ss amiga-specific Options .Bl -ohang .It Cd options BB060STUPIDROM -When the bootloader (which passes -.Tn AmigaOS -.Tn ROM -information) claims we have a 68060 -.Tn CPU -without -.Tn FPU , -go look into the Processor Configuration Register (PCR) to find out. -You need this with -.Tn Amiga -.Tn ROM Ns s -up to (at least) V40.xxx (OS3.1), +When the bootloader (which passes AmigaOS ROM information) claims +we have a 68060 CPU without FPU, go look into the Processor +Configuration Register (PCR) to find out. +You need this with Amiga ROMs up to (at least) V40.xxx (OS3.1), when you boot via the bootblocks and don't have a DraCo. .It Cd options IOBZCLOCK=frequency The IOBlix boards come with two different serial master clocks: older ones @@ -2486,9 +2413,7 @@ use 24 MHz, newer ones use 22.1184 MHz. The driver normally assumes the latter. If your board uses 24 MHz, you can recompile your kernel with options IOBZCLOCK=24000000 -or patch the kernel variable -.Tn iobzclock -to the same value. +or patch the kernel variable iobzclock to the same value. .It Cd options LIMITMEM=value If there, limit the part of the first memory bank used by .Nx @@ -2510,10 +2435,10 @@ down and will only restart after a keybo Include support for AHDI (native Atari) disklabels. .It Cd options DISKLABEL_NBDA Include support for -.Nx Ns Tn /atari +.Nx Ns /atari labels. If you don't set this option, it will be set automatically. -.Nx Ns Tn /atari +.Nx Ns /atari will not work without it. .It Cd options FALCON_SCSI Include support for the 5380-SCSI configuration as found on the Falcon. @@ -2544,27 +2469,19 @@ Default is 2 seconds. Include i386-specific system calls for modifying the local descriptor table, used by Windows emulators. .It Cd options PAE -Enable -.Tn PAE (Physical Address Extension) -mode. -.Tn PAE -permits up to 36 bits physical addressing (64GB of physical memory), and -turns physical addresses to 64 bits entities in the memory management -subsystem. +Enable PAE (Physical Address Extension) mode. +PAE permits up to 36 bits physical addressing (64GB of physical +memory), and turns physical addresses to 64 bits entities in the +memory management subsystem. Userland virtual address space remains at 32 bits (4GB). -.Tn PAE -mode is required to enable the -.Tn NX/XD (No-eXecute/eXecute Disable) +PAE mode is required to enable the NX/XD (No-eXecute/eXecute Disable) bit for pages, which allows marking certain ones as not being executable. Any attempt to execute code from such a page will raise an exception. .It Cd options REALBASEMEM=integer Overrides the base memory size passed in from the boot block. (Value given in kilobytes.) Use this option only if the boot block reports the size incorrectly. -(Note that some -.Tn BIOS Ns es -put the extended -.Tn BIOS +(Note that some BIOSes put the extended BIOS data area at the top of base memory, and therefore report a smaller base memory size to prevent programs overwriting it. This is correct behavior, and you should not use the @@ -2589,10 +2506,8 @@ In order for this option to take effect, .Em CYRIX_CACHE_WORKS must also be specified. .It Cd options PCIBIOS -Enable support for initializing the -.Tn PCI -bus using information from the -.Tn BIOS . +Enable support for initializing the PCI bus using information from +the BIOS. See .Xr pcibios 4 for details. @@ -2649,8 +2564,7 @@ See .Xr pcmcia 4 for details. .It Cd options PCIC_ISA_INTR_ALLOC_MASK=mask -Controls the allowable interrupts that may be used for -.Tn PCMCIA +Controls the allowable interrupts that may be used for PCMCIA devices. This mask is a logical-or of power-of-2s of allowable interrupts: .Bd -literal -offset 04n @@ -2681,8 +2595,7 @@ Include support for MC68881/MC68882 emul .It Cd options FPSP Include support for 68040 floating point. .It Cd options M68020,M68030,M68040,M68060 -Include support for a specific -.Tn CPU , +Include support for a specific CPU, at least one (the one you are using) should be specified. .It Cd options M060SP Include software support for 68060.