From aa52a5a900bdec01cd64392151f45ae2b913614b Mon Sep 17 00:00:00 2001 From: ru Date: Wed, 16 Jun 2004 08:33:57 +0000 Subject: Assorted markup, spelling, and grammar fixes. --- share/man/man4/acpi.4 | 6 +-- share/man/man4/aha.4 | 6 +-- share/man/man4/ata.4 | 9 ++-- share/man/man4/awi.4 | 2 +- share/man/man4/bpf.4 | 2 +- share/man/man4/bridge.4 | 8 +++- share/man/man4/ddb.4 | 18 ++++---- share/man/man4/gre.4 | 2 +- share/man/man4/inet.4 | 6 +-- share/man/man4/ip.4 | 10 ++-- share/man/man4/kame.4 | 6 +-- share/man/man4/kue.4 | 2 +- share/man/man4/mac_portacl.4 | 6 +-- share/man/man4/man4.i386/cx.4 | 12 +++-- share/man/man4/mpt.4 | 2 +- share/man/man4/ng_one2many.4 | 14 +++--- share/man/man4/ng_rfc1490.4 | 25 +++++----- share/man/man4/pcm.4 | 86 ++++++++++++++++++++-------------- share/man/man4/random.4 | 4 +- share/man/man4/sbp.4 | 4 +- share/man/man4/smb.4 | 26 +++++------ share/man/man4/smp.4 | 2 +- share/man/man4/syscons.4 | 15 ++++-- share/man/man4/tcp.4 | 10 ++-- share/man/man4/umass.4 | 18 ++++---- share/man/man4/wlan.4 | 19 ++++---- share/man/man5/config.5 | 5 +- share/man/man5/devfs.5 | 3 +- share/man/man5/hosts.lpd.5 | 4 +- share/man/man5/libmap.conf.5 | 18 ++++---- share/man/man5/make.conf.5 | 16 +++++-- share/man/man5/periodic.conf.5 | 20 +++++--- share/man/man5/rc.conf.5 | 92 ++++++++++++++++++++----------------- share/man/man5/remote.5 | 4 +- share/man/man5/resolver.5 | 27 ++++++----- share/man/man7/build.7 | 2 +- share/man/man7/firewall.7 | 4 +- share/man/man7/hier.7 | 42 ++++++++--------- share/man/man8/diskless.8 | 9 ++-- share/man/man9/DEVICE_IDENTIFY.9 | 2 +- share/man/man9/VOP_GETPAGES.9 | 4 +- share/man/man9/accept_filter.9 | 26 +++++------ share/man/man9/buf.9 | 6 +-- share/man/man9/bus_alloc_resource.9 | 2 +- share/man/man9/cd.9 | 10 ++-- share/man/man9/copy.9 | 18 +++----- share/man/man9/device_add_child.9 | 4 +- share/man/man9/mac.9 | 2 +- share/man/man9/mutex.9 | 4 +- share/man/man9/pfil.9 | 67 +++++++++++++++++++-------- share/man/man9/style.9 | 19 ++++---- share/man/man9/sx.9 | 4 +- share/man/man9/taskqueue.9 | 3 +- share/man/man9/time.9 | 6 +-- share/man/man9/timeout.9 | 10 ++-- share/man/man9/vm_page_alloc.9 | 1 + share/man/man9/vslock.9 | 1 + 57 files changed, 426 insertions(+), 329 deletions(-) (limited to 'share') diff --git a/share/man/man4/acpi.4 b/share/man/man4/acpi.4 index 003eb57..575a975 100644 --- a/share/man/man4/acpi.4 +++ b/share/man/man4/acpi.4 @@ -250,7 +250,7 @@ except that the ACPI namespace will still be scanned. .It Li button .Pq Vt device -Supports ACPI button devices (typically power and sleep buttons.) +Supports ACPI button devices (typically power and sleep buttons). .It Li cmbat .Pq Vt device Control-method batteries device. @@ -271,7 +271,7 @@ Supports an ACPI laptop lid switch, which typically puts a system to sleep. .It Li quirks .Pq Vt feature -Don't honor quirks. +Do not honor quirks. Quirks automatically disable ACPI functionality based on the XSDT table's OEM vendor name and revision date. .It Li pci @@ -374,7 +374,7 @@ must be set to 1. .It Va hw.acpi.cpu.cx_supported List of supported CPU idle states and their transition latency in microseconds. -Each state has a type (e.g., C2.) +Each state has a type (e.g., C2). C1 is equivalent to the ia32 HLT instruction, C2 provides a deeper sleep with the same semantics, and C3 provides the deepest sleep but additionally requires bus mastering to be disabled. diff --git a/share/man/man4/aha.4 b/share/man/man4/aha.4 index 0371e1f..d44c75d 100644 --- a/share/man/man4/aha.4 +++ b/share/man/man4/aha.4 @@ -57,7 +57,7 @@ driver. .Pp One device hint entry for every card to be attached by the system is required. -Specific values for the port address, irq, and drq may be specified. +Specific values for the port address, IRQ, and DRQ may be specified. If wildcard values are used, the driver will query the device for its current settings and use those. If the port address @@ -67,7 +67,7 @@ The possible port addresses for this card are 0x330, 0x334, 0x230, 0x234, 0x130, and 0x134. .Pp -The AHA-1640 is a MCA bus card. +The AHA-1640 is an MCA bus card. Since the MCA bus is a self-identifying bus, no setting of hints is required. .Sh BUGS @@ -81,7 +81,7 @@ The AHA-154xCP is a plug and play controller. However, its resources are set using the on-board BIOS and cannot be moved. Failures to attached for this card are often caused when the resources -set in the BIOS conflict +set in the BIOS conflict. .Sh SEE ALSO .Xr ahb 4 , .Xr ahc 4 , diff --git a/share/man/man4/ata.4 b/share/man/man4/ata.4 index 281e998..c714511 100644 --- a/share/man/man4/ata.4 +++ b/share/man/man4/ata.4 @@ -97,7 +97,7 @@ The .Nm driver provides access to ATA (IDE) and SerialATA disk drives, ATAPI CDROM/DVD drives, ZIP/LS120 ATAPI drives and ATAPI tape drives -connected to controllers according to the ATA/ATAPI standards. +connected to controllers according to the ATA/ATAPI standards. .Pp The currently supported ATA/SATA controller chips are: .Pp @@ -134,7 +134,7 @@ SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630, SIS630S, SIS633, SIS635, SIS730 VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686, VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237. .El .Pp -Unknown ATA chipsets are supported in PIO modes, and if the standard +Unknown ATA chipsets are supported in PIO modes, and if the standard busmaster DMA registers are present and contain valid setup, DMA is also enabled, although the max mode is limitted to UDMA33, as it is not known what the chipset can do and how to program it. @@ -147,7 +147,7 @@ See .Xr atacontrol 8 . .Pp The -.nm +.Nm driver sets the maximum transfer mode supported by the hardware as default. However the .Nm @@ -158,7 +158,7 @@ the .Nm driver has detected that the required 80 conductor cable is not present or could not be detected properly, -or that one of the devices on the channel only accepts up +or that one of the devices on the channel only accepts up to UDMA2/ATA33. .Pp ATAPI devices are set to PIO mode by default because severe DMA problems are @@ -205,7 +205,6 @@ even when not present. This is useful in hotswap senarios where disks should always show up as the same numbered device, and not depend on attach order. -.Pp .Sh SEE ALSO .Xr atacontrol 8 , .Xr burncd 8 diff --git a/share/man/man4/awi.4 b/share/man/man4/awi.4 index 1dd2fb8..3e5036b 100644 --- a/share/man/man4/awi.4 +++ b/share/man/man4/awi.4 @@ -113,8 +113,8 @@ The device failed to complete the request from the system. .El .Sh SEE ALSO .Xr arp 4 , -.Xr cnw 4 , .Xr card 4 , +.Xr cnw 4 , .Xr miibus 4 , .Xr netintro 4 , .Xr pccard 4 , diff --git a/share/man/man4/bpf.4 b/share/man/man4/bpf.4 index 2bb89c5..b9a3d33 100644 --- a/share/man/man4/bpf.4 +++ b/share/man/man4/bpf.4 @@ -711,7 +711,7 @@ struct bpf_insn insns[] = { .Xr ioctl 2 , .Xr byteorder 3 , .Xr ng_bpf 4 , -.Xr bpf 9 . +.Xr bpf 9 .Rs .%A McCanne, S. .%A Jacobson V. diff --git a/share/man/man4/bridge.4 b/share/man/man4/bridge.4 index 37b8e1b..1098f2e 100644 --- a/share/man/man4/bridge.4 +++ b/share/man/man4/bridge.4 @@ -121,7 +121,9 @@ section for more examples. The list of interfaces is rescanned every time the list is modified, bridging is enabled, or new interfaces are created or destroyed. -An explicit request to refresh the bridge configuration can also +An explicit request to refresh the +.Nm +configuration can also be done by writing any value to .Va net.link.ether.bridge.refresh . Interfaces that are in the list but cannot be used @@ -139,7 +141,9 @@ Also, bridging is not compatible with interfaces which use hardware loopback, because there is no way to tell locally generated packets from externally generated ones. .Sh EXAMPLES -A simple bridge configuration with three interfaces in the same +A simple +.Nm +configuration with three interfaces in the same cluster can be set as follows. No cluster-ID is specified here, which will cause the interfaces to appear as part of cluster #1. diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4 index 1e2c6ac..58ed5c7 100644 --- a/share/man/man4/ddb.4 +++ b/share/man/man4/ddb.4 @@ -132,7 +132,7 @@ variable, it displays and waits for a response. The valid responses for it are: .Pp -.Bl -tag -compact -width SPC +.Bl -tag -compact -width ".Li SPC" .It Li SPC one more page .It Li RET @@ -196,19 +196,19 @@ display as an instruction .It Li I display as an instruction with possible alternate formats depending on the machine: -.Bl -tag -width powerpc -compact +.Bl -tag -width ".Tn powerpc" -compact .It Tn alpha Show the registers of the instruction. .It Tn amd64 -No alternate format +No alternate format. .It Tn i386 -No alternate format +No alternate format. .It Tn ia64 -No alternate format +No alternate format. .It Tn powerpc -No alternate format +No alternate format. .It Tn sparc64 -No alternate format +No alternate format. .El .El .It Cm xf @@ -513,7 +513,7 @@ modifier to indicate user register (e.g., .Li $eax:u ) . .Pp Built-in variables currently supported are: -.Bl -tag -width tabstops -compact +.Bl -tag -width ".Li tabstops" -compact .It Li radix Input and output radix .It Li maxoff @@ -541,7 +541,7 @@ and unary Special rules in .Nm are: -.Bl -tag -width Identifiers +.Bl -tag -width ".Em Identifiers" .It Em Identifiers The name of a symbol is translated to the value of the symbol, which is the address of the corresponding object. diff --git a/share/man/man4/gre.4 b/share/man/man4/gre.4 index e8c903b..d45b903 100644 --- a/share/man/man4/gre.4 +++ b/share/man/man4/gre.4 @@ -75,7 +75,7 @@ GRE mode is also the default tunnel mode on Cisco routers. This is also the default mode of operation of the .Nm interfaces. -As part of the GRE mode +As part of the GRE mode, .Nm also supports Cisco WCCP protocol, both version 1 and version 2. Since there is no reliable way to distinguish between WCCP versions, it diff --git a/share/man/man4/inet.4 b/share/man/man4/inet.4 index cff0783..b922bf9 100644 --- a/share/man/man4/inet.4 +++ b/share/man/man4/inet.4 @@ -58,12 +58,12 @@ interface provides access to the protocol. .Sh ADDRESSING Internet addresses are four byte quantities, stored in -network standard format (on little endian machines, such as the +network standard format (on little endian machines, such as the .Tn alpha , .Tn amd64 , -.Tn i386 +.Tn i386 and -.Tn ia64 +.Tn ia64 these are word and byte reversed). The include file .In netinet/in.h diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4 index 575725f..1c17866 100644 --- a/share/man/man4/ip.4 +++ b/share/man/man4/ip.4 @@ -326,9 +326,9 @@ consequences that the administrator should carefully evaluate before modifying these settings. .Pp Ports are allocated at random within the specified port range in order -to increase the difficulty of random spoofing attacks. In scenarios -such as benchmarking, this behavior may be undesireable. In these -cases, +to increase the difficulty of random spoofing attacks. +In scenarios such as benchmarking, this behavior may be undesireable. +In these cases, .Va net.inet.ip.portrange.randomized can be used to toggle randomization off. .Ss "Multicast Options" @@ -431,7 +431,7 @@ struct ip_mreq { } .Ed .Pp -.Dv imr_interface +.Va imr_interface should be set to .Dv INADDR_ANY to choose the default multicast interface, @@ -442,7 +442,7 @@ the host is multihomed. Since .Fx 4.4 , if the -.Dv imr_interface +.Va imr_interface member is within the network range .Li 0.0.0.0/8 , it is treated as an interface index in the system interface MIB, diff --git a/share/man/man4/kame.4 b/share/man/man4/kame.4 index a0284f4..a9d57c3 100644 --- a/share/man/man4/kame.4 +++ b/share/man/man4/kame.4 @@ -80,8 +80,8 @@ See below for conformance to standards and/or internet drafts. .Xr mchat 1 .Pq - , .Xr ifmcstat 8 , -.Xr pim6dd 8 [ /usr/ports/net/pim6dd ] , -.Xr pim6sd 8 [ /usr/ports/net/pim6sd ] , +.Xr pim6dd 8 Pq Pa ports/net/pim6dd , +.Xr pim6sd 8 Pq Pa ports/net/pim6sd , .Xr pim6stat 8 . .\" .Ss Transition Tools @@ -96,7 +96,7 @@ is not yet integrated into .\" .Ss IPsec and tunnelling .Xr ipsec 4 , -.Xr racoon 8 [ /usr/ports/security/racoon ] , +.Xr racoon 8 Pq Pa ports/security/racoon , .Xr setkey 8 . .Pp Dozen of existing tools are modified for IPsec support, like diff --git a/share/man/man4/kue.4 b/share/man/man4/kue.4 index ec34399..c9d09e8 100644 --- a/share/man/man4/kue.4 +++ b/share/man/man4/kue.4 @@ -47,7 +47,7 @@ The driver provides support for USB ethernet adapters based on the Kawasaki LSI KL5KLUSB101B chipset, including the following: .Pp -.Bl -bullet +.Bl -bullet -compact .It 3Com 3c19250 .It diff --git a/share/man/man4/mac_portacl.4 b/share/man/man4/mac_portacl.4 index 4abb0cf..250eb2d 100644 --- a/share/man/man4/mac_portacl.4 +++ b/share/man/man4/mac_portacl.4 @@ -96,12 +96,12 @@ these are automatically selected by the IP stack. .Pp When .Nm -is enabled it will control binding access to ports up to the port +is enabled, it will control binding access to ports up to the port number set in the .Va security.mac.portacl.port_high .Xr sysctl 8 variable. -By default all attempts to bind to +By default, all attempts to bind to .Nm controlled ports will fail if not explicitly allowed by the port access control list, though binding by the superuser will be allowed, @@ -198,7 +198,7 @@ entry will not function port). .El .It Va security.mac.portacl.suser_exempt -Allow superuser (i.e. root) to bind to all +Allow superuser (i.e., root) to bind to all .Nm protected ports, even if the port access control list does not explicitly allow this. diff --git a/share/man/man4/man4.i386/cx.4 b/share/man/man4/man4.i386/cx.4 index 6cf1474..c880990 100644 --- a/share/man/man4/man4.i386/cx.4 +++ b/share/man/man4/man4.i386/cx.4 @@ -38,9 +38,11 @@ The .Nm driver needs either .Xr sppp 4 -or +or .Xr netgraph 4 . -Which one to use is determined by the NETGRAPH_CRONYX option. +Which one to use is determined by the +.Dv NETGRAPH_CRONYX +option. If this option is present in your kernel configuration file, the .Nm driver will be compiled with @@ -80,9 +82,9 @@ for information about the .Nm adapter configuration. .Sh SEE ALSO -.Xr sppp 4 , -.Xr ifconfig 8 , -.Xr sconfig 8 , +.Xr sppp 4 , +.Xr ifconfig 8 , +.Xr sconfig 8 , .Xr spppcontrol 8 .Sh HISTORY The diff --git a/share/man/man4/mpt.4 b/share/man/man4/mpt.4 index 0ee6fd2..2e5cb57 100644 --- a/share/man/man4/mpt.4 +++ b/share/man/man4/mpt.4 @@ -34,7 +34,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd 07 November, 2003 +.Dd November 7, 2003 .Dt MPT 4 .Os .Sh NAME diff --git a/share/man/man4/ng_one2many.4 b/share/man/man4/ng_one2many.4 index b340441..2bdcd56 100644 --- a/share/man/man4/ng_one2many.4 +++ b/share/man/man4/ng_one2many.4 @@ -76,12 +76,12 @@ Before an interface or link can be plumbed into a group, its status must be marked as being .Dq up . This is normally setup during the initial boot stages by -.Xr rc.conf 5 . -It is also possible to change an interfaces status to -.Dq up +.Xr rc.conf 5 . +It is also possible to change an interface's status to +.Dq up by using the .Xr ifconfig 8 -utility. +utility. .Sh TRANSMIT ALGORITHMS .Bl -tag -width foo .It NG_ONE2MANY_XMIT_ROUNDROBIN @@ -125,7 +125,7 @@ following: Sets the node configuration using a .Dv "struct ng_one2many_link_config" as the control message argument: -.Bd -literal -offset 0n +.Bd -literal /* Node configuration structure */ struct ng_one2many_config { u_int32_t xmitAlg; /* how to distribute packets */ @@ -155,7 +155,7 @@ returns a containing statistics for the corresponding .Dv many link, which may or may not be currently connected: -.Bd -literal -offset 0n +.Bd -literal /* Statistics structure (one for each link) */ struct ng_one2many_link_stats { u_int64_t recvOctets; /* total octets rec'd on link */ @@ -189,7 +189,7 @@ corresponding to networking interfaces .Dv fxp0 through .Dv fxp3 : -.Bd -literal -offset 0n +.Bd -literal # Plumb nodes together ngctl mkpeer fxp0: one2many upper one diff --git a/share/man/man4/ng_rfc1490.4 b/share/man/man4/ng_rfc1490.4 index 52a7099..bcba26d 100644 --- a/share/man/man4/ng_rfc1490.4 +++ b/share/man/man4/ng_rfc1490.4 @@ -53,16 +53,18 @@ DLCI channels. .Pp The .Dv downstream -hook is used to transmit and receive encapsulated frames. On the other -side of the node, the +hook is used to transmit and receive encapsulated frames. +On the other side of the node, the .Dv inet and .Dv ppp hooks are used to transmit and receive raw IP frames and PPP frames, -respectively. PPP frames are transmitted and received according to +respectively. +PPP frames are transmitted and received according to RFC 1973; in particular, frames appearing on the .Dv ppp -hook begin with the PPP protocol number. The +hook begin with the PPP protocol number. +The .Dv ethernet hook can be used to transmit and receive Ethernet frames (without a checksum) in RFC 1490's bridging format. @@ -89,18 +91,18 @@ Transmits and receives PPP frames. .El .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: -.Bl -tag -width foo +.Bl -tag -width indent .It Dv NGM_RFC1490_SETENCAP This command sets encapsulation method for the node. The desired method must be passed as a string message argument, and must be one of the following supported encapsulation modes: -.Bl -tag -.It Qq ietf-ip +.Bl -tag -width ".Qq Li ietf-snap" +.It Qq Li ietf-ip IP packets are sent using simple RFC1490/2427 encapsulation. -.It Qq ietf-snap +.It Qq Li ietf-snap IP packets are sent inside SNAP frames. Also conforms to RFC1490/2427. -.It Qq cisco +.It Qq Li cisco IP packets are sent and received using proprietary Cisco encapsulation method. .El @@ -129,9 +131,8 @@ Not all of RFC 1490 is implemented. .%T "PPP in Frame Relay" .%O RFC 1973 .Re -.Rs -http://www.cisco.com/warp/public/121/frf8modes.pdf -.Re +.Pp +.Pa http://www.cisco.com/warp/public/121/frf8modes.pdf .Sh HISTORY The .Nm diff --git a/share/man/man4/pcm.4 b/share/man/man4/pcm.4 index 3179aca..718d8c4 100644 --- a/share/man/man4/pcm.4 +++ b/share/man/man4/pcm.4 @@ -31,7 +31,9 @@ .Sh NAME .Nm pcm , .Nm snd -.Nd FreeBSD PCM audio device infrastructure +.Nd +.Fx +PCM audio device infrastructure .Sh SYNOPSIS For a card with bridge driver support, and a PnP card: .Cd "device pcm" @@ -106,33 +108,37 @@ in .Ss Boot Variables In general, the module .Pa snd_foo -corresponds to device foo and can be -loaded by the boot loader via -.Pa boot/loader.conf +corresponds to +.Cd "device foo" +and can be +loaded by the boot +.Xr loader 8 +via +.Xr loader.conf 5 or from the command line using the .Xr kldload 8 utility. Options which can be specified in .Pa /boot/loader.conf include: -.Bl -tag -width snd_emu10k1_load -offset indent +.Bl -tag -width ".Va snd_emu10k1_load" -offset indent .It Va snd_driver_load -.Pq Dq NO +.Pq Dq Li NO If set to -.Dq YES , +.Dq Li YES , this option loads all available drivers. .It Va snd_emu10k1_load -.Pq Dq NO +.Pq Dq Li NO If set to -.Dq YES , -Only the SoundBlaster 5.1 driver and dependent modules will be loaded. +.Dq Li YES , +only the SoundBlaster 5.1 driver and dependent modules will be loaded. .It Va snd_foo_load -.Pq Dq NO +.Pq Dq Li NO If set to -.Dq YES , +.Dq Li YES , load driver for card/chipset foo. .El -.Ss VCHANS +.Ss VCHANs Each device can optionally support more playback channels that physical hardware provides by using .Dq virtual channels @@ -145,8 +151,8 @@ interface but can only be manipulated while the device is inactive. .Ss Runtime Configuration The following .Xr sysctl 8 -tunables are available: -.Bl -tag -width ".It Va hw.snd.report_soft_formats" -offset indent +variables are available: +.Bl -tag -width ".Va hw.snd.report_soft_formats" -offset indent .It Va hw.snd.pcm%d.buffersize Configure the amount of .Tn DMA @@ -167,7 +173,7 @@ the default device for Equivalent to a symlink from .Pa /dev/dsp to -.Pa /dev/dsp${hw.snd.unit} . +.Pa /dev/dsp Ns Va ${hw.snd.unit} . .It Va hw.snd.report_soft_formats Controls the internal format conversion if it is available transparently to the application software. @@ -178,15 +184,21 @@ Level of verbosity for the .Pa /dev/sndstat device. Higher values include more output and the highest level, -three, should be used when reported problems. +three, should be used when reporting problems. Other options include: -0 - Installed devices and their allocated bus resources. -1 - The number of playback, record, virtual channels, and +.Bl -tag -width 2n +.It 0 +Installed devices and their allocated bus resources. +.It 1 +The number of playback, record, virtual channels, and flags per device. -2 - Channel information per device including the channel's +.It 2 +Channel information per device including the channel's current format, speed, and pseudo device statistics such as buffer overruns and buffer underruns. -3 - File names and versions of the currently sound loaded modules. +.It 3 +File names and versions of the currently sound loaded modules. +.El .It Va hw.snd.maxautovchans Global .Tn VCHAN @@ -225,7 +237,9 @@ The driver supports most of the .Fn ioctl functions, and most applications work unmodified. A few differences exist, while memory mapped playback is -supported natively and in Linux emulation, memory mapped recording is +supported natively and in +.Tn Linux +emulation, memory mapped recording is not due to .Tn VM system design. @@ -236,7 +250,7 @@ See for a complete list of the supported .Fn ioctl functions. -.Ss SUPPORTED CARDS +.Ss Supported Cards Below we include a list of supported codecs/cards. If your sound card is not listed here, it may be supported by a bridge driver. @@ -254,12 +268,13 @@ not wired to the ISA DMA controller. .It Yamaha OPL-SAx (ISA) Works perfectly in all modes. This chip is used in several PnP cards, -but also (in non-PnP mode) on motherboards and laptops (e.g. the +but also (in non-PnP mode) on motherboards and laptops (e.g., the Toshiba Libretto). .It OPTi931 (ISA) The chip is buggy, but the driver has many workarounds to make it work in full duplex because for some time these were the only full duplex -cards I could find. u-law formats uses U8 format internally because of +cards I could find. +U-law format uses U8 format internally because of a bug in the chip. .It Trident 4DWave DX/NX (PCI) .It ENSONIQ AudioPCI ES1370/1371 (PCI) @@ -273,7 +288,7 @@ The drivers may create the following device nodes: .Pp -.Bl -tag -width "/dev/dspr%d.%dXXX" -compact +.Bl -tag -width ".Pa /dev/audio%d.%d" -compact .It Pa /dev/audio%d.%d Sparc-compatible audio device. .It Pa /dev/dsp%d.%d @@ -292,36 +307,39 @@ status, including all channels and drivers. .Pp The first number in the device node represents the unit number of the -.Nm PCM +.Nm device. All .Nm -PCM devices are listed in -.Pa /dev/sndstat. +.Pa /dev/sndstat . Additional messages are sometimes recorded when the device is probed and attached, these messages can be viewed with the .Xr dmesg 8 utility. .Sh DIAGNOSTICS -.Bl -tag -width 2m +.Bl -diag .It ac97: dac not ready AC97 codec is not likely to be accompanied with the sound card. .It unsupported subdevice XX A device node is not created properly. .El .Sh BUGS -Some features of your cards (e.g. global volume control) might not +Some features of your cards (e.g., global volume control) might not be supported on all devices. .Sh HISTORY The .Nm device driver first appeared in -.Fx 2.2.6 written by Luigi Rizzo. +.Fx 2.2.6 +written by +.An Luigi Rizzo . It was later rewritten in -.Fx 4.0 by Cameron Grant. +.Fx 4.0 +by +.An Cameron Grant . The API evolved from the VOXWARE standard which later became OSS standard. .Sh SEE ALSO @@ -349,4 +367,4 @@ later revised the device driver for .An Seigo Tanimura Aq tanimura@r.dl.itc.u-tokyo.ac.jp revised this manual page. It was then rewritten for -.Fx 5.2 . \ No newline at end of file +.Fx 5.2 . diff --git a/share/man/man4/random.4 b/share/man/man4/random.4 index 4cd998f..f483b5b 100644 --- a/share/man/man4/random.4 +++ b/share/man/man4/random.4 @@ -32,6 +32,7 @@ .Sh DESCRIPTION The .Nm +device returns an endless supply of random bytes when read. It also accepts and reads data as any ordinary (and willing) file, @@ -81,6 +82,7 @@ kern.random.yarrow.fastthresh: 100 kern.random.yarrow.slowthresh: 160 kern.random.yarrow.slowoverthresh: 2 .Ed +.Pp (These would not be seen if a hardware generator is present.) .Pp @@ -322,7 +324,7 @@ algorithm by Bruce Schneier, .Em et al . The only hardware implementation currently is for the -.Em VIA C3 Nehemiah +.Tn VIA C3 Nehemiah (stepping 3 or greater) CPU. More will be added in the future. diff --git a/share/man/man4/sbp.4 b/share/man/man4/sbp.4 index 128e36f..866a917 100644 --- a/share/man/man4/sbp.4 +++ b/share/man/man4/sbp.4 @@ -72,8 +72,8 @@ If you want to force to detach the device, run .Dq Nm fwcontrol Fl r several times. .Pp -Some (broken) HDDs don't work well with tagged queuing. If you have problems -with such drives, try +Some (broken) HDDs do not work well with tagged queuing. +If you have problems with such drives, try .Dq Nm camcontrol [device id] tags -N 1 to disable tagged queuing. .Sh SEE ALSO diff --git a/share/man/man4/smb.4 b/share/man/man4/smb.4 index 8645c03..1c6556b 100644 --- a/share/man/man4/smb.4 +++ b/share/man/man4/smb.4 @@ -40,7 +40,7 @@ character device driver provides generic i/o to any .Xr smbus 4 instance. In order to control SMB devices, use -.Pa /dev/smb Ns Em ? +.Pa /dev/smb? with the ioctls described below. Any of these ioctl commands takes a pointer to .Vt struct smbcmd @@ -73,40 +73,40 @@ The field is always used, and provides the address of the SMBus slave device to talk to. .Pp -.Bl -column ".Sy SMB_QUICK_WRITE" -compact +.Bl -column ".Dv SMB_QUICK_WRITE" -compact .It Em Ioctl Ta Em Description .Pp -.It Sy SMB_QUICK_WRITE Ta +.It Dv SMB_QUICK_WRITE Ta The .Em QuickWrite command just issues the device address with write intent to the bus, without transferring any data. -.It Sy SMB_QUICK_READ Ta +.It Dv SMB_QUICK_READ Ta The .Em QuickRead command just issues the device address with read intent to the bus, without transferring any data. -.It Sy SMB_SENDB Ta +.It Dv SMB_SENDB Ta The .Em SendByte command sends the byte provided in the .Fa cmd field to the device. -.It Sy SMB_RECVB Ta +.It Dv SMB_RECVB Ta The .Em ReceiveByte command reads a single byte from the device which will be returned in the .Fa cmd field. -.It Sy SMB_WRITEB Ta +.It Dv SMB_WRITEB Ta The .Em WriteByte command first sends the byte from the .Fa cmd field to the device, followed by the byte given in .Fa data.byte . -.It Sy SMB_WRITEW Ta +.It Dv SMB_WRITEW Ta The .Em WriteWord command first sends the byte from the @@ -114,7 +114,7 @@ command first sends the byte from the field to the device, followed by the word given in .Fa data.word . Note that the SMBus byte-order is little-endian by definition. -.It Sy SMB_READB Ta +.It Dv SMB_READB Ta The .Em ReadByte command first sends the byte from the @@ -123,7 +123,7 @@ field to the device, and then reads one byte of data from the device. The returned data will be stored in the location pointed to by .Fa data.byte_ptr . -.It Sy SMB_READW Ta +.It Dv SMB_READW Ta The .Em ReadWord command first sends the byte from the @@ -132,7 +132,7 @@ field to the device, and then reads one word of data from the device. The returned data will be stored in the location pointed to by .Fa data.word_ptr . -.It Sy SMB_PCALL Ta +.It Dv SMB_PCALL Ta The .Em ProcedureCall command first sends the byte from the @@ -142,7 +142,7 @@ field to the device, followed by the word provided in It then reads one word of data from the device, and returns it in the location pointed to by .Fa data.process.rdata . -.It Sy SMB_BWRITE Ta +.It Dv SMB_BWRITE Ta The .Em BlockWrite command first sends the byte from the @@ -155,7 +155,7 @@ The SMBus specification mandates that no more than 32 bytes of data can be transferred in a single block read or write command. This value is available in the constant .Dv SMB_MAXBLOCKSIZE . -.It Sy SMB_BREAD Ta +.It Dv SMB_BREAD Ta The .Em BlockRead command first sends the byte from the diff --git a/share/man/man4/smp.4 b/share/man/man4/smp.4 index c15ccdb..81a42d0 100644 --- a/share/man/man4/smp.4 +++ b/share/man/man4/smp.4 @@ -60,7 +60,7 @@ command may be used to view the status of multi-processor support. .Fx supports hyperthreading on Intel CPU's on the i386 platform. Since using logical CPUs can cause performance penalties under certain loads, -the logical CPUs can be disabled by setting the +the logical CPUs can be disabled by setting the .Va machdep.hlt_logical_cpus sysctl to one. .Sh SEE ALSO diff --git a/share/man/man4/syscons.4 b/share/man/man4/syscons.4 index a99324f..cd2000b 100644 --- a/share/man/man4/syscons.4 +++ b/share/man/man4/syscons.4 @@ -148,7 +148,7 @@ variable in to the desired keymap file so that it will be automatically loaded when the system starts up. .Ss Software Font -For most modern video cards, e.g. VGA, the +For most modern video cards, e.g., VGA, the .Nm driver and the video card driver allow the user to change the font used on the screen. @@ -345,11 +345,16 @@ unless you explicitly load a software font at startup. See .Sx EXAMPLES below. -.It SC_NO_SUSPEND_VTYSWITCH -This option, which is also available as loader tunable and sysctl -.Va ( hw.syscons.sc_no_suspend_vtswitch ) , +.It Dv SC_NO_SUSPEND_VTYSWITCH +This option, which is also available as +.Xr loader 8 +tunable and +.Xr sysctl 8 +variable +.Pq Va hw.syscons.sc_no_suspend_vtswitch , disables switching between virtual terminals (graphics <-> text) during -suspend/resume (ACPI and APM). Use this option if your system is freezing +suspend/resume (ACPI and APM). +Use this option if your system is freezing when you are running X and trying to suspend. .El .Pp diff --git a/share/man/man4/tcp.4 b/share/man/man4/tcp.4 index 51959e1..3ba5598 100644 --- a/share/man/man4/tcp.4 +++ b/share/man/man4/tcp.4 @@ -121,7 +121,7 @@ supports a number of socket options which can be set with .Xr setsockopt 2 and tested with .Xr getsockopt 2 : -.Bl -tag -width ".Dv TCP_MD5SIG" +.Bl -tag -width ".Dv TCP_NODELAY" .It Dv TCP_NODELAY Under most circumstances, .Tn TCP @@ -183,10 +183,14 @@ digests on incoming traffic are not verified. The current default behavior for the system is to respond to a system advertising this option with TCP-MD5; this may change. .Pp -One common use for this in a FreeBSD router deployment is to enable +One common use for this in a +.Fx +router deployment is to enable based routers to interwork with Cisco equipment at peering points. Support for this feature conforms to RFC 2385. -Only IPv4 (AF_INET) sessions are supported. +Only IPv4 +.Pq Dv AF_INET +sessions are supported. .Pp In order for this option to function correctly, it is necessary for the administrator to add a tcp-md5 key entry to the system's security diff --git a/share/man/man4/umass.4 b/share/man/man4/umass.4 index 372898d..a49ee5b 100644 --- a/share/man/man4/umass.4 +++ b/share/man/man4/umass.4 @@ -86,15 +86,15 @@ Among the supported digital cameras are: Asahi Optical (PENTAX) Optio 230 & 330 .El .Pp -.Nm usb +.Xr usb 4 and one of -.Nm uhci +.Xr uhci 4 or -.Nm ohci +.Xr ohci 4 must be configured in the kernel as well. Last but not least, support for SCSI drives, -.Nm da . +.Xr da 4 . .Sh EXAMPLES .Bd -literal -offset indent device umass @@ -130,9 +130,9 @@ mount -t ufs /dev/da0c /mnt .Ed .Pp Write a disklabel to the Zip drive (see -.Nm vpo +.Xr vpo 4 for the -.Nm disktab +.Xr disktab 5 entry), creates the file system and mounts the new file system on /mnt. .Pp .Dl "newfs_msdos /dev/da0" @@ -149,7 +149,7 @@ based file systems when storing information such as images and videos. These file systems can be accessed by specifying the file system type as -.Nm msdos +.Cm msdos when using .Xr mount 8 . .Sh SEE ALSO @@ -158,8 +158,8 @@ when using .Xr usb 4 , .Xr vpo 4 , .Xr disktab 5 , -.Xr camcontrol 8 , -.Xr bsdlabel 8 +.Xr bsdlabel 8 , +.Xr camcontrol 8 .\".Sh HISTORY .Sh AUTHORS .An -nosplit diff --git a/share/man/man4/wlan.4 b/share/man/man4/wlan.4 index 035d339..e560195 100644 --- a/share/man/man4/wlan.4 +++ b/share/man/man4/wlan.4 @@ -46,24 +46,23 @@ and drivers but will eventually be required by all 802.11 drivers. .Pp If the associated interface is marked for debugging with, for example, -.Bd -literal -offset indent -ifconfig wi0 debug -.Ed +.Pp +.Dl "ifconfig wi0 debug" .Pp then messages describing the operation of the 802.11 protocol will be sent to the console. With the interface marked for debugging, doing: -.Bd -literal -offset indent -sysctl debug.ieee80211=1 -.Ed +.Pp +.Dl "sysctl debug.ieee80211=1" .Pp causes additional messages to be generated. Many drivers will also display the contents of each 802.11 frame sent and received when the interface is marked with -both debugging and ``link2''; e.g. -.Bd -literal -offset indent -ifconfig wi0 debug link2 -.Ed +both debugging and +.Cm link2 ; +e.g., +.Pp +.Dl "ifconfig wi0 debug link2" .Pp Beware however that some management frames may be processed entirely within the device and not be received by the host. diff --git a/share/man/man5/config.5 b/share/man/man5/config.5 index 52ff0f8..63d7b32 100644 --- a/share/man/man5/config.5 +++ b/share/man/man5/config.5 @@ -23,7 +23,7 @@ .\" .\" $FreeBSD$ .\" -.Dd July 3, 2003 +.Dd May 13, 2004 .Dt CONFIG 5 .Os .Sh NAME @@ -128,7 +128,8 @@ embedded environments that do not start from .\" -------- FILES -------- .It Ic files Ar filename Specifies a file containing a list of files specific to that kernel -configuration file (ala files.ARCH). +configuration file (a la +.Pa files. Ns Aq Ar arch ) . .\" -------- HINTS -------- .It Ic hints Ar filename Specifies a file to load a static device configuration specification diff --git a/share/man/man5/devfs.5 b/share/man/man5/devfs.5 index f4067be..8ef5841 100644 --- a/share/man/man5/devfs.5 +++ b/share/man/man5/devfs.5 @@ -64,7 +64,8 @@ mount point. .Pp The .Xr mknod 8 -tool can be used to recover deleted device entries under devfs. +tool can be used to recover deleted device entries under +.Nm . .Sh FILES .Bl -tag -width /dev/XXXX -compact .It Pa /dev diff --git a/share/man/man5/hosts.lpd.5 b/share/man/man5/hosts.lpd.5 index 35a9b3a..910ac66 100644 --- a/share/man/man5/hosts.lpd.5 +++ b/share/man/man5/hosts.lpd.5 @@ -46,7 +46,9 @@ List every hostname or IP address on a line itself. .Pp If you want to allow access for any and all host, you can usually use the NIS netgroups feature to -do this by adding a line with a single '+' character. +do this by adding a line with a single +.Ql + +character. .Sh FILES .Bl -tag -width /etc/hosts.lpdxxxxx -compact .It Pa /etc/hosts.lpd diff --git a/share/man/man5/libmap.conf.5 b/share/man/man5/libmap.conf.5 index 784aa37..4299e58 100644 --- a/share/man/man5/libmap.conf.5 +++ b/share/man/man5/libmap.conf.5 @@ -48,7 +48,7 @@ executable or library in brackets. All mappings following a constraint will only be evaluated for that constraint. Constraints can be one of three types: .Bl -tag -width indent -.It Exact +.It Exact The constraint is matched literally so that only an executable with an identical fully qualified pathname will match the constraint. This means that the executable @@ -61,10 +61,10 @@ This is the default constraint type. A constraint with no path is matched against the basename of the executable. .Pa foo -will match +will match .Pa /bin/foo , .Pa /usr/local/sbin/foo , -or any other executable named +or any other executable named .Pa foo , no matter what its path is. .It Directory @@ -74,16 +74,16 @@ pathname of the executable. will match any executable with a path starting with /usr/bin. .El .Pp -Note that the executable path matched against is the -.Pa path -parameter in an +Note that the executable path matched against is the +.Fa path +parameter in an .Fn exec* -function call. +function call. The Directory or Exact constraints can only match when the executable is called with a full pathname. Most programs executed from a shell are run without a full path, via .Fn exec*p , -so the Basename constraint type is the most useful. +so the Basename constraint type is the most useful. .Pp WARNING! Constrained mappings must never appear first in the configuration file. @@ -95,7 +95,7 @@ The most common use at the date of writing is for allowing multiple .Tn POSIX threading libraries to be used on a system without relinking or changing symlinks. -.Sh EXAMPLE +.Sh EXAMPLES .Bd -literal # /etc/libmap.conf # diff --git a/share/man/man5/make.conf.5 b/share/man/man5/make.conf.5 index 1b82ab9..df86cc3 100644 --- a/share/man/man5/make.conf.5 +++ b/share/man/man5/make.conf.5 @@ -609,7 +609,9 @@ Set to disable the installation of as an suid root program. .It Va SENDMAIL_MC .Pq Vt str -The default m4 configuration file to use at install time. +The default +.Xr m4 1 +configuration file to use at install time. The value should include the full path to the .Pa .mc file, e.g., @@ -621,7 +623,9 @@ Note that is now deprecated. .It Va SENDMAIL_SUBMIT_MC .Pq Vt str -The default m4 configuration file for mail submission +The default +.Xr m4 1 +configuration file for mail submission to use at install time. The value should include the full path to the .Pa .mc @@ -643,14 +647,18 @@ file(s), e.g., .Pa /etc/mail/bar.mc . .It Va SENDMAIL_CF_DIR .Pq Vt str -Override the default location for the m4 configuration files used to build a +Override the default location for the +.Xr m4 1 +configuration files used to build a .Pa .cf file from a .Pa .mc file. .It Va SENDMAIL_M4_FLAGS .Pq Vt str -Flags passed to m4 when building a +Flags passed to +.Xr m4 1 +when building a .Pa .cf file from a .Pa .mc diff --git a/share/man/man5/periodic.conf.5 b/share/man/man5/periodic.conf.5 index 82e057d..dc6a9b8 100644 --- a/share/man/man5/periodic.conf.5 +++ b/share/man/man5/periodic.conf.5 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd June 22, 2000 +.Dd May 30, 2004 .Dt PERIODIC.CONF 5 .Os .Sh NAME @@ -659,25 +659,31 @@ As an example, this variable might be set to if the portupgrade port has been installed. .It Va pkg_version_index .Pq Vt string -This variable specifies the INDEX file from +This variable specifies the +.Pa INDEX +file from .Pa /usr/ports that should be used by .Xr pkg_version 1 . Because the dependency tree may be substantially different between versions of .Fx , -there may be more than one INDEX file in +there may be more than one +.Pa INDEX +file in .Pa /usr/ports . .Pp Note, if the .Va pkg_version variable is set to -.Dq portversion , -it will also be necessary to arrange that the correct INDEX file is specified +.Dq Li portversion , +it will also be necessary to arrange that the correct +.Pa INDEX +file is specified using environment variables and that -.Dq pkg_version_index +.Va pkg_version_index is cleared in .Pa /etc/periodic.conf -.Pq pkg_version_index= . +.Pq Dq Li pkg_version_index= . .It Va weekly_local .Pq Vt str Set to a list of extra scripts that should be run after all other diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 index 7543dc6..a30e490 100644 --- a/share/man/man5/rc.conf.5 +++ b/share/man/man5/rc.conf.5 @@ -226,33 +226,35 @@ based cards. List of removable network interfaces to be supported by .Pa /etc/pccard_ether . .It Va tmpmfs -Controls the creation of an mfs +Controls the creation of a .Pa /tmp -file system. +memory file system. Always happens if set to .Dq Li YES and never happens if set to .Dq Li NO . -If set anything else, a memory file system is created if +If set to anything else, a memory file system is created if .Pa /tmp is not writable. .It Va tmpsize -Controls the size of a created mfm -.Pa /tmp . +Controls the size of a created +.Pa /tmp +memory file system. .It Va varmfs -Controls the creation of an mfs +Controls the creation of a .Pa /var -file system. +memory file system. Always happens if set to .Dq Li YES and never happens if set to .Dq Li NO . -If set anything else, a memory file system is created if +If set to anything else, a memory file system is created if .Pa /var is not writable. .It Va varsize -Controls the size of a created mfm -.Pa /var . +Controls the size of a created +.Pa /var +memory file system. .It Va populate_var Controls the automatic population of the .Pa /var @@ -261,7 +263,9 @@ Always happens if set to .Dq Li YES and never happens if set to .Dq Li NO . -If set anything else, a memory file system is created if /tmp is not writable. +If set to anything else, a memory file system is created if +.Pa /tmp +is not writable. Note that this process requires access to certain commands in .Pa /usr before @@ -673,9 +677,8 @@ enables packet filtering. .Pp Typical usage will require putting -.Bd -literal -pf_enable="YES" -.Ed +.Pp +.Dl pf_enable="YES" .Pp into .Pa /etc/rc.conf @@ -684,7 +687,7 @@ and editing appropriately. .Pp Having -.Bd -literal +.Bd -literal -offset indent options PFIL_HOOKS options RANDOM_IP_ID .Ed @@ -693,14 +696,14 @@ in the kernel configuration file is required for use as a .Xr kld 4 module. .Pp -.Bd -literal -device pf -.Ed +.Dl "device pf" .Pp builds it into the kernel. .It Va pf_rules .Pq Vt str -Path to pf ruleset configuration file +Path to +.Xr pf 4 +ruleset configuration file (default .Pa /etc/pf.conf ) . .It Va pf_program @@ -738,7 +741,7 @@ is set to .Dq Li YES this controls where .Xr pflogd 8 -stores the logfile. +stores the logfile (default .Pa /var/log/pflog ) . Check @@ -1959,7 +1962,8 @@ Also refer to the files in for more detailed configuration information. .It Va atm_load .Pq Vt str -This is a list of physical ATM interface drivers to load. Typical values are +This is a list of physical ATM interface drivers to load. +Typical values are .Dq Li hfa_pci and/or .Dq Li hea_pci . @@ -2947,46 +2951,52 @@ and in time to be mounted from .Xr fstab 5 . Each listed unit -.Nm X +.Ar X must specify at least a .Ar type in a -.Nm ramdisk_X_config +.Va ramdisk_ Ns Ao Ar X Ac Ns Va _config variable. -.It Va ramdisk_X_config +.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _config .Pq Vt str Arguments to .Xr mdconfig 8 for ramdisk -.Nm X . -At minimum a -.Fl Ar t type -must be specified, where +.Ar X . +At minimum a +.Fl t Ar type +must be specified, where .Ar type must be one of -.Nm malloc +.Cm malloc or -.Nm swap . -.It Va ramdisk_X_newfs +.Cm swap . +.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _newfs .Pq Vt str -Optional arguments passed to +Optional arguments passed to .Xr newfs 8 to initialize ramdisk -.Nm X . -.It Va ramdisk_X_owner +.Ar X . +.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _owner .Pq Vt str An ownership specification passed to .Xr chown 8 after the specified ramdisk unit -.Nm X -has been mounted. Both the md device and the mount point will be changed. -.It Va ramdisk_X_perms +.Ar X +has been mounted. +Both the +.Xr md 4 +device and the mount point will be changed. +.It Va ramdisk_ Ns Ao Ar X Ac Ns Va _perms .Pq Vt str A mode string passed to .Xr chmod 1 after the specified ramdisk unit -.Nm X -has been mounted. Both the md device and the mount point will be changed. +.Ar X +has been mounted. +Both the +.Xr md 4 +device and the mount point will be changed. .El .Sh FILES .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact @@ -3001,6 +3011,7 @@ has been mounted. Both the md device and the mount point will be changed. .Xr info 1 , .Xr kbdcontrol 1 , .Xr makewhatis 1 , +.Xr vi 1 , .Xr vidcontrol 1 , .Xr ip 4 , .Xr kld 4 , @@ -3038,9 +3049,9 @@ has been mounted. Both the md device and the mount point will be changed. .Xr rc.sendmail 8 , .Xr route 8 , .Xr routed 8 , +.Xr rpcbind 8 , .Xr rpc.lockd 8 , .Xr rpc.statd 8 , -.Xr rpcbind 8 , .Xr rwhod 8 , .Xr savecore 8 , .Xr sshd 8 , @@ -3049,7 +3060,6 @@ has been mounted. Both the md device and the mount point will be changed. .Xr syslogd 8 , .Xr timed 8 , .Xr usbd 8 , -.Xr vi 1 , .Xr vinum 8 , .Xr yp 8 , .Xr ypbind 8 , diff --git a/share/man/man5/remote.5 b/share/man/man5/remote.5 index 33ac813..e50f1f3 100644 --- a/share/man/man5/remote.5 +++ b/share/man/man5/remote.5 @@ -207,5 +207,7 @@ The file format appeared in .Bx 4.2 . .Sh BUGS -Tip uses its own notion of the serial ports data rate rather than the +The +.Xr tip 1 +utility uses its own notion of the serial ports data rate rather than the system default for a serial port. diff --git a/share/man/man5/resolver.5 b/share/man/man5/resolver.5 index 535b54e..51b730e 100644 --- a/share/man/man5/resolver.5 +++ b/share/man/man5/resolver.5 @@ -32,7 +32,7 @@ .\" @(#)resolver.5 8.1 (Berkeley) 6/5/93 .\" $FreeBSD$ .\" -.Dd November 11, 1993 +.Dd December 7, 2003 .Dt RESOLVER 5 .Os .Sh NAME @@ -83,7 +83,8 @@ If no entry is present, the domain is determined from the local host name returned by .Xr gethostname 3 ; -the domain part is taken to be everything after the first `.'. +the domain part is taken to be everything after the first +.Ql \&. . Finally, if the host name does not contain a domain part, the root domain is assumed. .It Sy search @@ -113,8 +114,9 @@ The IP address and optional network pairs are separated by slashes. Up to 10 pairs may be specified. +E.g., .Pp -e.g. sortlist 130.155.160.0/255.255.240.0 130.155.0.0 +.Dl "sortlist 130.155.160.0/255.255.240.0 130.155.0.0" .It Sy options Options allows certain internal resolver variables to be modified. The syntax is @@ -148,21 +150,22 @@ will be tried first as an absolute name before any elements are appended to it. .It Sy timeout: Ns Ar n sets the amount of time the resolver will wait for a response from a remote -name server before retrying the query via a different name server. Measured in -seconds, the default is +name server before retrying the query via a different name server. +Measured in seconds, the default is .Dv RES_TIMEOUT (see -.Pa ) . +.In resolv.h ) . .It Sy attempts: Ns Ar n sets the number of times the resolver will send a query to its name servers -before giving up and returning an error to the calling application. The -default is +before giving up and returning an error to the calling application. +The default is .Dv RES_DFLRETRY (see -.Pa ) . +.In resolv.h ) . .It Sy no_tld_query tells the resolver not to attempt to resolve a top level domain name, that -is, a name that contains no dots. Use of this option doesn't prevent +is, a name that contains no dots. +Use of this option does not prevent the resolver from obeying the standard .Sy domain and @@ -186,8 +189,8 @@ the last instance will override. The keyword and value must appear on a single line, and the keyword (e.g.\& .Sy nameserver ) -must start the line. The value follows -the keyword, separated by white space. +must start the line. +The value follows the keyword, separated by white space. .Sh FILES .Bl -tag -width /etc/resolv.conf -compact .It Pa /etc/resolv.conf diff --git a/share/man/man7/build.7 b/share/man/man7/build.7 index a38da6c..b0b6481 100644 --- a/share/man/man7/build.7 +++ b/share/man/man7/build.7 @@ -142,7 +142,7 @@ method of updating your system from the latest sources is: make buildworld make buildkernel KERNCONF=FOO make installkernel KERNCONF=FOO -.Aq Reboot the new kernel in single user mode + make installworld mergemaster .Ed diff --git a/share/man/man7/firewall.7 b/share/man/man7/firewall.7 index 127334b..ecb38b7 100644 --- a/share/man/man7/firewall.7 +++ b/share/man/man7/firewall.7 @@ -359,8 +359,8 @@ to indirectly bind services that do not otherwise give you the option. .Xr dummynet 4 , .Xr ipnat 5 , .Xr rc.conf 5 , -.Xr smb.conf 5 [ /usr/ports/net/samba ] , -.Xr samba 7 [ /usr/ports/net/samba ] , +.Xr smb.conf 5 Pq Pa ports/net/samba , +.Xr samba 7 Pq Pa ports/net/samba , .Xr config 8 , .Xr ipfw 8 , .Xr jail 8 , diff --git a/share/man/man7/hier.7 b/share/man/man7/hier.7 index 313f981..6bf7f9c 100644 --- a/share/man/man7/hier.7 +++ b/share/man/man7/hier.7 @@ -40,7 +40,7 @@ .Nd layout of file systems .Sh DESCRIPTION A sketch of the file system hierarchy. -.Bl -tag -width "/stand/" +.Bl -tag -width ".Pa /libexec/" .It Pa / root directory of the file system .It Pa /bin/ @@ -48,7 +48,7 @@ user utilities fundamental to both single-user and multi-user environments .It Pa /boot/ programs and configuration files used during operating system bootstrap .Pp -.Bl -tag -width defaults/ -compact +.Bl -tag -width ".Pa defaults/" -compact .It Pa defaults/ default bootstrapping configuration files; see .Xr loader.conf 5 @@ -87,7 +87,7 @@ mount point used by .It Pa /etc/ system configuration files and scripts .Pp -.Bl -tag -width "disklabels/" -compact +.Bl -tag -width ".Pa defaults/" -compact .It Pa defaults/ default system configuration files; see @@ -137,7 +137,7 @@ critical system libraries needed for binaries in and .Pa /sbin .Pp -.Bl -tag -width "geom/" -compact +.Bl -tag -width ".Pa geom/" -compact .It Pa geom/ class-specific libraries for the .Xr geom 8 @@ -172,7 +172,7 @@ temporary files that are not guaranteed to persist across system reboots .It Pa /usr/ contains the majority of user utilities and applications .Pp -.Bl -tag -width "libdata/" -compact +.Bl -tag -width ".Pa libdata/" -compact .It Pa bin/ common utilities, programming tools, and applications .It Pa compat/ @@ -185,7 +185,7 @@ useful and semi-frivolous programs .It Pa include/ standard C include files .Pp -.Bl -tag -width "kerberos5/" -compact +.Bl -tag -width ".Pa kerberos5/" -compact .It Pa altq/ C include files for alternate queueing .It Pa arpa/ @@ -194,7 +194,7 @@ C include files for Internet service protocols C include files for the SNMP daemon .It Pa cam/ C include files for the Common Access Methods Layer -.Bl -tag -width "kerberos5/" -compact +.Bl -tag -width ".Pa kerberos5/" -compact .It Pa scsi/ The SCSI device on top of CAM .El @@ -202,7 +202,7 @@ The SCSI device on top of CAM C include files for programming various .Fx devices -.Bl -tag -width "kerberos5/" -compact +.Bl -tag -width ".Pa kerberos5/" -compact .It Pa ic/ Various header files describing driver- and bus-independent hardware circuits @@ -224,7 +224,7 @@ The WaveLAN driver .El .It Pa fs/ -.Bl -tag -width "kerberos5/" -compact +.Bl -tag -width ".Pa kerberos5/" -compact .It Pa fdescfs/ per-process file descriptors file system .It Pa fifofs/ @@ -253,13 +253,13 @@ union file system .El .It Pa g++/ GNU C++ include files -.Bl -tag -width "kerberos5/" -compact +.Bl -tag -width ".Pa kerberos5/" -compact .It Pa std/ GNU C++ libstdc++ include files .El .It Pa geom/ GEOM framework -.Bl -tag -width "kerberos5/" -compact +.Bl -tag -width ".Pa kerberos5/" -compact .It Pa concat/ CONCAT GEOM class .It Pa gate/ @@ -273,7 +273,7 @@ STRIPE GEOM class .It Pa isc/ ISC utility library libisc include files .It Pa isofs/ -.Bl -tag -width "kerberos5/" -compact +.Bl -tag -width ".Pa kerberos5/" -compact .It Pa cd9660/ iso9660 file system .El @@ -344,7 +344,7 @@ system C include files (kernel data structures) .\" Tcl language; .\" see .\" .Xr Tcl n -.\" .Bl -tag -width "kerberos5/" -compact +.\" .Bl -tag -width ".Pa kerberos5/" -compact .\" .It Pa generic/ .\" ??? .\" .It Pa unix/ @@ -352,7 +352,7 @@ system C include files (kernel data structures) .\" .El .It Pa ufs/ C include files for UFS (The U-word File System) -.Bl -tag -width "kerberos5/" -compact +.Bl -tag -width ".Pa kerberos5/" -compact .It Pa ffs/ Fast file system .It Pa ufs/ @@ -439,7 +439,7 @@ system daemons & system utilities (executed by users) .It Pa share/ architecture-independent files .Pp -.Bl -tag -width "calendar/" -compact +.Bl -tag -width ".Pa calendar/" -compact .It Pa calendar/ a variety of pre-fab calendar files; see @@ -575,7 +575,7 @@ MIB files files used by syscons; see .Xr syscons 4 -.Bl -tag -width "scrnmaps/xx" -compact +.Bl -tag -width ".Pa scrnmaps/" -compact .It Pa fonts/ console fonts; see @@ -614,7 +614,7 @@ see .Bx , third-party, and/or local source files .Pp -.Bl -tag -width "kerberos5/" -compact +.Bl -tag -width ".Pa kerberos5/" -compact .It Pa bin/ source code for files in /bin .It Pa contrib/ @@ -658,7 +658,7 @@ source code for files in /usr/sbin .Pp .It Pa X11R6/ X11R6 distribution executables, libraries, etc (optional). -.Bl -tag -width "include/" -compact +.Bl -tag -width ".Pa include/" -compact .It Pa bin/ X11R6 binaries (servers, utilities, local packages/ports). .It Pa etc/ @@ -676,7 +676,7 @@ architecture-independent files. .It Pa /var/ multi-purpose log, temporary, transient, and spool files .Pp -.Bl -tag -width "preserve/" -compact +.Bl -tag -width ".Pa preserve/" -compact .It Pa account/ system accounting files .Pp @@ -691,7 +691,7 @@ see timed command scheduling files; see .Xr \&at 1 -.Bl -tag -width "preserve/" -compact +.Bl -tag -width ".Pa preserve/" -compact .It Pa jobs/ directory containing job files .It Pa spool/ @@ -709,7 +709,7 @@ and files used by cron; see .Xr cron 8 -.Bl -tag -width "preserve/" -compact +.Bl -tag -width ".Pa preserve/" -compact .It Pa tabs/ crontab files; see diff --git a/share/man/man8/diskless.8 b/share/man/man8/diskless.8 index a190e78..c1917fa 100644 --- a/share/man/man8/diskless.8 +++ b/share/man/man8/diskless.8 @@ -132,7 +132,7 @@ cp /boot/pxeboot /tftpdir/ In phase 3, the kernel acquires IP networking configuration in one of two ways, and then proceeds to mount the root file system and start operation. -If the phase 2 loader supporst passing network configuration to the +If the phase 2 loader supports passing network configuration to the kernel using the kernel environment, then the kernel will configure the network interface using that information. Otherwise, it must use @@ -419,9 +419,12 @@ the following options: .D1 Cd "options BOOTP_NFSROOT" .D1 Cd "options BOOTP_COMPAT" .Pp -NOTE: The PXE environment does not require these uptions. +.Em Note : +the PXE environment does not require these options. .Pp -The diskless booting environment relies on memory-backed file systems to +The +.Nm +booting environment relies on memory-backed file systems to support temporary local storage in the event that the root file system is mounted read-only; as such, it is necessary to add the following to the device section of the kernel configuration: diff --git a/share/man/man9/DEVICE_IDENTIFY.9 b/share/man/man9/DEVICE_IDENTIFY.9 index e9e4b74..1794c4c 100644 --- a/share/man/man9/DEVICE_IDENTIFY.9 +++ b/share/man/man9/DEVICE_IDENTIFY.9 @@ -56,7 +56,7 @@ for each resource (refer to for more information). .Pp Since the device tree and the device driver tree are disjoint, the -.Nm +.Fn DEVICE_IDENTIFY routine needs to take this into account. If you load and unload your device driver that has the identify routine, the child node has the potential for adding the same node diff --git a/share/man/man9/VOP_GETPAGES.9 b/share/man/man9/VOP_GETPAGES.9 index cd502ce..3ead1af1 100644 --- a/share/man/man9/VOP_GETPAGES.9 +++ b/share/man/man9/VOP_GETPAGES.9 @@ -87,7 +87,7 @@ Offset in the file at which the mapped pages begin. .Pp The status of the .Fn VOP_PUTPAGES -method is returned on a page-by-page basis in the array +method is returned on a page-by-page basis in the array .Fa rtvals[] . The possible status values are as follows: .Bl -tag -width VM_PAGER_ERROR @@ -137,7 +137,7 @@ or deactivate it (otherwise), and finally call to arouse any threads currently waiting for the page to be faulted in, for each page read. .Sh RETURN VALUES -If it successfully reads +If it successfully reads .Fa m[reqpage] , .Fn VOP_GETPAGES returns diff --git a/share/man/man9/accept_filter.9 b/share/man/man9/accept_filter.9 index 105be63..af9e888 100644 --- a/share/man/man9/accept_filter.9 +++ b/share/man/man9/accept_filter.9 @@ -61,7 +61,7 @@ of .Sh IMPLEMENTATION NOTES A module that wants to be an accept filter must provide a -.Vt struct accept_filter +.Vt "struct accept_filter" to the system: .Bd -literal struct accept_filter { @@ -76,30 +76,30 @@ struct accept_filter { The module should register it with the function .Fn accept_filt_add , passing a pointer to a -.Fa struct accept_filter , +.Vt "struct accept_filter" , allocated with -.Fn malloc . +.Xr malloc 9 . .Pp The fields of -.Vt struct accept_filter +.Vt "struct accept_filter" are as follows: -.Bl -tag -width accf_callbackXXX -.It Vt accf_name +.Bl -tag -width ".Va accf_callback" +.It Va accf_name Name of the filter; this is how it will be accessed from userland. -.It Fn accf_callback +.It Va accf_callback The callback that the kernel will do once the connection is established. It is the same as a socket upcall and will be called when the connection is established and whenever new data arrives on the socket, unless the callback modifies the socket's flags. -.It Fn accf_create +.It Va accf_create Called whenever a .Xr setsockopt 2 installs the filter onto a listening socket. -.It Fn accf_destroy +.It Va accf_destroy Called whenever the user removes the accept filter on the socket. .El .Pp @@ -115,13 +115,13 @@ the kernel will then disallow and further userland use of the filter. The .Fn accept_filt_get function is used internally to locate which accept filter to use via the -.Fn setsockopt +.Xr setsockopt 2 system call. .Pp The .Fn accept_filt_generic_mod_event function provides a simple way to avoid duplication of code -for accept filters which don't use the argument field to load +for accept filters which do not use the argument field to load and unload themselves. This function can be used in the .Vt moduledata_t @@ -146,6 +146,6 @@ and .Pp The accept filter concept was pioneered by .An David Filo -at Yahoo! +at Yahoo!\& and refined to be a loadable module system by -.An Alfred Perlstein. +.An Alfred Perlstein . diff --git a/share/man/man9/buf.9 b/share/man/man9/buf.9 index c122c51..b809b82 100644 --- a/share/man/man9/buf.9 +++ b/share/man/man9/buf.9 @@ -126,10 +126,8 @@ In the case where B_DELWRI is not set, the underlying dirty pages are still properly marked as dirty and the buffer can be completely freed without losing that clean/dirty state information. -.Po -XXX do we have to check other flags in -regards to this situation ??? -.Pc +(XXX do we have to check other flags in +regards to this situation ???) .Pp The kernel reserves a portion of its KVM space to hold VM Buffer's data maps. diff --git a/share/man/man9/bus_alloc_resource.9 b/share/man/man9/bus_alloc_resource.9 index b0c151b..c6865b5 100644 --- a/share/man/man9/bus_alloc_resource.9 +++ b/share/man/man9/bus_alloc_resource.9 @@ -136,7 +136,7 @@ activate resource atomically. .It Dv RF_SHAREABLE resource permits contemporaneous sharing. It should always be set unless you know that the resource cannot be shared. -It is the bus driver's task to filter out the flag if the bus doesn't +It is the bus driver's task to filter out the flag if the bus does not support sharing. For example, .Xr pccard 4 diff --git a/share/man/man9/cd.9 b/share/man/man9/cd.9 index f86344b..96a4504 100644 --- a/share/man/man9/cd.9 +++ b/share/man/man9/cd.9 @@ -43,7 +43,7 @@ and WORM drives .Tn ( SCSI type 4) that support CDROM type commands. -Some drives don't behave as the driver expects. +Some drives do not behave as the driver expects. See the .Sx QUIRKS section for information on possible flags. @@ -91,16 +91,14 @@ determine whether the drive in question needs 10 byte commands. First, it issues a CAM Path Inquiry command to determine whether the protocol that the drive speaks typically only allows 10 byte commands. -.Po -ATAPI and USB +(ATAPI and USB are two prominent examples of protocols where you generally only want to -send 10 byte commands. -.Pc +send 10 byte commands.) Then, if it gets an ILLEGAL REQUEST error back from a 6 byte MODE SENSE or MODE SELECT command, it attempts to send the 10 byte version of the command instead. The only reason you would need a -quirk is if your drive uses a protocol (e.g. +quirk is if your drive uses a protocol (e.g., .Tn SCSI ) that typically doesn't have a problem with 6 byte commands. .El diff --git a/share/man/man9/copy.9 b/share/man/man9/copy.9 index 58ac263..b6b975f 100644 --- a/share/man/man9/copy.9 +++ b/share/man/man9/copy.9 @@ -94,12 +94,10 @@ to kernel-space address The number of bytes actually copied, including the terminating NUL, is returned in .Fa *done -.Po -if +(if .Fa done is -.No non- Ns Dv NULL -.Pc . +.No non- Ns Dv NULL ) . .It Fn copyinstr Copies a NUL-terminated string, at most .Fa len @@ -110,21 +108,19 @@ to kernel-space address The number of bytes actually copied, including the terminating NUL, is returned in .Fa *done -.Po -if +(if .Fa done is -.No non- Ns Dv NULL Ns -.Pc . +.No non- Ns Dv NULL ) . .\" .It Fn copyoutstr .\" Copies a NUL-terminated string, at most .\" bytes long, from kernel-space address -.\" .Pa kaddr +.\" .Fa kaddr .\" to user-space address -.\" .Pa uaddr . +.\" .Fa uaddr . .\" The number of bytes actually copied, including the terminating .\" NUL, is returned in -.\" .Pa *done . +.\" .Fa *done . .El .Sh RETURN VALUES The diff --git a/share/man/man9/device_add_child.9 b/share/man/man9/device_add_child.9 index 04e026f..68877ad 100644 --- a/share/man/man9/device_add_child.9 +++ b/share/man/man9/device_add_child.9 @@ -96,10 +96,10 @@ is used, then the new child will be added as if its order was zero. .Pp When adding a device in the context of .Xr DEVICE_IDENTIFY 9 -routine, some care must be taken to ensure that the device hasn't +routine, some care must be taken to ensure that the device has not already been added to the tree. Because the device name and -.Ft devclass_t +.Vt devclass_t are associated at probe time (not child addition time), previous instances of the driver (say in a module that was later unloaded) may have already added the instance. diff --git a/share/man/man9/mac.9 b/share/man/man9/mac.9 index f8423ab..a6b3410 100644 --- a/share/man/man9/mac.9 +++ b/share/man/man9/mac.9 @@ -218,7 +218,7 @@ Sub-contracted staff include: .An Dag-Erling Sm\(/orgrav . .Pp Additional contributors include: -.Sn Pawel Dawidek , +.An Pawel Dawidek , .An Chris Faulhaber , .An Ilmar Habibulin , .An Mike Halderman , diff --git a/share/man/man9/mutex.9 b/share/man/man9/mutex.9 index 0d2ac45..2f8ec7d 100644 --- a/share/man/man9/mutex.9 +++ b/share/man/man9/mutex.9 @@ -334,7 +334,7 @@ This check should only be made if the running thread already owns The .Fn mtx_assert function allows assertions specified in -.Ar what +.Fa what to be made about .Fa mutex . If the assertions are not true and the kernel is compiled with @@ -499,8 +499,8 @@ No locks are needed when calling these functions. .Sh SEE ALSO .Xr condvar 9 , .Xr msleep 9 , -.Xr MUTEX_PROFILING 9 , .Xr mtx_pool 9 , +.Xr MUTEX_PROFILING 9 , .Xr panic 9 , .Xr sema 9 , .Xr sx 9 diff --git a/share/man/man9/pfil.9 b/share/man/man9/pfil.9 index ac73e97..4d0cded 100644 --- a/share/man/man9/pfil.9 +++ b/share/man/man9/pfil.9 @@ -27,6 +27,7 @@ .\" SUCH DAMAGE. .\" .\" $FreeBSD$ +.\" .Dd September 8, 2003 .Dt PFIL 9 .Os @@ -49,9 +50,9 @@ .Fn pfil_head_register "struct pfil_head *head" .Ft int .Fn pfil_head_unregister "struct pfil_head *head" -.Ft struct pfil_head * +.Ft "struct pfil_head *" .Fn pfil_head_get "int af" "u_long dlt" -.Ft struct packet_filter_hook * +.Ft "struct packet_filter_hook *" .Fn pfil_hook_get "int dir" "struct pfil_head *head" .Ft void .Fn pfil_add_hook "int (*func)()" "void *arg" "int flags" "struct pfil_head *" @@ -71,9 +72,12 @@ transformations. .Pp Packet filtering points are registered with .Fn pfil_head_register . -Filtering points are identified by a key (void *) and a data link type -(int) in the -.Em pfil_head +Filtering points are identified by a key +.Pq Vt "void *" +and a data link type +.Pq Vt int +in the +.Vt pfil_head structure. Packet filters use the key and data link type to look up the filtering point with which they register themselves. @@ -103,11 +107,18 @@ When a filter is invoked, the packet appears just as if it .Dq came off the wire . That is, all protocol fields are in network byte order. The filter is called with its specified argument, the pointer to the -pointer to the mbuf containing the packet, the pointer to the network -interface that the packet is traversing, and the direction (PFIL_IN -or PFIL_OUT) that the packet is traveling. -The filter may change which mbuf the mbuf ** argument references. -The filter returns an errno if the packet processing is to stop, or 0 +pointer to the +.Vt mbuf +containing the packet, the pointer to the network +interface that the packet is traversing, and the direction +.Dv ( PFIL_IN +or +.Dv PFIL_OUT ) +that the packet is traveling. +The filter may change which mbuf the +.Vt "mbuf\ **" +argument references. +The filter returns an error (errno) if the packet processing is to stop, or 0 if the processing is to continue. If the packet processing is to stop, it is the responsibility of the filter to free the packet. @@ -115,20 +126,28 @@ filter to free the packet. The .Nm interface is enabled in the kernel via the -.Sy PFIL_HOOKS +.Dv PFIL_HOOKS option. .Sh RETURN VALUES If successful, -.Fn pfil_head_get -returns the pfil_head structure for the given key/dlt. -.Fn pfil_add_hook +.Fn pfil_head_get +returns the +.Vt pfil_head +structure for the given key/dlt. +The +.Fn pfil_add_hook and .Fn pfil_remove_hook -return 0 if successful. If called with flag PFIL_WAITOK, +functions +return 0 if successful. +If called with flag +.Dv PFIL_WAITOK , .Fn pfil_remove_hook is expected to always succeed. .Pp +The .Fn pfil_head_unregister +function might sleep! .Sh HISTORY The @@ -138,7 +157,7 @@ interface first appeared in The .Nm input and output lists were originally implemented as -.Fd \*[Lt]sys/queue.h\*[Gt] +.In sys/queue.h .Dv LIST structures; however this was changed in @@ -166,19 +185,29 @@ as well as be less IP-centric. Fine-grained locking was added in .Fx 5.2 . .Sh BUGS +The .Fn pfil_hook_get +function is only safe for internal use. .Pp -FreeBSD implements only hooks for AF_INET and AF_INET6. +.Fx +implements only hooks for +.Dv AF_INET +and +.Dv AF_INET6 . Packets diverted through these hooks have data in host byte order contrary to the above statements. .Pp The .Xr bridge 4 -diverts inbound AF_INET traffic, but contrary to the above +diverts inbound +.Dv AF_INET +traffic, but contrary to the above statements, the data is provided in host byte order. .Pp -When a pfil_head is being modified no traffic is diverted +When a +.Vt pfil_head +is being modified, no traffic is diverted (to avoid deadlock). This means that unwanted traffic may flow for a short period of time. diff --git a/share/man/man9/style.9 b/share/man/man9/style.9 index cc3727c..f64e3c5 100644 --- a/share/man/man9/style.9 +++ b/share/man/man9/style.9 @@ -120,7 +120,7 @@ Do not use files in for files in the kernel. .Pp Leave a blank line before the next group, the -.Pa /usr/include +.Pa /usr/include files, which should be sorted alphabetically by name. .Bd -literal @@ -247,17 +247,20 @@ is treated as #endif /* !COMPAT_43 */ .Ed .Pp -The project is slowly moving to use the -.St -isoC-99 +The project is slowly moving to use the +.St -isoC-99 unsigned integer identifiers of the form -.Ic uintXX_t -in preference to the older BSD-style integer identifiers of the form -.Ic u_intXX_t . +.Vt uintXX_t +in preference to the older +.Bx Ns -style +integer identifiers of the form +.Vt u_intXX_t . New code should use the former, and old code should be converted to the new form if other major work is being done in that area and -there's no overriding reason to prefer the older BSD-style. +there is no overriding reason to prefer the older +.Bx Ns -style . Like white-space commits, care should be taken in making -.Ic uintXX_t +.Vt uintXX_t only commits. .Pp Enumeration values are all uppercase. diff --git a/share/man/man9/sx.9 b/share/man/man9/sx.9 index 0ff91c7..c07dc9d 100644 --- a/share/man/man9/sx.9 +++ b/share/man/man9/sx.9 @@ -131,9 +131,9 @@ and the .Fn sx_assert function tests -.Ar sx +.Fa sx for the assertions specified in -.Ar what +.Fa what , and panics if they are not met. The following assertions are supported: .Bl -tag -width ".Dv SX_UNLOCKED" diff --git a/share/man/man9/taskqueue.9 b/share/man/man9/taskqueue.9 index e7d6b82..ef323ff 100644 --- a/share/man/man9/taskqueue.9 +++ b/share/man/man9/taskqueue.9 @@ -52,7 +52,6 @@ struct task { task_fn ta_func; /* task handler */ void *ta_context; /* argument for handler */ }; - .Ed .Ft struct taskqueue * .Fn taskqueue_create "const char *name" "int mflags" "taskqueue_enqueue_fn enqueue" "void *context" @@ -197,7 +196,7 @@ The thread taskqueue runs in a kernel thread context, and tasks run from this thread do not run under the Giant kernel lock. If the caller wants to run under Giant, he should explicitly acquire and release Giant in his taskqueue handler routine. - +.Pp To use these queues, call .Fn taskqueue_enqueue diff --git a/share/man/man9/time.9 b/share/man/man9/time.9 index 05560d5..a5bf973 100644 --- a/share/man/man9/time.9 +++ b/share/man/man9/time.9 @@ -93,11 +93,9 @@ It is set from .Va time at boot, and is updated by the periodic timer interrupt. -.Po -It is +(It is not updated by -.Xr settimeofday 2 . -.Pc +.Xr settimeofday 2 . ) .Pp All of these variables contain times expressed in seconds and microseconds since midnight (0 hour), diff --git a/share/man/man9/timeout.9 b/share/man/man9/timeout.9 index beb2553..94325ce 100644 --- a/share/man/man9/timeout.9 +++ b/share/man/man9/timeout.9 @@ -103,7 +103,9 @@ which can be used in conjunction with the function to request that a scheduled timeout be canceled. The .Fn timeout -call is the old style and new code should use the callout_* functions. +call is the old style and new code should use the +.Fn callout_* +functions. .Pp The function .Fn callout_handle_init @@ -144,7 +146,9 @@ The behavior of calling untimeout without a previously initialized handle is undefined. The .Fn untimeout -call is the old style and new code should use the callout_* functions. +call is the old style and new code should use the +.Fn callout_* +functions. .Pp As handles are recycled by the system, it is possible (although unlikely) that a handle from one invocation of @@ -176,7 +180,7 @@ The function .Fn callout_init initializes a callout so it can be passed to .Fn callout_stop , -.Fn callout_drain +.Fn callout_drain or .Fn callout_reset without any side effects. diff --git a/share/man/man9/vm_page_alloc.9 b/share/man/man9/vm_page_alloc.9 index 2062dd3..c364488 100644 --- a/share/man/man9/vm_page_alloc.9 +++ b/share/man/man9/vm_page_alloc.9 @@ -89,6 +89,7 @@ is no backing VM object. This is typically used to allocate pages within the kernel virtual address space. .El +.El .Sh RETURN VALUES The .Vt vm_page_t diff --git a/share/man/man9/vslock.9 b/share/man/man9/vslock.9 index 39f7a93..5476271 100644 --- a/share/man/man9/vslock.9 +++ b/share/man/man9/vslock.9 @@ -95,3 +95,4 @@ its per-process locked memory limit. .It Bq Er EFAULT Some portion of the indicated address range is not allocated. There was an error faulting/mapping a page. +.El -- cgit v1.1