diff options
Diffstat (limited to 'share/man')
264 files changed, 1570 insertions, 1570 deletions
diff --git a/share/man/man1/builtin.1 b/share/man/man1/builtin.1 index a13d793..5701deb 100644 --- a/share/man/man1/builtin.1 +++ b/share/man/man1/builtin.1 @@ -137,7 +137,7 @@ Note that, in the case of builtin commands, the command is executed in a subshell if it occurs as any component of a pipeline except the last. .Pp -If a command specified to the shell contains a slash +If a command specified to the shell contains a slash .Dq \&/ , the shell will not execute a builtin command, even if the last component of the specified command matches the name of a builtin command. diff --git a/share/man/man3/intro.3 b/share/man/man3/intro.3 index b32d9e6..a58b093 100644 --- a/share/man/man3/intro.3 +++ b/share/man/man3/intro.3 @@ -98,7 +98,7 @@ a number of system call interfaces provided in previous releases of have been included for source code compatibility. Use of these routines should, for the most part, be avoided. The manual page entry for each compatibility routine -indicates the proper interface to use. +indicates the proper interface to use. .It Xr libkvm Pq Fl l Ns Ar kvm Functions used to access kernel memory are in this library. They can be used against both a running system and a crash dump. @@ -121,11 +121,11 @@ flag. .\" .It Xr libom .\" Old math library. .\" .It Xr libplot Pq Fl l Ns Ar plot -.\" Device independent plotting functions. +.\" Device independent plotting functions. .\" (See .\" .Xr plot 3 . ) .\" .It Xr libplotf77 Pq Fl l Ns Ar plotf77 -.\" The device independent plotting functions for fortran. +.\" The device independent plotting functions for fortran. .\" (See .\" .Xr plot 3 . ) .\" .It Xr libresolv Pq Fl l Ns Ar resolv diff --git a/share/man/man3/pthread.3 b/share/man/man3/pthread.3 index 201523e..15bb724 100644 --- a/share/man/man3/pthread.3 +++ b/share/man/man3/pthread.3 @@ -370,7 +370,7 @@ stack and optionally invoke it. .Ft void .Fn pthread_cleanup_push "void (*routine)(void *)" "void *routine_arg" .Xc -Push the specified cancellation cleanup handler onto the calling thread's +Push the specified cancellation cleanup handler onto the calling thread's cancellation stack. .El .Sh INSTALLATION diff --git a/share/man/man3/queue.3 b/share/man/man3/queue.3 index c2d08e9..613cb1b 100644 --- a/share/man/man3/queue.3 +++ b/share/man/man3/queue.3 @@ -344,7 +344,7 @@ removes the element from the head of the list. For optimum efficiency, elements being removed from the head of the list should explicitly use -this macro instead of the generic +this macro instead of the generic .Fa SLIST_REMOVE macro. .Pp @@ -488,7 +488,7 @@ The macro removes the element at the head of the tail queue. For optimum efficiency, elements being removed from the head of the tail queue should -use this macro explicitly rather than the generic +use this macro explicitly rather than the generic .Fa STAILQ_REMOVE macro. .Pp diff --git a/share/man/man3/stdarg.3 b/share/man/man3/stdarg.3 index 1ec79c7..19cdb0a 100644 --- a/share/man/man3/stdarg.3 +++ b/share/man/man3/stdarg.3 @@ -99,11 +99,11 @@ macro expands to an expression that has the type and value of the next argument in the call. The parameter .Fa ap -is the +is the .Em va_list Fa ap initialized by .Fn va_start . -Each call to +Each call to .Fn va_arg modifies .Fa ap @@ -111,7 +111,7 @@ so that the next call returns the next argument. The parameter .Fa type is a type name specified so that the type of a pointer to an -object that has the specified type can be obtained simply by +object that has the specified type can be obtained simply by adding a * to .Fa type . @@ -124,9 +124,9 @@ random errors will occur. .Pp The first use of the .Fn va_arg -macro after that of the +macro after that of the .Fn va_start -macro returns the argument after +macro returns the argument after .Fa last . Successive invocations return the values of the remaining arguments. @@ -134,7 +134,7 @@ arguments. The .Fn va_end macro handles a normal return from the function whose variable argument -list was initialized by +list was initialized by .Fn va_start . .Pp The @@ -185,7 +185,7 @@ These macros are .Em not compatible with the historic macros they replace. A backward compatible version can be found in the include -file +file .Aq Pa varargs.h . .Sh BUGS Unlike the diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index d5e3323..d42b6f1 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -182,7 +182,7 @@ MAN= aac.4 \ xl.4 \ xpt.4 \ yp.4 \ - zero.4 + zero.4 MLINKS= ata.4 acd.4 ata.4 ad.4 ata.4 afd.4 ata.4 ast.4 MLINKS+=bktr.4 brooktree.4 diff --git a/share/man/man4/aac.4 b/share/man/man4/aac.4 index 2a7577d..07d35df 100644 --- a/share/man/man4/aac.4 +++ b/share/man/man4/aac.4 @@ -35,10 +35,10 @@ .Cd device pci .Cd device aac .Sh DESCRIPTION -The +The .Nm driver provides support for the Adaptec AAC family SCSI Ultra2 and Ultra160 -RAID controllers. +RAID controllers. These controllers support RAID 0, 1, 5, 10, and volume sets. They have four channels in the add-in version or 1-2 channels in the motherboard integrated version, @@ -64,27 +64,27 @@ Dell PERC 3/Di Access to RAID containers is available via the .Pa /dev/aacd? device nodes. -Individual drives cannot be accessed +Individual drives cannot be accessed unless they are part of a container or volume set, -and non-fixed disks cannot be accessed. +and non-fixed disks cannot be accessed. Containers can be configured by using -either the on-board BIOS utility of the card, +either the on-board BIOS utility of the card, or a Linux-based management application. .Pp The .Pa /dev/aac? -device nodes provides access to the management interface of the controller. +device nodes provides access to the management interface of the controller. One node exists per installed card. Compiling the driver with the .Dv AAC_COMPAT_LINUX -option enables the Linux-compatible +option enables the Linux-compatible +.Xr ioctl 2 +interface for the management device. +The .Xr ioctl 2 -interface for the management device. -The -.Xr ioctl 2 -command set is heavily tailored to existing linux applications. +command set is heavily tailored to existing linux applications. Native -.Xr ioctl 2 +.Xr ioctl 2 support is not present at this time. .Sh FILES .Bl -tag -width /boot/kernel/aac.ko -compact @@ -98,10 +98,10 @@ aac loadable module .Sh DIAGNOSTICS Compiling with .Dv AAC_DEBUG -set to a number between 0 and 3 +set to a number between 0 and 3 will enable increasingly verbose debug messages. .Pp -The adapter can send status and alert messages asynchronously +The adapter can send status and alert messages asynchronously to the driver. These messages are printed on the system console, and are also queued for retrieval by a management application. .Sh SEE ALSO @@ -123,16 +123,16 @@ and is .Sh BUGS This driver has not been tested on Alpha, though it should work. .Pp -The controller is not actually paused on suspend/resume. +The controller is not actually paused on suspend/resume. .Pp -Adapter-initiated messages are not returned back to the controller, +Adapter-initiated messages are not returned back to the controller, possibly causing a resource leak on the controller. .Pp Unloading and reloading the driver as a kernel loadable module without rebooting the system is strongly discouraged. .Pp -Only the Linux-compatible -.Xr ioctl 2 +Only the Linux-compatible +.Xr ioctl 2 interface is implemented at this time. This is not a bug, but native .Xr ioctl 2 diff --git a/share/man/man4/adv.4 b/share/man/man4/adv.4 index 04f6a23..320eab8 100644 --- a/share/man/man4/adv.4 +++ b/share/man/man4/adv.4 @@ -80,7 +80,7 @@ ABP930U PCI No 20MHz 16 ABP930UA PCI No 20MHz 16 ABP960 PCI No 10MHz 16 ABP960U PCI No 20MHz 16 -.El +.El .Pp Footnotes: .Bl -enum -compact @@ -97,7 +97,7 @@ This board has been sold by SIIG as the i542 SpeedMaster. .It This board has been sold by SIIG as the Fast SCSI Pro PCI. .El -.Ed +.Ed .Pp .Bd -ragged -offset indent .Bl -column "ABP510/5150 " "ISA PnP " "Yes " "10MHz " Commands @@ -113,8 +113,8 @@ ABP940U PCI No 20MHz 240 ABP3960UA PCI No 20MHz 240 ABP970 PCI No 10MHz 240 ABP970U PCI No 20MHz 240 -.El -.Ed +.El +.Ed .Pp .Bd -ragged -offset indent .Bl -column "ABP510/5150 " "ISA PnP " "Yes " "10MHz " "Commands " "Channels " @@ -127,8 +127,8 @@ ABP950 PCI No 10MHz 240 2 ABP980 PCI No 10MHz 240 4 ABP980U PCI No 20MHz 240 4 ABP[3]980UA PCI No 20MHz 16 4 -.El -.Ed +.El +.Ed .Pp For ISA or Vesa Local Bus adapters, one kernel config entry is required for every card to be attached by the system. Specific values for the port @@ -139,7 +139,7 @@ possible port address locations and attaches to the first unattached card it finds. The possible port addresses for these card are 0x110, 0x130, 0x150, 0x190, 0x210, 0x230, 0x250, and 0x330. .Pp -Per target configuration performed in the +Per target configuration performed in the .Tn AdvanceWare menu, which is accessible at boot, is honored by this driver. diff --git a/share/man/man4/adw.4 b/share/man/man4/adw.4 index 8611919..16da918 100644 --- a/share/man/man4/adw.4 +++ b/share/man/man4/adw.4 @@ -55,7 +55,7 @@ Both chips support, synchronous transfers 16bit transfers, tagged queueing, and up to 253 concurrent SCSI transactions. .Pp -Per target configuration performed in the +Per target configuration performed in the .Tn AdvanceWare menu, which is accessible at boot, is honored by this driver. diff --git a/share/man/man4/aha.4 b/share/man/man4/aha.4 index d0a47a6..4d7be20 100644 --- a/share/man/man4/aha.4 +++ b/share/man/man4/aha.4 @@ -53,7 +53,7 @@ specified. If wildcard values are used, the driver will query the device for its current settings and use those. If the port address is a wildcard, the driver consults an internal table of possible port address locations and attaches to the first unattached card it finds. The possible -port addresses for this card are 0x330, 0x334, 0x230, 0x234, 0x130, and +port addresses for this card are 0x330, 0x334, 0x230, 0x234, 0x130, and 0x134. .Sh SEE ALSO .Xr ahb 4 , diff --git a/share/man/man4/ahb.4 b/share/man/man4/ahb.4 index bc3c9c5..de8b747 100644 --- a/share/man/man4/ahb.4 +++ b/share/man/man4/ahb.4 @@ -38,7 +38,7 @@ .Sh DESCRIPTION This driver provides access to the .Tn SCSI -bus connected to an Adaptec +bus connected to an Adaptec 174x hostadapter in .Dq Em enhanced mode. diff --git a/share/man/man4/ahc.4 b/share/man/man4/ahc.4 index 649291a..3e8ad58 100644 --- a/share/man/man4/ahc.4 +++ b/share/man/man4/ahc.4 @@ -122,21 +122,21 @@ Most modern motherboards perform the initialization correctly and work fine with this option enabled. .Pp Individual controllers may be configured to operate in the target role -through the +through the .Dq Dv AHC_TMODE_ENABLE configuration option. The value assigned to this option should be a bitmap of all units where target mode is desired. -For example, a value of 0x25, would enable target mode on units 0, 2, and 5. +For example, a value of 0x25, would enable target mode on units 0, 2, and 5. .Pp -Per target configuration performed in the +Per target configuration performed in the .Tn SCSI-Select menu, accessible at boot -in +in .No non- Ns Tn EISA models, -or through an +or through an .Tn EISA -configuration utility for +configuration utility for .Tn EISA models, is honored by this driver. @@ -152,7 +152,7 @@ Twin Channel controllers, the primary channel selection. For systems that store non-volatile settings in a system specific manner rather than a serial eeprom directly connected to the aic7xxx controller, -the +the .Tn BIOS must be enabled for the driver to access this information. This restriction applies to all @@ -163,8 +163,8 @@ Note that I/O addresses are determined automatically by the probe routines, but care should be taken when using a 284x .Pq Tn VESA No local bus controller in an -.Tn EISA -system. The jumpers setting the I/O area for the 284x should match the +.Tn EISA +system. The jumpers setting the I/O area for the 284x should match the .Tn EISA slot into which the card is inserted to prevent conflicts with other .Tn EISA @@ -185,7 +185,7 @@ aic7770 10 EISA/VL 10MHz 16Bit 4 1 aic7850 10 PCI/32 10MHz 8Bit 3 aic7860 10 PCI/32 20MHz 8Bit 3 aic7870 10 PCI/32 10MHz 16Bit 16 -aic7880 10 PCI/32 20MHz 16Bit 16 +aic7880 10 PCI/32 20MHz 16Bit 16 aic7890 20 PCI/32 40MHz 16Bit 16 3 4 5 6 7 8 aic7891 20 PCI/64 40MHz 16Bit 16 3 4 5 6 7 8 aic7892 20 PCI/64 80MHz 16Bit 16 3 4 5 6 7 8 @@ -194,7 +194,7 @@ aic7895C 15 PCI/32 20MHz 16Bit 16 2 3 4 5 8 aic7896 20 PCI/32 40MHz 16Bit 16 2 3 4 5 6 7 8 aic7897 20 PCI/64 40MHz 16Bit 16 2 3 4 5 6 7 8 aic7899 20 PCI/64 80MHz 16Bit 16 2 3 4 5 6 7 8 -.El +.El .Pp .Bl -enum -compact .It @@ -257,7 +257,7 @@ Some Quantum drives (at least the Empire 2100 and 1080s) will not run on an Rev B in synchronous mode at 10MHz. Controllers with this problem have a 42 MHz clock crystal on them and run slightly above 10MHz. This confuses the drive and hangs the bus. Setting a maximum synchronous negotiation rate -of 8MHz in the +of 8MHz in the .Tn SCSI-Select utility will allow normal operation. .Pp diff --git a/share/man/man4/amd.4 b/share/man/man4/amd.4 index 43da3d2..71bdfad 100644 --- a/share/man/man4/amd.4 +++ b/share/man/man4/amd.4 @@ -9,7 +9,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -39,7 +39,7 @@ driver provides support for the based SCSI cards, such as Tekram DC390 or Tekram DC390T. .Sh SEE ALSO .Xr cd 4 , -.Xr ch 4 , +.Xr ch 4 , .Xr da 4 , .Xr intro 4 , .Xr sa 4 , diff --git a/share/man/man4/amr.4 b/share/man/man4/amr.4 index 8a05d29..4f75530 100644 --- a/share/man/man4/amr.4 +++ b/share/man/man4/amr.4 @@ -9,7 +9,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. diff --git a/share/man/man4/an.4 b/share/man/man4/an.4 index 4553ceb..56df198 100644 --- a/share/man/man4/an.4 +++ b/share/man/man4/an.4 @@ -104,7 +104,7 @@ command. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ancontrol 8 , .Xr ifconfig 8 .Sh HISTORY diff --git a/share/man/man4/asr.4 b/share/man/man4/asr.4 index 258b97f..889338d 100644 --- a/share/man/man4/asr.4 +++ b/share/man/man4/asr.4 @@ -89,7 +89,7 @@ and was ported over to the CAM layer represented in 4.0. The .Nm driver was kindly donated by Adaptec -and is maintained by +and is maintained by .An Mark Salyzyn Aq mark_salyzyn@adaptec.com . This manual page was written by .An Mark Salyzyn diff --git a/share/man/man4/ata.4 b/share/man/man4/ata.4 index e173eed..06b04a2 100644 --- a/share/man/man4/ata.4 +++ b/share/man/man4/ata.4 @@ -115,7 +115,7 @@ Ultra DMA 33 (UDMA2), 33 MB/sec Ultra DMA 66 (UDMA4), 66 MB/sec .It Promise Ultra/Fasttrak-100 Ultra DMA 100 (UDMA5), 100 MB/sec -.It ServerWorks ROSB4 +.It ServerWorks ROSB4 Ultra DMA 33 (UDMA2), 33 MB/sec .It SiS 5591 Ultra DMA 33 (UDMA2), 33 MB/sec @@ -186,7 +186,7 @@ to use a special 80 conductor cable, and the driver tries to determine if you have such a cable attached before setting UDMA4 mode. .Pp -The use of UDMA4(66MHz) and higher together with non-UDMA4 devices on +The use of UDMA4(66MHz) and higher together with non-UDMA4 devices on the same ATA channel is not recommended, unless they are run at the non-UDMA4 device's lower speed. The driver has been designed to handle that kind of setup but lots of diff --git a/share/man/man4/atkbd.4 b/share/man/man4/atkbd.4 index 9bf5f0b..e9f971f 100644 --- a/share/man/man4/atkbd.4 +++ b/share/man/man4/atkbd.4 @@ -46,8 +46,8 @@ driver, provides access to the AT 84 keyboard or the AT enhanced keyboard which is connected to the AT keyboard controller. .Pp This driver is required for the console drivers -.Xr syscons 4 -and +.Xr syscons 4 +and .Xr pcvt 4 . .Pp There can be only one @@ -92,7 +92,7 @@ Numpad 5 (without NumLock) .It 55 Right Arrow and Numpad 6 (without NumLock) .It 56 -Numpad + +Numpad + .It 57 End and Numpad 1 (without NumLock) .It 58 @@ -158,12 +158,12 @@ It may be useful for laptop computers whose function keys have special functions and these functions are forgotten when the keyboard is reset. .It bit 2 (ALT_SCANCODESET) -Certain keyboards, such as those on some ThinkPad models, behave +Certain keyboards, such as those on some ThinkPad models, behave like the old XT keyboard and require this option. .El .\".Sh FILES .Sh EXAMPLES -The +The .Nm driver requires the keyboard controller .Nm atkbdc . diff --git a/share/man/man4/atkbdc.4 b/share/man/man4/atkbdc.4 index b3ca8cd..1aba04d 100644 --- a/share/man/man4/atkbdc.4 +++ b/share/man/man4/atkbdc.4 @@ -47,7 +47,7 @@ This controller is required for the keyboard driver and the PS/2 pointing device driver .Nm psm . .Pp -There can be only one +There can be only one .Nm device configured in the system. .Sh DRIVER CONFIGURATION @@ -55,7 +55,7 @@ device configured in the system. The following kernel configuration options can be used to control the .Nm driver. -They may be set in the kernel configuration file +They may be set in the kernel configuration file .Pq see Xr config 8 . .Bl -tag -width MOUSE .It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y @@ -76,16 +76,16 @@ wait before eventually giving up -- the driver will wait * .Fa Y msecs at most. -If the drivers seem unable to detect +If the drivers seem unable to detect devices, you may want to increase these values. The default values are -200 msec for +200 msec for .Fa X and 5 for .Fa Y . .It Em KBDIO_DEBUG=N -Sets the debug level to +Sets the debug level to .Fa N . The default value is zero, which suppresses all debugging output. .El diff --git a/share/man/man4/aue.4 b/share/man/man4/aue.4 index 3f34871..fea6e76 100644 --- a/share/man/man4/aue.4 +++ b/share/man/man4/aue.4 @@ -128,7 +128,7 @@ The driver failed to allocate an mbuf for the receiver ring. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Rs diff --git a/share/man/man4/awi.4 b/share/man/man4/awi.4 index 2821326..9af5b06 100644 --- a/share/man/man4/awi.4 +++ b/share/man/man4/awi.4 @@ -2,8 +2,8 @@ .\" $FreeBSD$ .\" .Dd October 31, 1999 -.Dt AWI 4 -.Os +.Dt AWI 4 +.Os .Sh NAME .Nm awi .Nd "AMD PCnetMobile IEEE 802.11 PCMCIA wireless network driver" @@ -68,7 +68,7 @@ driver include: 2Mbps Direct Sequence PCCARD adapter .El .Pp -The original Xircom Netwave AirSurfer is supported by the +The original Xircom Netwave AirSurfer is supported by the .Xr cnw 4 driver. .Sh MEDIA SELECTION @@ -129,7 +129,7 @@ Doesn't create IBSS itself. .Xr arp 4 , .Xr cnw 4 , .Xr ifmedia 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr pcmcia 4 , .Xr wi 4 , .Xr ifconfig 8 diff --git a/share/man/man4/bktr.4 b/share/man/man4/bktr.4 index 9825f92..249bfc9 100644 --- a/share/man/man4/bktr.4 +++ b/share/man/man4/bktr.4 @@ -24,11 +24,11 @@ capture on low cost, high performance boards. The driver based on the Matrox Meteor driver and uses the same API. The bktr driver should support most video cards based on the .Em "Brooktree Bt848/849/878/879 Video Capture Chip" . -The driver also supports +The driver also supports .Em FM Radio if the Tuner supports it. .Pp -Specifically, the following cards are known to work: +Specifically, the following cards are known to work: .Bd -unfilled -offset indent .Em Hauppage Wincast TV and WinTV/PCI .Em STB TV PCI Television Tuner diff --git a/share/man/man4/blackhole.4 b/share/man/man4/blackhole.4 index 9e1b0c8..628e06e 100644 --- a/share/man/man4/blackhole.4 +++ b/share/man/man4/blackhole.4 @@ -16,7 +16,7 @@ .Dt BLACKHOLE 4 .Os .Sh NAME -.Nm blackhole +.Nm blackhole .Nd a .Xr sysctl 8 MIB for manipulating behaviour in respect of refused TCP or UDP connection @@ -38,7 +38,7 @@ Normal behaviour, when a TCP SYN segment is received on a port where there is no socket accepting connections, is for the system to return a RST segment, and drop the connection. The connecting system will see this as a "Connection reset by peer". By turning the TCP black -hole MIB on to a numeric value of one, the incoming SYN segment +hole MIB on to a numeric value of one, the incoming SYN segment is merely dropped, and no RST is sent, making the system appear as a blackhole. By setting the MIB value to two, any segment arriving on a closed port is dropped without returning a RST. This provides @@ -76,7 +76,7 @@ but should be used together with other security mechanisms. .An Geoffrey M. Rehmet .Sh HISTORY The TCP and UDP -.Nm +.Nm MIBs first appeared in .Fx 4.0 . diff --git a/share/man/man4/bt.4 b/share/man/man4/bt.4 index d45d2ff..f5128fe 100644 --- a/share/man/man4/bt.4 +++ b/share/man/man4/bt.4 @@ -111,12 +111,12 @@ patch kit. The driver was rewritten by to take advantage of new board features and work with the CAM SCSI framework in .Fx 3.0 . .Pp -Special thanks to +Special thanks to .An Leonard N. Zubkoff for writing such a complete and well documented Mylex/BusLogic MultiMaster driver for Linux. Support in this driver for the wide range of MultiMaster controllers and firmware revisions, with their otherwise undocumented quirks, -would not have been possible without his efforts. +would not have been possible without his efforts. .Sh FILES .Bl -tag -width /usr/share/man0/template.doc -compact .It Pa sys/dev/buslogic/bt.c diff --git a/share/man/man4/cd.4 b/share/man/man4/cd.4 index 1ff58cc..9c6b471 100644 --- a/share/man/man4/cd.4 +++ b/share/man/man4/cd.4 @@ -39,38 +39,38 @@ .Sh DESCRIPTION The .Nm -driver provides support for a +driver provides support for a .Tn SCSI .Tn CD-ROM (Compact Disc-Read Only Memory) drive. -In an attempt to look like a regular disk, the +In an attempt to look like a regular disk, the .Nm driver synthesizes a partition table, with one partition covering the entire .Tn CD-ROM . It is possible to modify this partition table using .Xr disklabel 8 , -but it will only last until the +but it will only last until the .Tn CD-ROM is unmounted. -In general the interfaces are similar to those described by -.Xr ad 4 +In general the interfaces are similar to those described by +.Xr ad 4 and .Xr da 4 . .Pp As the .Tn SCSI -adapter is probed during boot, the +adapter is probed during boot, the .Tn SCSI bus is scanned for devices. Any devices found which answer as CDROM -(type 5) or WORM (type 4) type devices will be `attached' to the +(type 5) or WORM (type 4) type devices will be `attached' to the .Nm driver. Prior to .Fx 2.1 , the first device found will be attached as .Li cd0 -the next, +the next, .Li cd1 , etc. Beginning in @@ -84,7 +84,7 @@ The system utility .Xr disklabel 8 may be used to read the synthesized disk label -structure, which will contain correct figures for the size of the +structure, which will contain correct figures for the size of the .Tn CD-ROM should that information be required. .Sh KERNEL CONFIGURATION @@ -93,7 +93,7 @@ Any number of devices may be attached to the system regardless of system configuration as all resources are dynamically allocated. .Sh IOCTLS -The following +The following .Xr ioctl 2 calls which apply to .Tn SCSI @@ -215,7 +215,7 @@ struct ioc_play_msf u_char end_f; }; .Ed -.It Dv CDIOCREADSUBCHANNEL +.It Dv CDIOCREADSUBCHANNEL .Pq Li "struct ioc_read_subchannel" Read information from the subchannel at the location specified by this structure: @@ -236,7 +236,7 @@ struct ioc_read_subchannel { .Ed .It Dv CDIOREADTOCHEADER .Pq Li "struct ioc_toc_header" -Return summary information about the table of contents for the mounted +Return summary information about the table of contents for the mounted .Tn CD-ROM . The information is returned into the following structure: .Bd -literal -offset indent @@ -246,7 +246,7 @@ struct ioc_toc_header { u_char ending_track; }; .Ed -.It Dv CDIOREADTOCENTRYS +.It Dv CDIOREADTOCENTRYS .Pq Li "struct ioc_read_toc_entry" Return information from the table of contents entries mentioned. (Yes, this command name is misspelled.) The argument structure is defined as follows: @@ -308,11 +308,11 @@ Tell the drive to spin-up (-down) the .Tn CD-ROM . .It Dv CDIOCALLOW .It Dv CDIOCPREVENT -Tell the drive to allow (prevent) manual ejection of the +Tell the drive to allow (prevent) manual ejection of the .Tn CD-ROM disc. Not all drives support this feature. .It Dv CDIOCEJECT -Eject the +Eject the .Tn CD-ROM . .It Dv CDIOCCLOSE Tell the drive to close its door and load the media. Not all drives @@ -334,7 +334,7 @@ struct ioc_pitch .Ed .El .Sh NOTES -When a +When a .Tn CD-ROM is changed in a drive controlled by the .Nm @@ -351,13 +351,13 @@ The audio code in the driver only support .Tn SCSI-2 standard audio commands. -Because many +Because many .Tn CD-ROM manufacturers have not followed the standard, there are many .Tn CD-ROM drives for which audio will not work. Some work is planned to support -some of the more common `broken' +some of the more common `broken' .Tn CD-ROM drives; however, this is not yet under way. .Sh CHANGER OPERATION diff --git a/share/man/man4/ch.4 b/share/man/man4/ch.4 index 59fc1fa..da818da 100644 --- a/share/man/man4/ch.4 +++ b/share/man/man4/ch.4 @@ -36,7 +36,7 @@ .Sh DESCRIPTION The .Xr ch -driver provides support for a +driver provides support for a .Em SCSI media changer. It allows many slots of media to be multiplexed between @@ -47,18 +47,18 @@ the media. A SCSI adapter must also be separately configured into the system before a SCSI changer can be configured. .Pp -As the SCSI adapter is probed during boot, the +As the SCSI adapter is probed during boot, the .Em SCSI bus is scanned for devices. Any devices found which answer as 'Changer' -type devices will be 'attached' to the +type devices will be 'attached' to the .Nm driver. In .Fx releases prior to 2.1, the first found will be attached as .Em ch0 -and the next, +and the next, .Em ch1 etc. Beginning in 2.1 it is possible to specify what ch unit a device should @@ -90,7 +90,7 @@ Import/export element (portal). Data transfer element (drive). .El .Pp -The following +The following .Xr ioctl 2 calls apply to the changer. They are defined @@ -174,7 +174,7 @@ ioctl to query the jukebox' status. Perform the \fBINITIALIZE ELEMENT STATUS\fR call on the media changer device. This forces the media changer to update its internal status information with respect to loaded media. It also scans any barcode -labels provided that it has a label reader. The +labels provided that it has a label reader. The .Nm driver's status is not affected by this call. .It Dv CHIOGSTATUS @@ -188,12 +188,12 @@ With each call to .Dv CHIOGSTATUS , the status of one or more elements of one type may be queried. .Pp -The application passes a changer_element_status_request structure to the +The application passes a changer_element_status_request structure to the .Nm driver which contains the following fields: .Bd -literal -offset indent u_int cesr_element_type; -u_int cesr_element_base; +u_int cesr_element_base; u_int cesr_element_count; u_int cesr_flags; struct changer_element_status *cesr_element_status; @@ -204,7 +204,7 @@ base address and number of elements for which information is to be returned in the array of changer_element_status structures pointed to by the cesr_element_status field. The application must allocate enough memory for cesr_element_count status structures (see below). -The cesr_flags can optionally be set to +The cesr_flags can optionally be set to .Dv CESR_VOLTAGS to indicate that volume tag (bar code) information is to be read from the jukebox and returned. @@ -260,7 +260,7 @@ The element supports medium import. Note that not all flags are valid for all element types. .El .Sh NOTES -This version of the +This version of the .Nm driver has been tested with a DEC TZ875 (5 slot, one DLT drive) and a and a Breece Hill Q47 (60 slot, four DLT drives, barcode reader). @@ -275,16 +275,16 @@ element handling, multiple picker operation and other things. .An -nosplit The .Nm -driver was written by +driver was written by .An Jason R. Thorpe Aq thorpej@and.com for And Communications, .Pa http://www.and.com/ . -It was added to the system by +It was added to the system by .An Stefan Grefen Aq grefen@goofy.zdv.uni-mainz.de who apparently had such a device. It was ported to CAM by .An Kenneth Merry Aq ken@FreeBSD.org . -It was updated to support volume tags by +It was updated to support volume tags by .An Hans Huebner Aq hans@artcom.de . .Sh FILES .Bl -tag -width /dev/ch[0-9] -compact diff --git a/share/man/man4/cue.4 b/share/man/man4/cue.4 index fea2e5d..aea1950 100644 --- a/share/man/man4/cue.4 +++ b/share/man/man4/cue.4 @@ -71,7 +71,7 @@ The driver failed to allocate an mbuf for the receiver ring. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY diff --git a/share/man/man4/dc.4 b/share/man/man4/dc.4 index 24892cc..48b10f7 100644 --- a/share/man/man4/dc.4 +++ b/share/man/man4/dc.4 @@ -260,7 +260,7 @@ the card should be configured correctly. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Rs diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4 index bee394f..6952092 100644 --- a/share/man/man4/ddb.4 +++ b/share/man/man4/ddb.4 @@ -1,30 +1,30 @@ -.\" +.\" .\" Mach Operating System .\" Copyright (c) 1991,1990 Carnegie Mellon University .\" All Rights Reserved. -.\" +.\" .\" Permission to use, copy, modify and distribute this software and its .\" documentation is hereby granted, provided that both the copyright .\" notice and this permission notice appear in all copies of the .\" software, derivative works or modified versions, and any portions .\" thereof, and that both notices appear in supporting documentation. -.\" +.\" .\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" .\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR .\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. -.\" +.\" .\" Carnegie Mellon requests users of this software to return to -.\" +.\" .\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU .\" School of Computer Science .\" Carnegie Mellon University .\" Pittsburgh PA 15213-3890 -.\" +.\" .\" any improvements or extensions that they make and grant Carnegie Mellon .\" the rights to redistribute these changes. -.\" +.\" .\" changed a \# to #, since groff choked on it. -.\" +.\" .\" HISTORY .\" ddb.4,v .\" Revision 1.1 1993/07/15 18:41:02 brezak @@ -35,28 +35,28 @@ .\" [92/01/17 14:19:22 jsb] .\" Changes for OSF debugger modifications. .\" [91/12/12 tak] -.\" +.\" .\" Revision 2.5 91/06/25 13:50:22 rpd .\" Added some watchpoint explanation. .\" [91/06/25 rpd] -.\" +.\" .\" Revision 2.4 91/06/17 15:47:31 jsb .\" Added documentation for continue/c, match, search, and watchpoints. .\" I've not actually explained what a watchpoint is; maybe Rich can .\" do that (hint, hint). .\" [91/06/17 10:58:08 jsb] -.\" +.\" .\" Revision 2.3 91/05/14 17:04:23 mrt .\" Correcting copyright -.\" +.\" .\" Revision 2.2 91/02/14 14:10:06 mrt .\" Changed to new Mach copyright .\" [91/02/12 18:10:12 mrt] -.\" +.\" .\" Revision 2.2 90/08/30 14:23:15 dbg .\" Created. .\" [90/08/30 dbg] -.\" +.\" .\" $FreeBSD$ .Dd January 16, 1996 .Dt DDB 4 @@ -86,12 +86,12 @@ The general command syntax is: .Ar address Ns Op Li , Ns Ar count .Pp A blank line repeats the previous command from the address `next' with -count 1 and no modifiers. Specifying +count 1 and no modifiers. Specifying .Ar address sets `dot' to the -address. Omitting +address. Omitting .Ar address -uses `dot'. A missing +uses `dot'. A missing .Ar count is taken to be 1 for printing commands or infinity for stack traces. @@ -101,7 +101,7 @@ The debugger has a feature like the .Xr more 1 command -for the output. If an output line exceeds the number set in the +for the output. If an output line exceeds the number set in the .Li \&$lines variable, it displays .Dq Em --db_more-- @@ -190,7 +190,7 @@ Execute an examine command with the last specified parameters to it except that the last start address subtracted by the size displayed by it is used as the start address. .It Cm print Ns Op Cm /acdoruxz -Print +Print .Ar addr Ns s according to the modifier character (as described above for .Li examine ) . @@ -226,7 +226,7 @@ on the command line at succeeding locations starting with .Ar addr The write unit size can be specified in the modifier with a letter .Li b -(byte), +(byte), .Li h (half word) or .Li l @@ -243,7 +243,7 @@ It's best to enclose each expression in parentheses. .Op Li = .Ar expr .Xc -Set the named variable or register with the value of +Set the named variable or register with the value of .Ar expr . Valid variable names are described below. .It Cm break Ns Op Cm /u @@ -251,8 +251,8 @@ Set a break point at .Ar addr . If .Ar count -is supplied, continues -.Ar count +is supplied, continues +.Ar count - 1 times before stopping at the break point. If the break point is set, a break point number is printed with @@ -277,7 +277,7 @@ point at the low-level code paths may also cause strange behavior. .It Cm delete Ar addr .It Cm delete Li \&# Ns Ar number Delete the break point. The target break point can be specified by a -break point number with +break point number with .Li # , or by using the same .Ar addr @@ -285,7 +285,7 @@ specified in the original .Cm break command. .It Cm step Ns Op Cm /p -Single step +Single step .Ar count times (the comma is a mandatory part of the syntax). If the @@ -332,13 +332,13 @@ only print when the matching return is hit. .Xc Stack trace. The .Li u -option traces user space; if omitted, +option traces user space; if omitted, .Cm trace only traces kernel space. .Ar count -is the number of frames to be traced. -If +is the number of frames to be traced. +If .Ar count is omitted, all frames are printed. .Pp @@ -365,7 +365,7 @@ Display all process information. The process information may not be shown if it is not supported in the machine, or the bottom of the stack of the target process is not in the main memory at that time. -The +The .Li m modifier will alter the display to show VM map addresses for the process and not show other info. @@ -382,12 +382,12 @@ The support of the modifier depends on the machine. If not supported, incorrect information will be displayed. .It Xo -.Cm show map Ns Op Cm /f +.Cm show map Ns Op Cm /f .Ar addr .Xc -Prints the VM map at +Prints the VM map at .Ar addr . -If the +If the .Li f modifier is specified the complete map is printed. @@ -485,7 +485,7 @@ Work variable. can be 0 to 31. .El .Sh EXPRESSIONS -Almost all expression operators in C are supported except +Almost all expression operators in C are supported except .Sq Li \&~ , .Sq Li \&^ , and unary diff --git a/share/man/man4/de.4 b/share/man/man4/de.4 index 7b62b7f..a174d90 100644 --- a/share/man/man4/de.4 +++ b/share/man/man4/de.4 @@ -40,7 +40,7 @@ driver provides support for the Ethernet adapters based on the Digital Equipment DC21x4x based self-contained Ethernet chips. .Pp It supports the DEC PCI DE435 card, DEC EISA DE425, DEC DE450, DEC DE500, -SMC 8432, 9332 and 9334, Cogent EM100FX and EM440TX, Asante, +SMC 8432, 9332 and 9334, Cogent EM100FX and EM440TX, Asante, ZNYX ZX3xx, and others based on the 21040 and 21041 Ethernet controllers or the 21140[A], 21141, 21142 and 21143 Fast 100Mbps Ethernet controllers. .Pp @@ -92,7 +92,7 @@ method of configuration is not supported. .It "de%d: waking device from sleep/snooze mode" The 21041 and 21140A chips support suspending the operation of the card. .It "de%d: error: desired IRQ of %d does not match device's actual IRQ of %d" -The device probe detected that the board is configured for a different +The device probe detected that the board is configured for a different interrupt than the one specified in the kernel configuration file. .It "de%d: not configured; limit of %d reached or exceeded" There is a limit of 32 diff --git a/share/man/man4/dpt.4 b/share/man/man4/dpt.4 index fa0afbf..e5ad3e8 100644 --- a/share/man/man4/dpt.4 +++ b/share/man/man4/dpt.4 @@ -9,7 +9,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -58,7 +58,7 @@ EISA Bus Driver Attachment .El .Sh SEE ALSO .Xr cd 4 , -.Xr ch 4 , +.Xr ch 4 , .Xr da 4 , .Xr sa 4 , .Xr scsi 4 diff --git a/share/man/man4/ed.4 b/share/man/man4/ed.4 index 82658e3..709838e 100644 --- a/share/man/man4/ed.4 +++ b/share/man/man4/ed.4 @@ -45,7 +45,7 @@ driver provides support for 8 and 16bit ethernet cards that are based on the National Semiconductor DS8390 and similar NICs manufactured by other companies. .Pp It supports all 80x3 series ethernet cards manufactured by Western Digital and SMC, -the SMC Ultra, the 3Com 3c503, the Novell NE1000/NE2000 and compatible cards, +the SMC Ultra, the 3Com 3c503, the Novell NE1000/NE2000 and compatible cards, the HP PC Lan+ and the Digital Equipment EtherWorks DE305 card. ISA, PCI and PC Card devices are supported. .Pp @@ -104,7 +104,7 @@ option to (BNC is the default). .Sh DIAGNOSTICS .Bl -diag -.It "ed%d: kernel configured irq %d doesn't match board configured irq %d." +.It "ed%d: kernel configured irq %d doesn't match board configured irq %d." The irq number that was specified in the kernel config file (and then compiled into the kernel) differs from the irq that has been set on the interface card. .It "ed%d: failed to clear shared memory at %x - check configuration." diff --git a/share/man/man4/fd.4 b/share/man/man4/fd.4 index 671eb8b..3b76b7a 100644 --- a/share/man/man4/fd.4 +++ b/share/man/man4/fd.4 @@ -76,7 +76,7 @@ fd = fcntl(STDERR_FILENO, F_DUPFD, 0); Flags to the .Xr open 2 call other than -.Dv O_RDONLY , +.Dv O_RDONLY , .Dv O_WRONLY and .Dv O_RDWR diff --git a/share/man/man4/fdc.4 b/share/man/man4/fdc.4 index e61a04f..476a71a 100644 --- a/share/man/man4/fdc.4 +++ b/share/man/man4/fdc.4 @@ -66,12 +66,12 @@ can be turned off using flags .It Pa /dev/fd* floppy disk device nodes .It Pa /dev/fd*. Ns Ar "<size in kB>" -floppy disk device nodes where the trailing number indicates the floppy -capacity +floppy disk device nodes where the trailing number indicates the floppy +capacity .It Pa /sys/i386/conf/GENERIC -sample generic kernel config file +sample generic kernel config file .It Pa /sys/isa/fd.c -floppy driver source +floppy driver source .El .Sh SEE ALSO .Xr fdformat 1 , diff --git a/share/man/man4/fxp.4 b/share/man/man4/fxp.4 index 9502319..c915b77 100644 --- a/share/man/man4/fxp.4 +++ b/share/man/man4/fxp.4 @@ -86,7 +86,7 @@ the line .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY diff --git a/share/man/man4/ichsmb.4 b/share/man/man4/ichsmb.4 index b9f3591..6decec4 100644 --- a/share/man/man4/ichsmb.4 +++ b/share/man/man4/ichsmb.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/icmp.4 b/share/man/man4/icmp.4 index 8f87f45..9fc2020 100644 --- a/share/man/man4/icmp.4 +++ b/share/man/man4/icmp.4 @@ -70,11 +70,11 @@ and calls, though the .Xr connect 2 call may also be used to fix the destination for future -packets (in which case the +packets (in which case the .Xr read 2 or .Xr recv 2 -and +and .Xr write 2 or .Xr send 2 @@ -102,7 +102,7 @@ connected; when the system runs out of memory for an internal data structure; .It Bq Er EADDRNOTAVAIL -when an attempt is made to create a +when an attempt is made to create a socket with a network address for which no network interface exists. .El diff --git a/share/man/man4/icmp6.4 b/share/man/man4/icmp6.4 index b7a5a83..3aeb1c3 100644 --- a/share/man/man4/icmp6.4 +++ b/share/man/man4/icmp6.4 @@ -1,6 +1,6 @@ .\" Copyright (C) 1999 WIDE Project. .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -12,7 +12,7 @@ .\" 3. Neither the name of the project nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE diff --git a/share/man/man4/inet.4 b/share/man/man4/inet.4 index 48dedc3..9275de4 100644 --- a/share/man/man4/inet.4 +++ b/share/man/man4/inet.4 @@ -82,7 +82,7 @@ Sockets may be created with the local address .Dv INADDR_ANY to effect .Dq wildcard -matching on incoming messages. +matching on incoming messages. The address in a .Xr connect 2 or @@ -237,7 +237,7 @@ Defaults to on. .Pq ip.ttl Integer: default time-to-live .Pq Dq TTL -to use for outgoing +to use for outgoing .Tn IP packets. .It Dv IPCTL_SOURCEROUTE diff --git a/share/man/man4/inet6.4 b/share/man/man4/inet6.4 index 62607ec..a0b48cb 100644 --- a/share/man/man4/inet6.4 +++ b/share/man/man4/inet6.4 @@ -294,7 +294,7 @@ and should normally be enabled on all systems. Defaults to on. .It Dv IPV6CTL_DEFHLIM .Pq ip6.hlim -Integer: default hop limit value to use for outgoing +Integer: default hop limit value to use for outgoing .Tn IPv6 packets. This value applies to all the transport protocols on top of @@ -415,7 +415,7 @@ Integer: trigger level of cached, unreferenced, protocol-cloned routes which initiates dynamic adaptation (default 128). .El .Ss Interaction between IPv4/v6 sockets -The behavior of +The behavior of .Dv AF_INET6 TCP/UDP socket is documented in RFC2553. Basically, it says this: diff --git a/share/man/man4/intpm.4 b/share/man/man4/intpm.4 index 1845872..960fc05 100644 --- a/share/man/man4/intpm.4 +++ b/share/man/man4/intpm.4 @@ -34,10 +34,10 @@ .Cd device smbus .Cd device intpm .Sh DESCRIPTION -This driver provides access to +This driver provides access to .Tn Intel PIIX4 PCI Controller function 3 , Power management controller. -Currently, only smbus controller +Currently, only smbus controller function is implemented. But it also have bus idle monitoring function. It @@ -56,7 +56,7 @@ manual page was written by .An Takanori Watanabe Aq takawata@shidahara1.planet.sci.kobe-u.ac.jp . .Sh BUGS This device requires IRQ 9 exclusively. -To use this, you should enable -ACPI function in BIOS configuration, or PnP mechanism assigns conflicted +To use this, you should enable +ACPI function in BIOS configuration, or PnP mechanism assigns conflicted IRQ for PnP ISA card. And don't use IRQ 9 for Non-PnP ISA cards. diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4 index 02d2a64..4ccbb11 100644 --- a/share/man/man4/ip.4 +++ b/share/man/man4/ip.4 @@ -45,7 +45,7 @@ .Ft int .Fn socket AF_INET SOCK_RAW proto .Sh DESCRIPTION -.Tn IP +.Tn IP is the transport layer protocol used by the Internet protocol family. Options may be set at the @@ -65,11 +65,11 @@ special-purpose applications. .Pp There are several .Tn IP-level -.Xr setsockopt 2 +.Xr setsockopt 2 and .Xr getsockopt 2 options. -.Dv IP_OPTIONS +.Dv IP_OPTIONS may be used to provide .Tn IP options to be transmitted in the @@ -81,7 +81,7 @@ options may be used with any socket type in the Internet family. The format of .Tn IP options to be sent is that specified by the -.Tn IP +.Tn IP protocol specification (RFC-791), with one exception: the list of addresses for Source Route options must include the first-hop gateway at the beginning of the list of gateways. @@ -93,13 +93,13 @@ use a zero-length buffer: setsockopt(s, IPPROTO_IP, IP_OPTIONS, NULL, 0); .Ed .Pp -.Dv IP_TOS -and -.Dv IP_TTL +.Dv IP_TOS +and +.Dv IP_TTL may be used to set the type-of-service and time-to-live -fields in the -.Tn IP -header for +fields in the +.Tn IP +header for .Dv SOCK_STREAM , SOCK_DGRAM , and certain types of .Dv SOCK_RAW @@ -113,22 +113,22 @@ int ttl = 60; /* max = 255 */ setsockopt(s, IPPROTO_IP, IP_TTL, &ttl, sizeof(ttl)); .Ed .Pp -If the -.Dv IP_RECVDSTADDR -option is enabled on a -.Dv SOCK_DGRAM +If the +.Dv IP_RECVDSTADDR +option is enabled on a +.Dv SOCK_DGRAM socket, the .Xr recvmsg 2 -call will return the destination -.Tn IP -address for a -.Tn UDP -datagram. -The msg_control field in the msghdr structure points to a buffer -that contains a cmsghdr structure followed by the -.Tn IP -address. +call will return the destination +.Tn IP +address for a +.Tn UDP +datagram. +The msg_control field in the msghdr structure points to a buffer +that contains a cmsghdr structure followed by the +.Tn IP +address. The cmsghdr fields have the following values: .Bd -literal cmsg_len = sizeof(struct in_addr) @@ -136,7 +136,7 @@ cmsg_level = IPPROTO_IP cmsg_type = IP_RECVDSTADDR .Ed .Pp -.Dv IP_PORTRANGE +.Dv IP_PORTRANGE may be used to set the port range used for selecting a local port number on a socket with an unspecified (zero) port number. It has the following @@ -168,7 +168,7 @@ systems. The range is normally from .Dv IPPORT_RESERVED - 1 down to .Li IPPORT_RESERVEDSTART -in descending order. +in descending order. This is adjustable through the sysctl setting: .Sy net.inet.ip.portrange.lowfirst and @@ -176,18 +176,18 @@ and .El .Ss "Multicast Options" .Pp -.Tn IP -multicasting is supported only on -.Dv AF_INET +.Tn IP +multicasting is supported only on +.Dv AF_INET sockets of type -.Dv SOCK_DGRAM -and +.Dv SOCK_DGRAM +and .Dv SOCK_RAW , and only on networks where the interface driver supports multicasting. .Pp -The -.Dv IP_MULTICAST_TTL +The +.Dv IP_MULTICAST_TTL option changes the time-to-live (TTL) for outgoing multicast datagrams in order to control the scope of the multicasts: @@ -203,36 +203,36 @@ group and if multicast loopback has not been disabled on the sending socket (see below). Multicast datagrams with TTL greater than 1 may be forwarded to other networks if a multicast router is attached to the local network. .Pp -For hosts with multiple interfaces, each multicast transmission is +For hosts with multiple interfaces, each multicast transmission is sent from the primary network interface. -The -.Dv IP_MULTICAST_IF -option overrides the default for +The +.Dv IP_MULTICAST_IF +option overrides the default for subsequent transmissions from a given socket: .Bd -literal struct in_addr addr; setsockopt(s, IPPROTO_IP, IP_MULTICAST_IF, &addr, sizeof(addr)); .Ed .Pp -where "addr" is the local -.Tn IP +where "addr" is the local +.Tn IP address of the desired interface or -.Dv INADDR_ANY +.Dv INADDR_ANY to specify the default interface. -An interface's local IP address and multicast capability can -be obtained via the -.Dv SIOCGIFCONF -and -.Dv SIOCGIFFLAGS -ioctls. +An interface's local IP address and multicast capability can +be obtained via the +.Dv SIOCGIFCONF +and +.Dv SIOCGIFFLAGS +ioctls. Normal applications should not need to use this option. .Pp If a multicast datagram is sent to a group to which the sending host itself belongs (on the outgoing interface), a copy of the datagram is, by default, -looped back by the IP layer for local delivery. -The -.Dv IP_MULTICAST_LOOP -option gives the sender explicit control +looped back by the IP layer for local delivery. +The +.Dv IP_MULTICAST_LOOP +option gives the sender explicit control over whether or not subsequent datagrams are looped back: .Bd -literal u_char loop; /* 0 = disable, 1 = enable (default) */ @@ -252,16 +252,16 @@ to the sending host on a different interface from that on which it was sent, if the host belongs to the destination group on that other interface. The loopback control option has no effect on such delivery. .Pp -A host must become a member of a multicast group before it can receive -datagrams sent to the group. To join a multicast group, use the -.Dv IP_ADD_MEMBERSHIP +A host must become a member of a multicast group before it can receive +datagrams sent to the group. To join a multicast group, use the +.Dv IP_ADD_MEMBERSHIP option: .Bd -literal struct ip_mreq mreq; setsockopt(s, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq)); .Ed .Pp -where +where .Fa mreq is the following structure: .Bd -literal @@ -271,20 +271,20 @@ struct ip_mreq { } .Ed .Pp -.Dv imr_interface +.Dv imr_interface should -be -.Dv INADDR_ANY -to choose the default multicast interface, -or the -.Tn IP +be +.Dv INADDR_ANY +to choose the default multicast interface, +or the +.Tn IP address of a particular multicast-capable interface if the host is multihomed. -Membership is associated with a single interface; -programs running on multihomed hosts may need to -join the same group on more than one interface. -Up to -.Dv IP_MAX_MEMBERSHIPS +Membership is associated with a single interface; +programs running on multihomed hosts may need to +join the same group on more than one interface. +Up to +.Dv IP_MAX_MEMBERSHIPS (currently 20) memberships may be added on a single socket. .Pp @@ -294,10 +294,10 @@ struct ip_mreq mreq; setsockopt(s, IPPROTO_IP, IP_DROP_MEMBERSHIP, &mreq, sizeof(mreq)); .Ed .Pp -where +where .Fa mreq -contains the same values as used to add the membership. -Memberships are dropped when the socket is closed or the process exits. +contains the same values as used to add the membership. +Memberships are dropped when the socket is closed or the process exits. .\"----------------------- .Ss "Raw IP Sockets" .Pp @@ -311,11 +311,11 @@ and calls, though the .Xr connect 2 call may also be used to fix the destination for future -packets (in which case the +packets (in which case the .Xr read 2 or .Xr recv 2 -and +and .Xr write 2 or .Xr send 2 @@ -338,17 +338,17 @@ Outgoing packets automatically have an header prepended to them (based on the destination address and the protocol number the socket is created with), -unless the -.Dv IP_HDRINCL +unless the +.Dv IP_HDRINCL option has been set. Incoming packets are received with .Tn IP header and options intact. .Pp -.Dv IP_HDRINCL +.Dv IP_HDRINCL indicates the complete IP header is included with the data -and may be used only with the -.Dv SOCK_RAW +and may be used only with the +.Dv SOCK_RAW type. .Bd -literal #include <netinet/in_systm.h> @@ -358,8 +358,8 @@ int hincl = 1; /* 1 = on, 0 = off */ setsockopt(s, IPPROTO_IP, IP_HDRINCL, &hincl, sizeof(hincl)); .Ed .Pp -Unlike previous -.Bx +Unlike previous +.Bx releases, the program must set all the fields of the IP header, including the following: .Bd -literal @@ -369,7 +369,7 @@ ip->ip_id = 0; /* 0 means kernel set appropriate value */ ip->ip_off = offset; .Ed .Pp -If the header source address is set to +If the header source address is set to .Dv INADDR_ANY , the kernel will choose an appropriate address. .Sh ERRORS @@ -387,7 +387,7 @@ connected; when the system runs out of memory for an internal data structure; .It Bq Er EADDRNOTAVAIL -when an attempt is made to create a +when an attempt is made to create a socket with a network address for which no network interface exists. .It Bq Er EACCES diff --git a/share/man/man4/ipfirewall.4 b/share/man/man4/ipfirewall.4 index 63043e4..e6d6b08 100644 --- a/share/man/man4/ipfirewall.4 +++ b/share/man/man4/ipfirewall.4 @@ -33,7 +33,7 @@ time option .Dv IPFIREWALL_DEFAULT_TO_ACCEPT allows the administrator to change this fixed rule to permit everything. .Pp -The value passed to +The value passed to .Fn setsockopt is a struct ip_fw describing the rule (see below). In some cases diff --git a/share/man/man4/joy.4 b/share/man/man4/joy.4 index 954e0e0..9d25512 100644 --- a/share/man/man4/joy.4 +++ b/share/man/man4/joy.4 @@ -44,29 +44,29 @@ perl -e 'open(JOY,"/dev/joy0")||die;while(1) Several ioctl() calls are also available. They take an argument of type int * -.Bl -tag -width JOY_SET_X_OFFSET +.Bl -tag -width JOY_SET_X_OFFSET .It Dv JOY_SETTIMEOUT Fa int *limit Set the time limit (in microseconds) for reading the joystick status. Setting a value too small may prevent to get correct values for the positions (which are then set to -2147483648), however this can be useful if one is -only interested by the buttons status. +only interested by the buttons status. .It Dv JOY_GETTIMEOUT Fa int *limit Get the time limit (in microseconds) used for reading the joystick -status. +status. .It Dv JOY_SET_X_OFFSET Fa int *offset Set the value to be added to the X position when reading the joystick -status. +status. .It Dv JOY_SET_Y_OFFSET Fa int *offset Set the value to be added to the Y position when reading the joystick -status. +status. .It Dv JOY_GET_X_OFFSET Fa int *offset Get the value which is added to the X position when reading the joystick -status. +status. .It Dv JOY_GET_Y_OFFSET Fa int *offset Get the value which is added to the Y position when reading the joystick -status. +status. .El .Sh TECHNICAL SPECIFICATIONS The pinout of the DB-15 connector is as follow: diff --git a/share/man/man4/kame.4 b/share/man/man4/kame.4 index 5493779..a4a0b17 100644 --- a/share/man/man4/kame.4 +++ b/share/man/man4/kame.4 @@ -1,6 +1,6 @@ .\" Copyright (C) 1995, 1996, 1997, 1998 and 1999 WIDE Project. .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -12,7 +12,7 @@ .\" 3. Neither the name of the project nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE @@ -201,7 +201,7 @@ status of KAME software at following THAI project web page: .\" .Sh HISTORY The -.Nm +.Nm project started in April 1999. .Nm kit was mostly integrated into diff --git a/share/man/man4/keyboard.4 b/share/man/man4/keyboard.4 index fa7cff9..24d9098 100644 --- a/share/man/man4/keyboard.4 +++ b/share/man/man4/keyboard.4 @@ -11,10 +11,10 @@ The PC keyboard is used as the console character input device. The keyboard is owned by the current virtual console. -To switch between the virtual consoles use the sequence +To switch between the virtual consoles use the sequence .Ar ALT+Fn , which means hold down ALT and press one of the function keys. -The +The virtual console with the same number as the function key is then selected as the current virtual console and given exclusive use of the keyboard and display. @@ -50,12 +50,12 @@ Switch virtual console. Change the meaning of another key. .El .Pp -The keyboard is seen as a number of keys numbered from 1 to n. This +The keyboard is seen as a number of keys numbered from 1 to n. This number is often referred to as the "scancode" for a given key. The number -of the key is transmitted as an 8 bit char with bit 7 as 0 when a key is +of the key is transmitted as an 8 bit char with bit 7 as 0 when a key is pressed, and the number with bit 7 as 1 when released. -This makes it +This makes it possible to make the mapping of the keys fully configurable. .Pp The meaning of every key is programmable via the PIO_KEYMAP ioctl call, that @@ -91,21 +91,21 @@ represented by the map array, as shown below: 0x1E 'a' 'A' 0x01 0x01 'a' 'A' 0x01 0x01 .Ed .Pp -This is the default mapping for the key labelled 'A' which normally has -scancode 0x1E. The eight states are as shown, giving the 'A' key its -normal behavior. +This is the default mapping for the key labelled 'A' which normally has +scancode 0x1E. The eight states are as shown, giving the 'A' key its +normal behavior. The spcl field is used to give the key "special" treatment, and is -interpreted as follows. +interpreted as follows. Each bit corresponds to one of the states above. -If the bit is 0 the -key emits the number defined in the corresponding map[] entry. -If the bit is 1 the key is "special". This means it does not emit -anything; instead it changes the "state". That means it is a shift, -control, alt, lock, switch-screen, function-key or no-op key. +If the bit is 0 the +key emits the number defined in the corresponding map[] entry. +If the bit is 1 the key is "special". This means it does not emit +anything; instead it changes the "state". That means it is a shift, +control, alt, lock, switch-screen, function-key or no-op key. The bitmap is backwards ie. 7 for base, 6 for shift etc. .Pp The flgs field defines if the key should react on caps-lock (1), -num-lock (2), both (3) or ignore both (0). +num-lock (2), both (3) or ignore both (0). .Pp The .Xr kbdcontrol 1 diff --git a/share/man/man4/kld.4 b/share/man/man4/kld.4 index f583419..2714cb0 100644 --- a/share/man/man4/kld.4 +++ b/share/man/man4/kld.4 @@ -34,7 +34,7 @@ .Sh DESCRIPTION The LKM (Loadable Kernel Modules) facility has been deprecated in .Fx 3.0 -and above in favor of the +and above in favor of the .Nm interface. This interface, like its @@ -73,12 +73,12 @@ and .Xr kldstat 8 programs. .Pp -The +The .Xr kldload 8 program can load either .Xr a.out 5 or ELF formatted loadable modules. -The +The .Xr kldunload 8 program unloads any given loaded module, if no other module is dependent upon the given module. @@ -98,12 +98,12 @@ device nodes must exist for the devices to be accessed. They are usually created by using .Xr MAKEDEV 8 -or -.Xr mknod 8 +or +.Xr mknod 8 (if the device is not supported by the .Xr MAKEDEV 8 script) or, by writing a -shell script to run +shell script to run .Xr kldload 8 which should run the appropriate program to create the devices when the driver has been successfully loaded. @@ -114,9 +114,9 @@ driver has been successfully loaded. directory containing module binaries built for the kernel also residing in the directory. .It Pa /usr/include/sys/module.h -file containing definitions required to compile a +file containing definitions required to compile a .Nm -module +module .It Pa /usr/share/examples/kld example source code implementing a sample kld module .El @@ -142,7 +142,7 @@ A as a dependency, then loads an instance of module A when any of the modules are loaded. .Pp If a custom entry point is used for a module, and the module is compiled as -an +an .Sq ELF binary, then .Xr kldload 8 diff --git a/share/man/man4/kue.4 b/share/man/man4/kue.4 index 45c1204..532a6d9 100644 --- a/share/man/man4/kue.4 +++ b/share/man/man4/kue.4 @@ -73,7 +73,7 @@ The driver failed to allocate an mbuf for the receiver ring. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY diff --git a/share/man/man4/lpbb.4 b/share/man/man4/lpbb.4 index 2f20e29..77e70c5 100644 --- a/share/man/man4/lpbb.4 +++ b/share/man/man4/lpbb.4 @@ -42,7 +42,7 @@ The driver supports the Philips official I2C parallel bit-banging interface. .Pp .Bd -literal - + LS05 pin 14 (Vcc) o ------- | | | +--+--+---------------------+--+--+------------+------+-o 1 | @@ -63,7 +63,7 @@ driver supports the Philips official I2C parallel bit-banging interface. -------- | 1 - .1 uF capacitor | 6 - 10K 5% resistors | 25-pin male D | 1 - 4-pin connector | 1 - 25-pin male D connector | connector to PC | 1 - 74LS05 open collector hex inverter | - printer port ------------------------------------------------------- + printer port ------------------------------------------------------- .Ed .Sh SEE ALSO .Xr iicbb 4 , diff --git a/share/man/man4/lpt.4 b/share/man/man4/lpt.4 index 697da66..ff9aac7 100644 --- a/share/man/man4/lpt.4 +++ b/share/man/man4/lpt.4 @@ -70,8 +70,8 @@ The parallel port bus is allocated by lpt when the printer device is opened and released only when the transfer is completed: either when the device is closed or when the entire buffer is sent in interrupt driven mode. .Pp -The driver can be configured to be either interrupt-driven, or -to poll the printer. Ports that are configured to be +The driver can be configured to be either interrupt-driven, or +to poll the printer. Ports that are configured to be interrupt-driven can be switched to polled mode by using the .Xr lptcontrol 8 command. @@ -102,8 +102,8 @@ first parallel port driver There are lots of them, especially in cheap parallel port implementations. .Pp It is only possible to open a lpt port when a printer is connected and -on-line, making it impossible to run -.Xr lptcontrol 8 +on-line, making it impossible to run +.Xr lptcontrol 8 when there is no printer connected. .Pp This driver could still stand a rewrite. diff --git a/share/man/man4/man4.alpha/osf1.4 b/share/man/man4/man4.alpha/osf1.4 index ec6e9a4..d4a1743 100644 --- a/share/man/man4/man4.alpha/osf1.4 +++ b/share/man/man4/man4.alpha/osf1.4 @@ -40,8 +40,8 @@ To load the OSF/1 ABI support kernel module: The .Nm module provides limited -alpha OSF/1 (also known as Digital UNIX, later known as Tru64 UNIX) -ABI (application binary interface) +alpha OSF/1 (also known as Digital UNIX, later known as Tru64 UNIX) +ABI (application binary interface) compatibility for userland applications. The module provides the following significant facilities: .Bl -bullet @@ -87,7 +87,7 @@ minimal OSF1 run-time environment We cannot run OSF/1 applications which rely on the .Xr pthread 3 API, such as the JDK. -OSF/1's pthreads library uses Mach system calls. +OSF/1's pthreads library uses Mach system calls. Mach system calls would be very difficult to support in .Fx . .Sh HISTORY diff --git a/share/man/man4/man4.i386/aic.4 b/share/man/man4/man4.i386/aic.4 index 2d4de95..c48d005 100644 --- a/share/man/man4/man4.i386/aic.4 +++ b/share/man/man4/man4.i386/aic.4 @@ -9,7 +9,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -42,7 +42,7 @@ Many systems that use these controller chips do not have a boot ROM and therefore cannot be booted from. .Sh SEE ALSO .Xr cd 4 , -.Xr ch 4 , +.Xr ch 4 , .Xr da 4 , .Xr intro 4 , .Xr sa 4 diff --git a/share/man/man4/man4.i386/alpm.4 b/share/man/man4/man4.i386/alpm.4 index 9c54d13..aceee0d 100644 --- a/share/man/man4/man4.i386/alpm.4 +++ b/share/man/man4/man4.i386/alpm.4 @@ -36,7 +36,7 @@ .Sh DESCRIPTION This driver provides access to the .Tn Aladdin 15x3 Power Management Unit . -Currently, only smbus controller +Currently, only smbus controller function is implemented. .Pp The embedded SMBus controller of the Aladdin chipset may give you access @@ -51,7 +51,7 @@ monitoring chip of your mainboard. .Sh HISTORY The .Nm -manual page example first appeared in +manual page example first appeared in .Fx 4.0 . .Sh AUTHORS This diff --git a/share/man/man4/man4.i386/apm.4 b/share/man/man4/man4.i386/apm.4 index b301a2f..a19cb7f 100644 --- a/share/man/man4/man4.i386/apm.4 +++ b/share/man/man4/man4.i386/apm.4 @@ -1,12 +1,12 @@ .\" LP (Laptop Package) -.\" +.\" .\" Copyright (c) 1994 by HOSOKAWA, Tatsumi <hosokawa@mt.cs.keio.ac.jp> -.\" +.\" .\" This software may be used, modified, copied, and distributed, in .\" both source and binary form provided that the above copyright and -.\" these terms are retained. Under no circumstances is the author -.\" responsible for the proper functioning of this software, nor does -.\" the author assume any responsibility for damages incurred with its +.\" these terms are retained. Under no circumstances is the author +.\" responsible for the proper functioning of this software, nor does +.\" the author assume any responsibility for damages incurred with its .\" use. .\" .\" $FreeBSD$ @@ -28,19 +28,19 @@ on laptop PCs. provides the following power management functions. .Bl -enum -offset indent .It -When the system wakes up from suspended mode, +When the system wakes up from suspended mode, .Nm adjusts the system clock to RTC. -.It -When the system wakes up from suspended mode, +.It +When the system wakes up from suspended mode, .Nm -passes a message to +passes a message to .Xr syslogd 8 comprising of system wakeup time and elapsed time during suspended mode. .It .Nm -slows CPU clock when there are no system activities (runnable processes, -interrupts, etc.). This function is available only on systems whose APM +slows CPU clock when there are no system activities (runnable processes, +interrupts, etc.). This function is available only on systems whose APM supports CPU idling. .It .Nm @@ -63,33 +63,33 @@ Control execution of HLT in the kernel context switch routine. .It Sy APMIO_GETPWSTATUS Get per battery information. .Pp -Some APM implementations execute the HLT +Some APM implementations execute the HLT .Pq Halt CPU until an interrupt occurs instruction in the .Dq Em Idle CPU call, while others do not. Thus enabling this may result in redundant HLT executions because .Dq Em Idle CPU -is called from the kernel context switch routine that inherently executes -HLT. This may reduce peak system performance. +is called from the kernel context switch routine that inherently executes +HLT. This may reduce peak system performance. .Pp -Also the system hangs up if HLT instruction is disabled in the kernel -context switch routine, and if the APM implementation of the machine +Also the system hangs up if HLT instruction is disabled in the kernel +context switch routine, and if the APM implementation of the machine does not execute HLT in .Dq Em Idle CPU . -On some implementations that do not support CPU clock slowdown, APM +On some implementations that do not support CPU clock slowdown, APM might not execute HLT. .Nm disables .Sy APMIO_NOTHALTCPU -operation on such machines. +operation on such machines. .Pp The current version of .Nm does not call .Dq Em Idle CPU -from the kernel context switch routine if clock slowdown is not supported, -and it executes HLT instruction by default. Therefore, there is +from the kernel context switch routine if clock slowdown is not supported, +and it executes HLT instruction by default. Therefore, there is no need to use these two operations in most cases. .El .Pp @@ -98,7 +98,7 @@ These interfaces are used by .It .Nm polls APM events and handles the following events. -.Bl -column PMEV_POWERSTATECHANGEXXX "suspend system xxxxx" +.Bl -column PMEV_POWERSTATECHANGEXXX "suspend system xxxxx" .It Sy "Name " "Action " "Description" .It Dv "PMEV_STANDBYREQ " No "suspend system " "standby request" .It Dv "PMEV_SUSPENDREQ " No "suspend system " "suspend request" @@ -110,7 +110,7 @@ polls APM events and handles the following events. .It Dv "PMEV_BATTERYLOW " No "notify message " "battery low" .It Dv "PMEV_UPDATETIME " No "adjust clock " "update time" .El -.El +.El .Sh BUGS WARNING! Many, if not most, of the implementations of APM-bios in laptops today are buggy. You may be putting your LCD-display and batteries at @@ -122,23 +122,23 @@ power and batteries ASAP, if not immediately, and disable this code. We are very interested in getting this code working, so please send you observations of any anomalous behavior to us. .Pp -When +When .Nm -is active, calling the BIOS setup routine by using hot-keys, +is active, calling the BIOS setup routine by using hot-keys, may cause serious trouble when resuming the system. BIOS setup programs should be called during bootstrap, or from DOS. .Pp -Some APM implementations cannot handle events such as pushing the -power button or closing the cover. On such implementations, the system +Some APM implementations cannot handle events such as pushing the +power button or closing the cover. On such implementations, the system .Ar must be suspended .Ar only -by using +by using .Xr apm 8 -or +or .Xr zzz 8 . .Pp -Disk spin-down, LCD backlight control, and power on demand have not +Disk spin-down, LCD backlight control, and power on demand have not been supported on the current version. .Sh SEE ALSO .Xr apm 8 , diff --git a/share/man/man4/man4.i386/asc.4 b/share/man/man4/man4.i386/asc.4 index fdfa15a..2c8c66d 100644 --- a/share/man/man4/man4.i386/asc.4 +++ b/share/man/man4/man4.i386/asc.4 @@ -44,7 +44,7 @@ The character device driver currently handles the .Tn GI1904 Ns -based hand scanner (e.g. Trust Amiscan Grey). -It uses DMA and interrupts. +It uses DMA and interrupts. Up to 50 lines of scanned input data are buffered in the driver. .Pp The device can operate at four different resolutions: 100, 200, 300 @@ -89,7 +89,7 @@ Get current resolution in dots per inch (dpi). Get current width of the bitmap in pixels. .It Dv ASC_SHEIGHT .Pq Li int -Set the height of the bitmap in +Set the height of the bitmap in .Xr pbm 5 mode. This is actually a limit on the amount of lines scannable after the first read @@ -116,10 +116,10 @@ Set the timeout for the completion of reading one buffer. Since a handy scanner is a human/computer interface timeout values are usually higher than those of a flat scanner; the default is 15 seconds. After -timeout is reached the read operation will fail with +timeout is reached the read operation will fail with .Er EBUSY . Note that -the timeout timer starts anew for each buffer to be read and thus +the timeout timer starts anew for each buffer to be read and thus reducing it does not result in faster scans for longer images. .It Dv ASC_GBTIME .Pq Li int @@ -132,13 +132,13 @@ requests that modify a parameter except .Dv ASC_SBTIME do not have an effect on an ongoing scan process. The user must close the device and open it again for the new selections to take effect. -Consequently, the selections are +Consequently, the selections are .Em not reset when the device is opened or closed. .Pp Similarly, requests that read a value do not report the value that is used for the ongoing scan process. The values needed during the scan -process are saved when it starts and thus are not accessed by +process are saved when it starts and thus are not accessed by .Fn ioctl requests. .Pp diff --git a/share/man/man4/man4.i386/asr.4 b/share/man/man4/man4.i386/asr.4 index 258b97f..889338d 100644 --- a/share/man/man4/man4.i386/asr.4 +++ b/share/man/man4/man4.i386/asr.4 @@ -89,7 +89,7 @@ and was ported over to the CAM layer represented in 4.0. The .Nm driver was kindly donated by Adaptec -and is maintained by +and is maintained by .An Mark Salyzyn Aq mark_salyzyn@adaptec.com . This manual page was written by .An Mark Salyzyn diff --git a/share/man/man4/man4.i386/cs.4 b/share/man/man4/man4.i386/cs.4 index 6604175..95657c2 100644 --- a/share/man/man4/man4.i386/cs.4 +++ b/share/man/man4/man4.i386/cs.4 @@ -37,13 +37,13 @@ .Sh DESCRIPTION The .Nm -driver provides support for ISA ethernet adapters based on the +driver provides support for ISA ethernet adapters based on the .Tn Crystal Semiconductor CS8900 and .Tn CS8920 -NICs. These devices are used on the -.Tn IBM EtherJet ISA -adapters and in many embedded applications where the high integration, small +NICs. These devices are used on the +.Tn IBM EtherJet ISA +adapters and in many embedded applications where the high integration, small size and low cost of the CS89x0 family compensate for their drawbacks. .Pp The @@ -52,10 +52,10 @@ driver will obtain configuration parameters either from the configuration entry or from the card. Parameters specified in the configuration entry will be used if present; the card may be soft-configured so these may be any valid value. Adapters based on the CS8920 normally offer PnP configuration and the driver -will detect the -.Tn IBM EtherJet -and the -.Tn CSC6040 +will detect the +.Tn IBM EtherJet +and the +.Tn CSC6040 adapters automatically. .Pp Note that the CS8900 is limited to 4 IRQ values; these are normally implemented @@ -97,16 +97,16 @@ In particular, NFS operations should be limited to 1k read/write transactions in order to avoid overruns. .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh AUTHORS .An -nosplit The .Nm -device driver was written by -.An Maxim Bolotin -and +device driver was written by +.An Maxim Bolotin +and .An Oleg Sharoiko . This manpage was written by .An Michael Smith . diff --git a/share/man/man4/man4.i386/dgb.4 b/share/man/man4/man4.i386/dgb.4 index c62b40c..4782d27 100644 --- a/share/man/man4/man4.i386/dgb.4 +++ b/share/man/man4/man4.i386/dgb.4 @@ -60,7 +60,7 @@ default = number_of_described_DigiBoard_cards * 16 .Ed .Pp -If it is less than the actual number of ports +If it is less than the actual number of ports the system will be able to use only the first .Dv NDGBPORTS @@ -111,10 +111,10 @@ This is practical because the DigiBoard cards have large input and output buffers (more than 1Kbyte per port) and hardware that allows efficiently finding the port that needs attention. -The only problem seen with this policy is slower +The only problem seen with this policy is slower SLIP and PPP response. .Pp -Each line in the kernel configuration file describes one card, not one port +Each line in the kernel configuration file describes one card, not one port as in the .Xr sio 4 driver. @@ -135,7 +135,7 @@ needed. The .Cm port value must be the same -as the +as the port set on the card by jumpers. For PC/Xi cards the same rule is applicable to the @@ -151,7 +151,7 @@ In fact there are no jumpers to do it. Just write the address you want as the .Cm iomem -value in kernel config file and the card will be programmed +value in kernel config file and the card will be programmed to use this address. .Pp The same range of memory addresses may be used @@ -289,7 +289,7 @@ start of the source file The memory address for the PC/Xe's 8K window is misaligned (it should be on an 8K boundary) or outside of the first megabyte. .It dgb\fIX\fP: 1st reset failed -Problems with accessing I/O port of the card, probably +Problems with accessing I/O port of the card, probably the wrong .Cm port value is specified in the kernel config file. @@ -309,11 +309,11 @@ Problems with the on-board BIOS. Probably the memory addresses of the DigiBoard overlap with some other device or with RAM. .It dgb\fIX\fP: FEP code download failed -Problems with downloading of the Front-End Processor's micro-OS. +Problems with downloading of the Front-End Processor's micro-OS. Probably the memory addresses of the DigiBoard overlap with some other device or with RAM. .It dgb\fIX\fP: FEP/OS start failed -Problems with starting of the Front-End Processor's micro-OS. +Problems with starting of the Front-End Processor's micro-OS. Probably the memory addresses of the DigiBoard overlap with some other device or with RAM. .It dgb\fIX\fP: too many ports @@ -336,7 +336,7 @@ Internal problems in the polling logic of driver. .It dgb\fIX\fP: event queue's head or tail is wrong! Internal problems in the driver or hardware. .It dgb\fIX\fP: port \fIY\fP: got event on nonexisting port -Some status changed on a port that is physically present but is +Some status changed on a port that is physically present but is unusable due to misconfiguration. .It dgb\fIX\fP: port \fIY\fP: event \fIN\fP mstat \fIM\fP lstat \fIK\fP The driver got a strange event from card. @@ -362,8 +362,8 @@ The .Nm driver is derived from the .Xr sio 4 -driver and the DigiBoard driver from -.Tn Linux +driver and the DigiBoard driver from +.Tn Linux and is .Ud .Sh BUGS @@ -374,7 +374,7 @@ is broken. of fixed length of 1/4 s is sent anyway. .Pp -There was a bug in implementation of +There was a bug in implementation of .Xr select 2 . It is fixed now but not widely tested yet. .Pp diff --git a/share/man/man4/man4.i386/el.4 b/share/man/man4/man4.i386/el.4 index 092f944..caf3f1d 100644 --- a/share/man/man4/man4.i386/el.4 +++ b/share/man/man4/man4.i386/el.4 @@ -9,7 +9,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. diff --git a/share/man/man4/man4.i386/ex.4 b/share/man/man4/man4.i386/ex.4 index dda2c7f..f999309 100644 --- a/share/man/man4/man4.i386/ex.4 +++ b/share/man/man4/man4.i386/ex.4 @@ -49,7 +49,7 @@ cards the Plug-N-Play support should be disabled. The device probe found an installed card, and was able to correctly install the device driver. .It "ex%d: WARNING: board's EEPROM is configured for IRQ %d, using %d" -The device probe detected that the board is configured for a different +The device probe detected that the board is configured for a different interrupt than the one specified in the kernel configuration file. .It "ex%d: invalid IRQ." The device probe detected an invalid IRQ setting. diff --git a/share/man/man4/man4.i386/fe.4 b/share/man/man4/man4.i386/fe.4 index de674d4..866b297 100644 --- a/share/man/man4/man4.i386/fe.4 +++ b/share/man/man4/man4.i386/fe.4 @@ -204,7 +204,7 @@ The driver will generate a warning message, if the IRQ setting specified in the kernel config file does not match one stored in EEPROM. Then, it will use the value specified in the config file. -(This behavior has been changed from the previous releases.) +(This behavior has been changed from the previous releases.) .Ss Allied-Telesis AT1700 series and RE2000 series adapters Automatic I/O port address detection is available with Allied-Telesis AT1700 series and RE2000 series, @@ -263,7 +263,7 @@ The unnecessarily allocated clusters are freed within short lifetime, and it will not affect long term kernel memory usage. .Pp Although XNS and IPX supports are included in the driver, -they are never be tested and must have a lot of bugs. +they are never be tested and must have a lot of bugs. .Sh AUTHORS, COPYRIGHT AND DISCLAIMER The .Nm diff --git a/share/man/man4/man4.i386/gsc.4 b/share/man/man4/man4.i386/gsc.4 index c73188a..6b6b5d7 100644 --- a/share/man/man4/man4.i386/gsc.4 +++ b/share/man/man4/man4.i386/gsc.4 @@ -71,7 +71,7 @@ I had neither enough documentation nor experience in writing interrupt driven device drivers. .Pp -The device can operate at four different +The device can operate at four different .Em resolutions : 100, 200, 300 and 400dpi. @@ -86,24 +86,24 @@ Thus the scans can easily processed by any graphic package around .Xr xpaint 1 , .Xr xv 1 , .Xr xli 1 -only to name some of them ...). In +only to name some of them ...). In .Em raw mode a bit which is set means a black pixel because the scanner detects black points on white paper. On the other hand, because pnm format describes -intensities of electron beams in video screens a set bit in +intensities of electron beams in video screens a set bit in .Em pbm mode means a white pixel. .Pp -The +The .Em width of the output bitmap is fixed as given by the resolution value. -However, the +However, the .Em height of the bitmap must be -supplied in +supplied in .Em pnm mode since the driver must know at what time the .Sq end-of-file @@ -113,11 +113,11 @@ directly copy the scanner output into a pbm file with .Xr cat . Of course you can obtain a similar effect by using .Xr dd 1 -with the driver in +with the driver in .Em raw mode. .Pp -The +The .Em graymap output mode is not yet implemented into the driver. It is even questionable if external programs would not do this job @@ -150,7 +150,7 @@ open though untouched state otherwise the request will fail and is set to .Er EBUSY . .It GSC_SWIDTH int -Set the +Set the .Em width of the bitmap. Actually, this is an alternative @@ -177,7 +177,7 @@ width .El .Pp Values which are not reported in the above table will cause the ioctl -call to fail with +call to fail with .Xr errno 2 set to .Er EINVAL . @@ -194,9 +194,9 @@ the right part that is exceeding the standard line. .It GSC_GWIDTH int Get current width of the bitmap in pixels. .It GSC_SHEIGHT int -Set the +Set the .Em height -of the bitmap in +of the bitmap in .Em pnm mode. This is actually @@ -217,7 +217,7 @@ This upper limit is checked before it overwrites the current value and pases an .Er ENOMEM in the -.Xr errno 2 +.Xr errno 2 variable. However, since the bitmap width can change after a buffer length was selected a read request may fail with @@ -269,37 +269,37 @@ starts scanning. It can then be set to a short amount to react Note that the user should be left time to at least fill one buffer without having to haste. .Pp -Note that the +Note that the .Em pbm -versus +versus .Em raw mode selection is done by the minor number not by ioctl requests. -In +In .Em raw mode the selected height of the bitmap will have no effect. .Sh FILES .Bl -tag -width /dev/gsc0pd .It Pa /dev/gsc0 -device node for +device node for .Em raw output, has minor number 0. .It Pa /dev/gsc0d -device node for +device node for .Em raw -output emitting +output emitting .Em debug messages if the GSCDEBUG option was given at compile time, has minor number 32. .It Pa /dev/gsc0p -device node for output in +device node for output in .Em pbm file format, has minor number 8. .It Pa /dev/gsc0pd -device node for +device node for .Em pbm -and +and .Em debug mode, has minor number 40. .El diff --git a/share/man/man4/man4.i386/ie.4 b/share/man/man4/man4.i386/ie.4 index 01f35a7..b19625e 100644 --- a/share/man/man4/man4.i386/ie.4 +++ b/share/man/man4/man4.i386/ie.4 @@ -17,8 +17,8 @@ The .Nm driver provides support for 8 and 16bit ISA ethernet cards that are based on the Intel i82586 chip. -It supports the AT&T Starlan 10 and Starlan Fiber, -the EN100, the Intel EtherExpress 16, the 3COM 3C507 and the RACAL Interlan +It supports the AT&T Starlan 10 and Starlan Fiber, +the EN100, the Intel EtherExpress 16, the 3COM 3C507 and the RACAL Interlan NI5210. .Sh DIAGNOSTICS .Bl -diag @@ -34,7 +34,7 @@ The device probe could not access the shared memory to determine its size. The device probe found a different size for the shared memory than the one specified in the kernel configuration file. .It "ie%d: kernel configured irq %d doesn't match board configured irq %d" -The device probe detected that the board is configured for a different +The device probe detected that the board is configured for a different interrupt than the one specified in the kernel configuration file. .It "ie%d: reset" The Intel i82586 had to be reset by the driver. @@ -52,11 +52,11 @@ Check your coax cable and terminator resistors. .It "ie%d: TDR detected a short %d clocks away" The driver detected a short circuit in the ethernet cable. -Check your +Check your coax cable and terminator resistors. .It "ie%d: TDR returned unknown status %x" The driver got an unknown status from the card during the ethernet cable -test. +test. .It "ie%d: multicast address setup command failed" The card could not be put into multicast mode. .It "ie%d: configure command failed" @@ -65,11 +65,11 @@ The card refused to respond correctly during configuration. The programming of the Ethernet (MAC) address failed. .El .Sh CAVEATS -The Racal Interlan NI5210 comes in variants with 8 and 16 kbytes of +The Racal Interlan NI5210 comes in variants with 8 and 16 kbytes of shared memory. -It is strongly advisable to use the 16 kbyte variant. +It is strongly advisable to use the 16 kbyte variant. You can upgrade your 8 kbyte card to 16 kbyte by adding an additional -RAM chip. +RAM chip. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -83,8 +83,8 @@ device driver was written by .An Garrett A. Wollman , based on code by .An William F. Jolitz -and Lawrence Berkeley Laboratories. -.Tn 3C507 +and Lawrence Berkeley Laboratories. +.Tn 3C507 support was written by .An Charles M. Hannum . This manual page was written by diff --git a/share/man/man4/man4.i386/le.4 b/share/man/man4/man4.i386/le.4 index 5b8a1f5..c5f1588 100644 --- a/share/man/man4/man4.i386/le.4 +++ b/share/man/man4/man4.i386/le.4 @@ -36,7 +36,7 @@ .Sh DESCRIPTION The .Nm -driver provides support for the later Digital Equipment EtherWORKS II +driver provides support for the later Digital Equipment EtherWORKS II (DE200, DE201, DE202, DE422), and the DEC EtherWORKS III NICs (DE203, DE204, and DE205) NICs. .Pp @@ -83,7 +83,7 @@ the EtherWORKS card. .Sh HISTORY The .Nm -device driver was present in +device driver was present in .Fx 2.0 . .Sh AUTHORS .An -nosplit diff --git a/share/man/man4/man4.i386/lnc.4 b/share/man/man4/man4.i386/lnc.4 index 3324032..bcc5326 100644 --- a/share/man/man4/man4.i386/lnc.4 +++ b/share/man/man4/man4.i386/lnc.4 @@ -116,7 +116,7 @@ Ethernet device drivers. .Sh HISTORY The .Nm -device driver first appeared in +device driver first appeared in .Fx 2.2 . .Sh AUTHORS .An -nosplit diff --git a/share/man/man4/man4.i386/matcd.4 b/share/man/man4/man4.i386/matcd.4 index 530c4eb..b31cf53 100644 --- a/share/man/man4/man4.i386/matcd.4 +++ b/share/man/man4/man4.i386/matcd.4 @@ -2,7 +2,7 @@ .\"Authored by Frank Durda IV .\" .\"Program and Documentation are Copyright 1994, 1995 Frank Durda IV. -.\"All rights reserved. +.\"All rights reserved. .\" "FDIV" is a trademark of Frank Durda IV. .\" .\" @@ -40,18 +40,18 @@ .\" conditions even if it is unsupported, not a complete system .\" and/or does not contain compiled code. .\"8. These conditions will be in force for the full life of the -.\" copyright. +.\" copyright. .\"9. If all the above conditions are met, modifications to other .\" parts of this file may be freely made, although any person .\" or persons making changes do not receive the right to add their .\" name or names to the copyright strings and notices in this .\" software. Persons making changes are encouraged to insert edit .\" history in matcd.c and to put your name and details of the -.\" change there. +.\" change there. .\"10. You must have prior written permission from the author to .\" deviate from these terms. .\" -.\"Vendors who produce product(s) containing this code are encouraged +.\"Vendors who produce product(s) containing this code are encouraged .\"(but not required) to provide copies of the finished product(s) to .\"the author and to correspond with the author about development .\"activity relating to this code. Donations of development hardware @@ -105,7 +105,7 @@ been included in computers made by Tandy, AST, Packard Bell and many others. .Pp These drives connect to the PC ISA bus through a proprietary host interface. This interface can exist as a stand-alone ISA card, or can be included on -a sound card. +a sound card. .Sh DRIVER CONFIGURATION The .Nm @@ -116,7 +116,7 @@ read operations are limited to one drive per host interface at any instant. To support multiple host interfaces, it is necessary to modify the entries in the kernel configuration file. Normally your system comes with the file \fI/usr/src/sys/i386/conf/GENERIC\fR. You should make -a copy of this file and give it the name of your system. +a copy of this file and give it the name of your system. You can then edit the new file to include devices you want the system to support and delete the device entries that you don't want. .Pp @@ -135,7 +135,7 @@ device matcd1 at isa? port ? additional entries). .Pp Note that the kernel configuration does not need to be modified to support -up to four drives on a single host interface. It is also not necessary to +up to four drives on a single host interface. It is also not necessary to have four drives on a single interface before adding a second interface. .Pp By default, @@ -143,7 +143,7 @@ By default, searches for the CD-ROM host interface adapters by using a table of known I/O ports on Creative host adapters (see \fIoptions.h\fR). Although this is very flexible, it can cause problems when your system has other devices -that are located at the I/O ports that +that are located at the I/O ports that .Nm is checking for CD-ROM host interfaces. In addition, checking multiple locations can cause the boot process to take longer than it could. @@ -187,14 +187,14 @@ Matsushita CR-562-x Matsushita CR-563-x .El Most resellers leave these original markings on the drives since the label -also has the FCC, VDE, CSA and RU certification marks. +also has the FCC, VDE, CSA and RU certification marks. .Pp Both of these drive models have motorized trays. There is also a custom version of these drives that does not have the volume control or headphone jack (seen on some Tandy computers), but this drive also works with .Nm . .Pp -The Matsushita CR-522-x and CR-523-x CD-ROM drive is not usable with +The Matsushita CR-522-x and CR-523-x CD-ROM drive is not usable with .Nm . The CR-522 and CR-523 can also be identified from the front as it requires a CD-caddy. @@ -202,8 +202,8 @@ requires a CD-caddy. Drives with IDE interfaces must use an IDE driver. .Pp The TEAC CD-55 4X CD-ROM drive also uses the Creative/Panasonic interface -but the TEAC drive is \fInot\fR compatible with the Matsushita CR-56x drives. -The TEAC drive cannot be used with +but the TEAC drive is \fInot\fR compatible with the Matsushita CR-56x drives. +The TEAC drive cannot be used with .Nm . .Pp The most common source of host interface adapters for the Panasonic drives @@ -218,7 +218,7 @@ driver: .Bl -tag -width LONGNAME -compact -offset indent .It Creative Sound Blaster Pro (SBPRO) (CT1330A) -.It Creative +.It Creative Sound Blaster 16 (CT1730) .It Creative Sound Blaster 16 - cost-reduced (CT1740) @@ -247,7 +247,7 @@ interface release new versions of their adapters all the time. In addition to Creative Labs adapters, adapters that are compatible with Media Vision, IBM and Lasermate adapters are also supported. However, these adapters use a wide range of I/O port addresses, so the driver -must be reconfigured to locate these adapters. +must be reconfigured to locate these adapters. .Pp It is important to understand that some manufacturers have a different host interface implementation. If you have a board that won't communicate @@ -263,15 +263,15 @@ driver supports block and character access. Partition "a" returns "c" cannot be "mounted" with cd9660 or other filesystem emulators.) No other partitions are supported. .Pp -The +The .Nm matcdl devices work the same as the normal .Nm devices except that the drive trays are locked and remain locked until all of the devs on that drive are closed. .Pp -.Nm Matcd -accepts numerous +.Nm Matcd +accepts numerous .Fn ioctl commands, including disk and functions related to CD-ROM audio and tray control features. The commands are: @@ -342,17 +342,17 @@ The .Fn ioctl commands defined above are the only ones that the .Nm -driver supports. +driver supports. .Sh FILES .Bl -tag -width /dev/(r)matcd0a_/dev/(r)matcdl0a -compact .It Pa /dev/[r]matcd0a /dev/[r]matcdl0a is used to access 2048-byte blocks of data on a CD-ROM disc -that is recorded in the Mode 1 Form 1 format. +that is recorded in the Mode 1 Form 1 format. .It Pa /dev/[r]matcd0c /dev/[r]matcdl0c is used to access 2352-byte frames on a CD-ROM disc recorded in any format. .It Pa /usr/src/sys/i386/isa/matcd/* -Source code and compilation options for +Source code and compilation options for .Nm . .El .Pp @@ -387,8 +387,8 @@ numbers are always contiguous. The driver and documentation was written by .An Frank Durda IV . .Pp -Program and Documentation are Copyright 1994, 1995, -All rights reserved. +Program and Documentation are Copyright 1994, 1995, +All rights reserved. .Sh HISTORY The .Nm diff --git a/share/man/man4/man4.i386/meteor.4 b/share/man/man4/man4.i386/meteor.4 index b4d2ed8..14616cd 100644 --- a/share/man/man4/man4.i386/meteor.4 +++ b/share/man/man4/man4.i386/meteor.4 @@ -15,7 +15,7 @@ The driver provides support for a PCI .Em video capture. -It allows the capture of 24 bit RGB, 16 bit RGB and 16 bit YUV +It allows the capture of 24 bit RGB, 16 bit RGB and 16 bit YUV output formats. .Pp .Ss Meteor Driver Installation @@ -206,7 +206,7 @@ memory into the user process space, and issues either the single-capture or the continuous capture call (see: .Dv METEORCAPTUR .Xr ioctl 2 -call) to load the data into the memory mapped buffer. +call) to load the data into the memory mapped buffer. .Pp As explained in the .Dv METEORCAPTUR @@ -263,20 +263,20 @@ main() exit(1); } - mmbuf=(char *)mmap((caddr_t)0, SIZE, PROT_READ, + mmbuf=(char *)mmap((caddr_t)0, SIZE, PROT_READ, MAP_SHARED, i, (off_t)0); #ifdef SINGLE_MODE /* single frame capture */ c = METEOR_CAP_SINGLE ; ioctl(i, METEORCAPTUR, &c); /* wait for the frame */ - + /* directly access the frame buffer array data in mmbuf */ #else /* continuous frame capture */ c = METEOR_CAP_CONTINOUS ; ioctl(i, METEORCAPTUR, &c); /* returns immediately */ - + /* directly access the frame buffer array data in mmbuf */ c = METEOR_CAP_STOP_CONT ; @@ -293,7 +293,7 @@ Memory mapped, multi-frame ring buffer synchronize capture. This continuous capture mode is synchronized with the application that processes up to 32 frames. This gives the advantages of both single and -continuous capture modes. +continuous capture modes. .Pp The kernel notifies the application of a new data by raising an application defined signal. @@ -409,7 +409,7 @@ usr2_catcher() /* add frame processing here */ /* deactivate frame */ common_mem->active &= ~(1 << (sig_cnt % 16)); - common_mem->num_active_bufs--; + common_mem->num_active_bufs--; /* process next frame on next interrupt */ sig_cnt = ((sig_cnt+1) % FRAME_MAX); @@ -601,7 +601,7 @@ will also attempt to reallocate a new contiguous kernel buffer if the new geometry exceeds the old geometry. On other hand, if the new geometry will fit in the existing buffer, -the existing buffer is used. +the existing buffer is used. .Pp If .Dv METEORSETGEO @@ -849,7 +849,7 @@ and and .Dv METEORGCHCV are used to set and get the chrominance -gain control and effects the UV output amplitude. +gain control and effects the UV output amplitude. .Pp If .Dv METEORSCHCV @@ -899,7 +899,7 @@ invalid signed char pointer. requests .Dv METEORSCOUNT and -.Dv METEORGCOUNT +.Dv METEORGCOUNT .Pp .Dv METEORGCOUNT is used to get the count of frame errors, DMA errors and diff --git a/share/man/man4/man4.i386/mse.4 b/share/man/man4/man4.i386/mse.4 index bde26bb..3dc8cb0 100644 --- a/share/man/man4/man4.i386/mse.4 +++ b/share/man/man4/man4.i386/mse.4 @@ -31,7 +31,7 @@ The interface circuit may come on an integrated I/O card or as an option on video cards. .Pp The bus and InPort mice have two or three buttons, -and a D-sub 9-pin male connector or a round DIN 9-pin +and a D-sub 9-pin male connector or a round DIN 9-pin male connector. .Pp The primary port address of the bus and InPort mouse interface cards @@ -51,22 +51,22 @@ It may be 15, 30, 60 or 120Hz. The difference between the two types of the mice is not in mouse devices (in fact they are exactly the same). But in the circuit on the interface cards. -This means that the device from a bus mouse package can be +This means that the device from a bus mouse package can be connected to the interface card from an InPort mouse package, or vice versa, provided that their connectors match. .Ss Operation Levels The .Nm -driver has two levels of operation. +driver has two levels of operation. The current operation level can be set via an ioctl call. .Pp At the level zero the basic support is provided; the device driver will report -horizontal and vertical movement of the attached device +horizontal and vertical movement of the attached device and state of up to three buttons in the format described below. It is a subset of the MouseSystems protocol. .Pp .Bl -tag -width Byte_1 -compact -.It Byte 1 +.It Byte 1 .Bl -tag -width bit_7 -compact .It bit 7 Always one. @@ -91,23 +91,23 @@ Always zero. Always zero. .El .Pp -This is the default level of operation and the driver is initially +This is the default level of operation and the driver is initially at this level when opened by the user program. .Pp At the operation level one (extended level), a data packet is encoded in the standard format -.Dv MOUSE_PROTO_SYSMOUSE +.Dv MOUSE_PROTO_SYSMOUSE as defined in .Xr mouse 4 . .Ss Acceleration The .Nm driver can somewhat `accelerate' the movement of the pointing device. -The faster you move the device, the further the pointer -travels on the screen. -The driver has an internal variable which governs the effect of +The faster you move the device, the further the pointer +travels on the screen. +The driver has an internal variable which governs the effect of the acceleration. -Its value can be modified via the driver flag +Its value can be modified via the driver flag or via an ioctl call. .Ss Device Number The minor device number of the @@ -118,9 +118,9 @@ minor = (`unit' << 1) | `non-blocking' .Ed .Pp where `unit' is the device number (usually 0) and the `non-blocking' bit -is set to indicate ``don't block waiting for mouse input, +is set to indicate ``don't block waiting for mouse input, return immediately''. -The `non-blocking' bit should be set for \fIXFree86\fP, +The `non-blocking' bit should be set for \fIXFree86\fP, therefore the minor device number usually used for \fIXFree86\fP is 1. See .Sx FILES @@ -131,26 +131,26 @@ for device node names. The .Nm driver accepts the following driver flag. -Set it in the -kernel configuration file +Set it in the +kernel configuration file .Pq see Xr config 8 or in the User Configuration Menu at -the boot time +the boot time .Pq see Xr boot 8 . .Pp .Bl -tag -width MOUSE .It bit 4..7 ACCELERATION This flag controls the amount of acceleration effect. -The smaller the value of this flag is, more sensitive the movement becomes. -The minimum value allowed, thus the value for the most sensitive setting, +The smaller the value of this flag is, more sensitive the movement becomes. +The minimum value allowed, thus the value for the most sensitive setting, is one. Setting this flag to zero will completely disables the -acceleration effect. +acceleration effect. .El .Sh IOCTLS -There are a few +There are a few .Xr ioctl 2 -commands for mouse drivers. +commands for mouse drivers. These commands and related structures and constants are defined in .Ao Pa sys/mouse.h Ac . General description of the commands is given in @@ -167,7 +167,7 @@ These commands manipulate the operation level of the driver. .Pp .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw -Returns the hardware information of the attached device in the following +Returns the hardware information of the attached device in the following structure. Only the .Dv iftype @@ -192,7 +192,7 @@ field holds the number of buttons on the device. The .Dv iftype is either -.Dv MOUSE_IF_BUS +.Dv MOUSE_IF_BUS or .Dv MOUSE_IF_INPORT . .Pp @@ -211,9 +211,9 @@ The is always .Dv MOUSE_MODEL_GENERIC at the operation level 0. -It may be +It may be .Dv MOUSE_MODEL_GENERIC -or one of +or one of .Dv MOUSE_MODEL_XXX constants at higher operation levels. .Pp @@ -248,9 +248,9 @@ at the operation level one. .Pp The .Dv rate -is the status report rate (reports/sec) at which the device will send +is the status report rate (reports/sec) at which the device will send movement report to the host computer. -As there is no standard to detect the current setting, +As there is no standard to detect the current setting, this field is always set to -1. .Pp The @@ -259,7 +259,7 @@ is always set to -1. .Pp The .Dv accelfactor -field holds a value to control acceleration feature +field holds a value to control acceleration feature .Pq see Sx Acceleration . It is zero or greater. If it is zero, acceleration is disabled. @@ -290,8 +290,8 @@ Note that this detection method is not 100% reliable, thus, should be taken only as an advisory measure. .Pp Only -.Dv level -and +.Dv level +and .Dv accelfactor are modifiable by the .Dv MOUSE_SETMODE @@ -303,8 +303,8 @@ The command changes the current operation parameters of the mouse driver as specified in .Ar mode . Only -.Dv level -and +.Dv level +and .Dv accelfactor may be modifiable. Setting values in the other field does not generate @@ -323,7 +323,7 @@ These commands are not supported by the driver. .Pp .It Dv MOUSE_GETSTATUS Ar mousestatus_t *status -The command returns the current state of buttons and +The command returns the current state of buttons and movement counts as described in .Xr mouse 4 . .El @@ -341,18 +341,18 @@ movement counts as described in .Sh EXAMPLES .Dl "device mse0 at isa? port 0x23c irq 5" .Pp -Add the +Add the .Nm driver at the primary port address with the IRQ 5. .Pp .Dl "device mse1 at isa? port 0x238 flags 0x30 irq 4" .Pp -Define the +Define the .Nm driver at the secondary port address with the IRQ 4 and the acceleration factor of 3. .Sh CAVEAT -Some bus mouse interface cards generate interrupts at the fixed report rate +Some bus mouse interface cards generate interrupts at the fixed report rate when enabled, whether or not the mouse state is changing. The others generate interrupts only when the state is changing. .Sh SEE ALSO diff --git a/share/man/man4/man4.i386/npx.4 b/share/man/man4/man4.i386/npx.4 index e2504ae..4ad4041 100644 --- a/share/man/man4/man4.i386/npx.4 +++ b/share/man/man4/man4.i386/npx.4 @@ -64,7 +64,7 @@ of whether or not a NPX is present. .Pp If there is no NPX present in the system, the MATH_EMULATE or GPL_MATH_EMULATE option must be defined in the kernel configuration -file. +file. It will provide support for the instructions normally executed by the NPX. If there is no NPX in the system and the kernel is not built with math @@ -92,7 +92,7 @@ support a system with normal workload unless care is taken to compile the whole system (including third-party packages) with compiler options that avoid the use of the non-emulated instructions. .Sh BUGS -There are lots of them, especially on old cheap motherboards. +There are lots of them, especially on old cheap motherboards. In particular, some motherboards do not have the interrupt lines from the NPX to the CPU wired properly. If this is the case, the emulator must be used if consistent system diff --git a/share/man/man4/man4.i386/pcf.4 b/share/man/man4/man4.i386/pcf.4 index b1d33e2..ed61869 100644 --- a/share/man/man4/man4.i386/pcf.4 +++ b/share/man/man4/man4.i386/pcf.4 @@ -43,9 +43,9 @@ driver provides support to the Philips PCF8584 I2C controller for the system. .Pp The PCF8584 is an integrated circuit designed in CMOS technology which serves -as an interface between most standard parallel-bus +as an interface between most standard parallel-bus microcontrollers/microprocessors and the serial I2C-bus. -The PCF8584 +The PCF8584 provides both master and slave functions. Communication with I2C-bus is carried out on a byte-wise basis using interrupt or polled handshake. diff --git a/share/man/man4/man4.i386/perfmon.4 b/share/man/man4/man4.i386/perfmon.4 index c1fccbd..d4f15f9 100644 --- a/share/man/man4/man4.i386/perfmon.4 +++ b/share/man/man4/man4.i386/perfmon.4 @@ -12,7 +12,7 @@ .\" no representations about the suitability of this software for any .\" purpose. It is provided "as is" without express or implied .\" warranty. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS .\" ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF diff --git a/share/man/man4/man4.i386/pnp.4 b/share/man/man4/man4.i386/pnp.4 index 8e32dfa..5f3997d 100644 --- a/share/man/man4/man4.i386/pnp.4 +++ b/share/man/man4/man4.i386/pnp.4 @@ -97,7 +97,7 @@ another device with a different CSN/LDN pair. Sets the value of a 32-bit flags entry which is passed to the device driver. This can be used to set special operation modes (e.g. SB vs. WSS -emulation on some sound cards, etc.). +emulation on some sound cards, etc.). .El .Pp The current content of the table can be printed using the @@ -115,7 +115,7 @@ command. PnP devices are automatically recognized and configured by the kernel. A PnP device is identified by the following data structure: .Bd -literal -struct pnp_device { +struct pnp_device { char *pd_name; char *(*pd_probe ) (u_long csn, u_long vendor_id); void (*pd_attach ) (u_long csn, u_long vend_id, char * name, diff --git a/share/man/man4/man4.i386/ray.4 b/share/man/man4/man4.i386/ray.4 index 4994a4f..68df8f5 100644 --- a/share/man/man4/man4.i386/ray.4 +++ b/share/man/man4/man4.i386/ray.4 @@ -192,7 +192,7 @@ of the output from .Pp The following messages are enabled using the .Cm debug -option of +option of .Xr ifconfig 8 . .Bl -diag .It "ray?: cannot transmit - not running" @@ -316,7 +316,7 @@ The NIC has generated an interrupt with an incorrect control block. .It "ray?: unexpected SHUTDOWN" .It "ray?: unexpected DUMP_MEM" .It "ray?: unexpected START_TIMER" -The NIC has generated an interrupt signalling that +The NIC has generated an interrupt signalling that the indicated command has completed. At present these commands are never issued by the driver, so they represent firmware/hardware/driver bugs. @@ -341,7 +341,7 @@ Benign warning that may occur when the NIC is ejected. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ifconfig 8 , .Xr pccardd 8 , .Xr raycontrol 8 @@ -360,7 +360,7 @@ driver by .An "Christian E. Hopps" . The driver was re-structured by -.An Duncan Barclay Aq dmlb@FreeBSD.org , +.An Duncan Barclay Aq dmlb@FreeBSD.org , so that .Xr dhclient 8 would work. diff --git a/share/man/man4/man4.i386/sb.4 b/share/man/man4/man4.i386/sb.4 index 8fc9a4b..b1b9c7f 100644 --- a/share/man/man4/man4.i386/sb.4 +++ b/share/man/man4/man4.i386/sb.4 @@ -5,10 +5,10 @@ .\" This documentation is public domain, and is provided without warranty. .\" Alex Zepeda, the "author" of this page is not responsible for any .\" consequences of any sort of manipulation of this document. -.\" +.\" .\" SoundBlaster and any phrases including it's name are copyright .\" Creative Labs, not me. -.\" +.\" .\" alex!@bigfoot.com .\" $FreeBSD$ .\" @@ -65,11 +65,11 @@ the device. Support for this feature may be implemented in a future version of this driver. .Sh SEE ALSO -.Xr cdcontrol 1 , +.Xr cdcontrol 1 , .Xr mixer 8 .Sh AUTHORS .An -nosplit -The original SoundBlaster DSP and SoundBlaster 16 MIDI, and Yamaha OPL-3 +The original SoundBlaster DSP and SoundBlaster 16 MIDI, and Yamaha OPL-3 drivers were written by .An Hannu Savolainen . The SoundBlaster 16 DSP code was written by diff --git a/share/man/man4/man4.i386/spkr.4 b/share/man/man4/man4.i386/spkr.4 index b2775fd..6cd8c557 100644 --- a/share/man/man4/man4.i386/spkr.4 +++ b/share/man/man4/man4.i386/spkr.4 @@ -149,22 +149,22 @@ Sets the number of quarter notes per minute; default is 120. Musical names for common tempi are: .Bd -literal -offset indent Tempo Beats Per Minute -very slow Larghissimo +very slow Larghissimo Largo 40-60 Larghetto 60-66 - Grave - Lento + Grave + Lento Adagio 66-76 -slow Adagietto +slow Adagietto Andante 76-108 -medium Andantino +medium Andantino Moderato 108-120 -fast Allegretto +fast Allegretto Allegro 120-168 - Vivace - Veloce + Vivace + Veloce Presto 168-208 -very fast Prestissimo +very fast Prestissimo .Ed .It Li M[LNS] Set articulation. diff --git a/share/man/man4/man4.i386/streams.4 b/share/man/man4/man4.i386/streams.4 index 6860ad0..0530342 100644 --- a/share/man/man4/man4.i386/streams.4 +++ b/share/man/man4/man4.i386/streams.4 @@ -47,27 +47,27 @@ for userland applications. .Pp Internally, .Nm -provides STREAMS handles by using socket creation kernel routines, and +provides STREAMS handles by using socket creation kernel routines, and adding state-tracking information to the socket to permit manipulation by STREAMS emulation code in .Xr svr4 4 . -Hence, opening a stream device produces a result similar to what would be +Hence, opening a stream device produces a result similar to what would be obtained by calling .Xr socket 2 . .Pp Applications should never use this interface directly: STREAMS emulation is only provided as a service to support ABI requirements in -the SVR4 environment which +the SVR4 environment which .Xr svr4 4 -needs to present to client binaries. +needs to present to client binaries. .Sh BUGS This whole interface is a crude hack to produce STREAMS semantics -through emulation over sockes. +through emulation over sockes. .Pp -Programmers who hope to be able to use this interface to provide +Programmers who hope to be able to use this interface to provide SVR4 STREAMS services to BSD applications will be sorely disappointed. .Sh SEE ALSO -.Xr svr4 4 +.Xr svr4 4 .Sh HISTORY System V Release 4 ABI support first appeared in .Fx 4.0 . diff --git a/share/man/man4/man4.i386/svr4.4 b/share/man/man4/man4.i386/svr4.4 index a9d9d85..08a04fb 100644 --- a/share/man/man4/man4.i386/svr4.4 +++ b/share/man/man4/man4.i386/svr4.4 @@ -74,25 +74,25 @@ implementation is provided. .Sh LIMITATIONS Because the provided ABI has been developed in ignorance of actual SVR4 source code, there are bound to be unforseen interactions between SVR4 -client applications and the emulated ABI which cause applications to -malfunction. +client applications and the emulated ABI which cause applications to +malfunction. .Pp Additionally, some SVR4 operating systems do not adhere to the SVR4 ELF standard. In particular, Solaris does not set the ELF interpreter field in the -ELF header to a value which would allow the kernel to correctly +ELF header to a value which would allow the kernel to correctly identify a client executable as an SVR4 application. -Thus, in certain instances it is necessary to use the +Thus, in certain instances it is necessary to use the .Xr brandelf 1 utility to explicitly brand the executable, or to set the kern.fallback_elf_brand .Xr sysctl 8 -variable to define a "default" ABI for unbranded executables. +variable to define a "default" ABI for unbranded executables. Value ELFOSABI_SOLARIS represents Solaris; ELFOSABI_SYSV represents other SysVR4 operating systems. -See +See .Pa /usr/include/sys/elf_common.h -for ELFOSABI branding definitions, and +for ELFOSABI branding definitions, and .Xr brandelf 1 for information on branding executables. .Pp @@ -131,22 +131,22 @@ regardless of whether the module is statically linked into the kernel or loaded as a module. .Pp -STREAMS emulation is limited but (largely) functional. +STREAMS emulation is limited but (largely) functional. Assuming the .Xr streams 4 -module is loaded, a STREAMS handle can be obtained by opening one of the +module is loaded, a STREAMS handle can be obtained by opening one of the relevent files in .Pa /dev -or +or .Pa /compat/svr4/dev . -Internally, the +Internally, the .Xr streams 4 driver produces a socket descriptor and "tags" it with additional STREAMS -state information before returning it to the client application. +state information before returning it to the client application. The .Nm -environment uses the additional state information to recognize and -manipulate emulated STREAMS handles when STREAMS-specific +environment uses the additional state information to recognize and +manipulate emulated STREAMS handles when STREAMS-specific .Xr ioctl 2 calls are executed. .Pp @@ -160,7 +160,7 @@ Emulated connectionless STREAMS fail to receive data from the network in some circumstances (but succeed in others -- probably due to particular ways of initializing them which the .Xr streams 4 -module is mishandling, and interaction between STREAMS and +module is mishandling, and interaction between STREAMS and .Xr poll 2 ) . Connection-oriented STREAMS appear to be functional. .Pp @@ -168,7 +168,7 @@ Ironically, this SVR4 emulator does not (yet) support SVR4 semaphores or shared memory. .Pp .Xr ports 7 -to automatically create the +to automatically create the .Pa /compat/svr4 environment do not exist. .Xr tar 1 @@ -178,9 +178,9 @@ archives containing pre-populated trees can be obtained from Extensive testing has only really been carried out with Solaris 2.x binaries, with anecdotal reports of limited success coming from testers with early-revision SCO media. In theory, the basic SVR4 ABI should be constant -across the set of vendors who produce SVR4 operating systems, but in -practice that's probably not the case. If necessary, future work can -either implement additional +across the set of vendors who produce SVR4 operating systems, but in +practice that's probably not the case. If necessary, future work can +either implement additional .Xr kld 4 modules which produce functionality which contains OS-dependent departures from the behaviour which has been implemented in this @@ -194,7 +194,7 @@ client applications. .It Pa /compat/svr4 minimal SVR4 run-time environment .It Pa /sys/compat/svr4/syscalls.master -mappings between SVR4 syscalls and +mappings between SVR4 syscalls and .Nm module entrypoints. .El diff --git a/share/man/man4/man4.i386/tx.4 b/share/man/man4/man4.i386/tx.4 index 8a37970..2b8438b 100644 --- a/share/man/man4/man4.i386/tx.4 +++ b/share/man/man4/man4.i386/tx.4 @@ -81,7 +81,7 @@ Device and driver reset follows this error. Cannot allocate memory for received packet. Packet thrown away. .It "tx%d: can't stop %s DMA" -While reseting, driver failed to stop device correctly. +While reseting, driver failed to stop device correctly. .El .Sh BUGS The multicast packets filtering is not supported. diff --git a/share/man/man4/man4.i386/vx.4 b/share/man/man4/man4.i386/vx.4 index db0978c..c43cf64 100644 --- a/share/man/man4/man4.i386/vx.4 +++ b/share/man/man4/man4.i386/vx.4 @@ -72,7 +72,7 @@ a test for it based on the information supplied by 3Com, but the test resulted mostly in spurious warnings. .Pp The performance of this driver is somewhat limited by the fact that it uses -only polled-mode I/O and does not make use of the bus-mastering capability +only polled-mode I/O and does not make use of the bus-mastering capability of the cards. .Sh BUGS The diff --git a/share/man/man4/man4.i386/wd.4 b/share/man/man4/man4.i386/wd.4 index 8d67a12..e9e64ab 100644 --- a/share/man/man4/man4.i386/wd.4 +++ b/share/man/man4/man4.i386/wd.4 @@ -40,10 +40,10 @@ This driver provides access to disks connected to controllers that emulate the Western Digital WD100x series. This range of controllers includes WD1003 -type ST412 controllers, WD1007 ESDI controllers and also the generic IDE +type ST412 controllers, WD1007 ESDI controllers and also the generic IDE controllers found on most motherboards. .Pp -Your controller documentation is usually quick to point out any WD100x +Your controller documentation is usually quick to point out any WD100x compatibility. .Pp You can convey a number of hints and instructions to the driver using @@ -56,7 +56,7 @@ For each drive there are six bit-fields encoded in a 16 bit integer: .It 0x8000 Test and use the 32bit transfer capability of the drive. .It 0x4000 -If drive looks like it's coming out of sleep mode, assume it's +If drive looks like it's coming out of sleep mode, assume it's confused and reinitialize it. .It 0x2000 Probe for and use the bus-mastering DMA capabilities of modern diff --git a/share/man/man4/man4.i386/wl.4 b/share/man/man4/man4.i386/wl.4 index 982084b..320ba8a 100644 --- a/share/man/man4/man4.i386/wl.4 +++ b/share/man/man4/man4.i386/wl.4 @@ -47,29 +47,29 @@ about 400 feet (indoors, more outdoors) can be covered in circumference. This card can talk to the companion (wlp0) pccard. Speeds vary from 1 megabit to theoretically 2 megabits (roughly T1 in speed). .Pp -The card has three fundamental hardware +The card has three fundamental hardware units, a so-called PSA or programmable storage area, a radio modem, -and a ethernet lan controller. The latter component is the +and a ethernet lan controller. The latter component is the ancient (and not very honorable) Intel 82586 ethernet chip. Fundamentally it appears to the operating system as an ethernet system, and speaks IEEE MAC addresses. The radio modem simply translates ethernet packets to/from radio packets, that are either at 2.4 Ghz or 915 mhz depending on the radio modem. It supports a collision avoidance scheme. The lan controller -supports promiscuous mode, broadcast, and multicasting +supports promiscuous mode, broadcast, and multicasting (although there is a glitch -in the latter). "It thinks it is ethernet". -.Pp +in the latter). "It thinks it is ethernet". +.Pp How it is used depends on the kind of antennae deployed with it. Point to point applications are possible as are ethernet-like lan use. The vendor -ships an omni-directional antennae that works in the +ships an omni-directional antennae that works in the vicinity of 400 feet (indoors). Point to point antennae can be purchased that will go miles. .Sh SETUP The card can either be initialized with the vendor supplied DOS setup software. Typically minimally an IRQ, port, and Network ID must be supplied. -Michael Smith's +Michael Smith's .Xr wlconfig 8 utility can now be used to do this work from the UNIX side. The card is "not" plug and play. @@ -79,7 +79,7 @@ by the radio modem. .Sh CONTROL In addition to the config utility, there are several sysctl switches that can be used to modify runtime parameters. -The +The .Xr sysctl 8 variables are as follows: .Bl -diag @@ -94,9 +94,9 @@ This switch defaults to 0; i.e., the nwid is not ignored. It can be set to 1 to cause the nwid to not be used. This may be useful when the device is in promiscuous mode as one can watch for all packets and ignore nwid differences. -.It machdep.wl_xmit_watch <milliseconds> +.It machdep.wl_xmit_watch <milliseconds> This switch is not currently useful. -.It machdep.wl_gather_snr <milliseconds> +.It machdep.wl_gather_snr <milliseconds> This switch is not currently useful. .Pp There is also a signal strength cache in the driver. It may be interrogated @@ -105,12 +105,12 @@ with Incoming packets are checked for certain hardware radio-modem values including signal strength, silence, and quality, which range fro 0..63, 0..63, and 0..15 -respectively. Thus one can read out signal strenth values to see -how close/far peer nodes are. The signal strength cache is indexed by +respectively. Thus one can read out signal strenth values to see +how close/far peer nodes are. The signal strength cache is indexed by sender MAC address. There are two sysctls that change how it filters packets. Both are on by default. -.It machdep.wl_wlcache_mcastonly <0 | 1> +.It machdep.wl_wlcache_mcastonly <0 | 1> By default this switch is on. It forces the cache to filter out unicast packets. Only broadcast or multicast packets are accepted. diff --git a/share/man/man4/man4.i386/wt.4 b/share/man/man4/man4.i386/wt.4 index 8e726a2..dbe8391 100644 --- a/share/man/man4/man4.i386/wt.4 +++ b/share/man/man4/man4.i386/wt.4 @@ -9,7 +9,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -25,7 +25,7 @@ .\" .Dd July 10, 1995 .Dt WT 4 i386 -.Os +.Os .Sh NAME .Nm wt .Nd Archive/Wangtek cartridge tape driver @@ -38,9 +38,9 @@ driver provides support for the following Archive and Wangtek boards: .Pp .Bl -item -offset indent -compact .It -QIC-02 +QIC-02 .It -QIC-36 +QIC-36 .El .Sh SEE ALSO .Xr intro 4 diff --git a/share/man/man4/md.4 b/share/man/man4/md.4 index 5523bb2..fe1edbf 100644 --- a/share/man/man4/md.4 +++ b/share/man/man4/md.4 @@ -29,14 +29,14 @@ devices with .Cm malloc backing must share the malloc-per-bucket-quota. The exact size of this quota varies, in particular with the amount -of RAM in the +of RAM in the system. The exact value can be determined with .Xr vmstat 8 . .It Cm preload -A file loaded by +A file loaded by .Xr loader 8 -with type +with type .Sq md_image is used for backing store. For backwards compatibility the type diff --git a/share/man/man4/mem.4 b/share/man/man4/mem.4 index d2b3c46..5e07a24 100644 --- a/share/man/man4/mem.4 +++ b/share/man/man4/mem.4 @@ -121,7 +121,7 @@ We believe the region to be invalid or otherwise erroneous. .It MDF_FIXACTIVE The region cannot be disabled. .It MDF_BUSY -The region is currently owned by another process and may not be +The region is currently owned by another process and may not be altered. .El .Pp @@ -143,13 +143,13 @@ descriptors. If greater than 0, the array at will be filled with a corresponding number of descriptor structures, or the maximum, whichever is less. .Pp -The +The .Fa MEMRANGE_SET ioctl is used to add, alter and remove memory range attributes. A range with the MDF_FIXACTIVE flag may not be removed; a range with the MDF_BUSY flag may not be removed or updated. .Pp -.Fa mo_arg[0] +.Fa mo_arg[0] should be set to MEMRANGE_SET_UPDATE to update an existing or establish a new range, or to MEMRANGE_SET_REMOVE to remove a range. .Sh RETURN VALUES diff --git a/share/man/man4/mlx.4 b/share/man/man4/mlx.4 index f36897f..43efd7b 100644 --- a/share/man/man4/mlx.4 +++ b/share/man/man4/mlx.4 @@ -10,7 +10,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -40,9 +40,9 @@ driver provides support for Mylex DAC-family PCI to SCSI RAID controllers, including versions relabelled by Digital/Compaq. Supported controllers include: .Bl -bullet -.It +.It DAC960P -.It +.It DAC960PD .It DAC960PL @@ -62,8 +62,8 @@ All major firmware revisions (2.x, 3.x, 4.x and 5.x) are supported, however it is always advisable to upgrade to the most recent firmware available for the controller. .Pp -Compatible Mylex controllers not listed should work, but have not been -verified. +Compatible Mylex controllers not listed should work, but have not been +verified. .Sh DIAGNOSTICS .Ss Controller initialisation phase .Bl -diag @@ -224,7 +224,7 @@ driver was written by .Pp This manual page was written by .An Jeroen Ruigrok van der Werven -.Aq asmodai@FreeBSD.org +.Aq asmodai@FreeBSD.org and .An Michael Smith .Aq msmith@FreeBSD.org . diff --git a/share/man/man4/mly.4 b/share/man/man4/mly.4 index f21e2d7..2e0ed39 100644 --- a/share/man/man4/mly.4 +++ b/share/man/man4/mly.4 @@ -10,7 +10,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -43,9 +43,9 @@ PCI to SCSI RAID controllers with version 6.00 and later firmware. Supported controllers include: .Bl -bullet -.It +.It AcceleRAID 160 -.It +.It AcceleRAID 170 .It AcceleRAID 352 @@ -55,7 +55,7 @@ eXtremeRAID 2000 eXtremeRAID 3000 .El .Pp -Compatible Mylex controllers not listed should work, but have not been +Compatible Mylex controllers not listed should work, but have not been verified. .Pp Logical devices (array drives) attached to the controller are presented diff --git a/share/man/man4/mouse.4 b/share/man/man4/mouse.4 index 73c0835..55e5a7b 100644 --- a/share/man/man4/mouse.4 +++ b/share/man/man4/mouse.4 @@ -45,7 +45,7 @@ provide user programs with movement and button state information of the mouse. Currently there are specific device drivers for bus, InPort, PS/2, and USB mice. The serial mouse is not directly supported by a dedicated driver, but it is accessible via the serial device driver or via -.Xr moused 8 +.Xr moused 8 and .Xr sysmouse 4 . .Pp @@ -56,7 +56,7 @@ mouse data from the device via .Xr read 2 . Movement and button states are usually encoded in fixed-length data packets. Some mouse devices may send data in variable length of packets. -Actual protocol (data format) used by each driver differs widely. +Actual protocol (data format) used by each driver differs widely. .Pp The mouse drivers may have ``non-blocking'' attribute which will make the driver return immediately if mouse data is not available. @@ -66,16 +66,16 @@ The current operation level can be examined and changed via .Xr ioctl 2 commands. The level zero is the lowest level at which the driver offers the basic -service to user programs. +service to user programs. Most drivers provide horizontal and vertical movement of the mouse and state of up to three buttons at this level. At the level one, if supported by the driver, mouse data is encoded -in the standard format -.Dv MOUSE_PROTO_SYSMOUSE +in the standard format +.Dv MOUSE_PROTO_SYSMOUSE as follows: .Pp .Bl -tag -width Byte_1 -compact -.It Byte 1 +.It Byte 1 .Bl -tag -width bit_7 -compact .It bit 7 Always one. @@ -91,26 +91,26 @@ if the device does not have the middle button. Right button status; cleared if pressed, otherwise set. .El .It Byte 2 -The first half of horizontal movement count in two's complement; +The first half of horizontal movement count in two's complement; -128 through 127. .It Byte 3 -The first half of vertical movement count in two's complement; +The first half of vertical movement count in two's complement; -128 through 127. .It Byte 4 -The second half of the horizontal movement count in two's complement; +The second half of the horizontal movement count in two's complement; -128 through 127. To obtain the full horizontal movement count, add the byte 2 and 4. .It Byte 5 -The second half of the vertical movement count in two's complement; +The second half of the vertical movement count in two's complement; -128 through 127. To obtain the full vertical movement count, add the byte 3 and 5. .It Byte 6 The bit 7 is always zero. -The lower 7 bits encode the first half of +The lower 7 bits encode the first half of Z axis movement count in two's complement; -64 through 63. .It Byte 7 The bit 7 is always zero. -The lower 7 bits encode the second half of +The lower 7 bits encode the second half of the Z axis movement count in two's complement; -64 through 63. To obtain the full Z axis movement count, add the byte 6 and 7. .It Byte 8 @@ -124,11 +124,11 @@ the bit is set. .Pp The first 5 bytes of this format is compatible with the MouseSystems format. -The additional 3 bytes have their MSBs always set to zero. +The additional 3 bytes have their MSBs always set to zero. Thus, if the user program can interpret the MouseSystems data format and tries to find the first byte of the format by detecting the bit pattern -10000xxxb, -it will discard the additional bytes, thus, be able to decode x, y +10000xxxb, +it will discard the additional bytes, thus, be able to decode x, y and states of 3 buttons correctly. .Pp Device drivers may offer operation levels higher than one. @@ -139,7 +139,7 @@ The following commands are defined for the mouse drivers. The degree of support varies from one driver to another. -This section gives general +This section gives general description of the commands. Refer to manual pages of individual drivers for specific details. .Pp @@ -149,7 +149,7 @@ Refer to manual pages of individual drivers for specific details. These commands manipulate the operation level of the mouse driver. .Pp .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw -Returns the hardware information of the attached device in the following +Returns the hardware information of the attached device in the following Except for the .Dv iftype field, the device driver may not always fill the structure with correct @@ -196,9 +196,9 @@ or .Pp The .Dv model -may be +may be .Dv MOUSE_MODEL_GENERIC -or one of +or one of .Dv MOUSE_MODEL_XXX constants. .Pp @@ -206,7 +206,7 @@ The .Dv hwid is the ID value returned by the pointing device. It -depend on the interface type; refer to the manual page of +depend on the interface type; refer to the manual page of specific mouse drivers for possible values. .Pp .It Dv MOUSE_GETMODE Ar mousemode_t *mode @@ -225,21 +225,21 @@ typedef struct mousemode { .Pp The .Dv protocol -field tells the format in which the device status is returned +field tells the format in which the device status is returned when the mouse data is read by the user program. -It is one of +It is one of .Dv MOUSE_PROTO_XXX constants. .Pp The .Dv rate -field is the status report rate (reports/sec) at which the device will send +field is the status report rate (reports/sec) at which the device will send movement reports to the host computer. -1 if unknown or not applicable. .Pp The .Dv resolution field holds a value specifying resolution of the pointing device. -It is a positive value or one of +It is a positive value or one of .Dv MOUSE_RES_XXX constants. .Pp @@ -275,8 +275,8 @@ as specified in Only .Dv rate , .Dv resolution , -.Dv level -and +.Dv level +and .Dv accelfactor may be modifiable. Setting values in the other field does not generate @@ -284,16 +284,16 @@ error and has no effect. .Pp If you do not want to change the current setting of a field, put -1 there. -You may also put zero in +You may also put zero in .Dv resolution and .Dv rate , and the default value for the fields will be selected. .\" .Pp .\" .It Dv MOUSE_GETVARS Ar mousevar_t *vars -.\" Get internal variables of the mouse driver. +.\" Get internal variables of the mouse driver. .\" The variables which can be manipulated through these commands -.\" are specific to each driver. +.\" are specific to each driver. .\" This command may not be supported by all drivers. .\" .Bd -literal .\" typedef struct mousevar { @@ -302,12 +302,12 @@ and the default value for the fields will be selected. .\" .Ed .\" .Pp .\" If the commands are supported, the first element of the array is -.\" filled with a signature value. -.\" Apart from the signature data, there is currently no standard concerning +.\" filled with a signature value. +.\" Apart from the signature data, there is currently no standard concerning .\" the other elements of the buffer. .\" .Pp .\" .It Dv MOUSE_SETVARS Ar mousevar_t *vars -.\" Get internal variables of the mouse driver. +.\" Get internal variables of the mouse driver. .\" The first element of the array must be a signature value. .\" This command may not be supported by all drivers. .Pp @@ -331,7 +331,7 @@ It uses the same structure as above. This command may not be supported by all drivers. .Pp .It Dv MOUSE_GETSTATUS Ar mousestatus_t *status -The command returns the current state of buttons and +The command returns the current state of buttons and movement counts in the following structure. .Bd -literal typedef struct mousestatus { @@ -351,24 +351,24 @@ and fields hold the current and the previous state of the mouse buttons. When a button is pressed, the corresponding bit is set. The mouse drivers may support up to 31 buttons with the bit 0 through 31. -Few button bits are defined as +Few button bits are defined as .Dv MOUSE_BUTTON1DOWN -through +through .Dv MOUSE_BUTTON8DOWN . The first three buttons correspond to left, middle and right buttons. .Pp -If the state of the button has changed since the last +If the state of the button has changed since the last .Dv MOUSE_GETSTATUS call, the corresponding bit in the .Dv flags -field will be set. +field will be set. If the mouse has moved since the last call, the .Dv MOUSE_POSCHANGED bit in the .Dv flags field will also be set. .Pp -The other fields hold movement counts since the last +The other fields hold movement counts since the last .Dv MOUSE_GETSTATUS call. The internal counters will be reset after every call to this diff --git a/share/man/man4/mtio.4 b/share/man/man4/mtio.4 index 44b0707..b60778e 100644 --- a/share/man/man4/mtio.4 +++ b/share/man/man4/mtio.4 @@ -215,7 +215,7 @@ struct scsi_tape_errors { u_int64_t nbytes; /* total # bytes processed */ } wterr, rderr; }; - + union mterrstat { struct scsi_tape_errors scsi_errstat; char _reserved_padding[256]; diff --git a/share/man/man4/natm.4 b/share/man/man4/natm.4 index 07250fc..748f1de 100644 --- a/share/man/man4/natm.4 +++ b/share/man/man4/natm.4 @@ -7,17 +7,17 @@ .Nm natm .Nd Native Mode ATM protocol layer .Sh DESCRIPTION -The BSD ATM software comes with a -.Em native mode ATM protocol layer +The BSD ATM software comes with a +.Em native mode ATM protocol layer which provides socket level access to AAL0 and AAL5 virtual circuits. -To enable this protocol layer, add +To enable this protocol layer, add .Dl options NATM to your kernel configuration file and re-make the kernel (don't forget -to do +to do .Dq make clean ). .Sh NATM API -The NATM layer uses a +The NATM layer uses a .Dv struct sockaddr_natm to specify a virtual circuit: .Bd -literal -offset indent @@ -49,29 +49,29 @@ one would use the following: /* s now connected to ATM! */ .Ed .Pp -The +The .Fn socket call simply creates an unconnected NATM socket. The .Fn connect call associates an unconnected NATM socket with a virtual circuit and tells the driver to enable that virtual circuit -for receiving data. After the +for receiving data. After the .Fn connect -call one can +call one can .Fn read -or +or .Fn write to the socket to perform ATM I/O. .Sh Internal NATM operation Internally, the NATM protocol layer keeps a list of all active virtual -circuits on the system in -.Dv natm_pcbs . +circuits on the system in +.Dv natm_pcbs . This includes circuits currently being used for IP to prevent NATM and IP from clashing over virtual circuit usage. .Pp When a virtual circuit is enabled for receiving data, the NATM protocol layer passes the address of the protocol control block down -to the driver as a receive +to the driver as a receive .Dq handle . When inbound data arrives, the driver passes the data back with the appropriate receive handle. The NATM layer uses this to avoid the @@ -87,14 +87,14 @@ is pretty rapid (in fact, it is massive!), and the normal AAL0 handling of the driver is unable to handle it (you end up with a cell per small mbuf trying to make it to the application ... it turns out the socket layer can't keep up with that sort of data stream). To -solve this problem we have implemented a +solve this problem we have implemented a .Dq raw mode which batches unprocessed AAL0 info from the card into larger data chunks blocks. We can save this data to disk in real-time without the socket layer freaking out. Unfortunately, the data has RBD (receive buffer descriptors) and cells headers in it, and this has -to be filtered out after capture. -To enable +to be filtered out after capture. +To enable .Dq raw mode one does the following ioctl: .Bd -literal -offset indent diff --git a/share/man/man4/ncr.4 b/share/man/man4/ncr.4 index 316d1ff..7c2809c 100644 --- a/share/man/man4/ncr.4 +++ b/share/man/man4/ncr.4 @@ -9,7 +9,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -39,7 +39,7 @@ driver provides support for the NCR/Symbios 53C810, 53C810a, 53C895 and 53C896 SCSI controller chips. .Sh SEE ALSO .Xr cd 4 , -.Xr ch 4 , +.Xr ch 4 , .Xr da 4 , .Xr intro 4 , .Xr sa 4 , diff --git a/share/man/man4/netgraph.4 b/share/man/man4/netgraph.4 index a816fd5..b5c451c 100644 --- a/share/man/man4/netgraph.4 +++ b/share/man/man4/netgraph.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Authors: Julian Elischer <julian@FreeBSD.org> .\" Archie Cobbs <archie@FreeBSD.org> .\" @@ -44,10 +44,10 @@ .Nd graph based kernel networking subsystem .Sh DESCRIPTION The -.Nm +.Nm system provides a uniform and modular system for the implementation of kernel objects which perform various networking functions. The objects, -known as +known as .Em nodes , can be arranged into arbitrarily complicated graphs. Nodes have .Em hooks @@ -55,7 +55,7 @@ which are used to connect two nodes together, forming the edges in the graph. Nodes communicate along the edges to process data, implement protocols, etc. .Pp The aim of -.Nm +.Nm is to supplement rather than replace the existing kernel networking infrastructure. It provides: .Pp @@ -149,7 +149,7 @@ which should be used for data and messages received through that hook in preference to the general node-wide methods. .El .Pp -A node may decide to assign special meaning to some hooks. +A node may decide to assign special meaning to some hooks. For example, connecting to the hook named .Dq debug might trigger @@ -179,7 +179,7 @@ there is a sequence of edges connecting the two nodes, the message may be .Dq source routed by specifying the corresponding sequence -of +of .Tn ASCII hook names as the destination address for the message (relative addressing). If the destination is adjacent to the source, then the source @@ -192,8 +192,8 @@ for the message (absolute addressing). The two types of .Tn ASCII addressing may be combined, by specifying an absolute start node and a sequence -of hooks. Only the -.Tn ASCII +of hooks. Only the +.Tn ASCII addressing modes are available to control programs outside the kernel, as use of direct pointers is limited of course to kernel modules. .Pp @@ -201,7 +201,7 @@ Messages often represent commands that are followed by a reply message in the reverse direction. To facilitate this, the recipient of a control message is supplied with a .Dq return address -that is suitable for addressing a reply. +that is suitable for addressing a reply. .Pp Each control message contains a 32 bit value called a .Em typecookie @@ -215,7 +215,7 @@ at that node through a particular hook, (as opposed to having been directly addressed using its ID or global name), then that hook is identified to the receiving node. This allows a message to be rerouted or passed on, should a node decide that this is required, in much the same way that data packets -are passed around between nodes. A set of standard +are passed around between nodes. A set of standard messages for flow control and link management purposes are defined by the base system that are usually passed around in this manner. Flow control message would usually travel @@ -238,7 +238,7 @@ Each node has an input queue, and some operations can be considered to be 'writers' in that they alter the state of the node. Obviously in an SMP world it would be bad if the state of a node were changed while another data packet were transiting the node. For this purpose, the input queue -implements a +implements a .Em reader/writer semantic so that when there is a writer in the node, all other requests are queued, and while there are readers, a writer, and any following @@ -246,7 +246,7 @@ packets are queued. In the case where there is no reason to queue the data, the input method is called directly, as mentionned above. .Pp A node may declare that all requests should be considered as writers, -or that requests coming in over a particular hook should be considered to +or that requests coming in over a particular hook should be considered to be a writer, or even that packets leaving or entering across a particular hook should always be queued, rather than delivered directly (often useful for interrupt routines who want to get back to the hardware quickly). @@ -268,13 +268,13 @@ Netgraph nodes and support routines generally run at .Fn splnet . However, some nodes may want to send data and control messages from a different priority level. Netgraph supplies a mechanism which -utilizes the NETISR system to move message and data delivery to +utilizes the NETISR system to move message and data delivery to .Fn splnet . Nodes that run at other priorities (e.g. interfaces) can be directly linked to other nodes so that the combination runs at the other priority, -however any interaction with nodes running at splnet MUST be achieved via the +however any interaction with nodes running at splnet MUST be achieved via the queueing functions, (which use the -.Fn netisr +.Fn netisr feature of the kernel). Note that messages are always received at .Fn splnet . @@ -294,7 +294,7 @@ is the ability to join disparate kernel networking entities together in a consistent communication framework. .Pp An example is the node type -.Em socket +.Em socket which is both a netgraph node and a .Xr socket 2 BSD socket in the protocol family @@ -315,7 +315,7 @@ and may accept or reject that action (by returning the appropriate error code): .Bl -tag -width xxx .It Creation of a new node -The constructor for the type is called. If creation of a new node is +The constructor for the type is called. If creation of a new node is allowed, the constructor must call the generic node creation function (in object-oriented terms, the superclass constructor) and then allocate any special resources it needs. For nodes that @@ -326,7 +326,7 @@ name corresponding to the device name is assigned here as well. .It Creation of a new hook The hook is created and tentatively -linked to the node, and the node is told about the name that will be +linked to the node, and the node is told about the name that will be used to describe this hook. The node sets up any special data structures it needs, or may reject the connection, based on the name of the hook. .It Successful connection of two hooks @@ -334,7 +334,7 @@ After both ends have accepted their hooks, and the links have been made, the nodes get a chance to find out who their peer is across the link and can then decide to reject the connection. Tear-down is automatic. This is also the time at which -a node may decide whether to set a particular hook (or its peer) into +a node may decide whether to set a particular hook (or its peer) into .Em queuing mode. .It Destruction of a hook @@ -372,11 +372,11 @@ The item contains a pointer to an mbuf and metadata about the packet. .Pp The node is notified on which hook the item arrived, and can use this information in its processing decision. -The receiving node must always +The receiving node must always .Fn NG_FREE_M the mbuf chain on completion or error, or pass it on to another node (or kernel module) which will then be responsible for freeing it. -Similarly the +Similarly the .Em item must be freed if it is not to be passed on to another node, by using the .Fn NG_FREE_ITEM @@ -384,26 +384,26 @@ macro. If the item still holds references to mbufs or metadata at the time of freeing then they will also be appropriatly freed. Therefore, if there is any chance that the mbuf or metadata will be changed or freed separatly from the item, it is very important -that these fields be retrieved using the +that these fields be retrieved using the .Fn NGI_GET_M and .Fn NGI_GET_META macros that also remove the reference within the item. (or multiple frees of the same object will occur). .Pp -If it is only required to examine the contents of the mbufs or the +If it is only required to examine the contents of the mbufs or the metadata, then it is possible to use the .Fn NGI_M and .Fn NGI_META macros to both read and rewrite these fields. .Pp -In addition to the mbuf chain itself there may also be a pointer to a +In addition to the mbuf chain itself there may also be a pointer to a structure describing meta-data about the message (e.g. priority information). This pointer may be .Dv NULL if there is no additional information. The format for this information is -described in +described in .Pa sys/netgraph/netgraph.h . The memory for meta-data must allocated via .Fn malloc @@ -420,10 +420,10 @@ the request item itself, or to use it to pass the message on further. .Pp The receiving node may decide to defer the data by queueing it in the .Nm -NETISR system (see below). It achieves this by setting the +NETISR system (see below). It achieves this by setting the .Dv HK_QUEUE flag in the flags word of the hook on which that data will arrive. -The infrastructure will respect that bit and queue the data for delivery at +The infrastructure will respect that bit and queue the data for delivery at a later time, rather than deliver it directly. A node may decide to set the bit on the .Em peer @@ -441,7 +441,7 @@ conformance with Frame Relay standards. .Pp The node may elect to nominate a different receive data function for data received on a particular hook, to simplify coding. It uses -the +the .Fn NG_HOOK_SET_RCVDATA hook fn macro to do this. The function receives the same arguments in every way other than it will receive all (and only) packets from that hook. @@ -450,15 +450,15 @@ This method is called when a control message is addressed to the node. As with the received data, an .Em item is reveived, with a pointer to the control message. -The message can be examined using the +The message can be examined using the .Fn NGI_MSG macro, or completely extracted from the item using the .Fn NGI_GET_MSG which also removes the reference within the item. If the Item still holds a reference to the message when it is freed -(using the +(using the .Fn NG_FREE_ITEM -macro), then the message will also be freed appropriatly. If the +macro), then the message will also be freed appropriatly. If the reference has been removed the node must free the message itself using the .Fn NG_FREE_MSG macro. @@ -468,7 +468,7 @@ The return address is retrieved from the .Em item using the .Fn NGI_RETADDR -macro and is of type +macro and is of type .Em ng_ID_t . All control messages and replies are allocated with @@ -480,7 +480,7 @@ however it is more usual to use the and .Fn NG_MKRESPONSE macros to allocate and fill out a message. -Messages must be freed using the +Messages must be freed using the .Fn NG_FREE_MSG macro. .Pp @@ -491,7 +491,7 @@ the message out another hook to that on which it arrived. .Pp The node may elect to nominate a different receive message function for messages received on a particular hook, to simplify coding. It uses -the +the .Fn NG_HOOK_SET_RCVMSG hook fn macro to do this. The function receives the same arguments in every way other than it will receive all (and only) messages from that hook. @@ -504,12 +504,12 @@ framework for the .Dq type module writer to use. .Sh Addressing -The +The .Nm framework provides an unambiguous and simple to use method of specifically -addressing any single node in the graph. The naming of a node is +addressing any single node in the graph. The naming of a node is independent of its type, in that another node, or external component -need not know anything about the node's type in order to address it so as +need not know anything about the node's type in order to address it so as to send it a generic message type. Node and hook names should be chosen so as to make addresses meaningful. .Pp @@ -557,9 +557,9 @@ One could always send a control message to node C from anywhere by using the name .Em "Frame1:uplink.dlci16" . In this case, node C would also be notified that the message -reached it via its hook +reached it via its hook .Dq mux . -Similarly, +Similarly, .Em "Frame1:uplink.dlci20" could reliably be used to reach node D, and node A could refer to node B as @@ -576,11 +576,11 @@ Note that this is only for .Em control messages . In each of these cases, where a relative addressing mode is used, the recipient is notified of the hook on which the -message arrived, as well as +message arrived, as well as the originating node. This allows the option of hop-by-hop distibution of messages and state information. -Data messages are +Data messages are .Em only routed one hop at a time, by specifying the departing hook, with each node making @@ -590,15 +590,15 @@ it decodes the frame relay header to determine the DLCI, and then forwards the unwrapped frame to either C or D. .Pp In a similar way, flow control messages may be routed in the reverse -direction to outgoing data. For example a "buffer nearly full" message from +direction to outgoing data. For example a "buffer nearly full" message from .Em "Frame1: -would be passed to node +would be passed to node .Em B which might decide to send similar messages to both nodes .Em C -and +and .Em D . -The nodes would use +The nodes would use .Em "Direct hook pointer" addressing to route the messages. The message may have travelled from .Em "Frame1: @@ -620,14 +620,14 @@ over an ISDN line: [ (no name) ] [ (no name) ] .Ed .Sh Netgraph Structures -Structures are defined in -.Pa sys/netgraph/netgraph.h +Structures are defined in +.Pa sys/netgraph/netgraph.h (for kernel sructures only of interest to nodes) and -.Pa sys/netgraph/ng_message.h +.Pa sys/netgraph/ng_message.h (for message definitions also of interest to user programs). .Pp -The two basic object types that are of interest to node authors are +The two basic object types that are of interest to node authors are .Em nodes and .Em hooks . @@ -659,9 +659,9 @@ completed. .It node ID .Pp -Of type +Of type .Em ng_ID_t , -This property can be retrieved using the macro +This property can be retrieved using the macro .Fn NG_NODE_ID "node" . .Pp .It @@ -681,7 +681,7 @@ if (strncmp( .It A node dependent opaque cookie .Pp -You may place anything of type +You may place anything of type .Em pointer here. Use the macros @@ -694,7 +694,7 @@ to set and retrieve this property. number of hooks .Pp Use -.Fn NG_NODE_NUMHOOKS "node" +.Fn NG_NODE_NUMHOOKS "node" to retrieve this value. .Pp .It @@ -707,11 +707,11 @@ tested for some condition. where fn is a function that will be called for each hook with the form .Fn fn hook arg -and returning 0 to terminate the search. If the search is terminated, then +and returning 0 to terminate the search. If the search is terminated, then .Em rethook will be set to the hook at which the search was terminated. .El -.It struct ng_hook +.It struct ng_hook Node authors should always use the following typedef to declare their hook pointers. .Pp @@ -724,7 +724,7 @@ accessed in the following manner: .It A node dependent opaque cookie. .Pp -You may place anything of type +You may place anything of type .Em pointer here. Use the macros @@ -736,7 +736,7 @@ to set and retrieve this property. .It An associate node. .Pp -You may use the macro +You may use the macro .Fn NG_HOOK_NODE "hook" to find the associated node. .Pp @@ -786,7 +786,7 @@ on the node. From a hook you can obtain the corresponding node, and from a node, it is possible to traverse all the active hooks. .Pp -A current example of how to define a node can always be seen in +A current example of how to define a node can always be seen in .Em sys/netgraph/ng_sample.c and should be used as a starting point for new node writers. .El @@ -815,7 +815,7 @@ struct ng_mesg { #define NGF_RESP 0x0001 /* Response */ .Ed .Pp -Control messages have the fixed header shown above, followed by a +Control messages have the fixed header shown above, followed by a variable length data section which depends on the type cookie and the command. Each field is explained below: .Bl -tag -width xxx @@ -868,8 +868,8 @@ Room for a short human readable version of (for debugging purposes only). .El .Pp -Some modules may choose to implement messages from more than one -of the header files and thus recognize more than one type cookie. +Some modules may choose to implement messages from more than one +of the header files and thus recognize more than one type cookie. .Sh Control Message ASCII Form Control messages are in binary format for efficiency. However, for debugging and human interface purposes, and if the node type supports @@ -918,7 +918,7 @@ does not have an explicit index, the index is implicitly the previous element's index plus one. .It o Structures are enclosed in curly braces, and each field is specified -in the form +in the form .Dq fieldname=value . .It o Any array element or structure field whose value is equal to its @@ -972,7 +972,7 @@ number of hooks attached. The ID is an internal number unique to that node. .It Dv NGM_LISTHOOKS This returns the information given by .Dv NGM_NODEINFO , -but in addition +but in addition includes an array of fields describing each link, and the description for the node at the far end of that link. .It Dv NGM_LISTNAMES @@ -1029,7 +1029,7 @@ contains the binary version of the control message. .El .Sh Flow Control Messages In addition to the control messages that affect nodes with respect to the -graph, there are also a number of +graph, there are also a number of .Em Flow-control messages defined. At present these are .Em NOT @@ -1037,7 +1037,7 @@ handled automatically by the system, so nodes need to handle them if they are going to be used in a graph utilising flow control, and will be in the likely path of these messages. The default action of a node that doesn't understand these messages should -be to pass them onto the next node. Hopefully some helper functions +be to pass them onto the next node. Hopefully some helper functions will assist in this eventually. These messages are also defined in .Pa sys/netgraph/ng_message.h and have a separate cookie @@ -1048,10 +1048,10 @@ Data moving through the .Nm system can be accompanied by meta-data that describes some aspect of that data. The form of the meta-data is a fixed header, -which contains enough information for most uses, and can optionally +which contains enough information for most uses, and can optionally be supplemented by trailing .Em option -structures, which contain a +structures, which contain a .Em cookie (see the section on control messages), an identifier, a length and optional data. If a node does not recognize the cookie associated with an option, @@ -1161,7 +1161,7 @@ Data entering from .Dv left2right is sent to the right and data from .Dv right2left -to left. +to left. .Pp .It RFC1490 MUX Encapsulates/de-encapsulates frames encoded according to RFC 1490. @@ -1210,19 +1210,19 @@ for example to make several LAN ports act together to get a higher speed link between two machines. .It Various PPP related nodes. There is a full multilink PPP implementation that runs in Netgraph. -The +The .Em Mpd -port can use these modules to make a very low latency high -capacity ppp system. It also supports +port can use these modules to make a very low latency high +capacity ppp system. It also supports .Em PPTP vpns using the .Em PPTP node. .It PPPOE A server and client side implememtation of PPPoE. Used in conjunction with -either +either .Xr ppp 8 -or the +or the .Em mpd port . .It BRIDGE This node, togther with the ethernet nodes allows a very flexible @@ -1230,7 +1230,7 @@ bridging system to be implemented. .It KSOCKET This intriguing node looks like a socket to the system but diverts all data to and from the netgraph system for further processing. This allows -such things as UDP tunnels to be almost trivially implemented from the +such things as UDP tunnels to be almost trivially implemented from the command line. .El .Pp @@ -1267,13 +1267,13 @@ should be used if possible to free data and meta data (see Messages sent using .Fn ng_send_message are freed by the recipient. As in the case above, the addresses -associated with the message are freed by whatever allocated them so the +associated with the message are freed by whatever allocated them so the recipient should copy them if it wants to keep that information. .It 4 Both control mesages and data are delivered and queued with -a netgraph +a netgraph .Em item . -The item must be freed using +The item must be freed using .Fn NG_FREE_ITEM "item" or passed on to another node. .El @@ -1284,15 +1284,15 @@ Definitions for use solely within the kernel by .Nm nodes. .It Pa /sys/netgraph/ng_message.h -Definitions needed by any file that needs to deal with -.Nm +Definitions needed by any file that needs to deal with +.Nm messages. .It Pa /sys/netgraph/ng_socket.h -Definitions needed to use +Definitions needed to use .Nm socket type nodes. .It Pa /sys/netgraph/ng_{type}.h -Definitions needed to use +Definitions needed to use .Nm {type} nodes, including the type cookie definition. @@ -1327,7 +1327,7 @@ and .Xr nghook 8 . .Pp Also look in /usr/share/examples/netgraph for solutions to several -common networking problems, solved using +common networking problems, solved using .Nm . .Sh SEE ALSO .Xr socket 2 , diff --git a/share/man/man4/netintro.4 b/share/man/man4/netintro.4 index 9b9f2b0..f7715be 100644 --- a/share/man/man4/netintro.4 +++ b/share/man/man4/netintro.4 @@ -59,8 +59,8 @@ All network protocols are associated with a specific .Em protocol family . A protocol family provides basic services to the protocol implementation to allow it to function within a specific -network environment. These services may include -packet fragmentation and reassembly, routing, addressing, and +network environment. These services may include +packet fragmentation and reassembly, routing, addressing, and basic transport. A protocol family may support multiple methods of addressing, though the current protocol implementations do not. A protocol family is normally comprised of a number @@ -68,7 +68,7 @@ of protocols, one per .Xr socket 2 type. It is not required that a protocol family support all socket types. A protocol family may contain multiple -protocols supporting the same socket abstraction. +protocols supporting the same socket abstraction. .Pp A protocol supports one of the socket abstractions detailed in .Xr socket 2 . @@ -177,7 +177,7 @@ certain interfaces such as the loopback interface, .Xr lo 4 , do not. .Pp -The following +The following .Xr ioctl 2 calls may be used to manipulate network interfaces. The @@ -185,7 +185,7 @@ The is made on a socket (typically of type .Dv SOCK_DGRAM ) in the desired domain. -Most of the requests supported in earlier releases +Most of the requests supported in earlier releases take an .Vt ifreq structure as its parameter. This structure has the form @@ -295,10 +295,10 @@ the address family in which the original socket was opened. .It Dv SIOCGIFCONF Get interface configuration list. This request takes an .Vt ifconf -structure (see below) as a value-result parameter. The +structure (see below) as a value-result parameter. The .Va ifc_len field should be initially set to the size of the buffer -pointed to by +pointed to by .Va ifc_buf . On return it will contain the length, in bytes, of the configuration list. diff --git a/share/man/man4/ng_UI.4 b/share/man/man4/ng_UI.4 index 4a52287..04b771a 100644 --- a/share/man/man4/ng_UI.4 +++ b/share/man/man4/ng_UI.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_async.4 b/share/man/man4/ng_async.4 index 647caeb..7b2fb96 100644 --- a/share/man/man4/ng_async.4 +++ b/share/man/man4/ng_async.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_bpf.4 b/share/man/man4/ng_bpf.4 index f6b9f1e..dda938a 100644 --- a/share/man/man4/ng_bpf.4 +++ b/share/man/man4/ng_bpf.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -135,7 +135,7 @@ This node shuts down upon receipt of a control message, or when all hooks have been disconnected. .Sh EXAMPLES It is possible to configure a node from the command line, using -.Xr tcpdump 1 +.Xr tcpdump 1 to generate raw BPF instructions which are then fed into an .Xr awk 1 script to create the ASCII form of a diff --git a/share/man/man4/ng_bridge.4 b/share/man/man4/ng_bridge.4 index 02d136b..ee4966f 100644 --- a/share/man/man4/ng_bridge.4 +++ b/share/man/man4/ng_bridge.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 2000 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -179,7 +179,7 @@ Same as .Dv NGM_BRIDGE_GET_STATS , but also atomically clears the statistics as well. .It Dv NGM_BRIDGE_GET_TABLE -Returns the current host mapping table used to direct packets, in a +Returns the current host mapping table used to direct packets, in a .Dv "struct ng_bridge_host_ary" . .El .Sh SHUTDOWN diff --git a/share/man/man4/ng_cisco.4 b/share/man/man4/ng_cisco.4 index 1a8abb8..d04f7a6 100644 --- a/share/man/man4/ng_cisco.4 +++ b/share/man/man4/ng_cisco.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -98,7 +98,7 @@ hook is connected to the .Dv inet hook of an .Xr ng_iface 4 -node, as is usually the case, then configuration is automatic as the +node, as is usually the case, then configuration is automatic as the .Xr ng_iface 4 understands the .Dv NGM_CISCO_GET_IPADDR diff --git a/share/man/man4/ng_echo.4 b/share/man/man4/ng_echo.4 index 2e08afa..ff923bf 100644 --- a/share/man/man4/ng_echo.4 +++ b/share/man/man4/ng_echo.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_ether.4 b/share/man/man4/ng_ether.4 index 07d445a..2667de4 100644 --- a/share/man/man4/ng_ether.4 +++ b/share/man/man4/ng_ether.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 2000 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -47,7 +47,7 @@ The .Nm netgraph node type allows Ethernet interfaces to interact with the -.Xr netgraph 4 +.Xr netgraph 4 networking subsystem. Once the .Nm diff --git a/share/man/man4/ng_frame_relay.4 b/share/man/man4/ng_frame_relay.4 index b7d5ecd..d2b83d8 100644 --- a/share/man/man4/ng_frame_relay.4 +++ b/share/man/man4/ng_frame_relay.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_hole.4 b/share/man/man4/ng_hole.4 index e4d19e6..3fad941 100644 --- a/share/man/man4/ng_hole.4 +++ b/share/man/man4/ng_hole.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_iface.4 b/share/man/man4/ng_iface.4 index 9291f6d..1f4b395 100644 --- a/share/man/man4/ng_iface.4 +++ b/share/man/man4/ng_iface.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -67,7 +67,7 @@ An node has a single hook corresponding to each supported protocol. Packets transmitted via the interface flow out the corresponding protocol-specific hook. -Similarly, packets received on a hook appear on the interface as +Similarly, packets received on a hook appear on the interface as packets received into the corresponding protocol stack. The currently supported protocols are IP, IPv6, AppleTalk, IPX, ATM, NATM, and NS. @@ -79,7 +79,7 @@ The configuration can only be changed when the interface is down. The default mode is point-to-point. .Pp .Nm Iface -nodes support the Berkeley Packet Filter (BPF). +nodes support the Berkeley Packet Filter (BPF). .Sh HOOKS This node type supports the following hooks: .Pp diff --git a/share/man/man4/ng_ksocket.4 b/share/man/man4/ng_ksocket.4 index 122c135..2dd2e44 100644 --- a/share/man/man4/ng_ksocket.4 +++ b/share/man/man4/ng_ksocket.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -80,7 +80,7 @@ are the decimal equivalent of the same arguments to Alternately, aliases for the commonly used values are accepted as well. For example .Dv inet/dgram/udp -is a more readable but equivalent version of +is a more readable but equivalent version of .Dv 2/2/17 . .Sh CONTROL MESSAGES This node type supports the generic control messages, plus the following: diff --git a/share/man/man4/ng_lmi.4 b/share/man/man4/ng_lmi.4 index 71f8790..8997563 100644 --- a/share/man/man4/ng_lmi.4 +++ b/share/man/man4/ng_lmi.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_mppc.4 b/share/man/man4/ng_mppc.4 index 3d6add6..c0888c9 100644 --- a/share/man/man4/ng_mppc.4 +++ b/share/man/man4/ng_mppc.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-2000 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $Whistle: ng_mppc.8,v 1.1 1999/12/08 20:20:39 archie Exp $ diff --git a/share/man/man4/ng_one2many.4 b/share/man/man4/ng_one2many.4 index c30d84b..2eca160 100644 --- a/share/man/man4/ng_one2many.4 +++ b/share/man/man4/ng_one2many.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 2000 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -81,7 +81,7 @@ hook. .It NG_ONE2MANY_XMIT_ALL Packets are delivered out all the .Dv many -hooks. Each packet goes out each +hooks. Each packet goes out each .Dv many hook. .El diff --git a/share/man/man4/ng_ppp.4 b/share/man/man4/ng_ppp.4 index e1793f7..ca4cdf2 100644 --- a/share/man/man4/ng_ppp.4 +++ b/share/man/man4/ng_ppp.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_pppoe.4 b/share/man/man4/ng_pppoe.4 index 20420a4..2cfd5cb 100644 --- a/share/man/man4/ng_pppoe.4 +++ b/share/man/man4/ng_pppoe.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -89,11 +89,11 @@ This generic message returns is a human-readable version of the node status. (not yet) .It Dv NGM_PPPOE_CONNECT Tell a nominated newly created hook that it's session should enter -the state machine in a manner to become a client. It must be newly created and +the state machine in a manner to become a client. It must be newly created and a service name can be given as an argument. It is legal to specify a zero length service name. This is common on some DSL setups. A session request packet will be broadcast on the Ethernet. -This command uses the +This command uses the .Dv ngpppoe_init_data structure shown below. .It Dv NGM_PPPOE_LISTEN @@ -102,9 +102,9 @@ the state machine in a manner to become a server listener. The argument given is the name of the service to listen on behalf of. A zero length service length will match all requests for service. A matching service request packet will be passed unmodified back to the process responsible -for starting the service. It can then examine it and pass it on to -the session that is started to answer the request. -This command uses the +for starting the service. It can then examine it and pass it on to +the session that is started to answer the request. +This command uses the .Dv ngpppoe_init_data structure shown below. .It Dv NGM_PPPOE_OFFER @@ -116,10 +116,10 @@ a request packet to be forwarded to it from the startup server, which in turn probably received it from a LISTEN mode hook ( see above). This is so that information that is required for the session that is embedded in -the original session request packet, is made available to the state machine +the original session request packet, is made available to the state machine that eventually answers the request. When the Session request packet is -received, the session negotiation will proceed. -This command uses the +received, the session negotiation will proceed. +This command uses the .Dv ngpppoe_init_data structure shown below. .Pp @@ -166,9 +166,9 @@ control message, when all session have been disconnected or when the hook is disconnected. .Sh SYSCTLs If you are one of the unfortunate people who have an ISP that -uses some "pppoe" equipment from (I believe) 3com, and who have to +uses some "pppoe" equipment from (I believe) 3com, and who have to use a different ethertype on pppoe packets -(hey why not change it from the standard for +(hey why not change it from the standard for no reason?) then after you have kldloaded or compiled in your pppoe node, you may have to do the following sysctl: .Bd -literal @@ -177,13 +177,13 @@ you may have to do the following sysctl: sysctl -w net.graph.stupid_isp=1 .Ed .Pp -to enable the alternate ethertypes. Then phone your ISP and ask them +to enable the alternate ethertypes. Then phone your ISP and ask them why you need to set option "stupid_isp" for you to be able to connect. .Sh EXAMPLES -The following code uses +The following code uses .Dv libnetgraph to set up a -.Nm +.Nm node and connect it to both a socket node and an Ethernet node. It can handle the case of when a .Nm diff --git a/share/man/man4/ng_pptpgre.4 b/share/man/man4/ng_pptpgre.4 index e2755ff..10a9f81 100644 --- a/share/man/man4/ng_pptpgre.4 +++ b/share/man/man4/ng_pptpgre.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_rfc1490.4 b/share/man/man4/ng_rfc1490.4 index c78f9ee..e0dd7bf 100644 --- a/share/man/man4/ng_rfc1490.4 +++ b/share/man/man4/ng_rfc1490.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_socket.4 b/share/man/man4/ng_socket.4 index 817f05b..34de448 100644 --- a/share/man/man4/ng_socket.4 +++ b/share/man/man4/ng_socket.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -64,8 +64,8 @@ in the protocol family using the .Xr socket 2 system call. -Any control messages received by the node -and not having a cookie value of +Any control messages received by the node +and not having a cookie value of .Dv NGM_SOCKET_COOKIE are received by the process, using .Xr recvfrom 2 ; @@ -106,9 +106,9 @@ on which the data was received or should be sent. As a special case, to allow netgraph data sockets to be used as stdin or stdout on naive programs, a .Xr sendto 2 -with a NULL sockaddr pointer, a +with a NULL sockaddr pointer, a .Xr send 2 -or a +or a .Xr write 2 will succeed in the case where there is exactly ONE hook attached to the socket node, (and thus the path is unambiguous). @@ -123,7 +123,7 @@ This node type supports the generic control messages, plus the following: .Bl -tag -width foo .It Dv NGM_SOCK_CMD_NOLINGER When the last hook is removed from this node, it will shut down as -if it had received a +if it had received a .Dv NGM_SHUTDOWN message. Attempts to access the sockets associated will return .Er ENOTCONN . @@ -138,8 +138,8 @@ with neither the .Dv NGM_SOCKET_COOKIE or .Dv NGM_GENERIC_COOKIE -will be passed unaltered up the -.Dv NG_CONTROL +will be passed unaltered up the +.Dv NG_CONTROL socket. .Sh SHUTDOWN This node type shuts down and disappears when both the associated @@ -151,7 +151,7 @@ sockets have been closed, or a control message is received. In the latter case, attempts to write to the still-open sockets will return .Er ENOTCONN . -If the +If the .Dv NGM_SOCK_CMD_NOLINGER message has been received, closure of the last hook will also initiate a shutdown of the node. diff --git a/share/man/man4/ng_split.4 b/share/man/man4/ng_split.4 index 0655395..5a62944 100644 --- a/share/man/man4/ng_split.4 +++ b/share/man/man4/ng_split.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 2001 FreeBSD inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by FreeBSD Inc.; @@ -11,7 +11,7 @@ .\" Inc., Inc. trademarks, including the mark "FREEBSD .\" INC." on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY FREEBSD INC. "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, FreeBSD Inc. MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF FreeBSD Inc. IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Julian Elischer <julian@FreeBSD.org> .\" .\" $FreeBSD$ @@ -45,7 +45,7 @@ .Sh DESCRIPTION The .Nm split -node type is used to split a bidirectional stream of packets into +node type is used to split a bidirectional stream of packets into two separate unidirectional streams of packets. .Sh HOOKS This node type supports the following three hooks: @@ -53,10 +53,10 @@ This node type supports the following three hooks: .It Dv in Packets received on .Em in -are forwarded to +are forwarded to .Em mixed . .It Dv out -Packets received on +Packets received on .Em out will be discarded as illegal. .It Dv mixed @@ -78,10 +78,10 @@ control message, or when all hooks have been disconnected. The .Nm node type was implemented in -.Fx 3.5 +.Fx 3.5 but incorprated into .Fx -in +in .Fx 5.0 . .Sh AUTHORS .An Julian Elischer Aq julian@FreeBSD.org diff --git a/share/man/man4/ng_tee.4 b/share/man/man4/ng_tee.4 index f56ff37..3af948c 100644 --- a/share/man/man4/ng_tee.4 +++ b/share/man/man4/ng_tee.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_tty.4 b/share/man/man4/ng_tty.4 index 29cde80..98e3389 100644 --- a/share/man/man4/ng_tty.4 +++ b/share/man/man4/ng_tty.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ diff --git a/share/man/man4/ng_vjc.4 b/share/man/man4/ng_vjc.4 index cb1b46f..dccf642 100644 --- a/share/man/man4/ng_vjc.4 +++ b/share/man/man4/ng_vjc.4 @@ -1,6 +1,6 @@ .\" Copyright (c) 1996-1999 Whistle Communications, Inc. .\" All rights reserved. -.\" +.\" .\" Subject to the following obligations and disclaimer of warranty, use and .\" redistribution of this software, in source or object code forms, with or .\" without modifications are expressly permitted by Whistle Communications; @@ -11,7 +11,7 @@ .\" Communications, Inc. trademarks, including the mark "WHISTLE .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as .\" such appears in the above copyright notice or in the software. -.\" +.\" .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY .\" OF SUCH DAMAGE. -.\" +.\" .\" Author: Archie Cobbs <archie@FreeBSD.org> .\" .\" $FreeBSD$ @@ -82,7 +82,7 @@ When connecting to a node, the .Dv ip , .Dv vjuncomp , -.Dv vjcomp , +.Dv vjcomp , and .Dv vjip hooks should be connected to the diff --git a/share/man/man4/pass.4 b/share/man/man4/pass.4 index 7a96dee..b55c563 100644 --- a/share/man/man4/pass.4 +++ b/share/man/man4/pass.4 @@ -40,7 +40,7 @@ The .Nm driver provides a way for userland applications to issue CAM CCBs to the -kernel. +kernel. .Pp Since the .Nm diff --git a/share/man/man4/pci.4 b/share/man/man4/pci.4 index 8aa8b60..d31bd17 100644 --- a/share/man/man4/pci.4 +++ b/share/man/man4/pci.4 @@ -118,7 +118,7 @@ device class. The flags describe which of the fields the kernel should match against. A device must match all specified fields in order to be returned. The match flags are enumerated in the -.Va pci_getconf_flags +.Va pci_getconf_flags structure. Hopefully the flag values are obvious enough that they don't need to described in detail. @@ -134,7 +134,7 @@ Number of matches returned by the kernel. .It matches Buffer containing matching devices returned by the kernel. The items in this buffer are of type -.Va pci_conf , +.Va pci_conf , which consists of the following items: .Bl -tag -width pc_subvendor .It pc_sel @@ -202,7 +202,7 @@ buffer. .It PCI_GETCONF_LIST_CHANGED This status tells the user that the .Tn PCI -device list has changed since his last call to the +device list has changed since his last call to the .Dv PCIOCGETCONF ioctl and he must reset the .Va offset diff --git a/share/man/man4/pcn.4 b/share/man/man4/pcn.4 index 1a1aa8c..691fa0c 100644 --- a/share/man/man4/pcn.4 +++ b/share/man/man4/pcn.4 @@ -140,7 +140,7 @@ the card should be configured correctly. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Rs diff --git a/share/man/man4/pcvt.4 b/share/man/man4/pcvt.4 index e30cdd5..add327c 100644 --- a/share/man/man4/pcvt.4 +++ b/share/man/man4/pcvt.4 @@ -1,9 +1,9 @@ -.\" +.\" .\" Copyright (c) 1992, 2000 Hellmuth Michaelis, Brian Dunford-Shore, .\" Joerg Wunsch and Holger Veit. -.\" +.\" .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -43,7 +43,7 @@ .Sh NAME .Nm pcvt , .Nm vt -.Nd VT220 virtual screen system console +.Nd VT220 virtual screen system console .Sh SYNOPSIS .Cd "device vt0 at isa?" .Sh DESCRIPTION @@ -81,7 +81,7 @@ Completely independent virtual terminals for MDA/HGC/CGA/EGA and VGA .It Fully remappable keyboard to support national keyboards .It -All VT220 character sets plus ISO Latin-1 and DEC technical supported +All VT220 character sets plus ISO Latin-1 and DEC technical supported .It VT220 downloadable character set supported when run on EGA/VGA .It @@ -96,7 +96,7 @@ Support for MDA, CGA, EGA and VGA display adaptors .It Support for 132 column operation on some VGA chipsets .It -X Window Support for XFree86 +X Window Support for XFree86 .Po requires .Em XSERVER @@ -127,7 +127,7 @@ support .Ss Scrollback Each virtual .Nm -virtual terminal has 8 pages of memory attached which are used as a +virtual terminal has 8 pages of memory attached which are used as a scrollback buffer. By using .Em SHIFT-PageUp @@ -375,7 +375,7 @@ caps shift - swaps case of letter, ASCII code generating key, .It KBD_SCROLL stop output, -.It KBD_FUNC +.It KBD_FUNC function key, .It KBD_KP keypad keys, @@ -527,7 +527,7 @@ struct screeninfo { int pure_vt_mode; /* flag, pure VT mode or HP/VT mode */ /* on write, if -1, no change */ int screen_size; /* screen size */ - /* on write, if -1, no change */ + /* on write, if -1, no change */ int force_24lines; /* force 24 lines if 25 lines VT mode */ /* or 28 lines HP mode to get pure */ /* VT220 screen size */ @@ -557,7 +557,7 @@ sets the number of columns for the current screen, .Pp its parameter is a pointer to an integer containing either a value of 80, or a value of 132. -Note that setting the number of columns to 132 is only supported on +Note that setting the number of columns to 132 is only supported on some VGA adaptors. Any unsupported numbers cause the ioctl to fail with .Va errno @@ -609,7 +609,7 @@ struct pcvtid { int rmajor; /* revision number, major */ #define PCVTIDMAJOR 3 int rminor; /* revision number, minor */ -#define PCVTIDMINOR 00 +#define PCVTIDMINOR 00 }; .Ed .Pp @@ -669,7 +669,7 @@ option supports a subset of the USL-style commands used to control the virtual terminal interface. This feature is mainly intended to allow -.Em XFree86 +.Em XFree86 to switch between virtual screens even when running an X server. They are ugly with respect to the implied semantics @@ -724,14 +724,14 @@ with much help from and .An J\(:org Wunsch Aq joerg@FreeBSD.org . .Pp -This driver is based on several people's previous work, notably -the historic +This driver is based on several people's previous work, notably +the historic .Xr pccons 4 implementation by .An William Jolitz Aq ljolitz@cardio.ucsf.edu and .An Don Ahn , -and the keyboard mapping code from +and the keyboard mapping code from .An Holger Veit Aq veit@first.gmd.de . .Sh SEE ALSO .Xr cursor 1 , diff --git a/share/man/man4/ppbus.4 b/share/man/man4/ppbus.4 index dcdd842..4626a10 100644 --- a/share/man/man4/ppbus.4 +++ b/share/man/man4/ppbus.4 @@ -113,7 +113,7 @@ bidirectional 8/4-bits mode, also called NIBBLE mode .It byte mode, also called PS/2 mode .It -Extended Capability Port mode, ECP +Extended Capability Port mode, ECP .It Enhanced Parallel Port mode, EPP .It @@ -164,13 +164,13 @@ performance parallel port link that would still be compatible with the standard parallel port. .Pp The EPP mode has two types of cycle: address and data. -What makes the +What makes the difference at hardware level is the strobe of the byte placed on the data lines. -Data are strobed with nAutofeed, addresses are strobed with +Data are strobed with nAutofeed, addresses are strobed with nSelectin signals. .Pp -A particularity of the ISA implementation of the EPP protocol is that an +A particularity of the ISA implementation of the EPP protocol is that an EPP cycle fits in an ISA cycle. In this fashion, parallel port peripherals can operate at close to the same performance levels as an equivalent ISA plug-in @@ -180,7 +180,7 @@ At software level, you may implement the protocol you wish, using data and address cycles as you want. This is for the IEEE1284 compatible part. Then, -peripheral vendors may implement protocol handshake with the following +peripheral vendors may implement protocol handshake with the following status lines: PError, nFault and Select. Try to know how these lines toggle with your peripheral, allowing the peripheral to request more data, stop the diff --git a/share/man/man4/ppc.4 b/share/man/man4/ppc.4 index 9a57f71..6ecb52f 100644 --- a/share/man/man4/ppc.4 +++ b/share/man/man4/ppc.4 @@ -42,21 +42,21 @@ driver provides low level support to various parallel port chipsets for the .Xr ppbus 4 system. .Pp -During the probe phase, +During the probe phase, .Nm detects parallel port chipsets and initializes private data according to their operating mode: COMPATIBLE, -NIBBLE, PS/2, EPP, ECP and other mixed modes. -If a mode is provided at startup through the +NIBBLE, PS/2, EPP, ECP and other mixed modes. +If a mode is provided at startup through the .Va flags -variable of the boot -interface, the operating mode of the chipset is forced according to +variable of the boot +interface, the operating mode of the chipset is forced according to .Va flags and the hardware supported modes. .Pp -During the attach phase, +During the attach phase, .Nm -allocates a ppbus structure, initializes it and calls the ppbus +allocates a ppbus structure, initializes it and calls the ppbus attach function. .Ss Supported flags .Bl -item -offset indent @@ -82,7 +82,7 @@ bit 7: disable FIFO detection .El .Ss Supported chipsets Some parallel port chipsets are explicitly supported: -detection and initialisation code has been written according to +detection and initialisation code has been written according to their datasheets. .Bl -bullet -offset indent .It @@ -97,14 +97,14 @@ SMC-like chipsets with mixed modes (see .El .Ss Adding support to a new chipset You may want to add support for the newest chipset your motherboard was -sold with. -For the ISA bus, just retrieve the specs of the chipset and write the +sold with. +For the ISA bus, just retrieve the specs of the chipset and write the corresponding .Fn ppc_mychipset_detect "" function. Then add an entry to the general purpose .Fn ppc_detect "" -function. +function. .Pp Your .Fn ppc_mychipset_detect "" diff --git a/share/man/man4/ppi.4 b/share/man/man4/ppi.4 index 335e19c..9f19cfe 100644 --- a/share/man/man4/ppi.4 +++ b/share/man/man4/ppi.4 @@ -11,16 +11,16 @@ .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" -.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE -.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" .\" $FreeBSD$ @@ -53,7 +53,7 @@ interface is performed using .Fn ioctl calls. Each command takes a single .Ft u_int8_t -argument, transferring one byte of data. The following commands are +argument, transferring one byte of data. The following commands are available: .Bl -tag -width indent .It Dv PPIGDATA , PPISDATA diff --git a/share/man/man4/psm.4 b/share/man/man4/psm.4 index 07bbb6b..8bff201 100644 --- a/share/man/man4/psm.4 +++ b/share/man/man4/psm.4 @@ -42,15 +42,15 @@ The .Nm driver provides support for the PS/2 mouse style pointing device. -Currently there can be only one +Currently there can be only one .Nm device node in the system. As the PS/2 mouse port is located at the auxiliary port of the keyboard controller, -the keyboard controller driver, +the keyboard controller driver, .Nm atkbdc , must also be configured in the kernel. -Note that there is currently no provision of changing the +Note that there is currently no provision of changing the .Em irq number. .Pp @@ -61,12 +61,12 @@ The PS/2 style pointing device usually has several grades of resolution, that is, sensitivity of movement. They are typically 25, 50, 100 and 200 pulse per inch. -Some devices may have finer resolution. +Some devices may have finer resolution. The current resolution can be changed at runtime. The .Nm driver allows the user to initially set the resolution -via the driver flag +via the driver flag .Pq see Sx DRIVER CONFIGURATION or change it later via the .Xr ioctl 2 @@ -85,24 +85,24 @@ The report rate can be changed via an ioctl call. .Ss Operation Levels The .Nm -driver has three levels of operation. +driver has three levels of operation. The current operation level can be set via an ioctl call. .Pp At the level zero the basic support is provided; the device driver will report -horizontal and vertical movement of the attached device +horizontal and vertical movement of the attached device and state of up to three buttons. The movement and status are encoded in a series of fixed-length data packets .Pq see Sx Data Packet Format . -This is the default level of operation and the driver is initially +This is the default level of operation and the driver is initially at this level when opened by the user program. .Pp -The operation level one, the `extended' level, supports a roller (or wheel), +The operation level one, the `extended' level, supports a roller (or wheel), if any, and up to 11 buttons. The movement of the roller is reported as movement along the Z axis. 8 byte data packets are sent to the user program at this level. .Pp At the operation level two, data from the pointing device is passed to the -user program as is. +user program as is. Modern PS/2 type pointing devices often use proprietary data format. Therefore, the user program is expected to have intimate knowledge about the format from a particular device when operating @@ -117,7 +117,7 @@ A data packet from the PS/2 mouse style pointing device is three bytes long at the operation level zero: .Pp .Bl -tag -width Byte_1 -compact -.It Byte 1 +.It Byte 1 .Bl -tag -width bit_7 -compact .It bit 7 One indicates overflow in the vertical movement count. @@ -129,7 +129,7 @@ Set if the vertical movement count is negative. Set if the horizontal movement count is negative. .It bit 3 Always one. -.\" The ALPS GlidePoint clears this bit when the user `taps' the surface of +.\" The ALPS GlidePoint clears this bit when the user `taps' the surface of .\" the pad, otherwise the bit is set. .\" Most, if not all, other devices always set this bit. .It bit 2 @@ -142,32 +142,32 @@ Right button status; set if pressed. Left button status; set if pressed. .El .It Byte 2 -Horizontal movement count in two's complement; +Horizontal movement count in two's complement; -256 through 255. Note that the sign bit is in the first byte. .It Byte 3 -Vertical movement count in two's complement; +Vertical movement count in two's complement; -256 through 255. Note that the sign bit is in the first byte. .El .Pp At the level one, a data packet is encoded in the standard format -.Dv MOUSE_PROTO_SYSMOUSE +.Dv MOUSE_PROTO_SYSMOUSE as defined in .Xr mouse 4 . .Pp -At the level two, native level, there is no standard on the size and format +At the level two, native level, there is no standard on the size and format of the data packet. .Ss Acceleration The .Nm driver can somewhat `accelerate' the movement of the pointing device. -The faster you move the device, the further the pointer -travels on the screen. -The driver has an internal variable which governs the effect of +The faster you move the device, the further the pointer +travels on the screen. +The driver has an internal variable which governs the effect of the acceleration. -Its value can be modified via the driver flag +Its value can be modified via the driver flag or via an ioctl call. .Ss Device Number The minor device number of the @@ -178,9 +178,9 @@ minor = (`unit' << 1) | `non-blocking' .Ed .Pp where `unit' is the device number (usually 0) and the `non-blocking' bit -is set to indicate ``don't block waiting for mouse input, +is set to indicate ``don't block waiting for mouse input, return immediately''. -The `non-blocking' bit should be set for \fIXFree86\fP, +The `non-blocking' bit should be set for \fIXFree86\fP, therefore the minor device number usually used for \fIXFree86\fP is 1. See .Sx FILES @@ -190,7 +190,7 @@ for device node names. There are following kernel configuration options to control the .Nm driver. -They may be set in the kernel configuration file +They may be set in the kernel configuration file .Pq see Xr config 8 . .Bl -tag -width MOUSE .It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y @@ -209,13 +209,13 @@ msecs at most. If the driver seems unable to detect your pointing device, you may want to increase these values. The default values are -200 msec for +200 msec for .Fa X and 5 for .Fa Y . .It Em PSM_DEBUG=N , KBDIO_DEBUG=N -Sets the debug level to +Sets the debug level to .Fa N . The default debug level is zero. See @@ -226,18 +226,18 @@ for debug logging. The .Nm driver accepts the following driver flags. -Set them in the +Set them in the kernel configuration file or in the User Configuration Menu at -the boot time +the boot time .Pq see Xr boot 8 . .Pp .Bl -tag -width MOUSE .It bit 0..3 RESOLUTION -This flag specifies the resolution of the pointing device. +This flag specifies the resolution of the pointing device. It must be zero through four. The greater the value -is, the finer resolution the device will select. -Actual resolution selected by this field varies according to the model +is, the finer resolution the device will select. +Actual resolution selected by this field varies according to the model of the device. Typical resolutions are: .Pp @@ -253,14 +253,14 @@ Typical resolutions are: .El .Pp Leaving this flag zero will selects the default resolution for the -device (whatever it is). +device (whatever it is). .It bit 4..7 ACCELERATION This flag controls the amount of acceleration effect. -The smaller the value of this flag is, more sensitive the movement becomes. -The minimum value allowed, thus the value for the most sensitive setting, +The smaller the value of this flag is, more sensitive the movement becomes. +The minimum value allowed, thus the value for the most sensitive setting, is one. Setting this flag to zero will completely disables the -acceleration effect. +acceleration effect. .It bit 8 NOCHECKSYNC The .Nm @@ -269,7 +269,7 @@ the bit pattern of that byte. Although this method should work with most PS/2 pointing devices, it may interfere with some devices which are not so compatible with known devices. -If you think your pointing device is not functioning as expected, +If you think your pointing device is not functioning as expected, and the kernel frequently prints the following message to the console, .Bd -literal -offset indent psmintr: out of sync (xxxx != yyyy). @@ -283,7 +283,7 @@ driver will not try to identify the model of the pointing device and will not carry out model-specific initialization. The device should always act like a standard PS/2 mouse without such initialization. -Extra features, such as wheels and additional buttons, won't be +Extra features, such as wheels and additional buttons, won't be recognized by the .Nm driver. @@ -317,13 +317,13 @@ driver ignore certain error conditions when probing the PS/2 mouse port. It should never be necessary under normal circumstances. .It bit 13 HOOKRESUME The built-in PS/2 pointing device of some laptop computers is somehow -not operable immediately after the system `resumes' from +not operable immediately after the system `resumes' from the power saving mode, -though it will eventually become available. +though it will eventually become available. There are reports that stimulating the device by performing I/O will help waking up the device quickly. -This flag will enable a piece of code in the +This flag will enable a piece of code in the .Nm driver to hook the `resume' event and exercise some harmless I/O operations on the @@ -339,7 +339,7 @@ It has no effect unless the flag is set as well. .El .Sh IOCTLS -There are a few +There are a few .Xr ioctl 2 commands for mouse drivers. These commands and related structures and constants are defined in @@ -358,7 +358,7 @@ These commands manipulate the operation level of the driver. .Pp .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw -Returns the hardware information of the attached device in the following +Returns the hardware information of the attached device in the following structure. .Bd -literal typedef struct mousehw { @@ -377,7 +377,7 @@ The .Nm driver currently can detect the 3 button mouse from Logitech and report accordingly. -The 3 button mouse from the other manufacturer may or may not be +The 3 button mouse from the other manufacturer may or may not be reported correctly. However, it will not affect the operation of the driver. @@ -405,9 +405,9 @@ The is always .Dv MOUSE_MODEL_GENERIC at the operation level 0. -It may be +It may be .Dv MOUSE_MODEL_GENERIC -or one of +or one of .Dv MOUSE_MODEL_XXX constants at higher operation levels. Again the @@ -445,7 +445,7 @@ typedef struct mousemode { .Pp The .Dv protocol -is +is .Dv MOUSE_PROTO_PS2 at the operation level zero and two. .Dv MOUSE_PROTO_SYSMOUSE @@ -453,20 +453,20 @@ at the operation level one. .Pp The .Dv rate -is the status report rate (reports/sec) at which the device will send +is the status report rate (reports/sec) at which the device will send movement report to the host computer. -Typical supported values are 10, 20, 40, 60, 80, 100 and 200. +Typical supported values are 10, 20, 40, 60, 80, 100 and 200. Some mice may accept other arbitrary values too. .Pp The .Dv resolution -of the pointing device must be one of -.Dv MOUSE_RES_XXX +of the pointing device must be one of +.Dv MOUSE_RES_XXX constants or a positive value. The greater the value -is, the finer resolution the mouse will select. -Actual resolution selected by the -.Dv MOUSE_RES_XXX +is, the finer resolution the mouse will select. +Actual resolution selected by the +.Dv MOUSE_RES_XXX constant varies according to the model of mouse. Typical resolutions are: .Pp @@ -483,7 +483,7 @@ Typical resolutions are: .Pp The .Dv accelfactor -field holds a value to control acceleration feature +field holds a value to control acceleration feature .Pq see Sx Acceleration . It must be zero or greater. If it is zero, acceleration is disabled. .Pp @@ -521,8 +521,8 @@ as specified in Only .Dv rate , .Dv resolution , -.Dv level -and +.Dv level +and .Dv accelfactor may be modifiable. Setting values in the other field does not generate @@ -530,7 +530,7 @@ error and has no effect. .Pp If you do not want to change the current setting of a field, put -1 there. -You may also put zero in +You may also put zero in .Dv resolution and .Dv rate , @@ -553,14 +553,14 @@ and the default value for the fields will be selected. .\" .Pp .\" Upon returning to the user program, the driver will place the number .\" of valid data bytes in the buffer in the -.\" .Dv len +.\" .Dv len .\" field. .\" .Pp .It Dv MOUSE_READSTATE Ar mousedata_t *state .\" The command reads the hardware settings from the device. .\" Upon returning to the user program, the driver will place the number .\" of valid data bytes in the buffer in the -.\" .Dv len +.\" .Dv len .\" field. It is usually 3 bytes. .\" The buffer is formatted as follows: .\" .Pp @@ -570,11 +570,11 @@ and the default value for the fields will be selected. .\" .It bit 7 .\" Reserved. .\" .It bit 6 -.\" 0 - stream mode, 1 - remote mode. +.\" 0 - stream mode, 1 - remote mode. .\" In the stream mode, the pointing device sends the device status .\" whenever its state changes. In the remote mode, the host computer .\" must request the status to be sent. -.\" The +.\" The .\" .Nm .\" driver puts the device in the stream mode. .\" .It bit 5 @@ -600,7 +600,7 @@ and the default value for the fields will be selected. .\" the resolution code varies from one device to another. .\" .El .\" .It Byte 3 -.\" The status report rate (reports/sec) at which the device will send +.\" The status report rate (reports/sec) at which the device will send .\" movement report to the host computer. .\" .El These commands are not currently supported by the @@ -608,7 +608,7 @@ These commands are not currently supported by the driver. .Pp .It Dv MOUSE_GETSTATUS Ar mousestatus_t *status -The command returns the current state of buttons and +The command returns the current state of buttons and movement counts as described in .Xr mouse 4 . .El @@ -679,7 +679,7 @@ The ID code is described above. .Pp The seventh line shows the current hardware settings. .\" See -.\" .Dv MOUSE_READSTATE +.\" .Dv MOUSE_READSTATE .\" for definitions. These bytes are formatted as follows: .Pp @@ -689,12 +689,12 @@ These bytes are formatted as follows: .It bit 7 Reserved. .It bit 6 -0 - stream mode, 1 - remote mode. +0 - stream mode, 1 - remote mode. In the stream mode, the pointing device sends the device status whenever its state changes. In the remote mode, the host computer must request the status to be sent. -The +The .Nm driver puts the device in the stream mode. .It bit 5 @@ -722,23 +722,23 @@ Actual resolution for the resolution code varies from one device to another. .El .It Byte 3 -The status report rate (reports/sec) at which the device will send +The status report rate (reports/sec) at which the device will send movement report to the host computer. .El .Pp -Note that the pointing device will not be enabled until the +Note that the pointing device will not be enabled until the .Nm driver is opened by the user program. .Pp The rest of the lines show the device ID code, the number of detected -buttons and internal variables. +buttons and internal variables. .Pp At debug level 2, much more detailed information is logged. .Sh CAVEATS Many pad devices behave as if the first (left) button were pressed if the user `taps' the surface of the pad. -In contrast, some pad products, e.g. some verions of ALPS GlidePoint -and Interlink VersaPad, treat the tapping action +In contrast, some pad products, e.g. some verions of ALPS GlidePoint +and Interlink VersaPad, treat the tapping action as fourth button events. .Pp It is reported that Interlink VersaPad rquires both @@ -759,7 +759,7 @@ There is not a guaranteed way to re-synchronize with the first byte of the packet once we are out of synchronization with the data stream. However, if you are using the \fIXFree86\fP server and experiencing -the problem, you may be able to make the X server synchronize with the mouse +the problem, you may be able to make the X server synchronize with the mouse by switching away to a virtual terminal and getting back to the X server, unless the X server is accessing the mouse via .Xr moused 8 . @@ -790,7 +790,7 @@ driver is based on the work done by quite a number of people, including .An Andrew Herbert , .An Charles Hannum , .An Shoji Yuen -and +and .An Kazutaka Yokota to name the few. .Pp diff --git a/share/man/man4/pt.4 b/share/man/man4/pt.4 index d85ea8c..bab0880 100644 --- a/share/man/man4/pt.4 +++ b/share/man/man4/pt.4 @@ -37,7 +37,7 @@ .Sh DESCRIPTION The .Nm -driver provides support for a +driver provides support for a .Tn SCSI processor type device. These are usually scanners and other devices using the @@ -86,5 +86,5 @@ the .Sh HISTORY The .Nm -driver appeared in +driver appeared in .Fx 2.1 . diff --git a/share/man/man4/random.4 b/share/man/man4/random.4 index 3abe9ff..66132c4 100644 --- a/share/man/man4/random.4 +++ b/share/man/man4/random.4 @@ -129,7 +129,7 @@ A zero (0) value means interrupts are not considered as an entropy source. Set the variable to one (1) if you wish to use them for entropy harvesting. -All interrupt harvesting is setup by the +All interrupt harvesting is setup by the individual device drivers. .Pp The other variables are explained in the paper describing the diff --git a/share/man/man4/rl.4 b/share/man/man4/rl.4 index 295c5e8..7116eec 100644 --- a/share/man/man4/rl.4 +++ b/share/man/man4/rl.4 @@ -160,7 +160,7 @@ the card should be configured correctly. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Rs @@ -211,5 +211,5 @@ frame will have the magic length of 0xFFF0. When the driver encounters this value, it knows that it has finished processing all currently available packets. -Neither this magic value nor its significance are +Neither this magic value nor its significance are documented anywhere in the RealTek data sheets. diff --git a/share/man/man4/route.4 b/share/man/man4/route.4 index 1be1c5b..15cab83 100644 --- a/share/man/man4/route.4 +++ b/share/man/man4/route.4 @@ -36,7 +36,7 @@ .Dt ROUTE 4 .Os .Sh NAME -.Nm route +.Nm route .Nd kernel packet forwarding database .Sh SYNOPSIS .Fd #include <sys/types.h> @@ -86,7 +86,7 @@ is requested to address the packet to the gateway listed in the routing entry (i.e. the packet is forwarded). .Pp When routing a packet, -the kernel will attempt to find +the kernel will attempt to find the most specific route matching the destination. (If there are two different mask and value-under-the-mask pairs that match, the more specific is the one with more bits in the mask. @@ -168,14 +168,14 @@ at the .Dv SOL_SOCKET level is to be turned off. A process may ignore all messages from the routing socket -by doing a +by doing a .Xr shutdown 2 system call for further input. .Pp If a route is in use when it is deleted, the routing entry will be marked down and removed from the routing table, but the resources associated with it will not -be reclaimed until all references to it are released. +be reclaimed until all references to it are released. User processes can obtain information about the routing entry to a specific destination by using a .Dv RTM_GET diff --git a/share/man/man4/sa.4 b/share/man/man4/sa.4 index aedc72c..15970b0 100644 --- a/share/man/man4/sa.4 +++ b/share/man/man4/sa.4 @@ -53,9 +53,9 @@ before a .Tn SCSI sequential access device can be configured. .Sh MOUNT SESSIONS -The +The .Nm -driver is based around the concept of a +driver is based around the concept of a .Dq Em mount session , which is defined as the period between the time that a tape is mounted, and the time when it is unmounted. Any parameters set during @@ -67,7 +67,7 @@ close in several ways. These include: .It Closing a `rewind device', referred to as sub-mode 00 below. -An example is +An example is .Pa /dev/sa0 . .It Using the MTOFFL @@ -88,7 +88,7 @@ Bits 0 and 1 of the minor number are interpreted as The sub-modes differ in the action taken when the device is closed: .Bl -tag -width XXXX .It 00 -A close will rewind the device; if the tape has been +A close will rewind the device; if the tape has been written, then a file mark will be written before the rewind is requested. The device is unmounted. .It 01 @@ -99,18 +99,18 @@ Any further reads or writes will occur directly after the last read, or the written file mark. .It 10 A close will rewind the device. -If the tape has been +If the tape has been written, then a file mark will be written before the rewind is requested. On completion of the rewind an unload command will be issued. The device is unmounted. .El .Sh BLOCKING MODES .Tn SCSI -tapes may run in either +tapes may run in either .Sq Em variable or .Sq Em fixed -block-size modes. Most +block-size modes. Most .Tn QIC Ns -type devices run in fixed block-size mode, where most nine-track tapes and many new cartridge formats allow variable block-size. The difference @@ -118,7 +118,7 @@ between the two is as follows: .Bl -inset .It Variable block-size: Each write made to the device results in a single logical record -written to the tape. One can never read or write +written to the tape. One can never read or write .Em part of a record from tape (though you may request a larger block and read a smaller record); nor can one read multiple blocks. Data from a @@ -192,7 +192,7 @@ Many older .Tn SCSI-1 devices may not work properly with this driver yet. .Pp -Additionally, certain +Additionally, certain tapes (QIC tapes mostly) that were written under .Fx 2.X diff --git a/share/man/man4/scsi.4 b/share/man/man4/scsi.4 index 2e9d394..c4ca40e 100644 --- a/share/man/man4/scsi.4 +++ b/share/man/man4/scsi.4 @@ -61,7 +61,7 @@ of drivers to control various devices, and to utilize different .Tn SCSI host adapters through host adapter drivers. -When the system probes the +When the system probes the .Tn SCSI busses, it attaches any devices it finds to the appropriate drivers. The @@ -175,7 +175,7 @@ then the first non-wired disk shall come on line as The system allows common device drivers to work through many different types of adapters. The adapters take requests from the upper layers and do -all IO between the +all IO between the .Em SCSI bus and the system. The maximum size of a transfer is governed by the @@ -183,7 +183,7 @@ adapter. Most adapters can transfer 64KB in a single operation, however many can transfer larger amounts. .Sh TARGET MODE -Some adapters support +Some adapters support .Em target mode in which the system is capable of operating as a device, responding to operations initiated by another system. @@ -195,7 +195,7 @@ subsystem. see other scsi device entries. .Sh DIAGNOSTICS When the kernel is compiled with options CAMDEBUG, an XPT_DEBUG CCB can be -used to enable various amounts of tracing information on any +used to enable various amounts of tracing information on any specific device. Devices not being traced will not produce trace information. There are currently four debugging flags that may be turned on: diff --git a/share/man/man4/sd.4 b/share/man/man4/sd.4 index 7cf6d4c..3eb989d 100644 --- a/share/man/man4/sd.4 +++ b/share/man/man4/sd.4 @@ -34,7 +34,7 @@ .Sh DESCRIPTION The .Nm -driver has been replaced by the +driver has been replaced by the .Xr da 4 driver. .Sh SEE ALSO diff --git a/share/man/man4/sf.4 b/share/man/man4/sf.4 index 54960d1..91d65d6 100644 --- a/share/man/man4/sf.4 +++ b/share/man/man4/sf.4 @@ -156,7 +156,7 @@ the network connection (cable). .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Rs diff --git a/share/man/man4/si.4 b/share/man/man4/si.4 index e83bf97..8a3879d 100644 --- a/share/man/man4/si.4 +++ b/share/man/man4/si.4 @@ -101,7 +101,7 @@ The "locked state" is used to prevent the .Xr termios 4 settings from being changed. .Pp -To manipulate the initial/locked settings, the +To manipulate the initial/locked settings, the .Xr stty 1 command is useful. When setting the "locked" variables, enabling the mode on the lock device will lock the termios mode, while disabling the mode will @@ -138,7 +138,7 @@ was ported to run on BSDI by The System V driver source is/was available by ftp from .Sy ftp.specialix.co.uk . .Pp -This driver is not supported by Specialix International. +This driver is not supported by Specialix International. .Sh AUTHORS .An -nosplit .An Peter Wemm Aq peter@netplex.com.au diff --git a/share/man/man4/sis.4 b/share/man/man4/sis.4 index 41626a1..2ab0634 100644 --- a/share/man/man4/sis.4 +++ b/share/man/man4/sis.4 @@ -149,7 +149,7 @@ the card should be configured correctly. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Rs diff --git a/share/man/man4/sk.4 b/share/man/man4/sk.4 index ca14e88..c985996 100644 --- a/share/man/man4/sk.4 +++ b/share/man/man4/sk.4 @@ -183,7 +183,7 @@ the network connection (cable). .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr vlan 4 , .Xr ifconfig 8 diff --git a/share/man/man4/smp.4 b/share/man/man4/smp.4 index 179a80d..af71e6e 100644 --- a/share/man/man4/smp.4 +++ b/share/man/man4/smp.4 @@ -33,7 +33,7 @@ .Nm .Sh DESCRIPTION The -.Nm +.Nm kernel implements symmetric multiprocessor support. .Sh COMPATIBILITY The diff --git a/share/man/man4/spkr.4 b/share/man/man4/spkr.4 index b2775fd..6cd8c557 100644 --- a/share/man/man4/spkr.4 +++ b/share/man/man4/spkr.4 @@ -149,22 +149,22 @@ Sets the number of quarter notes per minute; default is 120. Musical names for common tempi are: .Bd -literal -offset indent Tempo Beats Per Minute -very slow Larghissimo +very slow Larghissimo Largo 40-60 Larghetto 60-66 - Grave - Lento + Grave + Lento Adagio 66-76 -slow Adagietto +slow Adagietto Andante 76-108 -medium Andantino +medium Andantino Moderato 108-120 -fast Allegretto +fast Allegretto Allegro 120-168 - Vivace - Veloce + Vivace + Veloce Presto 168-208 -very fast Prestissimo +very fast Prestissimo .Ed .It Li M[LNS] Set articulation. diff --git a/share/man/man4/st.4 b/share/man/man4/st.4 index e77028d..fd6891a 100644 --- a/share/man/man4/st.4 +++ b/share/man/man4/st.4 @@ -34,7 +34,7 @@ .Sh DESCRIPTION The .Nm -driver has been replaced by the +driver has been replaced by the .Xr sa 4 driver. .Sh SEE ALSO diff --git a/share/man/man4/ste.4 b/share/man/man4/ste.4 index d714553..2ac2def 100644 --- a/share/man/man4/ste.4 +++ b/share/man/man4/ste.4 @@ -142,7 +142,7 @@ the card should be configured correctly. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Rs diff --git a/share/man/man4/syncer.4 b/share/man/man4/syncer.4 index 8d4b104..60f9db4 100644 --- a/share/man/man4/syncer.4 +++ b/share/man/man4/syncer.4 @@ -49,7 +49,7 @@ usually processing one queue per second. For each .Xr vnode 9 on that queue, -the +the .Nm process forces a write out to disk of its dirty buffers. .Pp diff --git a/share/man/man4/sysmouse.4 b/share/man/man4/sysmouse.4 index bc77dc0..0e9493a 100644 --- a/share/man/man4/sysmouse.4 +++ b/share/man/man4/sysmouse.4 @@ -47,7 +47,7 @@ This arrangement makes it possible for the console and the user process .Pq such as the Tn X\ Window System to share the mouse. .Pp -The user process which wants to utilize mouse operation simply opens +The user process which wants to utilize mouse operation simply opens .Pa /dev/sysmouse with a .Xr open 2 @@ -62,21 +62,21 @@ the mouse. .Ss Operation Levels The .Nm -driver has two levels of operation. +driver has two levels of operation. The current operation level can be referred to and changed via ioctl calls. .Pp -The level zero, the basic level, is the lowest level at which the driver -offers the basic service to user programs. +The level zero, the basic level, is the lowest level at which the driver +offers the basic service to user programs. The .Nm driver provides horizontal and vertical movement of the mouse -and state of up to three buttons in the -.Tn MouseSystems +and state of up to three buttons in the +.Tn MouseSystems format as follows. .Pp .Bl -tag -width Byte_1 -compact -.It Byte 1 +.It Byte 1 .Bl -tag -width bit_7 -compact .It bit 7 Always one. @@ -92,17 +92,17 @@ if the device does not have the middle button. Right button status; cleared if pressed, otherwise set. .El .It Byte 2 -The first half of horizontal movement count in two's complement; +The first half of horizontal movement count in two's complement; -128 through 127. .It Byte 3 -The first half of vertical movement count in two's complement; +The first half of vertical movement count in two's complement; -128 through 127. .It Byte 4 -The second half of the horizontal movement count in two's complement; +The second half of the horizontal movement count in two's complement; -128 through 127. To obtain the full horizontal movement count, add the byte 2 and 4. .It Byte 5 -The second half of the vertical movement count in two's complement; +The second half of the vertical movement count in two's complement; -128 through 127. To obtain the full vertical movement count, add the byte 3 and 5. .El @@ -110,21 +110,21 @@ the byte 3 and 5. At the level one, the extended level, mouse data is encoded in the standard format .Dv MOUSE_PROTO_SYSMOUSE -as defined in +as defined in .Xr mouse 4 . .\" .Ss Acceleration .\" The .\" .Nm .\" driver can somewhat `accelerate' the movement of the pointing device. -.\" The faster you move the device, the further the pointer -.\" travels on the screen. -.\" The driver has an internal variable which governs the effect of -.\" the acceleration. Its value can be modified via the driver flag +.\" The faster you move the device, the further the pointer +.\" travels on the screen. +.\" The driver has an internal variable which governs the effect of +.\" the acceleration. Its value can be modified via the driver flag .\" or via an ioctl call. .Sh IOCTLS -This section describes two classes of +This section describes two classes of .Xr ioctl 2 -commands: +commands: commands for the .Nm driver itself, and commands for the console and the console control drivers. @@ -142,7 +142,7 @@ driver. These commands manipulate the operation level of the mouse driver. .Pp .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw -Returns the hardware information of the attached device in the following +Returns the hardware information of the attached device in the following structure. Only the .Dv iftype field is guaranteed to be filled with the correct value in the current @@ -180,12 +180,12 @@ or .Pp The .Dv model -is always +is always .Dv MOUSE_MODEL_GENERIC at the operation level 0. -It may be +It may be .Dv MOUSE_MODEL_GENERIC -or one of +or one of .Dv MOUSE_MODEL_XXX constants at higher operation levels. .Pp @@ -210,7 +210,7 @@ typedef struct mousemode { .Pp The .Dv protocol -field tells the format in which the device status is returned +field tells the format in which the device status is returned when the mouse data is read by the user program. It is .Dv MOUSE_PROTO_MSC @@ -260,7 +260,7 @@ The command changes the current operation parameters of the mouse driver as specified in .Ar mode . Only -.Dv level +.Dv level may be modifiable. Setting values in the other field does not generate error and has no effect. @@ -278,24 +278,24 @@ These commands are not supported by the driver. .Pp .It Dv MOUSE_GETSTATUS Ar mousestatus_t *status -The command returns the current state of buttons and +The command returns the current state of buttons and movement counts in the structure as defined in .Xr mouse 4 . .El .Ss Console and Consolectl Ioctls -The user process issues console +The user process issues console .Fn ioctl calls to the current virtual console in order to control the mouse pointer. The console -.Fn ioctl +.Fn ioctl also provides a method for the user process to receive a .Xr signal 3 when a button is pressed. .Pp The mouse daemon .Xr moused 8 -uses +uses .Fn ioctl calls to the console control device .Pa /dev/consolectl @@ -335,7 +335,7 @@ Adds position supplied in .Dv u.data to current position. .It Dv MOUSE_GETINFO -Returns current mouse position in the current virtual console +Returns current mouse position in the current virtual console and button status in .Dv u.data . .It Dv MOUSE_MODE @@ -347,8 +347,8 @@ The signal to be delivered is set in .El .Pp The above operations are for virtual consoles. -The operations defined -below are for the console control device and are used by +The operations defined +below are for the console control device and are used by .Xr moused 8 to pass mouse data to the console driver. .Pp @@ -363,17 +363,17 @@ driver if it is open. .Dv MOUSE_ACTION also processes button press actions and sends signal to the process if requested or performs cut and paste operations -if the current console is a text interface. +if the current console is a text interface. .It Dv MOUSE_BUTTONEVENT .Dv u.data specifies a button and its click count. The console driver will -use this information for signal delivery if requested or +use this information for signal delivery if requested or for cut and paste operations if the console is in text mode. .El .Pp .Dv MOUSE_MOTIONEVENT -and +and .Dv MOUSE_BUTTONEVENT are newer interface and are designed to be used together. They are intended to replace functions performed by @@ -395,14 +395,14 @@ struct mouse_data { .Ed .Pp .Dv x , -.Dv y +.Dv y and .Dv z represent movement of the mouse along respective directions. .Dv buttons tells the state of buttons. It encodes up to 31 buttons in the bit 0 though -the bit 30. If a button is held down, the corresponding bit is set. +the bit 30. If a button is held down, the corresponding bit is set. .Pp .It Dv mode .Bd -literal @@ -415,7 +415,7 @@ struct mouse_mode { The .Dv signal field specifies the signal to be delivered to the process. -It must be +It must be one of the values defined in .Ao Pa signal.h Ac . The @@ -432,7 +432,7 @@ struct mouse_event { .Pp The .Dv id -field specifies a button number as in +field specifies a button number as in .Dv u.data.buttons . Only one bit/button is set. The @@ -467,6 +467,6 @@ manual page example first appeared in .An -nosplit This manual page was written by -.An John-Mark Gurney Aq gurney_j@efn.org -and +.An John-Mark Gurney Aq gurney_j@efn.org +and .An Kazutaka Yokota Aq yokota@FreeBSD.org . diff --git a/share/man/man4/tcp.4 b/share/man/man4/tcp.4 index ec0c358..e9ac8d3 100644 --- a/share/man/man4/tcp.4 +++ b/share/man/man4/tcp.4 @@ -75,7 +75,7 @@ system call must be used after binding the socket with the .Xr bind 2 system call. Only -passive sockets may use the +passive sockets may use the .Xr accept 2 call to accept incoming connections. Only active sockets may use the @@ -142,7 +142,7 @@ various extensions which are provided in this implementation. The boolean option .Dv TCP_NOOPT -is provided to disable +is provided to disable .Tn TCP option use on a per-connection basis. .It Dv TCP_NOPUSH @@ -212,7 +212,7 @@ when no advice to the contrary is received from MSS negotiation. Maximum TCP send window. .It TCPCTL_RECVSPACE .Pq tcp.recvspace -Maximum TCP receive window. +Maximum TCP receive window. .It tcp.log_in_vain Log any connection attempts to ports where there is not a socket accepting connections. @@ -221,7 +221,7 @@ The number of packets allowed to be in-flight during the .Tn TCP slow-start phase on a non-local network. .It tcp.local_slowstart_flightsize -The number of packets allowed to be in-flight during the +The number of packets allowed to be in-flight during the .Tn TCP slow-start phase to local machines in the same subnet. .It tcp.msl @@ -233,7 +233,7 @@ Amount of time the connection should be idle before keepalive probes (if enabled) are sent. .It tcp.keepintvl The interval between keepalive probes sent to remote machines. -After +After .Dv TCPTV_KEEPCNT (default 8) probes are sent, with no response, the connection is dropped. .It tcp.always_keepalive @@ -259,7 +259,7 @@ reassembly queue if the system is low on mbufs. .\" .It tcp.tcp_lq_overflow If a connection is dropped due to a listen queue overflow, delete the -cloned route associated with the connection if it does not have any +cloned route associated with the connection if it does not have any prior information. .It tcp.blackhole If enabled, disable sending of RST when a connection is attempted @@ -314,7 +314,7 @@ when an attempt is made to create a socket with a port which has already been allocated; .It Bq Er EADDRNOTAVAIL -when an attempt is made to create a +when an attempt is made to create a socket with a network address for which no network interface exists. .It Bq Er EAFNOSUPPORT diff --git a/share/man/man4/termios.4 b/share/man/man4/termios.4 index b549296..58726df 100644 --- a/share/man/man4/termios.4 +++ b/share/man/man4/termios.4 @@ -407,7 +407,7 @@ and .Dv TIME mechanisms are activated by the receipt of the first byte, or a signal is received. If -data is in the buffer at the time of the +data is in the buffer at the time of the .Fn read , the result is as if data had been received immediately after the @@ -541,7 +541,7 @@ is discarded. Thus, if there are no bytes waiting (that is, the .Dv EOF occurred at the beginning of a line), a byte -count of zero is returned from the +count of zero is returned from the .Fn read , representing an end-of-file indication. If .Dv ICANON @@ -977,7 +977,7 @@ is set and the input queue is full, subsequent input shall cause an character to be transmitted to the output queue. .Pp -The initial input control value after +The initial input control value after .Fn open is implementation defined. .Ss Output Modes @@ -1109,7 +1109,7 @@ is set, two stop bits are used, otherwise one stop bit. For example, at If .Dv CREAD is set, the receiver is enabled. Otherwise, no character is -received. +received. Not all hardware supports this bit. In fact, this flag is pretty silly and if it were not part of the .Nm @@ -1138,7 +1138,7 @@ status lines. If is clear, the modem status lines are monitored. .Pp -Under normal circumstances, a call to the +Under normal circumstances, a call to the .Fn open function waits for the modem connection to complete. However, if the @@ -1146,7 +1146,7 @@ the modem connection to complete. However, if the flag is set or if .Dv CLOCAL -has been set, the +has been set, the .Fn open function returns immediately without waiting for the connection. @@ -1450,7 +1450,7 @@ entries of the array. .Pp The initial values of the flags and control characters -after +after .Fn open is set according to the values in the header diff --git a/share/man/man4/ti.4 b/share/man/man4/ti.4 index e832787..7d4db47 100644 --- a/share/man/man4/ti.4 +++ b/share/man/man4/ti.4 @@ -203,7 +203,7 @@ the network connection (cable). .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr vlan 4 , .Xr ifconfig 8 diff --git a/share/man/man4/tl.4 b/share/man/man4/tl.4 index caf4ab8..8d06ffa 100644 --- a/share/man/man4/tl.4 +++ b/share/man/man4/tl.4 @@ -119,7 +119,7 @@ allocating a pad buffer or collapsing an mbuf chain into a cluster. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY diff --git a/share/man/man4/ttcp.4 b/share/man/man4/ttcp.4 index 133a82a..6edc059 100644 --- a/share/man/man4/ttcp.4 +++ b/share/man/man4/ttcp.4 @@ -11,7 +11,7 @@ .\" no representations about the suitability of this software for any .\" purpose. It is provided "as is" without express or implied .\" warranty. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS .\" ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF @@ -131,7 +131,7 @@ sock = socket(PF_INET, SOCK_STREAM, 0); /* prepare request[] and sin */ -err = sendto(sock, request, req_len, MSG_EOF, +err = sendto(sock, request, req_len, MSG_EOF, (struct sockaddr *)&sin, sin.sin_len); /* do something if error */ @@ -143,7 +143,7 @@ close(sock); .Ed .Pp -Note that, after the +Note that, after the call to .Fn sendto , the socket is now in the same state as if the @@ -155,7 +155,7 @@ operations to perform on this socket are .Xr read 2 and .Xr close 2 . -(Because the client's +(Because the client's .Tn TCP sender is already shut down, it is not possible to .Xr connect 2 @@ -202,7 +202,7 @@ immediately closed. .Sh MIB VARIABLES The .Tn T/TCP -extensions require the +extensions require the .Dq Li net.inet.tcp.rfc1644 MIB variable to be true in order for the appropriate .Tn TCP diff --git a/share/man/man4/twe.4 b/share/man/man4/twe.4 index 92a45ae..3ea02fd 100644 --- a/share/man/man4/twe.4 +++ b/share/man/man4/twe.4 @@ -10,7 +10,7 @@ .\" notice, this list of conditions and the following disclaimer. .\" 2. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. diff --git a/share/man/man4/tx.4 b/share/man/man4/tx.4 index 8a37970..2b8438b 100644 --- a/share/man/man4/tx.4 +++ b/share/man/man4/tx.4 @@ -81,7 +81,7 @@ Device and driver reset follows this error. Cannot allocate memory for received packet. Packet thrown away. .It "tx%d: can't stop %s DMA" -While reseting, driver failed to stop device correctly. +While reseting, driver failed to stop device correctly. .El .Sh BUGS The multicast packets filtering is not supported. diff --git a/share/man/man4/udp.4 b/share/man/man4/udp.4 index bd9488e..5a30f86 100644 --- a/share/man/man4/udp.4 +++ b/share/man/man4/udp.4 @@ -60,11 +60,11 @@ and calls, though the .Xr connect 2 call may also be used to fix the destination for future -packets (in which case the +packets (in which case the .Xr recv 2 or .Xr read 2 -and +and .Xr send 2 or .Xr write 2 @@ -120,7 +120,7 @@ when an attempt is made to create a socket with a port which has already been allocated; .It Bq Er EADDRNOTAVAIL -when an attempt is made to create a +when an attempt is made to create a socket with a network address for which no network interface exists. .El diff --git a/share/man/man4/ukbd.4 b/share/man/man4/ukbd.4 index 7c51aca..3ccb964 100644 --- a/share/man/man4/ukbd.4 +++ b/share/man/man4/ukbd.4 @@ -67,7 +67,7 @@ The USB keyboards will be kbd1, kbd2, etc. You can see some information about the keyboard with the following command: .Bd -literal -offset indent -kbdcontrol -i < /dev/kbd1 +kbdcontrol -i < /dev/kbd1 .Ed .Pp or load a keymap with @@ -91,7 +91,7 @@ If you want to use a USB keyboard as your default and not use an AT keyboard at all, you will have to remove the .Nm atkbd from the kernel configuration file. -Because of the order of the device +Because of the order of the device initialisation, the USB keyboard will be detected AFTER the console driver initialises itself and you have to explicitly tellthe console driver to use the existence of the USB keyboard. This can be done in diff --git a/share/man/man4/ums.4 b/share/man/man4/ums.4 index 917738f..67fcf27b 100644 --- a/share/man/man4/ums.4 +++ b/share/man/man4/ums.4 @@ -73,7 +73,7 @@ driver to the kernel. .Pp .Dl moused -p /dev/ums0 -t auto .Pp -Use the first +Use the first .Nm USB mouse on the system as your console mouse. .Pp @@ -104,7 +104,7 @@ For XFree86 3.3.1 the entry should be: .Xr uhci 4 , .Xr usb 4 , .Xr XF86Config 5 , -.Xr moused 8 +.Xr moused 8 .\".Sh HISTORY .Sh AUTHORS .An -nosplit @@ -120,6 +120,6 @@ by .An MAEKAWA Masahide Aq bishop@rr.iij4u.or.jp . .Pp This manual page was written by -.An Nick Hibma Aq n_hibma@FreeBSD.org +.An Nick Hibma Aq n_hibma@FreeBSD.org with input from .An Kazutaka YOKOTA Aq yokota@zodiac.mech.utsunomiya-u.ac.jp . diff --git a/share/man/man4/unix.4 b/share/man/man4/unix.4 index 6f5d2c8..7356edb 100644 --- a/share/man/man4/unix.4 +++ b/share/man/man4/unix.4 @@ -49,7 +49,7 @@ that provides local (on-machine) interprocess communication through the normal .Xr socket 2 mechanisms. -The +The .Tn UNIX Ns -domain family supports the .Dv SOCK_STREAM @@ -88,7 +88,7 @@ The protocol family does not support broadcast addressing or any form of .Dq wildcard -matching on incoming messages. +matching on incoming messages. All addresses are absolute- or relative-pathnames of other .Tn UNIX Ns -domain @@ -101,7 +101,7 @@ or .Xr sendto 2 must be writable. .Sh PROTOCOLS -The +The .Tn UNIX Ns -domain protocol family is comprised of simple transport protocols that support the @@ -110,7 +110,7 @@ and .Dv SOCK_DGRAM abstractions. .Dv SOCK_STREAM -sockets also support the communication of +sockets also support the communication of .Ux file descriptors through the use of the .Ar msg_control @@ -122,7 +122,7 @@ and .Xr recvmsg 2 . .Pp Any valid descriptor may be sent in a message. -The file descriptor(s) to be passed are described using a +The file descriptor(s) to be passed are described using a .Ar struct cmsghdr that is defined in the include file .Aq Pa sys/socket.h . @@ -135,13 +135,13 @@ by the length field of the message; the length field is the sum of the size of the header plus the size of the array of file descriptors. .Pp -The received descriptor is a +The received descriptor is a .Em duplicate of the sender's descriptor, as if it were created with a call to .Xr dup 2 . Per-process descriptor flags, set with .Xr fcntl 2 , -are +are .Em not passed to a receiver. Descriptors that are awaiting delivery, or that are diff --git a/share/man/man4/urio.4 b/share/man/man4/urio.4 index d1abbf4..42dfdc4 100644 --- a/share/man/man4/urio.4 +++ b/share/man/man4/urio.4 @@ -59,7 +59,7 @@ device can be used by the Rio500 userland applications. .Sh FILES .Bl -tag -width /dev/ums0 -compact .It Pa /dev/urio0 -blocking device node +blocking device node .El .Sh EXAMPLES The following line in the kernel configuration file adds the @@ -107,7 +107,7 @@ CFLAGS="-I/usr/include/dev/usb" ./configure \\ .Sh AUTHORS .An -nosplit The -.Nm +.Nm driver was written by .An Iwasa Kazmi Aq kzmi@ca2.so-net.ne.jp for diff --git a/share/man/man4/vga.4 b/share/man/man4/vga.4 index aa14731..44edef3 100644 --- a/share/man/man4/vga.4 +++ b/share/man/man4/vga.4 @@ -71,27 +71,27 @@ option (see below) must be defined in the kernel configuration file. .Pp The .Nm vesa -module can be dynamically loaded into the kernel using +module can be dynamically loaded into the kernel using .Xr kldload 8 . .Sh DRIVER CONFIGURATION .Ss Kernel Configuration Options -The following kernel configuration options -.Pq see Xr config 8 +The following kernel configuration options +.Pq see Xr config 8 can be used to control the .Nm driver. These options provide compatibility with certain VGA cards. .Bl -tag -width MOUSE .It Dv VGA_ALT_SEQACCESS -You may want to try this option if the mouse pointer is not drawn correctly -or the font does not seem to be loaded properly on the VGA card. +You may want to try this option if the mouse pointer is not drawn correctly +or the font does not seem to be loaded properly on the VGA card. However, it may cause flicker on some systems. .It Dv VGA_SLOW_IOACCESS Older VGA cards may require this option for proper operation. It makes the driver perform byte-wide I/O to VGA registers and slow down a little. .It Dv VGA_WIDTH90 -This option enables 90 column modes: 90x25, 90x30, 90x43, 90x50, 90x60. +This option enables 90 column modes: 90x25, 90x30, 90x43, 90x50, 90x60. These modes are not always supported by the video card and the display. It is highly likely that LCD display cannot work with these modes. .El @@ -100,7 +100,7 @@ The following options add optional features to the driver. .Bl -tag -width MOUSE .It Dv VESA Add VESA BIOS support to the driver. -If the VGA card has the VESA BIOS extension 1.2 or later, +If the VGA card has the VESA BIOS extension 1.2 or later, this option will utilize the VESA BIOS service to switch to high resolution modes. .It Dv VESA_DEBUG=N @@ -172,7 +172,7 @@ The .Nm driver was written by .An S\(/oren Schmidt Aq sos@FreeBSD.org -and +and .An Kazutaka Yokota Aq yokota@FreeBSD.org . This manual page was written by .An Kazutaka Yokota . diff --git a/share/man/man4/vr.4 b/share/man/man4/vr.4 index 0765e71..0e4f362 100644 --- a/share/man/man4/vr.4 +++ b/share/man/man4/vr.4 @@ -149,7 +149,7 @@ the card should be configured correctly. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Rs diff --git a/share/man/man4/wb.4 b/share/man/man4/wb.4 index b9bb226..4b1400f 100644 --- a/share/man/man4/wb.4 +++ b/share/man/man4/wb.4 @@ -149,7 +149,7 @@ the card should be configured correctly. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY diff --git a/share/man/man4/wi.4 b/share/man/man4/wi.4 index c398b37..382a064 100644 --- a/share/man/man4/wi.4 +++ b/share/man/man4/wi.4 @@ -86,7 +86,7 @@ command. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ifconfig 8 , .Xr wicontrol 8 .Rs diff --git a/share/man/man4/worm.4 b/share/man/man4/worm.4 index d9c5ec1..108f595 100644 --- a/share/man/man4/worm.4 +++ b/share/man/man4/worm.4 @@ -1,4 +1,4 @@ -.\" +.\" .\" Copyright (C) 1996 .\" interface business GmbH .\" Tolkewitzer Strasse 49 @@ -9,7 +9,7 @@ .\" .\" Written by Joerg Wunsch <joerg_wunsch@interface-business.de> .\" -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -73,7 +73,7 @@ which is in the ports collection. .Pp The -.Xr cd 4 +.Xr cd 4 driver provides read-only access to CD, CD-R, and CD-RW drives, as well as WORM drives that support the CDROM command set. Therefore, users wishing to mount CDs in a WORM drive should use the diff --git a/share/man/man4/xl.4 b/share/man/man4/xl.4 index dad534b..45d7e42 100644 --- a/share/man/man4/xl.4 +++ b/share/man/man4/xl.4 @@ -188,7 +188,7 @@ the author considers it a manufacturing defect. .El .Sh SEE ALSO .Xr arp 4 , -.Xr netintro 4 , +.Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 .Sh HISTORY diff --git a/share/man/man4/xpt.4 b/share/man/man4/xpt.4 index f6bcdd6..adf1fef 100644 --- a/share/man/man4/xpt.4 +++ b/share/man/man4/xpt.4 @@ -39,7 +39,7 @@ None. The .Nm driver provides a way for userland applications to issue certain CAM CCBs -to the kernel. +to the kernel. .Pp Since the .Nm @@ -87,7 +87,7 @@ corresponding to the device in question. .It Pa /dev/xpt0 Character device node for the .Nm -driver. +driver. .El .Sh DIAGNOSTICS None. diff --git a/share/man/man4/yp.4 b/share/man/man4/yp.4 index 37ed0aa..b6657ed 100644 --- a/share/man/man4/yp.4 +++ b/share/man/man4/yp.4 @@ -61,7 +61,7 @@ support is enabled in .Xr nsswitch.conf 5 . .Pp The -.Nm YP +.Nm YP subsystem is started automatically in .Pa /etc/rc if it has been initialized in @@ -397,7 +397,7 @@ Additionally, includes support for Wietse Venema's tcp wrapper package; with tcp wrapper support enabled, the administrator can configure .Xr ypserv 8 -to respond only to selected client machines. +to respond only to selected client machines. .Pp While these enhancements provide better security than stock .Tn NIS Ns , @@ -468,12 +468,12 @@ It can also be made to register itself as an .Tn NIS v1 server in order to placate certain systems that insist on the presence of -a v1 server +a v1 server .No ( Fx uses only .Tn NIS v2, but many other systems, -including +including .Tn SunOS 4.x, search for both a v1 and v2 server when binding). .Fx Ns 's diff --git a/share/man/man5/core.5 b/share/man/man5/core.5 index a1b255f..34cc8c8 100644 --- a/share/man/man5/core.5 +++ b/share/man/man5/core.5 @@ -85,9 +85,9 @@ defined by the .Dv UPAGES manifest in the .Aq Pa sys/param.h -file. The +file. The .Fa u . -area starts with a +area starts with a .Fa user structure as given in .Aq Pa sys/user.h . @@ -102,9 +102,9 @@ in the .Fa u . area. The amount of stack image in the core file is given (in pages) by the -variable +variable .Fa u_ssize -in the +in the .Ar u . area. The size of a ``page'' is given by the constant diff --git a/share/man/man5/devfs.5 b/share/man/man5/devfs.5 index 28b55d5..c499735 100644 --- a/share/man/man5/devfs.5 +++ b/share/man/man5/devfs.5 @@ -49,7 +49,7 @@ devfs /dev devfs rw 0 0 .Sh DESCRIPTION The device file system, or .Nm , -provides access to kernel's device +provides access to kernel's device namespace in the global filesystem namespace. The conventional mount point is .Pa /dev . @@ -65,25 +65,25 @@ mount point. .Bl -tag -width /dev/XXXX -compact .It Pa /dev The normal -.Nm +.Nm mount point. .El .Sh SEE ALSO .Xr mount_devfs 8 .Sh HISTORY The -.Nm +.Nm filesystem first appeared in .Fx 2.0 . The .Nm -manual page first appeared in +manual page first appeared in .Fx 2.2 . .Sh AUTHORS -The +The .Nm manual page was written by .An Mike Pritchard Aq mpp@FreeBSD.org , -and was based on the +and was based on the .Xr mount_devfs 8 manual page. diff --git a/share/man/man5/dir.5 b/share/man/man5/dir.5 index 7482867..a07240a 100644 --- a/share/man/man5/dir.5 +++ b/share/man/man5/dir.5 @@ -52,7 +52,7 @@ It consists of records (directory entries) each of which contains information about a file and a pointer to the file itself. Directory entries may contain other directories as well as plain files; such nested directories are referred to as -subdirectories. +subdirectories. A hierarchy of directories and files is formed in this manner and is called a file system (or referred to as a file system tree). .\" An entry in this tree, diff --git a/share/man/man5/disktab.5 b/share/man/man5/disktab.5 index 5d82981..2fdbe49 100644 --- a/share/man/man5/disktab.5 +++ b/share/man/man5/disktab.5 @@ -52,13 +52,13 @@ to initialize the disk label on the disk. The format is patterned after the .Xr termcap 5 -terminal data base. Entries in +terminal data base. Entries in .Nm consist of a number of `:' separated fields. The first entry for each disk gives the names which are known for the disk, separated by `|' characters. The last name given should be a long name fully identifying -the disk. +the disk. .Pp The following list indicates the normal values stored for each disk entry. diff --git a/share/man/man5/elf.5 b/share/man/man5/elf.5 index bc7e831..f31fe2b 100644 --- a/share/man/man5/elf.5 +++ b/share/man/man5/elf.5 @@ -706,7 +706,7 @@ The section holds information defined by the program, whose format and meaning are determined solely by the program. .It Dv SHT_SYMTAB This section holds a symbol table. -Typically, +Typically, .Sy SHT_SYMTAB provides symbols for link editing, though it may also be used for dynamic linking. @@ -998,7 +998,7 @@ will include the .Sy SHF_ALLOC bit. Otherwise the bit will be off. -By convention, +By convention, .Dq NAME is supplied by the section to which the relocations apply. Thus a relocation @@ -1020,7 +1020,7 @@ By convention, .Dq NAME is supplied by the section to which the relocations apply. Thus a relocation -section for +section for .Sy .text normally would have the name .Sy .rela.text . @@ -1034,7 +1034,7 @@ This section is of type The attribute used is .Sy SHF_ALLOC . .It .rodata1 -This section hold read-only data that typically contributes to a +This section hold read-only data that typically contributes to a non-writable segment in the process image. This section is of type .Sy SHT_PROGBITS . @@ -1225,7 +1225,7 @@ header table index. .Pp Relocation is the process of connecting symbolic references with symbolic definitions. -Relocatable files must have information that +Relocatable files must have information that describes how to modify their section contents, thus allowing executable and shared object files to hold the right information for a process' program image. @@ -1310,13 +1310,13 @@ stored into the relocatable field. .%B "Executable and Linking Format (ELF)" .Re .Sh HISTORY -The ELF header files made their appearance in +The ELF header files made their appearance in .Fx 2.2.6 . ELF in itself first appeared in .At V . The ELF format is an adopted standard. .Sh AUTHORS -This manual page was written by +This manual page was written by .An Jeroen Ruigrok van der Werven .Aq asmodai@FreeBSD.org with inspiration from BSDi's BSD/OS diff --git a/share/man/man5/fbtab.5 b/share/man/man5/fbtab.5 index 5858e80..014ce47 100644 --- a/share/man/man5/fbtab.5 +++ b/share/man/man5/fbtab.5 @@ -11,7 +11,7 @@ The .Nm file contains a number of lines specifying a device together with a list -of devices with associated protections. +of devices with associated protections. Comments start with a # and extend to the end of the line. .Pp Blank lines or lines with only a comment are ignored. diff --git a/share/man/man5/fdescfs.5 b/share/man/man5/fdescfs.5 index 0fe7bde..61c3979 100644 --- a/share/man/man5/fdescfs.5 +++ b/share/man/man5/fdescfs.5 @@ -80,7 +80,7 @@ are equivalent. Flags to the .Xr open 2 call other than -.Dv O_RDONLY , +.Dv O_RDONLY , .Dv O_WRONLY and .Dv O_RDWR @@ -94,20 +94,20 @@ are ignored. .Xr mount_fdescfs 8 .Sh HISTORY The -.Nm +.Nm filesystem first appeared in .Bx 4.4 . -The +The .Nm -manual page first appeared in +manual page first appeared in .Fx 2.2 . .Sh AUTHORS .An -nosplit -The +The .Nm manual page was written by .An Mike Pritchard Aq mpp@FreeBSD.org , -and was based on the +and was based on the .Xr mount_fdescfs 8 manual page written by .An Jan-Simon Pendry . diff --git a/share/man/man5/forward.5 b/share/man/man5/forward.5 index 28735b1..b6d0e46 100644 --- a/share/man/man5/forward.5 +++ b/share/man/man5/forward.5 @@ -53,7 +53,7 @@ file must be owned by the user the mail is being sent to, or by root, and the user's shell must be listed in .Pa /etc/shells . .Pp -For example, if a +For example, if a .Nm .forward file contained the following lines: .Bd -literal -offset indent @@ -61,7 +61,7 @@ nobody@FreeBSD.org "|/usr/bin/vacation nobody" .Ed .Pp -Mail would be forwarded to +Mail would be forwarded to .Aq nobody@FreeBSD.org and to the program .Pa /usr/bin/vacation @@ -72,7 +72,7 @@ If a local user address is prefixed with a backslash character, mail is delivered directly to the user's mail spool file, bypassing further redirection. .Pp -For example, if user chris had a +For example, if user chris had a .Nm .forward file containing the following lines: .Bd -literal -offset indent @@ -80,7 +80,7 @@ chris@otherhost \echris .Ed .Pp -One copy of mail would be forwarded to +One copy of mail would be forwarded to .Ar chris@otherhost and another copy would be retained as mail for local user chris. .Sh FILES diff --git a/share/man/man5/fs.5 b/share/man/man5/fs.5 index b465680..f8c5e38 100644 --- a/share/man/man5/fs.5 +++ b/share/man/man5/fs.5 @@ -153,7 +153,7 @@ struct fs { int32_t fs_cpc; /* cyl per cycle in postbl */ int16_t fs_opostbl[16][8]; /* old rotation block list head */ int32_t fs_sparecon[50]; /* reserved for future constants */ - int32_t fs_contigsumsize; /* size of cluster summary array */ + int32_t fs_contigsumsize; /* size of cluster summary array */ int32_t fs_maxsymlinklen;/* max length of an internal symlink */ int32_t fs_inodefmt; /* format of on-disk inodes */ u_int64_t fs_maxfilesize;/* maximum representable file size */ @@ -204,7 +204,7 @@ referenced further unless disaster strikes. Addresses stored in inodes are capable of addressing fragments of `blocks'. File system blocks of at most size .Dv MAXBSIZE -can +can be optionally broken into 2, 4, or 8 pieces, each of which is addressable; these pieces may be .Dv DEV_BSIZE , @@ -309,7 +309,7 @@ Note that super-blocks are never more than size The path name on which the file system is mounted is maintained in .Fa fs_fsmnt . .Dv MAXMNTLEN -defines the amount of space allocated in +defines the amount of space allocated in the super-block for this name. The limit on the amount of summary information per file system is defined by @@ -318,7 +318,7 @@ For a 4096 byte block size, it is currently parameterized for a maximum of two million cylinders. .Pp Per cylinder group information is summarized in blocks allocated -from the first cylinder group's data blocks. +from the first cylinder group's data blocks. These blocks are read in from .Fa fs_csaddr (size diff --git a/share/man/man5/fstab.5 b/share/man/man5/fstab.5 index 3981be5..2aa625e 100644 --- a/share/man/man5/fstab.5 +++ b/share/man/man5/fstab.5 @@ -47,7 +47,7 @@ contains descriptive information about the various file systems. .Nm is only read by programs, and not written; -it is the duty of the system administrator to properly create +it is the duty of the system administrator to properly create and maintain this file. Each filesystem is described on a separate line; fields on each line are separated by tabs or spaces. @@ -68,7 +68,7 @@ describes the block special device or remote filesystem to be mounted. For filesystems of type .Em ufs , -the special file name is the block special file name, +the special file name is the block special file name, and not the character special file name. If a program needs the character special file name, the program must create it by appending a ``r'' after the @@ -84,27 +84,27 @@ The third field, describes the type of the filesystem. The system can support various filesystem types. Only the root, /usr, and /tmp filesystems need be statically -compiled into the kernel; +compiled into the kernel; everything else will be automatically loaded at mount time. (Exception: the UFS family - FFS and LFS cannot currently be demand-loaded.) Some people still prefer to statically compile other filesystems as well. .Bl -tag -width indent -offset indent -.It Em ufs +.It Em ufs a local .Tn UNIX filesystem -.It Em nfs +.It Em nfs a Sun Microsystems compatible ``Network File System'' -.It Em swap +.It Em swap a disk partition to be used for swapping .It Em msdos a DOS compatible filesystem -.It Em cd9660 +.It Em cd9660 a CD-ROM filesystem (as per ISO 9660) .\" maybe also say Rock Ridge extensions are handled ? -.It Em procfs -a file system for accessing process data +.It Em procfs +a file system for accessing process data .El .Pp The fourth field, @@ -193,7 +193,7 @@ program to determine the order in which filesystem checks are done at reboot time. The root filesystem should be specified with a .Fa fs_passno -of 1, and other filesystems should have a +of 1, and other filesystems should have a .Fa fs_passno of 2. Filesystems within a drive will be checked sequentially, diff --git a/share/man/man5/group.5 b/share/man/man5/group.5 index 44e2849..b40e5e0 100644 --- a/share/man/man5/group.5 +++ b/share/man/man5/group.5 @@ -44,7 +44,7 @@ The file file is the local source of group information. It can be used in conjunction with the Hesiod domain `group', and the NIS maps `group.byname' and `group.bygid', -as controlled by +as controlled by .Xr nsswitch.conf 5 . .Pp The file @@ -70,7 +70,7 @@ Group members. .Pp Lines whose first non-whitespace character is a pound-sign (#) are comments, and are ignored. -Blank lines that consist +Blank lines that consist only of spaces, tabs or newlines are also ignored. .Pp The @@ -90,7 +90,7 @@ is an optional password. This field is rarely used and an asterisk is normally placed in it rather than leaving it blank. -The +The .Ar member field contains the names of users granted the privileges of .Ar group . @@ -121,7 +121,7 @@ There are various limitations which are explained in the function where they occur; see section .Sx SEE ALSO . .Pp -In older implementations, +In older implementations, a group cannot have more than 200 members. The maximum line length of .Pa /etc/group diff --git a/share/man/man5/hosts.5 b/share/man/man5/hosts.5 index d7349bf..79b20c3 100644 --- a/share/man/man5/hosts.5 +++ b/share/man/man5/hosts.5 @@ -65,14 +65,14 @@ this file provides a backup used when the name server is not running. For the name server, it is suggested that only a few addresses be included in this file. -These include addresses for the local interfaces that +These include addresses for the local interfaces that .Xr ifconfig 8 needs at boot time and a few machines on the local network. .Pp This file may be created from the official host data base maintained at the Network Information Control Center -.Pq Tn NIC , +.Pq Tn NIC , though local changes may be required to bring it up to date regarding unofficial aliases and/or unknown hosts. As the data base maintained at diff --git a/share/man/man5/hosts.equiv.5 b/share/man/man5/hosts.equiv.5 index 08546a9..4293a8b 100644 --- a/share/man/man5/hosts.equiv.5 +++ b/share/man/man5/hosts.equiv.5 @@ -91,7 +91,7 @@ or comment character. .Pp For security reasons, a user's .Nm .rhosts -file will be ignored if it is not a regular file, or if it +file will be ignored if it is not a regular file, or if it is not owned by the user, or if it is writable by anyone other than the user. .Sh EXAMPLES @@ -102,7 +102,7 @@ Trust user from host .Dq bar.com . .Pp -.Dl +@allclient +.Dl +@allclient .Pp Trust all hosts from netgroup .Dq allclient . @@ -111,7 +111,7 @@ Trust all hosts from netgroup .Pp Trust all hosts from netgroup .Dq allclient -and their users +and their users except users from netgroup .Dq dau . .Sh FILES diff --git a/share/man/man5/link.5 b/share/man/man5/link.5 index 41fbc8d..85c0e27 100644 --- a/share/man/man5/link.5 +++ b/share/man/man5/link.5 @@ -134,7 +134,7 @@ This field provides for different versions of the dynamic linking implementation. The current version numbers understood by .Xr ld 1 -and +and .Xr ld.so 1 are .Em LD_VERSION_SUN (3) , @@ -252,7 +252,7 @@ The offset in the text segment of a string describing this link object. .It Fa sod_library If set, .Fa sod_name -specifies a library that is to be searched for by +specifies a library that is to be searched for by .Nm ld.so . The path name is obtained by searching a set of directories @@ -535,7 +535,7 @@ and .Fa hints_bucket structures define the layout of the library hints, normally found in .Dq Pa /var/run/ld.so.hints , -which is used by +which is used by .Nm ld.so to quickly locate the shared object images in the filesystem. diff --git a/share/man/man5/linprocfs.5 b/share/man/man5/linprocfs.5 index 762502b..f6c5842 100644 --- a/share/man/man5/linprocfs.5 +++ b/share/man/man5/linprocfs.5 @@ -58,7 +58,7 @@ CPU vendor and model information in human-readable form. .It Pa /compat/linux/proc/meminfo System memory information in human-readable form. .It Pa /compat/linux/proc/pid -directory containing process information for process +directory containing process information for process .Pa pid . .It Pa /compat/linux/proc/self directory containing process information for the current process diff --git a/share/man/man5/make.conf.5 b/share/man/man5/make.conf.5 index ac73356..8f31eec 100644 --- a/share/man/man5/make.conf.5 +++ b/share/man/man5/make.conf.5 @@ -81,7 +81,7 @@ The values of variables flagged as .Vt bool are ignored; the variable being -set at all (even to +set at all (even to .Dq Li FALSE or .Dq Li NO ) diff --git a/share/man/man5/motd.5 b/share/man/man5/motd.5 index 3564b40..2ffbc9e 100644 --- a/share/man/man5/motd.5 +++ b/share/man/man5/motd.5 @@ -29,7 +29,7 @@ in their home directories or through .It Pa /etc/motd The message of the day. .It Pa $HOME/.hushlogin -Suppresses output of +Suppresses output of .Pa /etc/motd . .El .Sh EXAMPLES diff --git a/share/man/man5/networks.5 b/share/man/man5/networks.5 index e429156..04ec15b 100644 --- a/share/man/man5/networks.5 +++ b/share/man/man5/networks.5 @@ -57,7 +57,7 @@ A ``#'' indicates the beginning of a comment; characters up to the end of the line are not interpreted by routines which search the file. This file is normally created from the official network data base maintained at the Network Information Control Center -.Pq Tn NIC , +.Pq Tn NIC , though local changes may be required to bring it up to date regarding unofficial aliases and/or unknown networks. diff --git a/share/man/man5/nsswitch.conf.5 b/share/man/man5/nsswitch.conf.5 index 4f48708..44a296f 100644 --- a/share/man/man5/nsswitch.conf.5 +++ b/share/man/man5/nsswitch.conf.5 @@ -3,10 +3,10 @@ .\" .\" Copyright (c) 1997, 1998, 1999 The NetBSD Foundation, Inc. .\" All rights reserved. -.\" +.\" .\" This code is derived from software contributed to The NetBSD Foundation .\" by Luke Mewburn. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -20,7 +20,7 @@ .\" This product includes software developed by Luke Mewburn. .\" 4. The name of the author may not be used to endorse or promote products .\" derived from this software without specific prior written permission. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. @@ -52,7 +52,7 @@ Each database comes from a source (such as local files, DNS, and and the order to look up the sources is specified in .Nm . .Pp -Each entry in +Each entry in .Nm consists of a database name, and a space separated list of sources. Each source can have an optional trailing criterion that determines diff --git a/share/man/man5/passwd.5 b/share/man/man5/passwd.5 index 23037cb..46367f7 100644 --- a/share/man/man5/passwd.5 +++ b/share/man/man5/passwd.5 @@ -47,7 +47,7 @@ The .Nm files are the local source of password information. They can be used in conjunction with the Hesiod domains -.Sq passwd +.Sq passwd and .Sq uid , and the @@ -56,7 +56,7 @@ maps .Sq passwd.byname , .Sq passwd.byuid , .Sq master.passwd.byname , -and +and .Sq master.passwd.byuid , as controlled by .Xr nsswitch.conf 5 . @@ -93,8 +93,8 @@ User's login shell. .El .Pp The -.Nm -file is generated from the +.Nm +file is generated from the .Nm master.password file by .Xr pwd_mkdb 8 , @@ -140,7 +140,7 @@ The field is a key for a user's login class. Login classes are defined in .Xr login.conf 5 , -which is a +which is a .Xr termcap 5 style database of user attributes, accounting, resource, and environment settings. @@ -223,7 +223,7 @@ lookups occur from the .Sq passwd.byname , .Sq passwd.byuid , .Sq master.passwd.byname , -and +and .Sq master.passwd.byuid .Tn NIS maps. @@ -342,7 +342,7 @@ file format first appeared in SunOS. .Pp The Hesiod support first appeared in .Fx 4.1 . -It was imported from the +It was imported from the .Nx Project, where it first appeared in .Nx 1.4 . diff --git a/share/man/man5/periodic.conf.5 b/share/man/man5/periodic.conf.5 index d9c92f7..8f211f7 100644 --- a/share/man/man5/periodic.conf.5 +++ b/share/man/man5/periodic.conf.5 @@ -389,7 +389,7 @@ if you want to run .Xr uptime 1 (or .Xr ruptime 1 -if +if .Va rwhod_enable is set to .Dq YES diff --git a/share/man/man5/procfs.5 b/share/man/man5/procfs.5 index 4e32369..26a4cce 100644 --- a/share/man/man5/procfs.5 +++ b/share/man/man5/procfs.5 @@ -121,9 +121,9 @@ can only be written when the process is stopped. .It Pa rlimit This is a read-only file containing the process current and maximum limits. -Each line is of the format +Each line is of the format .Ar rlimit current max -, with -1 +, with -1 indicating infinity. .It Pa status The process status. @@ -204,7 +204,7 @@ group. normal mount point for the .Nm . .It Pa /proc/pid -directory containing process information for process +directory containing process information for process .Pa pid . .It Pa /proc/curproc directory containing process information for the current process diff --git a/share/man/man5/remote.5 b/share/man/man5/remote.5 index f5e1e1d..2b0ac6d 100644 --- a/share/man/man5/remote.5 +++ b/share/man/man5/remote.5 @@ -59,11 +59,11 @@ field name followed by an `=' sign indicates a string value. A field name followed by a `#' sign indicates a numeric value. .Pp Entries named ``tip*'' and ``cu*'' -are used as default entries by +are used as default entries by .Xr tip 1 , and the .Xr cu 1 -interface to +interface to .Nm tip , as follows. When .Nm tip @@ -74,7 +74,7 @@ which the connection is to be made. When the interface is used, entries of the form ``cu300'' are used. .Sh CAPABILITIES Capabilities are either strings (str), numbers (num), or boolean -flags (bool). A string capability is specified by +flags (bool). A string capability is specified by .Em capability Ns Ar = Ns Em value ; for example, ``dv=/dev/harris''. A numeric capability is specified by .Em capability Ns Ar # Ns Em value ; @@ -88,7 +88,7 @@ Auto call unit type. (num) The baud rate used in establishing a connection to the remote host. -This is a decimal number. +This is a decimal number. The default baud rate is 300 baud. .It Cm \&cm (str) @@ -107,20 +107,20 @@ Disconnect message sent to the host when a disconnect is requested by the user. .It Cm \&du (bool) -This host is on a dial-up line. +This host is on a dial-up line. .It Cm \&dv (str) .Tn UNIX -device(s) to open to establish a connection. +device(s) to open to establish a connection. If this file refers to a terminal line, .Xr tip 1 attempts to perform an exclusive open on the device to ensure only one user at a time has access to the port. .It Cm \&el (str) -Characters marking an end-of-line. +Characters marking an end-of-line. The default is -.Dv NULL . +.Dv NULL . `~' escapes are only recognized by .Nm tip @@ -128,7 +128,7 @@ after one of the characters in `el', or after a carriage-return. .It Cm \&fs (str) -Frame size for transfers. +Frame size for transfers. The default frame size is equal to .Dv BUFSIZ . .It Cm \&hd @@ -139,13 +139,13 @@ echo should be performed. (str) Input end-of-file marks. The default is -.Dv NULL . +.Dv NULL . .It Cm \&oe (str) Output end-of-file string. The default is -.Dv NULL . -When +.Dv NULL . +When .Nm tip is transferring a file, this string is sent at end-of-file. @@ -160,7 +160,7 @@ is even parity. (str) Telephone number(s) for this host. If the telephone number field contains -an @ sign, +an @ sign, .Nm tip searches the file .Pa /etc/phones diff --git a/share/man/man5/services.5 b/share/man/man5/services.5 index e1dce91..18e3ed8 100644 --- a/share/man/man5/services.5 +++ b/share/man/man5/services.5 @@ -54,7 +54,7 @@ aliases .Ed .Pp Items are separated by any number of blanks and/or tab characters. -The port number and protocol name are considered a single +The port number and protocol name are considered a single .Em item ; a ``/'' is used to separate the port and protocol (e.g. ``512/tcp''). diff --git a/share/man/man5/stab.5 b/share/man/man5/stab.5 index b7dd687..9d71858 100644 --- a/share/man/man5/stab.5 +++ b/share/man/man5/stab.5 @@ -92,7 +92,7 @@ struct nlist { The low bits of the .Fa n_type field are used to place a symbol into -at most one segment, according to +at most one segment, according to the following masks, defined in .Aq Pa a.out.h . A symbol can be in none of these segments by having none of these segment @@ -172,7 +172,7 @@ and .Fa n_value fields of the given -.Fa n_type . +.Fa n_type . .Em Sdb uses the .Fa n_desc diff --git a/share/man/man5/sysctl.conf.5 b/share/man/man5/sysctl.conf.5 index 89ccba8..137d04d 100644 --- a/share/man/man5/sysctl.conf.5 +++ b/share/man/man5/sysctl.conf.5 @@ -1,6 +1,6 @@ .\" Copyright (c) 1999 Chris Costello <chris@FreeBSD.org> .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -9,7 +9,7 @@ .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE @@ -21,9 +21,9 @@ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. -.\" +.\" .\" $FreeBSD$ -.\" +.\" .Dd December 30, 1999 .Dt SYSCTL.CONF 5 .Os diff --git a/share/man/man5/utmp.5 b/share/man/man5/utmp.5 index 16de1ba..0692a97 100644 --- a/share/man/man5/utmp.5 +++ b/share/man/man5/utmp.5 @@ -59,7 +59,7 @@ the file. .Pp These files can grow rapidly on busy systems, so daily or weekly rotation -is recommended. +is recommended. If any one of these files does not exist, it is not created. They must be created manually and are maintained by .Xr newsyslog 8 . diff --git a/share/man/man6/intro.6 b/share/man/man6/intro.6 index 92168e1..4579085 100644 --- a/share/man/man6/intro.6 +++ b/share/man/man6/intro.6 @@ -40,11 +40,11 @@ .Sh DESCRIPTION This section contains information about games. The games -are located in +are located in .Pa /usr/games if installed. -You can get a short overview about all the games with the -command: +You can get a short overview about all the games with the +command: .Bd -literal -offset indent $ apropos '(6)' .Ed diff --git a/share/man/man7/ascii.7 b/share/man/man7/ascii.7 index 74ff250..a652085 100644 --- a/share/man/man7/ascii.7 +++ b/share/man/man7/ascii.7 @@ -48,18 +48,18 @@ set: 000 nul 001 soh 002 stx 003 etx 004 eot 005 enq 006 ack 007 bel 010 bs 011 ht 012 nl 013 vt 014 np 015 cr 016 so 017 si 020 dle 021 dc1 022 dc2 023 dc3 024 dc4 025 nak 026 syn 027 etb -030 can 031 em 032 sub 033 esc 034 fs 035 gs 036 rs 037 us -040 sp 041 ! 042 " 043 # 044 $ 045 % 046 & 047 ' -050 ( 051 ) 052 * 053 + 054 , 055 - 056 . 057 / -060 0 061 1 062 2 063 3 064 4 065 5 066 6 067 7 -070 8 071 9 072 : 073 ; 074 < 075 = 076 > 077 ? -100 @ 101 A 102 B 103 C 104 D 105 E 106 F 107 G -110 H 111 I 112 J 113 K 114 L 115 M 116 N 117 O -120 P 121 Q 122 R 123 S 124 T 125 U 126 V 127 W -130 X 131 Y 132 Z 133 [ 134 \e\ 135 ] 136 ^ 137 _ -140 ` 141 a 142 b 143 c 144 d 145 e 146 f 147 g -150 h 151 i 152 j 153 k 154 l 155 m 156 n 157 o -160 p 161 q 162 r 163 s 164 t 165 u 166 v 167 w +030 can 031 em 032 sub 033 esc 034 fs 035 gs 036 rs 037 us +040 sp 041 ! 042 " 043 # 044 $ 045 % 046 & 047 ' +050 ( 051 ) 052 * 053 + 054 , 055 - 056 . 057 / +060 0 061 1 062 2 063 3 064 4 065 5 066 6 067 7 +070 8 071 9 072 : 073 ; 074 < 075 = 076 > 077 ? +100 @ 101 A 102 B 103 C 104 D 105 E 106 F 107 G +110 H 111 I 112 J 113 K 114 L 115 M 116 N 117 O +120 P 121 Q 122 R 123 S 124 T 125 U 126 V 127 W +130 X 131 Y 132 Z 133 [ 134 \e\ 135 ] 136 ^ 137 _ +140 ` 141 a 142 b 143 c 144 d 145 e 146 f 147 g +150 h 151 i 152 j 153 k 154 l 155 m 156 n 157 o +160 p 161 q 162 r 163 s 164 t 165 u 166 v 167 w 170 x 171 y 172 z 173 { 174 | 175 } 176 ~ 177 del .Ed .Pp @@ -68,20 +68,20 @@ The set: .Bd -literal -offset left 00 nul 01 soh 02 stx 03 etx 04 eot 05 enq 06 ack 07 bel -08 bs 09 ht 0a nl 0b vt 0c np 0d cr 0e so 0f si +08 bs 09 ht 0a nl 0b vt 0c np 0d cr 0e so 0f si 10 dle 11 dc1 12 dc2 13 dc3 14 dc4 15 nak 16 syn 17 etb -18 can 19 em 1a sub 1b esc 1c fs 1d gs 1e rs 1f us -20 sp 21 ! 22 " 23 # 24 $ 25 % 26 & 27 ' -28 ( 29 ) 2a * 2b + 2c , 2d - 2e . 2f / -30 0 31 1 32 2 33 3 34 4 35 5 36 6 37 7 -38 8 39 9 3a : 3b ; 3c < 3d = 3e > 3f ? -40 @ 41 A 42 B 43 C 44 D 45 E 46 F 47 G -48 H 49 I 4a J 4b K 4c L 4d M 4e N 4f O -50 P 51 Q 52 R 53 S 54 T 55 U 56 V 57 W -58 X 59 Y 5a Z 5b [ 5c \e\ 5d ] 5e ^ 5f _ -60 \` 61 a 62 b 63 c 64 d 65 e 66 f 67 g -68 h 69 i 6a j 6b k 6c l 6d m 6e n 6f o -70 p 71 q 72 r 73 s 74 t 75 u 76 v 77 w +18 can 19 em 1a sub 1b esc 1c fs 1d gs 1e rs 1f us +20 sp 21 ! 22 " 23 # 24 $ 25 % 26 & 27 ' +28 ( 29 ) 2a * 2b + 2c , 2d - 2e . 2f / +30 0 31 1 32 2 33 3 34 4 35 5 36 6 37 7 +38 8 39 9 3a : 3b ; 3c < 3d = 3e > 3f ? +40 @ 41 A 42 B 43 C 44 D 45 E 46 F 47 G +48 H 49 I 4a J 4b K 4c L 4d M 4e N 4f O +50 P 51 Q 52 R 53 S 54 T 55 U 56 V 57 W +58 X 59 Y 5a Z 5b [ 5c \e\ 5d ] 5e ^ 5f _ +60 \` 61 a 62 b 63 c 64 d 65 e 66 f 67 g +68 h 69 i 6a j 6b k 6c l 6d m 6e n 6f o +70 p 71 q 72 r 73 s 74 t 75 u 76 v 77 w 78 x 79 y 7a z 7b { 7c | 7d } 7e ~ 7f del .Ed .Pp @@ -90,20 +90,20 @@ The set: .Bd -literal -offset left 0 nul 1 soh 2 stx 3 etx 4 eot 5 enq 6 ack 7 bel - 8 bs 9 ht 10 nl 11 vt 12 np 13 cr 14 so 15 si + 8 bs 9 ht 10 nl 11 vt 12 np 13 cr 14 so 15 si 16 dle 17 dc1 18 dc2 19 dc3 20 dc4 21 nak 22 syn 23 etb - 24 can 25 em 26 sub 27 esc 28 fs 29 gs 30 rs 31 us - 32 sp 33 ! 34 " 35 # 36 $ 37 % 38 & 39 ' - 40 ( 41 ) 42 * 43 + 44 , 45 - 46 . 47 / - 48 0 49 1 50 2 51 3 52 4 53 5 54 6 55 7 - 56 8 57 9 58 : 59 ; 60 < 61 = 62 > 63 ? - 64 @ 65 A 66 B 67 C 68 D 69 E 70 F 71 G - 72 H 73 I 74 J 75 K 76 L 77 M 78 N 79 O - 80 P 81 Q 82 R 83 S 84 T 85 U 86 V 87 W - 88 X 89 Y 90 Z 91 [ 92 \e\ 93 ] 94 ^ 95 _ - 96 ` 97 a 98 b 99 c 100 d 101 e 102 f 103 g -104 h 105 i 106 j 107 k 108 l 109 m 110 n 111 o -112 p 113 q 114 r 115 s 116 t 117 u 118 v 119 w + 24 can 25 em 26 sub 27 esc 28 fs 29 gs 30 rs 31 us + 32 sp 33 ! 34 " 35 # 36 $ 37 % 38 & 39 ' + 40 ( 41 ) 42 * 43 + 44 , 45 - 46 . 47 / + 48 0 49 1 50 2 51 3 52 4 53 5 54 6 55 7 + 56 8 57 9 58 : 59 ; 60 < 61 = 62 > 63 ? + 64 @ 65 A 66 B 67 C 68 D 69 E 70 F 71 G + 72 H 73 I 74 J 75 K 76 L 77 M 78 N 79 O + 80 P 81 Q 82 R 83 S 84 T 85 U 86 V 87 W + 88 X 89 Y 90 Z 91 [ 92 \e\ 93 ] 94 ^ 95 _ + 96 ` 97 a 98 b 99 c 100 d 101 e 102 f 103 g +104 h 105 i 106 j 107 k 108 l 109 m 110 n 111 o +112 p 113 q 114 r 115 s 116 t 117 u 118 v 119 w 120 x 121 y 122 z 123 { 124 | 125 } 126 ~ 127 del .Ed .Sh FILES diff --git a/share/man/man7/build.7 b/share/man/man7/build.7 index 5e79633..811d1d8 100644 --- a/share/man/man7/build.7 +++ b/share/man/man7/build.7 @@ -88,7 +88,7 @@ Rebuild the kernel and the kernel-modules. Install the kernel and the kernel-modules. .It Ar reinstallkernel Reinstall the kernel and the kernel-modules. -.It Ar upgrade +.It Ar upgrade Upgrade a.out (2.2.x/3.0) system to the new ELF way .It Ar most Build user commands, no libraries or include files. diff --git a/share/man/man7/clocks.7 b/share/man/man7/clocks.7 index ee3c087..ec208fa 100644 --- a/share/man/man7/clocks.7 +++ b/share/man/man7/clocks.7 @@ -52,11 +52,11 @@ happens to be 128. It isn't directly available to applications. The clock reported by .Xr clock 3 . This is a virtual clock with a frequency that happens to be 128. Its -actual frequency is given by the macro -.Dv CLOCKS_PER_SEC . +actual frequency is given by the macro +.Dv CLOCKS_PER_SEC . Note that .Dv CLOCKS_PER_SEC -may be floating point. Don't use +may be floating point. Don't use .Fn clock in new programs under .Fx . @@ -71,22 +71,22 @@ The clock reported by This is a virtual clock with a frequency that happens to be 128. Its actual frequency is given by the macro .Dv CLK_TCK -(deprecated; don't use) and by +(deprecated; don't use) and by .Fn sysconf SC_CLK_TCK and by .Xr sysctl 3 . Note that its frequency may be different from .Dv CLOCKS_PER_SEC . -Don't use +Don't use .Xr times 3 in new programs under .Fx . It is feeble compared with .Xr gettimeofday 2 -together with +together with .Fn getrusage . It is provided for POSIX -conformance. It is implemented by calling +conformance. It is implemented by calling .Fn gettimeofday and .Fn getrusage diff --git a/share/man/man7/environ.7 b/share/man/man7/environ.7 index 640413d..d9d550a 100644 --- a/share/man/man7/environ.7 +++ b/share/man/man7/environ.7 @@ -55,8 +55,8 @@ The size of the block units used by several commands, most notably .Xr du 1 and .Xr ls 1 . -.Ev BLOCKSIZE -may be specified in units of a byte by specifying a number, +.Ev BLOCKSIZE +may be specified in units of a byte by specifying a number, in units of a kilobyte by specifying a number followed by ``K'' or ``k'', in units of a megabyte by specifying a number followed by ``M'' or ``m'' and in units of a gigabyte by specifying a number followed @@ -80,7 +80,7 @@ This variable configures all programs which use to use the specified locale. .It Ev MAIL The location of the user's -mailbox instead of the default in /var/mail, +mailbox instead of the default in /var/mail, used by .Xr mail 1 , .Xr sh 1 , @@ -98,7 +98,7 @@ The sequence of directories, separated by colons, searched by .Xr system 3 , .Xr execvp 3 , etc, when looking for an executable file. -.Ev PATH +.Ev PATH is set to ``/usr/bin:/bin'' initially by .Xr login 1 . .It Ev PRINTER @@ -123,7 +123,7 @@ which may exploit special terminal capabilities. See for a list of terminal types. .It Ev TERMCAP The string describing the terminal in -.Ev TERM , +.Ev TERM , or, if it begins with a '/', the name of the termcap file. See diff --git a/share/man/man7/firewall.7 b/share/man/man7/firewall.7 index 78cc4ca..52c5ed3 100644 --- a/share/man/man7/firewall.7 +++ b/share/man/man7/firewall.7 @@ -45,11 +45,11 @@ Constructing a firewall may appear to be trivial, but most people get them wrong. The most common mistake is to create an exclusive firewall rather then an inclusive firewall. An exclusive firewall allows all packets through except for those matching a set of rules. -An inclusive firewall allows only packets matching the rulset +An inclusive firewall allows only packets matching the rulset through. Inclusive firewalls are much, much safer then exclusive firewalls but a tad more difficult to build properly. The second most common mistake is to blackhole everything except the -particular port you want to let through. TCP/IP needs to be able +particular port you want to let through. TCP/IP needs to be able to get certain types of ICMP errors to function properly - for example, to implement MTU discovery. Also, a number of common system daemons make reverse connections to the @@ -85,13 +85,13 @@ dangerous option to set because it means your firewall is disabled during booting. You should use this option while getting up to speed with .Fx -firewalling, but get rid of it once you understand how it all works +firewalling, but get rid of it once you understand how it all works to close the loophole. There is a third option called .Sy IPDIVERT which allows you to use the firewall to divert packets to a user program and is necessary if you wish to use .Xr natd 8 -to give private internal networks access to the outside world. +to give private internal networks access to the outside world. If you want to be able to limit the bandwidth used by certain types of traffic, the .Sy DUMMYNET @@ -104,20 +104,20 @@ interface cards. fxp0 is connected to the 'exposed' LAN. Machines on this LAN are dual-homed with both internal 10. IP addresses and internet-routed IP addresses. In our example, 192.100.5.x represents the internet-routed IP block while 10.x.x.x represents the internal -networks. While it isn't relevant to the example, 10.0.1.x is +networks. While it isn't relevant to the example, 10.0.1.x is assigned as the internal address block for the LAN on fxp0, 10.0.2.x for the LAN on fxp1, and 10.0.3.x for the LAN on fxp2. .Pp In this example we want to isolate all three LANs from the internet -as well as isolate them from each other, and we want to give all +as well as isolate them from each other, and we want to give all internal addresses access to the internet through a NAT gateway running on this machine. To make the NAT gateway work, the firewall machine is given two internet-exposed addresses on fxp0 in addition to an -internal 10. address on fxp0: one exposed address (not shown) +internal 10. address on fxp0: one exposed address (not shown) represents the machine's official address, and the second exposed address (192.100.5.5 in our example) represents the NAT gateway rendezvous IP. We make the example more complex by giving the machines -on the exposed LAN internal 10.0.0.x addresses as well as exposed +on the exposed LAN internal 10.0.0.x addresses as well as exposed addresses. The idea here is that you can bind internal services to internal addresses even on exposed machines and still protect those services from the internet. The only services you run on @@ -126,7 +126,7 @@ internet. .Pp It is important to note that the 10.0.0.x network in our example is not protected by our firewall. You must make sure that your -internet router protects this network from outside spoofing. +internet router protects this network from outside spoofing. Also, in our example, we pretty much give the exposed hosts free reign on our internal network when operating services through internal IP addresses (10.0.0.x). This is somewhat of security @@ -146,7 +146,7 @@ firewall_type="/etc/ipfw.conf" # temporary port binding range let # through the firewall. -# +# # NOTE: heavily loaded services running through the firewall may require # a larger port range for local-size binding. 4000-10000 or 4000-30000 # might be a better choice. @@ -160,7 +160,7 @@ ip_portrange_last=5000 # # FIREWALL: the firewall machine / nat gateway # LAN0 10.0.0.X and 192.100.5.X (dual homed) -# LAN1 10.0.1.X +# LAN1 10.0.1.X # LAN2 10.0.2.X # sw: ethernet switch (unmanaged) # @@ -187,7 +187,7 @@ ip_portrange_last=5000 # NOT SHOWN: The INTERNET ROUTER must contain rules to disallow # all packets with source IP addresses in the 10. block in order # to protect the dual-homed 10.0.0.x block. Exposed hosts are -# not otherwise protected in this example - they should only bind +# not otherwise protected in this example - they should only bind # exposed services to exposed IPs but can safely bind internal # services to internal IPs. # @@ -241,7 +241,7 @@ add 01501 deny all from 10.0.2.0/24 in via fxp0 # In this example rule set there are no restrictions between # internal hosts, even those on the exposed LAN (as long as # they use an internal IP address). This represents a -# potential security hole (what if an exposed host is +# potential security hole (what if an exposed host is # compromised?). If you want full restrictions to apply # between the three LANs, firewalling them off from each # other for added security, remove these two rules. @@ -327,12 +327,12 @@ add 05000 deny log ip from any to any frag add 06000 deny all from any to any .Ed .Sh PORT BINDING INTERNAL AND EXTERNAL SERVICES -We've mentioned multi-homing hosts and binding services to internal or -external addresses but we haven't really explained it. When you have a -host with multiple IP addresses assigned to it, you can bind services run +We've mentioned multi-homing hosts and binding services to internal or +external addresses but we haven't really explained it. When you have a +host with multiple IP addresses assigned to it, you can bind services run on that host to specific IPs or interfaces rather then all IPs. Take the firewall machine for example: With three interfaces -and two exposed IP addresses +and two exposed IP addresses on one of those interfaces, the firewall machine is known by 5 different IP addresses (10.0.0.1, 10.0.1.1, 10.0.2.1, 192.100.5.5, and say 192.100.5.1). If the firewall is providing file sharing services to the @@ -366,7 +366,7 @@ The .Nm manual page was originally written by .An Matthew Dillon -and first appeared +and first appeared in .Fx 4.3 , May 2001. diff --git a/share/man/man7/hier.7 b/share/man/man7/hier.7 index cd8551b..1ce9ec9 100644 --- a/share/man/man7/hier.7 +++ b/share/man/man7/hier.7 @@ -54,11 +54,11 @@ default bootstrapping configuration files; see .Xr loader.conf 5 .It Pa kernel/ pure kernel executable (the operating system loaded into memory -at boot time). +at boot time). .It Pa modules/ third-part loadable kernel modules; -see -.Xr kldstat 8 +see +.Xr kldstat 8 .El .It Pa /cdrom/ default mount point for CD-ROM drives @@ -76,7 +76,7 @@ block and character device files script for creating device files; see .Xr MAKEDEV 8 -.It Pa fd/ +.It Pa fd/ file descriptor files; see .Xr \&fd 4 @@ -85,7 +85,7 @@ see mount point used by .Xr sysinstall 8 .It Pa /etc/ -system configuration files and scripts +system configuration files and scripts .Pp .Bl -tag -width "disklabels/" -compact .It Pa defaults/ @@ -100,7 +100,7 @@ see isdn4bsd configuration files; see .Xr isdnd 8 -.It Pa kerberosIV/ +.It Pa kerberosIV/ configuration files for kerberos version IV; see .Xr kerberos 1 @@ -110,11 +110,11 @@ see .Xr ctime 3 .It Pa mail/ Sendmail control files -.It Pa mtree/ +.It Pa mtree/ mtree configuration files; see .Xr mtree 8 -.It Pa namedb/ +.It Pa namedb/ named configuration files; see .Xr named 8 @@ -125,7 +125,7 @@ see .Xr periodic 8 .It Pa ppp/ ppp configuration files; -see +see .Xr ppp 8 .It Pa ssl/ OpenSSL configuration files @@ -149,10 +149,10 @@ system programs and administration utilities fundamental to both single-user and multi-user environments .It Pa /stand/ programs used in a standalone environment -.It Pa /tmp/ +.It Pa /tmp/ temporary files .It Pa /usr/ -contains the majority of user utilities and applications +contains the majority of user utilities and applications .Pp .Bl -tag -width "libdata/" -compact .It Pa bin/ @@ -320,7 +320,7 @@ UFS filesystem .El .It Pa vm/ virtual memory; -see +see .Xr vmstat 8 .El .Pp @@ -356,7 +356,7 @@ see .Xr ld 1 .It Pa lint/ various prebuilt lint libraries; -see +see .Xr lint 1 .It Pa msdosfs/ Character set conversion tables @@ -384,7 +384,7 @@ see .Xr lpr 1 .It Pa sm.bin/ restricted shell for sendmail; -see +see .Xr smrsh 8 .It Pa uucp/ uucp utilities; @@ -501,7 +501,7 @@ localization files; see .Xr setlocale 3 .It Pa man/ -manual pages +manual pages .It Pa me/ macros for use with the me macro package; see @@ -526,7 +526,7 @@ see .Xr make 1 .It Pa nls/ national language support files; -see +see .Xr mklocale 1 .It Pa pcvt/ pcvt documentation and etc examples; @@ -536,7 +536,7 @@ see perl library files; see .Xr perl 1 -.It Pa sendmail/ +.It Pa sendmail/ sendmail configuration files; see .Xr sendmail 8 @@ -563,7 +563,7 @@ and console screen maps .El .It Pa tabset/ -tab description files for a variety of terminals; used in +tab description files for a variety of terminals; used in the termcap file; see .Xr termcap 5 @@ -571,7 +571,7 @@ see text processing macros; see .Xr nroff 1 -and +and .Xr troff 1 .It Pa vi/ localization support and utilities for @@ -586,7 +586,7 @@ BSD, third-party, and/or local source files .Pp .Bl -tag -width "kerberosIV/" -compact .It Pa bin/ -source code for files in /bin +source code for files in /bin .It Pa contrib/ source code for contributed software .It Pa crypto/ @@ -607,7 +607,7 @@ source code for files in /usr/lib source code for files in /usr/libexec .It Pa release/ files required to produce a -.Fx +.Fx release .It Pa sbin/ source code for files in /sbin @@ -647,7 +647,7 @@ architecture-independent files. multi-purpose log, temporary, transient, and spool files .Pp .Bl -tag -width "preserve/" -compact -.It Pa account/ +.It Pa account/ system accounting files .Pp .Bl -tag -width Fl -compact @@ -665,7 +665,7 @@ see .It Pa jobs/ directory containing job files .It Pa spool/ -directory containing output spool files +directory containing output spool files .El .Pp .It Pa backups/ @@ -686,11 +686,11 @@ see .Xr crontab 5 .El .Pp -.It Pa db/ +.It Pa db/ misc. automatically generated system-specific database files -.It Pa games/ +.It Pa games/ misc. game status and score files -.It Pa log/ +.It Pa log/ misc. system log files .Pp .Bl -tag -width Fl -compact @@ -700,18 +700,18 @@ see .Xr wtmp 5 .El .Pp -.It Pa mail/ +.It Pa mail/ user mailbox files .It Pa preserve/ temporary home of files preserved after an accidental death of an editor; see -.Xr \&ex 1 +.Xr \&ex 1 .It Pa msgs/ system messages database; see .Xr msgs 1 -.It Pa quotas/ +.It Pa quotas/ filesystem quota information files .It Pa run/ system information files describing various info about @@ -724,36 +724,36 @@ see .Xr utmp 5 .El .Pp -.It Pa rwho/ +.It Pa rwho/ rwho data files; see .Xr rwhod 8 , .Xr rwho 1 , and .Xr ruptime 1 -.It Pa spool/ +.It Pa spool/ misc. printer and mail system spooling directories .Pp .Bl -tag -width Fl -compact -.It Pa ftp/ +.It Pa ftp/ commonly ~ftp; the anonymous ftp root directory -.It Pa mqueue/ +.It Pa mqueue/ undelivered mail queue; see .Xr sendmail 8 .It Pa output/ line printer spooling directories -.It Pa secretmail/ +.It Pa secretmail/ secretmail spool directory; see .Xr xget 1 -.It Pa uucp/ +.It Pa uucp/ uucp spool directory .It Pa uucppublic/ commonly ~uucp; public uucp temporary directory .El .Pp -.It Pa tmp/ +.It Pa tmp/ temporary files that are kept between system reboots .Bl -tag -width Fl -compact .It Pa vi.recover/ diff --git a/share/man/man7/ports.7 b/share/man/man7/ports.7 index 910e368..c495c7c 100644 --- a/share/man/man7/ports.7 +++ b/share/man/man7/ports.7 @@ -37,13 +37,13 @@ The .Nm Ports Collection offers a simple way for users and administrators to install applications. -Each +Each .Em port contains any patches necessary to make the original application source code compile and run on BSD. Compiling an application is as simple as typing .Ic make build -in the port directory! The +in the port directory! The .Ql Pa Makefile automatically fetches the application source code, either from a local disk or via ftp, unpacks it diff --git a/share/man/man7/security.7 b/share/man/man7/security.7 index 70c6850..187c8b6 100644 --- a/share/man/man7/security.7 +++ b/share/man/man7/security.7 @@ -20,12 +20,12 @@ maintaining additional security mechanisms to keep those users is probably one of the single largest undertakings of the sysadmin. Machines are only as secure as you make them, and security concerns are ever competing -with the human necessity for convenience. +with the human necessity for convenience. .Ux systems, in general, are capable of running a huge number of simultaneous processes and many of these processes operate as servers - meaning that external entities -can connect and talk to them. As yesterday's mini-computers and mainframes +can connect and talk to them. As yesterday's mini-computers and mainframes become today's desktops, and as computers become networked and internetworked, security becomes an ever bigger issue. .Pp @@ -33,9 +33,9 @@ Security is best implemented through a layered onion approach. In a nutshell, what you want to do is to create as many layers of security as are convenient and then carefully monitor the system for intrusions. You do not want to overbuild your security or you will interefere with the detection side, and -detection is one of the single most important aspects of any security +detection is one of the single most important aspects of any security mechanism. For example, it makes little sense to set the -.Pa schg +.Pa schg flags .Po see @@ -70,8 +70,8 @@ network stack. Some D.O.S. attacks try to take advantages of bugs in the networking stack to crash a machine with a single packet. The latter can only be fixed by applying a bug fix to the kernel. Attacks on servers can often be fixed by properly specifying options to limit the load the servers -incur on the system under adverse conditions. Brute-force network -attacks are harder to deal with. A spoofed-packet attack, for example, is +incur on the system under adverse conditions. Brute-force network +attacks are harder to deal with. A spoofed-packet attack, for example, is nearly impossible to stop short of cutting your system off from the internet. It may not be able to take your machine down, but it can fill up internet pipe. @@ -98,12 +98,12 @@ able to do nothing more then mess with the user's files or crash the machine. User account compromises are very common because users tend not to take the precautions that sysads take. .Pp -System administrators must keep in mind that there are potentially many ways -to break root on a machine. The attacker may know the root password, +System administrators must keep in mind that there are potentially many ways +to break root on a machine. The attacker may know the root password, the attacker may find a bug in a root-run server and be able to break root over a network connection to that server, or the attacker may know of a bug in an suid-root -program that allows the attacker to break root once he has broken into a +program that allows the attacker to break root once he has broken into a user's account. If an attacker has found a way to break root on a machine, the attacker may not have a need to install a backdoor. Many of the root holes found and closed to date involve a considerable amount @@ -124,7 +124,7 @@ Securing root - root-run servers and suid/sgid binaries .It Securing user accounts .It -Securing the password file +Securing the password file .It Securing the kernel core, raw devices, and filesystems .It @@ -144,7 +144,7 @@ outside of the console or possibly even with a .Xr su 1 command. For example, make sure that your pty's are specified as being unsecure -in the +in the .Sq Pa /etc/ttys file so that direct root logins via telnet or rlogin are disallowed. If using @@ -159,11 +159,11 @@ verification to operate. One way to make root accessible is to add appropriate staff accounts to the wheel group .Pq in Pa /etc/group . The staff members placed -in the wheel group are allowed to +in the wheel group are allowed to .Sq su to root. You should never give staff -members native wheel access by putting the min the wheel group in their -password entry. Staff accounts should be placed in a +members native wheel access by putting the min the wheel group in their +password entry. Staff accounts should be placed in a .Sq staff group, and then added to the wheel group via the .Sq Pa /etc/group @@ -174,9 +174,9 @@ authentication method such as kerberos, to use kerberos's file in the root account to allow a .Xr ksu 1 to root without having to place anyone at all in the wheel group. This -may be the better solution since the wheel mechanism still allows an +may be the better solution since the wheel mechanism still allows an intruder to break root if the intruder has gotten hold of your password -file and can break into a staff account. While having the wheel mechanism +file and can break into a staff account. While having the wheel mechanism is better then having nothing at all, it isn't necessarily the safest option. .Pp @@ -185,7 +185,7 @@ by using an alternative login access method and *'ing out the crypted password for the staff accounts. This way an intruder may be able to steal the password file but will not be able to break into any staff accounts (or, indirectly, root, even if root has a crypted password associated with it). Staff members -get into their staff accounts through a secure login mechanism such as +get into their staff accounts through a secure login mechanism such as .Xr kerberos 1 or .Xr ssh 1 @@ -196,7 +196,7 @@ When you use a public/private key pair with ssh, you must generally secure the machine you are logging in FROM .Pq typically your workstation , but you can -also add an additional layer of protection to the key pair by password +also add an additional layer of protection to the key pair by password protecting the keypair when you create it with .Xr ssh-keygen 1 . Being able @@ -209,8 +209,8 @@ of sniffing the network from an unrelated, less secure machine. The more indirect security mechanisms also assume that you are logging in from a more restrictive server to a less restrictive server. For example, if your main box is running all sorts of servers, your workstation shouldn't -be running any. In order for your workstation to be reasonably secure -you should run as few servers as possible, up to and including no servers +be running any. In order for your workstation to be reasonably secure +you should run as few servers as possible, up to and including no servers at all, and you should run a password-protected screen blanker. Of course, given physical access to a workstation an attacker can break any sort of security you put on it. @@ -222,9 +222,9 @@ servers. Using something like kerberos also gives you the ability to disable or change the password for a staff account in one place and have it immediately effect all the machine the staff member may have an account on. If a staff -member's account gets compromised, the ability to instantly change his +member's account gets compromised, the ability to instantly change his password on all machines should not be underrated. With discrete passwords, -changing a password on N machines can be a mess. You can also impose +changing a password on N machines can be a mess. You can also impose re-passwording restrictions with kerberos: not only can a kerberos ticket be made to timeout after a while, but the kerberos system can require that the user choose a new password after a certain period of time @@ -283,7 +283,7 @@ It is better to be safe then sorry and the prudent sysadmin will restrict suid binaries that only staff should run to a special group that only staff can access, and get rid of .Pq chmod 000 -any suid binaries that nobody uses. A +any suid binaries that nobody uses. A server with no display generally does not need an xterm binary. Sgid binaries can be almost as dangerous. If an intruder can break an sgid-kmem binary the intruder might be able to read @@ -292,10 +292,10 @@ and thus read the crypted password file, potentially compromising any passworded account. Alternatively an intruder who breaks group kmem can monitor keystrokes sent through pty's, including pty's used by users who login through secure methods. An intruder -that breaks the tty group can write to almost any user's tty. If a user +that breaks the tty group can write to almost any user's tty. If a user is running a terminal -program or emulator with a keyboard-simulation feature, the intruder can -potentially +program or emulator with a keyboard-simulation feature, the intruder can +potentially generate a data stream that causes the user's terminal to echo a command, which is then run as that user. .Sh SECURING USER ACCOUNTS @@ -305,22 +305,22 @@ may not be able to do so with any general user accounts you might have. If you do have sufficient control then you may win out and be able to secure the user accounts properly. If not, you simply have to be more vigilant in your monitoring of those accounts. Use of ssh and kerberos for user accounts is -more problematic due to the extra administration and technical support +more problematic due to the extra administration and technical support required, but still a very good solution compared to a crypted password file. .Sh SECURING THE PASSWORD FILE -The only sure fire way is to *-out as many passwords as you can and -use ssh or kerberos for access to those accounts. Even though the +The only sure fire way is to *-out as many passwords as you can and +use ssh or kerberos for access to those accounts. Even though the crypted password file .Pq Pa /etc/spwd.db can only be read by root, it may -be possible for an intruder to obtain read access to that file even if the +be possible for an intruder to obtain read access to that file even if the attacker cannot obtain root-write access. .Pp -Your security scripts should always check for and report changes to +Your security scripts should always check for and report changes to the password file .Po -see +see .Sq Checking file integrity below .Pc . @@ -333,7 +333,7 @@ it is called the .Sq bpf device. An intruder will commonly attempt to run a packet sniffer -on a compromised machine. You do not need to give the intruder the +on a compromised machine. You do not need to give the intruder the capability and most systems should not have the bpf device compiled in. .Pp But even if you turn off the bpf device, @@ -345,7 +345,7 @@ to worry about. For that matter, the intruder can still write to raw disk devices. Also, there is another kernel feature called the module loader, .Xr kldload 8 . -An enterprising intruder can use a KLD module to install +An enterprising intruder can use a KLD module to install his own bpf device or other sniffing device on a running kernel. To avoid these problems you have to run the kernel at a higher secure level, at least securelevel 1. The securelevel @@ -382,7 +382,7 @@ The best way to detect an incursion is to look for modified, missing, or unexpected files. The best way to look for modified files is from another (often centralized) limited-access system. -Writing your security scripts on the extra-secure limited-access system +Writing your security scripts on the extra-secure limited-access system makes them mostly invisible to potential hackers, and this is important. In order to take maximum advantage you generally have to give the limited-access box significant access to the other machines in the business, @@ -398,13 +398,13 @@ of routing, the NFS method may be too insecure (network-wise) and using ssh may be the better choice even with the audit-trail tracks that ssh lays. .Pp Once you give a limit-access box at least read access to the client systems -it is supposed to monitor, you must write scripts to do the actual +it is supposed to monitor, you must write scripts to do the actual monitoring. Given an NFS mount, you can write scripts out of simple system utilities such as .Xr find 1 and .Xr md5 1 -It is best to physically md5 the client-box files boxes at least once a +It is best to physically md5 the client-box files boxes at least once a day, and to test control files such as those found in .Pa /etc and @@ -431,7 +431,7 @@ A good security script will also check for changes to user and staff members access configuration files: .Pa .rhosts , .Pa .shosts , -.Pa .ssh/authorized_keys +.Pa .ssh/authorized_keys and so forth... files that might fall outside the purview of the MD5 check. .Pp If you have a huge amount of user disk space it may take too long to run @@ -446,7 +446,7 @@ options see .Xr mount 8 .Pc -are what you want to look into. I would scan them anyway at least once a +are what you want to look into. I would scan them anyway at least once a week, since the object of this layer is to detect a break-in whether or not the breakin is effective. .Pp @@ -457,20 +457,20 @@ see .Pc is a relatively low-overhead feature of the operating system which I recommend using as a post-break-in evaluation -mechanism. It is especially useful in tracking down how an intruder has +mechanism. It is especially useful in tracking down how an intruder has actually broken into a system, assuming the file is still intact after the break-in occurs. .Pp Finally, security scripts should process the log files and the logs themselves should be generated in as secure a manner as possible - remote syslog can be very useful. An intruder tries to cover his tracks, and log files are critical -to the sysadmin trying to track down the time and method of the initial +to the sysadmin trying to track down the time and method of the initial break-in. One way to keep a permanent record of the log files is to run the system console to a serial port and collect the information on a continuing basis through a secure machine monitoring the consoles. .Sh PARANOIA A little paranoia never hurts. As a rule, a sysadmin can add any number -of security features as long as they do not effect convenience, and +of security features as long as they do not effect convenience, and can add security features that do effect convenience with some added thought. Even more importantly, a security administrator should mix it up a bit - if you use recommendations such as those given by this manual @@ -480,7 +480,7 @@ hacker who also has access to this manual page. This section covers Denial of Service attacks. A DOS attack is typically a packet attack. While there isn't much you can do about modern spoofed packet attacks that saturate your network, you can generally limit the damage -by ensuring that the attacks cannot take down your servers. +by ensuring that the attacks cannot take down your servers. .Bl -enum -offset indent .It Limiting server forks @@ -499,7 +499,7 @@ see .Pc has several options to limit this sort of attack. It should be noted that while it is possible to prevent a machine from going -down it is not generally possible to prevent a service from being disrupted +down it is not generally possible to prevent a service from being disrupted by the attack. Read the inetd manual page carefully and pay specific attention to the .Fl c , @@ -510,9 +510,9 @@ options. Note that spoofed-IP attacks will circumvent the .Fl C option to inetd, so typically a combination of options must be used. -Some standalone servers have self-fork-limitation parameters. +Some standalone servers have self-fork-limitation parameters. .Pp -Sendmail has its +Sendmail has its .Fl OMaxDaemonChildren option which tends to work much better than trying to use sendmail's load limiting options due to the @@ -520,10 +520,10 @@ load lag. You should specify a .Cm MaxDaemonChildren parameter when you start sendmail high enough to handle your expected load but no so high that the -computer cannot handle that number of sendmails without falling on its face. -It is also prudent to run sendmail in queued mode +computer cannot handle that number of sendmails without falling on its face. +It is also prudent to run sendmail in queued mode .Pq Fl ODeliveryMode=queued -and to run the daemon +and to run the daemon .Pq Cm sendmail -bd separate from the queue-runs .Pq Cm sendmail -q15m . @@ -535,20 +535,20 @@ but be sure to specify a reasonable option for that sendmail to prevent cascade failures. .Pp Syslogd can be attacked directly and it is strongly recommended that you use -the +the .Fl s option whenever possible, and the .Fl a option otherwise. .Pp You should also be fairly careful -with connect-back services such as tcpwrapper's reverse-identd, which can +with connect-back services such as tcpwrapper's reverse-identd, which can be attacked directly. You generally do not want to use the reverse-ident feature of tcpwrappers for this reason. .Pp It is a very good idea to protect internal services from external access by firewalling them off at your border routers. The idea here is to prevent -saturation attacks from outside your LAN, not so much to protect internal +saturation attacks from outside your LAN, not so much to protect internal services from network-based root compromise. Always configure an exclusive firewall, i.e. .So @@ -556,16 +556,16 @@ firewall everything *except* ports A, B, C, D, and M-Z .Sc . This way you can firewall off all of your low ports except for certain specific -services such as named +services such as named .Pq if you are primary for a zone , ntalkd, sendmail, and other internet-accessible services. If you try to configure the firewall the other way - as an inclusive or permissive firewall, there is a good chance that you -will forget to +will forget to .Sq close a couple of services or that you will add a new internal -service and forget to update the firewall. You can still open up the +service and forget to update the firewall. You can still open up the high-numbered port range on the firewall to allow permissive-like operation without compromising your low ports. Also take note that .Fx @@ -594,16 +594,16 @@ victim, especially when the attacker uses the same trick on several dozen broadcast addresses over several dozen different networks at once. Broadcast attacks of over a hundred and twenty megabits have been measured. A second common springboard attack is against the ICMP error reporting system. By -constructing packets that generate ICMP error responses, an attacker can -saturate a server's incoming network and cause the server to saturate its +constructing packets that generate ICMP error responses, an attacker can +saturate a server's incoming network and cause the server to saturate its outgoing network with ICMP responses. This type of attack can also crash the server by running it out of mbuf's, especially if the server cannot drain the ICMP responses it generates fast enough. The .Fx kernel has a new kernel -compile option called ICMP_BANDLIM which limits the effectiveness of these +compile option called ICMP_BANDLIM which limits the effectiveness of these sorts of attacks. The last major class of springboard attacks is related to -certain internal inetd services such as the udp echo service. An attacker +certain internal inetd services such as the udp echo service. An attacker simply spoofs a UDP packet with the source address being server A's echo port, and the destination address being server B's echo port, where server A and B are both on your LAN. The two servers then bounce this one packet back and @@ -613,7 +613,7 @@ exist with the internal chargen port. A competent sysadmin will turn off all of these inetd-internal test services. .Pp Spoofed packet attacks may also be used to overload the kernel route cache. -Refer to the net.inet.ip.rtexpire, rtminexpire, and rtmaxcache sysctl +Refer to the net.inet.ip.rtexpire, rtminexpire, and rtmaxcache sysctl parameters. A spoofed packet attack that uses a random source IP will cause the kernel to generate a temporary cached route in the route table, viewable with @@ -624,7 +624,7 @@ too big it will dynamically reduce the rtexpire but will never decrease it to less then rtminexpire. There are two problems: (1) The kernel does not react quickly enough when a lightly loaded server is suddenly attacked, and (2) The rtminexpire is not low enough for the kernel to survive a sustained attack. -If your servers are connected to the internet via a T3 or better it may be +If your servers are connected to the internet via a T3 or better it may be prudent to manually override both rtexpire and rtminexpire via .Xr sysctl 8 . Never set either parameter to zero @@ -635,32 +635,32 @@ table from attack. There are a few issues with both kerberos and ssh that need to be addressed if you intend to use them. Kerberos V is an excellent authentication protocol but the kerberized telnet and rlogin suck rocks. There are bugs that -make them unsuitable for dealing with binary streams. Also, by default -kerberos does not encrypt a session unless you use the +make them unsuitable for dealing with binary streams. Also, by default +kerberos does not encrypt a session unless you use the .Fl x option. Ssh encrypts everything by default. .Pp Ssh works quite well in every respect except when it is set up to forward encryption keys. -What this means is that if you have a secure workstation holding +What this means is that if you have a secure workstation holding keys that give you access to the rest of the system, and you ssh to an unsecure machine, your keys becomes exposed. The actual keys themselves are -not exposed, but ssh installs a forwarding port for the duration of your +not exposed, but ssh installs a forwarding port for the duration of your login and if a hacker has broken root on the unsecure machine he can utilize that port to use your keys to gain access to any other machine that your keys unlock. .Pp We recommend that you use ssh in combination with kerberos whenever possible -for staff logins. Ssh can be compiled with kerberos support. This reduces +for staff logins. Ssh can be compiled with kerberos support. This reduces your reliance on potentially exposable ssh keys while at the same time -protecting passwords via kerberos. Ssh keys -should only be used for automated tasks from secure machines (something +protecting passwords via kerberos. Ssh keys +should only be used for automated tasks from secure machines (something that kerberos is unsuited to). We also recommend that you either turn off key-forwarding in the ssh configuration, or that you make use of the .Pa "from=IP/DOMAIN" option that ssh allows in its .Pa authorized_keys -file to make the key only useable to entities logging in from specific +file to make the key only useable to entities logging in from specific machines. .Sh SEE ALSO .Xr chflags 1 , @@ -684,7 +684,7 @@ The .Nm manual page was originally written by .An Matthew Dillon -and first appeared +and first appeared in .Fx 3.1 , December 1998. diff --git a/share/man/man7/tuning.7 b/share/man/man7/tuning.7 index 0f29e42..8f340ac 100644 --- a/share/man/man7/tuning.7 +++ b/share/man/man7/tuning.7 @@ -35,7 +35,7 @@ later on if you add more memory to your machine. Finally, on larger systems with multiple SCSI disks (or multiple IDE disks operating on different controllers), we strongly recommend that you configure swap on each drive (up to four drives). The swap partitions on the drives should be -approximately the same size. The kernel can handle arbitrary sizes but +approximately the same size. The kernel can handle arbitrary sizes but internal data structures scale to 4 times the largest swap partition. Keeping the swap partitions near the same size will allow the kernel to optimally stripe swap space across the N disks. Don't worry about overdoing it a @@ -55,7 +55,7 @@ of a partition id). If your machine is intended to act as a mail or print server, or you are running a heavily visited web server, you should consider creating a much larger partition - perhaps a gig or more. It is very easy -to underestimate log file storage requirements. +to underestimate log file storage requirements. .Pp Sizing .Em /var/tmp @@ -64,7 +64,7 @@ the minimum we recommend. Also note that sysinstall will create a /tmp directory, but it is usually a good idea to make .Em /tmp a softlink to -.Em /var/tmp +.Em /var/tmp after the fact. Dedicating a partition for temporary file storage is important for two reasons: First, it reduces the possibility of filesystem corruption @@ -94,7 +94,7 @@ a 1 gigabyte /usr partition. However, if you install a lot of ports (especially window managers and linux-emulated binaries), we recommend at least a 2 gigabyte /usr and if you also intend to keep system source on the machine, we recommend a 3 gigabyte /usr. Do not underestimate the -amount of space you will need in this partition, it can creep up and +amount of space you will need in this partition, it can creep up and surprise you! .Pp The @@ -114,7 +114,7 @@ partitioning your system fragmentation introduced in the smaller more heavily write-loaded partitions will not bleed over into the mostly-read partitions. Additionally, keeping the write-loaded partitions closer to the edge of the disk (i.e. before the really big partitions instead of after -in the partition table) will increase I/O performance in the partitions +in the partition table) will increase I/O performance in the partitions where you need it the most. Now it is true that you might also need I/O performance in the larger partitions, but they are so large that shifting them more towards the edge of the disk will not lead to a significant @@ -129,7 +129,7 @@ and .Xr tunefs 8 parameters. Tuning .Fn newfs -requires more experience but can lead to significant improvements in +requires more experience but can lead to significant improvements in performance. There are three parameters that are relatively safe to tune: .Em blocksize , @@ -163,7 +163,7 @@ overcompensate you can wind up with a filesystem that has lots of free space remaining but cannot accommodate any more files. Using 32768, 65536, or 262144 bytes/inode is recommended. You can go higher but it will have only incremental effects on fsck recovery times. For -example, +example, .Em newfs -i 32768 ... .Pp Finally, increasing the @@ -177,7 +177,7 @@ and newfs will error out and tell you what the maximum is, then use that. .Xr tunefs 8 may be used to further tune a filesystem. This command can be run in single-user mode without having to reformat the filesystem. However, this -is possibly the most abused program in the system. Many people attempt to +is possibly the most abused program in the system. Many people attempt to increase available filesystem space by setting the min-free percentage to 0. This can lead to severe filesystem fragmentation and we do not recommend that you do this. Really the only tunefs option worthwhile here is turning on @@ -192,7 +192,7 @@ aware of: First, softupdates guarantees filesystem consistency in the case of a crash but could very easily be several seconds (even a minute!) behind updating the physical disk. If you crash you may lose more work than otherwise. Secondly, softupdates delays the freeing of filesystem -blocks. If you have a filesystem (such as the root filesystem) which is +blocks. If you have a filesystem (such as the root filesystem) which is close to full, doing a major update of it, e.g. .Em make installworld, can run it out of space and cause the update to fail. @@ -212,7 +212,7 @@ creating a burden on the system. For example, if you are running a heavily loaded web site, or a news server with lots of readers, you might want to consider turning off atime updates on your larger partitions with this mount option. Do not gratuitously turn off atime updates everywhere.. for -example, you might as well leave them turned on for mostly read-only +example, you might as well leave them turned on for mostly read-only partitions such as / and /usr (especially for / since some system utilities use the atime field for reporting). .Sh STRIPING DISKS @@ -220,7 +220,7 @@ In larger systems you can stripe partitions from several drives together to create a much larger overall partition. Striping can also improve the performance of a filesystem by splitting I/O operations across two or more disks. The -.Xr vinum 8 +.Xr vinum 8 and .Xr ccd 4 utilities may be used to create simple striped filesystems. Generally @@ -228,7 +228,7 @@ speaking, striping smaller partitions such as the root and /var/tmp, or essentially read-only partitions such as /usr is a complete waste of time. You should only stripe partitions that require serious I/O performance... typically /var, /home, or custom partitions used to hold databases and web -pages. Choosing the proper stripe size is also +pages. Choosing the proper stripe size is also important. Filesystems tend to store meta-data on power-of-2 boundaries and you usually want to reduce seeking rather than increase seeking. This means you want to use a large off-center stripe size such as 1152 sectors @@ -286,7 +286,7 @@ and sysctls are of particular interest if you are running network intensive applications. This controls the amount of send and receive buffer space allowed for any given TCP connection. The default is 16K. You can often -improve bandwidth utilization by increasing the default at the cost of +improve bandwidth utilization by increasing the default at the cost of eating up more kernel memory for each connection. We do not recommend increasing the defaults if you are serving hundreds or thousands of simultaneous connections because it is possible to quickly run the system @@ -306,7 +306,7 @@ to limit the bandwidth going to or from particular IP blocks or ports. For example, if you have a T1 you might want to limit your web traffic to 70% of the T1's bandwidth in order to leave the remainder available for mail and interactive use. Normally a heavily loaded web server -will not introduce significant latencies into other services even if +will not introduce significant latencies into other services even if the network link is maxed out, but enforcing a limit can smooth things out and lead to longer term stability. Many people also enforce artificial bandwidth limitations in order to ensure that they are not charged for @@ -326,7 +326,7 @@ turns on the window sizing extension to the TCP protocol. We do not recommend that you use this option unless you absolutely have to because many hosts on the internet can't handle the feature and may cause connections to freeze up. .Pp -We recommend that you turn on (set to 1) and leave on the +We recommend that you turn on (set to 1) and leave on the .Em net.inet.tcp.always_keepalive control. The default is usually off. This introduces a small amount of additional network bandwidth but guarantees that dead tcp connections @@ -386,7 +386,7 @@ by a megabyte or more, leaving more memory available for applications. The .Em maxusers kernel option defaults to an incredibly low value. For most modern machines, -you probably want to increase this value to 64, 128, or 256. We do not +you probably want to increase this value to 64, 128, or 256. We do not recommend going above 256 unless you need a huge number of file descriptors. Network buffers are also affected but can be controlled with a separate kernel option. Do not increase maxusers just to get more network mbufs. @@ -445,10 +445,10 @@ timebase, and even device operations. Additionally, higher-end cpus support 4MB MMU pages which the kernel uses to map the kernel itself into memory, which increases its efficiency under heavy syscall loads. .Sh IDE WRITE CACHING -.Fx 4.3 +.Fx 4.3 flirted with turning off IDE write caching. This reduced write bandwidth to IDE disks but was considered necessary due to serious data consistency -issues introduced by hard drive vendors. Basically the problem is that +issues introduced by hard drive vendors. Basically the problem is that IDE drives lie about when a write completes. With IDE write caching turned on, IDE hard drives will not only write data to disk out of order, they will sometimes delay some of the blocks indefinitely when under heavy disk @@ -462,7 +462,7 @@ sysctl variable. If IDE write caching is turned off, you can turn it back on by setting the .Em hw.ata.wc kernel variable back to 1. This must be done from the boot loader at boot -time. Attempting to do it after the kernel boots will have no effect. +time. Attempting to do it after the kernel boots will have no effect. Please see .Xr ata 4 , and @@ -496,7 +496,7 @@ improving network performance is to make sure you are using switches instead of hubs, especially these days where switches are almost as cheap. Hubs have severe problems under heavy loads due to collision backoff and one bad host can severely degrade the entire LAN. Second, optimize the network path -as much as possible. For example, in +as much as possible. For example, in .Xr firewall 7 we describe a firewall protecting internal hosts with a topology where the externally visible hosts are not routed through it. Use 100BaseT rather @@ -535,7 +535,7 @@ The .Nm manual page was originally written by .An Matthew Dillon -and first appeared +and first appeared in .Fx 4.3 , May 2001. diff --git a/share/man/man8/crash.8 b/share/man/man8/crash.8 index 3a582d4..9d91c6c 100644 --- a/share/man/man8/crash.8 +++ b/share/man/man8/crash.8 @@ -194,7 +194,7 @@ for details. .Pp To analyze a dump you should begin by running .Xr gdb 1 -with the +with the .Fl k flag on the system load image and core dump. If the core image is the result of a panic, diff --git a/share/man/man8/rc.8 b/share/man/man8/rc.8 index 4ea2fb9..191bf2e 100644 --- a/share/man/man8/rc.8 +++ b/share/man/man8/rc.8 @@ -58,7 +58,7 @@ is the command script which controls the automatic reboot .Nm rc.local is the script holding commands which are pertinent only to a specific site. Typically, the /usr/local/etc/rc.d -mechanism is used instead of rc.local these days but if +mechanism is used instead of rc.local these days but if you do want to use rc.local, /etc/rc still supports it. In this case, rc.local should source /etc/rc.conf and contain additional custom startup code for your system. diff --git a/share/man/man8/yp.8 b/share/man/man8/yp.8 index 37ed0aa..b6657ed 100644 --- a/share/man/man8/yp.8 +++ b/share/man/man8/yp.8 @@ -61,7 +61,7 @@ support is enabled in .Xr nsswitch.conf 5 . .Pp The -.Nm YP +.Nm YP subsystem is started automatically in .Pa /etc/rc if it has been initialized in @@ -397,7 +397,7 @@ Additionally, includes support for Wietse Venema's tcp wrapper package; with tcp wrapper support enabled, the administrator can configure .Xr ypserv 8 -to respond only to selected client machines. +to respond only to selected client machines. .Pp While these enhancements provide better security than stock .Tn NIS Ns , @@ -468,12 +468,12 @@ It can also be made to register itself as an .Tn NIS v1 server in order to placate certain systems that insist on the presence of -a v1 server +a v1 server .No ( Fx uses only .Tn NIS v2, but many other systems, -including +including .Tn SunOS 4.x, search for both a v1 and v2 server when binding). .Fx Ns 's diff --git a/share/man/man9/BUS_PRINT_CHILD.9 b/share/man/man9/BUS_PRINT_CHILD.9 index 49a4208..f23cbd1 100644 --- a/share/man/man9/BUS_PRINT_CHILD.9 +++ b/share/man/man9/BUS_PRINT_CHILD.9 @@ -50,7 +50,7 @@ for more information regarding the proper formatting of the messages printed by BUS_PRINT_CHILD. .Sh SEE ALSO .Xr device 9 , -.Xr driver 9 +.Xr driver 9 .Sh RETURN VALUES The number of characters output. .Sh AUTHORS diff --git a/share/man/man9/DEVICE_DETACH.9 b/share/man/man9/DEVICE_DETACH.9 index 0171f5a..175fb1a 100644 --- a/share/man/man9/DEVICE_DETACH.9 +++ b/share/man/man9/DEVICE_DETACH.9 @@ -46,7 +46,7 @@ the system (e.g. for pccard devices). .Pp The method should deallocate any system resources allocated during the .Xr DEVICE_ATTACH 9 -method and reset the hardware to a sane state (i.e. disable interrupts +method and reset the hardware to a sane state (i.e. disable interrupts etc.) .Sh RETURN VALUES Zero is returned on success, otherwise an appropriate error is returned. diff --git a/share/man/man9/KASSERT.9 b/share/man/man9/KASSERT.9 index e3f692b..2bb72f9 100644 --- a/share/man/man9/KASSERT.9 +++ b/share/man/man9/KASSERT.9 @@ -39,19 +39,19 @@ .Fn KASSERT expression "const char *msg" .Sh DESCRIPTION In a kernel compiled with "options INVARIANTS", -the +the .Fn KASSERT -macro tests the given +macro tests the given .Ar expression and if it is false, -calls the +calls the .Fn panic syscall, terminating the running system. .Pp In a kernel that does not have "options INVARIANTS", -the +the .Fn KASSERT -macro is defined to be a no-op. +macro is defined to be a no-op. .Sh EXAMPLES The kernel function .Fn vput diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index 011a48e..20f3b47 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -105,7 +105,7 @@ MLINKS+=copy.9 copyin.9 copy.9 copyinstr.9 copy.9 copyout.9 copy.9 copystr.9 MLINKS+=critical_enter.9 critical_exit.9 MLINKS+=device_ids.9 major.9 device_ids.9 minor.9 MLINKS+=device_ids.9 umajor.9 device_ids.9 uminor.9 -MLINKS+=devstat.9 devicestat.9 devstat.9 devstat_add_entry.9 +MLINKS+=devstat.9 devicestat.9 devstat.9 devstat_add_entry.9 MLINKS+=devstat.9 devstat_remove_entry.9 devstat.9 devstat_start_transaction.9 MLINKS+=devstat.9 devstat_end_transaction.9 MLINKS+=fetch.9 fubyte.9 fetch.9 fuswintr.9 fetch.9 fusword.9 fetch.9 fuword.9 diff --git a/share/man/man9/VFS.9 b/share/man/man9/VFS.9 index e58a8ff..5732c27 100644 --- a/share/man/man9/VFS.9 +++ b/share/man/man9/VFS.9 @@ -40,7 +40,7 @@ Calls used to set or query filesystems for settings or information. Filesytems that don't implement a VFS operation should use the appropriate .Fa vfs_std function from -.Pa src/sys/kern/vfs_default.c +.Pa src/sys/kern/vfs_default.c rather than implementing empty functions or casting to .Fa eopnotsupp . .Sh SEE ALSO diff --git a/share/man/man9/VFS_CHECKEXP.9 b/share/man/man9/VFS_CHECKEXP.9 index 6f73dde..184d7e1 100644 --- a/share/man/man9/VFS_CHECKEXP.9 +++ b/share/man/man9/VFS_CHECKEXP.9 @@ -36,7 +36,7 @@ .Ft int .Fn VFS_CHECKEXP "struct mount *mp" "struct sockaddr *nam" "int *exflagsp" "struct ucred **credanonp" .Sh DESCRIPTION -This is used by the NFS server to check if a mount point is exported +This is used by the NFS server to check if a mount point is exported to a client. .Pp Its arguments are: @@ -51,8 +51,8 @@ Return parameter for the export flags for this client. Return parameter for the anonymous credentials for this client. .El .Pp -This should be called on a file system's mount structure to determine if it -is exported to a client whose address is contained in +This should be called on a file system's mount structure to determine if it +is exported to a client whose address is contained in .Fa nam . .Pp It is generally called before @@ -62,7 +62,7 @@ to validate that a client has access to the filesystem. The filesystem should call .Xr vfs_export_lookup 9 with the address of an appropriate -.Dv netexport +.Dv netexport structure and the address of the client, .Fa nam , to verify that the client can access this filesystem. diff --git a/share/man/man9/VFS_FHTOVP.9 b/share/man/man9/VFS_FHTOVP.9 index ec61038..1f9e284 100644 --- a/share/man/man9/VFS_FHTOVP.9 +++ b/share/man/man9/VFS_FHTOVP.9 @@ -61,7 +61,7 @@ resources have been reused for a new file. For instance, UFS filesystem stores the inode number and inode generation counter in its filehandle. .Pp -A call to this function should generally be preceded by a call to +A call to this function should generally be preceded by a call to .Xr VFS_CHECKEXP 9 to check if the file is accessible to the client. .Sh RETURN VALUES diff --git a/share/man/man9/VOP_ACCESS.9 b/share/man/man9/VOP_ACCESS.9 index 00b308c..d644858 100644 --- a/share/man/man9/VOP_ACCESS.9 +++ b/share/man/man9/VOP_ACCESS.9 @@ -124,7 +124,7 @@ vop_access(struct vnode *vp, int mode, struct ucred *cred, struct proc *p) mask |= S_IWGRP; return (((mode of vp) & mask) == mask ? 0 : EACCES); } - + /* Otherwise, check everyone else. */ if (mode & VEXEC) mask |= S_IXOTH; diff --git a/share/man/man9/VOP_FSYNC.9 b/share/man/man9/VOP_FSYNC.9 index 3b7f4e4..298ea99 100644 --- a/share/man/man9/VOP_FSYNC.9 +++ b/share/man/man9/VOP_FSYNC.9 @@ -101,7 +101,7 @@ loop: */ if (bp->b_flags & B_BUSY) continue; - + /* * Make sure the buffer is dirty. */ diff --git a/share/man/man9/VOP_GETEXTATTR.9 b/share/man/man9/VOP_GETEXTATTR.9 index f9c662c..d2ffb6f 100644 --- a/share/man/man9/VOP_GETEXTATTR.9 +++ b/share/man/man9/VOP_GETEXTATTR.9 @@ -90,7 +90,7 @@ Insufficient memory available to fulfill request .It Bq Er EFAULT The uio structure refers to an invalid userspace address. .It Bq Er EINVAL -The +The .Fa name or .Fa uio diff --git a/share/man/man9/VOP_LEASE.9 b/share/man/man9/VOP_LEASE.9 index 66db58d..6c14f31 100644 --- a/share/man/man9/VOP_LEASE.9 +++ b/share/man/man9/VOP_LEASE.9 @@ -40,9 +40,9 @@ .Ft int .Fn VOP_LEASE "struct vnode *vp" "struct proc *p" "struct ucred *cred" "int type" .Sh DESCRIPTION -This entry point is currently not implemented. I believe the idea is to +This entry point is currently not implemented. I believe the idea is to validate a vnode for a particular set of user credentials and operation type. -The two operation types supported are LEASE_READ and LEASE_WRITE. The +The two operation types supported are LEASE_READ and LEASE_WRITE. The function currently always returns 0. .Sh LOCKS The vnode must be exclusively locked on entry, and should remain exclusively diff --git a/share/man/man9/VOP_LINK.9 b/share/man/man9/VOP_LINK.9 index dcf02bf..183df56 100644 --- a/share/man/man9/VOP_LINK.9 +++ b/share/man/man9/VOP_LINK.9 @@ -52,7 +52,7 @@ the vnode of the file to be linked pathname information about the file .El .Pp -The pathname info must be released on exit. The directory and +The pathname info must be released on exit. The directory and file vnodes should NOT be released on exit. .Sh LOCKS The directory, diff --git a/share/man/man9/VOP_LOCK.9 b/share/man/man9/VOP_LOCK.9 index c2363ef..fc61c37 100644 --- a/share/man/man9/VOP_LOCK.9 +++ b/share/man/man9/VOP_LOCK.9 @@ -126,7 +126,7 @@ start: } if (vp->v_tag == VT_NON) return ENOENT; - + vop = VTOVON(vp); if (vop->von_flag & VON_LOCKED) { vop->von_flag |= VON_WANTED; diff --git a/share/man/man9/VOP_LOOKUP.9 b/share/man/man9/VOP_LOOKUP.9 index 4d8f790..295acfa 100644 --- a/share/man/man9/VOP_LOOKUP.9 +++ b/share/man/man9/VOP_LOOKUP.9 @@ -305,7 +305,7 @@ vop_lookup(struct vnode *dvp, *vpp = dvp; return 0; } - + error = VFS_VGET(dvp->v_mount, ..., &vp); if (error) return error; diff --git a/share/man/man9/VOP_OPENCLOSE.9 b/share/man/man9/VOP_OPENCLOSE.9 index 00d308c..831af83 100644 --- a/share/man/man9/VOP_OPENCLOSE.9 +++ b/share/man/man9/VOP_OPENCLOSE.9 @@ -73,7 +73,7 @@ to be locked on entry and will leave it locked on return. .Xr VOP_CLOSE 9 expects at least a reference to be associated with the vnode and does not care whether the vnode is locked or not. The lock and reference state is -left unchanged on return. Note that +left unchanged on return. Note that .Fa vn_close expects an unlocked, referenced vnode and will dereference the vnode prior to returning. diff --git a/share/man/man9/VOP_RDWR.9 b/share/man/man9/VOP_RDWR.9 index 5f015b0..7b4ca87 100644 --- a/share/man/man9/VOP_RDWR.9 +++ b/share/man/man9/VOP_RDWR.9 @@ -110,7 +110,7 @@ vop_read(struct vnode *vp, struct uio *uio, int ioflag, struct ucred *cred) xfersize = uio->uio_resid; if (bytesinfile < xfersize) xfersize = bytesinfile; - + error = bread(vp, lbn, size, NOCRED, &bp); if (error) { brelse(bp); @@ -131,7 +131,7 @@ vop_read(struct vnode *vp, struct uio *uio, int ioflag, struct ucred *cred) break; xfersize = size; } - + error = uiomove((char *)bp->b_data + blkoffset, (int)xfersize, uio); if (error) break; @@ -170,7 +170,7 @@ vop_write(struct vnode *vp, struct uio *uio, int ioflag, struct ucred *cred) xfersize = size - blkoffset; if (uio->uio_resid < xfersize) xfersize = uio->uio_resid; - + if (uio->uio_offset + xfersize > size of file) vnode_pager_setsize(vp, uio->uio_offset + xfersize); diff --git a/share/man/man9/VOP_REMOVE.9 b/share/man/man9/VOP_REMOVE.9 index 86a8f06..4826825 100644 --- a/share/man/man9/VOP_REMOVE.9 +++ b/share/man/man9/VOP_REMOVE.9 @@ -57,7 +57,7 @@ pathname information about the file .Sh LOCKS Both .Fa dvp -and +and .Fa vp should be locked on entry and remain locked on return. .Sh RETURN VALUES diff --git a/share/man/man9/VOP_RENAME.9 b/share/man/man9/VOP_RENAME.9 index d610a64..9985247 100644 --- a/share/man/man9/VOP_RENAME.9 +++ b/share/man/man9/VOP_RENAME.9 @@ -38,7 +38,7 @@ .Fd #include <sys/param.h> .Fd #include <sys/vnode.h> .Ft int -.Fn VOP_RENAME "struct vnode *fdvp" "struct vnode *fvp" "struct componentname *fcnp" "struct vnode *tdvp" "struct vnode *tvp" "struct componentname *tcnp" +.Fn VOP_RENAME "struct vnode *fdvp" "struct vnode *fvp" "struct componentname *fcnp" "struct vnode *tdvp" "struct vnode *tvp" "struct componentname *tcnp" .Sh DESCRIPTION This renames a file and possibly changes its parent directory. If the destination object exists, it will be removed first. @@ -60,15 +60,15 @@ pathname information about the file's new name .El .Sh LOCKS The source directory and file are unlocked but are expected to have their -ref count bumped on entry. The VOP routine is expected to +ref count bumped on entry. The VOP routine is expected to .Fn vrele both prior to returning. .Pp The destination directory and file are locked as well as having their ref -count bumped. The VOP routine is expected to +count bumped. The VOP routine is expected to .Fn vput -both prior to +both prior to returning. .Sh PSEUDOCODE .Bd -literal @@ -197,7 +197,7 @@ vop_rename(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp, */ ...; } - + /* * Add name in new directory. */ @@ -272,7 +272,7 @@ vop_rename(struct vnode *fdvp, struct vnode *fvp, struct componentname *fcnp, /* * Unlink the source. If a directory was moved to a new parent, - * update its ".." entry. Gobs of ugly UFS code omitted here. + * update its ".." entry. Gobs of ugly UFS code omitted here. */ ...; diff --git a/share/man/man9/VOP_SETEXTATTR.9 b/share/man/man9/VOP_SETEXTATTR.9 index fc0805c..3c69b14 100644 --- a/share/man/man9/VOP_SETEXTATTR.9 +++ b/share/man/man9/VOP_SETEXTATTR.9 @@ -59,7 +59,7 @@ the process setting the extended attribute .El .Pp The uio structure is used in a manner similar to the argument of the same -name in +name in .Xr VOP_WRITE . However, as extended attributes provide a strict "name=value" semantic, non-zero offsets will be rejected. diff --git a/share/man/man9/acl.9 b/share/man/man9/acl.9 index 6fa9a55..2cdd83a 100644 --- a/share/man/man9/acl.9 +++ b/share/man/man9/acl.9 @@ -94,7 +94,7 @@ to implement the details. Depending on the underlying file system, each file or directory may have zero or more ACLs associated with it, named using the .Fa type -field of the appropriate vnode ACL calls, +field of the appropriate vnode ACL calls, .Xr VOP_ACLCHECK 9 , .Xr VOP_GETACL 9 , and diff --git a/share/man/man9/at_exit.9 b/share/man/man9/at_exit.9 index 7561279..414e045 100644 --- a/share/man/man9/at_exit.9 +++ b/share/man/man9/at_exit.9 @@ -50,7 +50,7 @@ The function .Fa func is called with the a pointer to the exiting process's proc structure. .Pp -If the requirement for notification is removed, then the function +If the requirement for notification is removed, then the function .Fn rm_at_exit must be called with the exact .Fa func diff --git a/share/man/man9/at_fork.9 b/share/man/man9/at_fork.9 index 0fe439a..c9b87e0 100644 --- a/share/man/man9/at_fork.9 +++ b/share/man/man9/at_fork.9 @@ -55,7 +55,7 @@ as used in .Xr rfork 2 to indicate the type of fork. .Pp -If the requirement for notification is removed, then the function +If the requirement for notification is removed, then the function .Fn rm_at_fork must be called with the exact .Fa func @@ -63,7 +63,7 @@ argument as the corresponding call to .Fn at_fork . .Sh RETURN VALUES .Fn at_fork -returns an errno, 0 meaning success. +returns an errno, 0 meaning success. .Fn rm_at_fork returns the number of items removed (should be 0 or 1). .Sh SEE ALSO diff --git a/share/man/man9/bios.9 b/share/man/man9/bios.9 index 83db9b4..cc7e452 100644 --- a/share/man/man9/bios.9 +++ b/share/man/man9/bios.9 @@ -28,7 +28,7 @@ .Dt BIOS 9 .Os .Sh NAME -.Nm bios_sigsearch , +.Nm bios_sigsearch , .Nm bios32_SDlookup , .Nm bios32 .Nd interact with PC BIOS @@ -63,7 +63,7 @@ bytes of the BIOS image and .Fa sig are compared at .Fa sigofs -bytes offset from the current location. If no match is found, the +bytes offset from the current location. If no match is found, the current location is incremented by .Fa paralen bytes and the search repeated. If the signature is found, its effective @@ -79,7 +79,7 @@ physical address .It SMBIOStable If not NULL, points to a .Ft struct SMBIOS_table -structure containing information read from the System Management BIOS table +structure containing information read from the System Management BIOS table during system startup. .It DMItable If not NULL, points to a diff --git a/share/man/man9/buf.9 b/share/man/man9/buf.9 index d3fdef1..9a4b82c 100644 --- a/share/man/man9/buf.9 +++ b/share/man/man9/buf.9 @@ -39,7 +39,7 @@ .Nd "kernel buffer I/O scheme used in FreeBSD VM system" .Sh DESCRIPTION The kernel implements a KVM abstraction of the buffer cache which allows it -to map potentially disparate vm_page's into contiguous KVM for use by +to map potentially disparate vm_page's into contiguous KVM for use by (mainly filesystem) devices and device I/O. This abstraction supports block sizes from DEV_BSIZE (usually 512) to upwards of several pages or more. It also supports a relatively primitive byte-granular valid range and dirty @@ -65,18 +65,18 @@ size is 4096). .Pp VM buffers also keep track of a byte-granular dirty range and valid range. This feature is normally only used by the NFS subsystem. I'm not sure why it -is used at all, actually, since we have DEV_BSIZE valid/dirty granularity +is used at all, actually, since we have DEV_BSIZE valid/dirty granularity within the VM buffer. If a buffer dirty operation creates a 'hole', the dirty range will extend to cover the hole. If a buffer validation operation creates a 'hole' the byte-granular valid range is left alone and will not take into account the new extension. Thus the whole byte-granular -abstraction is considered a bad hack and it would be nice if we could get rid +abstraction is considered a bad hack and it would be nice if we could get rid of it completely. .Pp A VM buffer is capable of mapping the underlying VM cache pages into KVM in order to allow the kernel to directly manipulate the data associated with the (vnode,b_offset,b_size). The kernel typically unmaps VM buffers the moment -they are no longer needed but often keeps the 'struct buf' structure +they are no longer needed but often keeps the 'struct buf' structure instantiated and even bp->b_pages array instantiated despite having unmapped them from KVM. If a page making up a VM buffer is about to undergo I/O, the system typically unmaps it from KVM and replaces the page in the b_pages[] @@ -100,14 +100,14 @@ device no longer needs a buffer it typically flags it as B_RELBUF. Due to the underlying pages being marked clean, the B_DELWRI|B_RELBUF combination must be interpreted to mean that the buffer is still actually dirty and must be written to its backing store before it can actually be released. In the case -where B_DELWRI is not set, the underlying dirty pages are still properly +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. ( 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. Even though this is virtual space (since the buffers are mapped -from the buffer cache), we cannot make it arbitrarily large because +maps. Even though this is virtual space (since the buffers are mapped +from the buffer cache), we cannot make it arbitrarily large because instantiated VM Buffers (struct buf's) prevent their underlying pages in the buffer cache from being freed. This can complicate the life of the paging system. diff --git a/share/man/man9/bus_alloc_resource.9 b/share/man/man9/bus_alloc_resource.9 index 53b6439..6b60610 100644 --- a/share/man/man9/bus_alloc_resource.9 +++ b/share/man/man9/bus_alloc_resource.9 @@ -45,7 +45,7 @@ .Fn bus_alloc_resource "device_t dev" "int type" "int *rid" "u_long start" "u_long end" "u_long count" "u_int flags" .Sh DESCRIPTION This is an easy interface to the resource-management functions. -It hides the indirection through the parent's method table. +It hides the indirection through the parent's method table. This function generally should be called in attach, but (except in some race cases) never earlier. .Pp @@ -99,7 +99,7 @@ If you specified the default values for .Fa start and .Fa end , -then the default value of the bus is used if +then the default value of the bus is used if .Fa count is smaller than the default value and .Fa count @@ -142,9 +142,9 @@ should be saved in the softc of the device after these calls. portid = 0; irqid = 0; - portres = bus_alloc_resource(dev, SYS_RES_IOPORT, &portid, + portres = bus_alloc_resource(dev, SYS_RES_IOPORT, &portid, 0ul, ~0ul, 32, RF_ACTIVE); - irqres = bus_alloc_resource(dev, SYS_RES_IRQ, &irqid, + irqres = bus_alloc_resource(dev, SYS_RES_IRQ, &irqid, 0ul, ~0ul, 1, RF_ACTIVE | RF_SHAREABLE); .Ed .Sh SEE ALSO diff --git a/share/man/man9/bus_generic_print_child.9 b/share/man/man9/bus_generic_print_child.9 index bd57dfe..b94cd7b 100644 --- a/share/man/man9/bus_generic_print_child.9 +++ b/share/man/man9/bus_generic_print_child.9 @@ -53,7 +53,7 @@ bus_generic_print_child itself calls two functions and .Fn bus_print_child_footer The former prints "foo0: <FooCard 1234>" and the latter "on bar0". -These routines should be used if possible in your own code if +These routines should be used if possible in your own code if .Fn bus_generic_print_child does not completely suit your needs. .Sh SEE ALSO diff --git a/share/man/man9/bus_release_resource.9 b/share/man/man9/bus_release_resource.9 index fe75dec..2a8b250 100644 --- a/share/man/man9/bus_release_resource.9 +++ b/share/man/man9/bus_release_resource.9 @@ -87,7 +87,7 @@ The kernel will panic, if it can't release the resource. .Sh EXAMPLES .Bd -literal /* deactivate IRQ */ - bus_teardown_intr(dev, foosoftc->irqres, foosoftc->irqid); + bus_teardown_intr(dev, foosoftc->irqres, foosoftc->irqid); /* release IRQ resource */ bus_release_resource(dev, SYS_RES_IRQ, foosoftc->irqid, diff --git a/share/man/man9/condvar.9 b/share/man/man9/condvar.9 index 611113b..0288fb3 100644 --- a/share/man/man9/condvar.9 +++ b/share/man/man9/condvar.9 @@ -1,12 +1,12 @@ -.\" +.\" .\" Copyright (C) 2000 Jason Evans <jasone@freebsd.org>. All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice(s), this list of conditions and the following disclaimer as -.\" the first lines of this file unmodified other than the possible +.\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), this list of conditions and the following disclaimer in the diff --git a/share/man/man9/devclass_add_driver.9 b/share/man/man9/devclass_add_driver.9 index ef2afcd..e78132c 100644 --- a/share/man/man9/devclass_add_driver.9 +++ b/share/man/man9/devclass_add_driver.9 @@ -46,7 +46,7 @@ .Ft driver_t * .Fn devclass_find_driver "devclass_t dc" "const char *name" .Sh DESCRIPTION -These functions can be used to add new drivers into the system, remove +These functions can be used to add new drivers into the system, remove old ones and search for existing ones. Normally drivers are added automatically during system initialisation. .Sh SEE ALSO diff --git a/share/man/man9/devclass_get_device.9 b/share/man/man9/devclass_get_device.9 index 86aa325..a95f3c0 100644 --- a/share/man/man9/devclass_get_device.9 +++ b/share/man/man9/devclass_get_device.9 @@ -40,7 +40,7 @@ .Ft device_t .Fn devclass_get_device "devclass_t dc" "int unit" .Sh DESCRIPTION -This function retrieves the device instance with the given unit number +This function retrieves the device instance with the given unit number and returns it. .Sh RETURN VALUES If the device exists, it is returned, otherwise NULL is returned. diff --git a/share/man/man9/device_add_child.9 b/share/man/man9/device_add_child.9 index d27cd35..1bb1a01 100644 --- a/share/man/man9/device_add_child.9 +++ b/share/man/man9/device_add_child.9 @@ -52,13 +52,13 @@ and arguments specify the name and unit number of the device. If the name is unknown then the caller should pass .Dv NULL . -If the unit is unknown then the caller should pass +If the unit is unknown then the caller should pass .Dv -1 and the system will choose the next available unit number. .Pp The name of the device is used to determine which drivers might be appropriate for the device. If a name is specified then only drivers -of that name are probed. If no name is given then all drivers for the +of that name are probed. If no name is given then all drivers for the owning bus are probed. .Pp This allows busses which can uniquely identify device instances (such @@ -67,7 +67,7 @@ match. For busses which rely on supplied probe hints where only one driver can have a change of probing the device, the driver name should specified as the device name. .Pp -Normally unit numbers will be chosen automatically by the system and a +Normally unit numbers will be chosen automatically by the system and a unit number of .Dv -1 should be given. @@ -77,16 +77,16 @@ be passed. If the specified unit number is already allocated, a new unit will be allocated and a diagnostic message printed. .Pp If the devices attached to a bus must be probed in a specific order -(e.g. for the ISA bus some devices are sensitive to failed probe attempts +(e.g. for the ISA bus some devices are sensitive to failed probe attempts of unrelated drivers and therefore must be probed first), the .Fa order argument of .Xr device_add_child_ordered 9 should be used to specify a partial ordering. -The new device will be added before any existing device with a greater +The new device will be added before any existing device with a greater order. -If +If .Xr device_add_child 9 is used, then the new child will be added as if its order was zero. .Sh RETURN VALUES diff --git a/share/man/man9/device_get_state.9 b/share/man/man9/device_get_state.9 index e591e65..dfec2c6 100644 --- a/share/man/man9/device_get_state.9 +++ b/share/man/man9/device_get_state.9 @@ -49,7 +49,7 @@ .Ft int .Fn device_is_alive "device_t dev" .Sh DESCRIPTION -The current state of a device is accessed by calling +The current state of a device is accessed by calling .Xr device_get_state 9 which returns .Dv DS_NOTPRESENT , diff --git a/share/man/man9/device_set_flags.9 b/share/man/man9/device_set_flags.9 index 38aa2e4..ab48f6e 100644 --- a/share/man/man9/device_set_flags.9 +++ b/share/man/man9/device_set_flags.9 @@ -47,7 +47,7 @@ Each device supports a set of driver-dependent flags which are often used to control device behaviour. These flags are read by calling .Xr device_get_flags 9 -and written by calling +and written by calling .Xr device_set_flags 9 . .Sh SEE ALSO .Xr device 9 diff --git a/share/man/man9/devstat.9 b/share/man/man9/devstat.9 index 4ad1c21..b3079cc 100644 --- a/share/man/man9/devstat.9 +++ b/share/man/man9/devstat.9 @@ -107,7 +107,7 @@ or other) and a passthrough flag to indicate pasthrough devices. See below for a complete list of types. .It priority The device priority. The priority is used to determine how devices are -sorted within +sorted within .Nm devstat Ns 's list of devices. Devices are sorted first by priority (highest to lowest), and then by attach order. See below for a complete list of available @@ -153,7 +153,7 @@ whether no data was transferred. .Fn devstat_end_transaction_bio is a wrapper for .Fn devstat_end_transaction -which pulls all the information from a +which pulls all the information from a .Va "struct bio" which is ready for biodone(). .Pp @@ -176,7 +176,7 @@ number is currently only a 32-bit integer, but it could be enlarged if someone has a system with more than four billion device arrival events. .It device_name The device name is a text string given by the registering driver to -identify itself. (e.g. +identify itself. (e.g. .Dq da , .Dq cd , .Dq sa , @@ -336,7 +336,7 @@ passed into .Fn devstat_end_transaction . The transaction types are as follows: .Bd -literal -offset indent -typedef enum { +typedef enum { DEVSTAT_NO_DATA = 0x00, DEVSTAT_READ = 0x01, DEVSTAT_WRITE = 0x02, diff --git a/share/man/man9/devtoname.9 b/share/man/man9/devtoname.9 index 206e84a..f88bd6f 100644 --- a/share/man/man9/devtoname.9 +++ b/share/man/man9/devtoname.9 @@ -1,6 +1,6 @@ .\" Copyright (c) 1999 Chris Costello .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -9,7 +9,7 @@ .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE @@ -21,9 +21,9 @@ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. -.\" +.\" .\" $FreeBSD$ -.\" +.\" .Dd September 25, 1999 .Os .Dt DEVTONAME 9 diff --git a/share/man/man9/driver.9 b/share/man/man9/driver.9 index f437c41..03c9d77 100644 --- a/share/man/man9/driver.9 +++ b/share/man/man9/driver.9 @@ -76,7 +76,7 @@ Each driver in the kernel is described by a structure. The structure contains the name of the device, a pointer to a list of methods, an indication of the kind of device which the driver implements and the size of the private data which the driver -needs to associate with a device instance. Each driver will implement +needs to associate with a device instance. Each driver will implement one or more sets of methods (called interfaces). The example driver implements the standard "driver" interface and the fictitious "bogo" interface. @@ -89,7 +89,7 @@ it is added to the list of drivers contained in the devclass of its parent bus type. For instance all PCI drivers would be contained in the devclass named "pci" and all ISA drivers would be in the devclass named "isa". -The reason the drivers are not held in the device object of the parent +The reason the drivers are not held in the device object of the parent bus is to handle multiple instances of a given type of bus. The .Dv DRIVER_MODULE diff --git a/share/man/man9/extattr.9 b/share/man/man9/extattr.9 index 8689b96..0ca12d5 100644 --- a/share/man/man9/extattr.9 +++ b/share/man/man9/extattr.9 @@ -29,7 +29,7 @@ .Os .Dt EXTATTR 9 .Sh NAME -.Nm extattr +.Nm extattr .Nd virtual file system named extended attributes .Sh SYNOPSIS .Fd #include <sys/param.h> @@ -73,7 +73,7 @@ specific new attributes may be defined. Extended attributes are named using a null-terminated character string. Depending on underlying file system semantics, this name may or may not be case-sensitive. Appropriate vnode extended attribute calls are: -.Xr VOP_GETEXTATTR 9 +.Xr VOP_GETEXTATTR 9 and .Xr VOP_SETEXTATTR 9 . .Sh SEE ALSO diff --git a/share/man/man9/ifnet.9 b/share/man/man9/ifnet.9 index a246244..dab3a76 100644 --- a/share/man/man9/ifnet.9 +++ b/share/man/man9/ifnet.9 @@ -12,7 +12,7 @@ .\" no representations about the suitability of this software for any .\" purpose. It is provided "as is" without express or implied .\" warranty. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS .\" ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF @@ -127,7 +127,7 @@ in the and .Li ifmultiaddr structures in -.Aq Pa net/if.h +.Aq Pa net/if.h and .Aq Pa net/if_var.h and the functions named above and defined in @@ -310,7 +310,7 @@ The output queue. (Manipulated by driver.) .\".Pq Li "struct ifqueue *" .\"A pointer to the input queue for devices which do not support polling .\"well. See the -.\".Sx Polling +.\".Sx Polling .\"section, below. (Initialized by driver.) .El .Pp @@ -481,7 +481,7 @@ placement of data in .Li mbuf Ns s to attempt to ensure that there is always sufficient space to prepend a link-layer header without allocating an -additional +additional .Li mbuf . .\" (See .\" .Xr mbuf 9 . ) @@ -732,7 +732,7 @@ A reference count of requests for this particular membership. Link the specified interface .Ar ifp into the list of network interfaces. Also initialize the list of -addresses on that interface, and create a link-layer +addresses on that interface, and create a link-layer .Li ifaddr structure to be the first element in that list. (A pointer to this address structure is saved in the global array @@ -757,7 +757,7 @@ routing socket. .It Fn ifpromisc Add or remove a promiscuous reference to .Ar ifp . -If +If .Ar pswitch is true, add a reference; if it is false, remove a reference. On reference count transitions @@ -773,7 +773,7 @@ but for the all-multicasts .Pq Dv IFF_ALLMULTI flag instead of the promiscuous flag. .It Fn ifunit -Return an +Return an .Li ifnet pointer for the interface named .Ar name . @@ -781,7 +781,7 @@ pointer for the interface named Process the ioctl request .Ar cmd , issued on socket -.Ar so +.Ar so by process .Ar p , with data parameter diff --git a/share/man/man9/inittodr.9 b/share/man/man9/inittodr.9 index 5e0e8f3..e99a58e 100644 --- a/share/man/man9/inittodr.9 +++ b/share/man/man9/inittodr.9 @@ -52,14 +52,14 @@ file system, as given in .Fa base . How the .Fa base -value is obtained will vary depending on the +value is obtained will vary depending on the root file system type. The heuristics used include: .Bl -bullet .It If the battery-backed clock has a valid time, it is used. .\" .It -.\" If the battery-backed clock does not have a valid time, and +.\" If the battery-backed clock does not have a valid time, and .\" the time provided in .\" .Fa base .\" is within reason, @@ -118,6 +118,6 @@ different. The .Fx implementation should do a better job of validating the time provided in -.Fa base +.Fa base when the battery-backed clock is unusable. Currently it unconditionally sets the system clock to this value. diff --git a/share/man/man9/intro.9 b/share/man/man9/intro.9 index 27ad145..0d927e9 100644 --- a/share/man/man9/intro.9 +++ b/share/man/man9/intro.9 @@ -45,11 +45,11 @@ Yes please. .Pp We would like all code to be fully prototyped. .Pp -If your code compiles cleanly with +If your code compiles cleanly with .Nm cc -.Ar -Wall +.Ar -Wall we would feel happy about it. -It is important to understand that this isn't a question of just shutting up +It is important to understand that this isn't a question of just shutting up .Nm cc , it is a question about avoiding the things it complains about. To put it bluntly, don't hide the problem by casting and other @@ -61,7 +61,7 @@ It isn't generally applied though. We would appreciate if people would pay attention to it, and at least not violate it blatantly. .Pp -We don't mind it too badly if you have your own style, but please make +We don't mind it too badly if you have your own style, but please make sure we can read it too. .Pp Please take time to read @@ -69,7 +69,7 @@ Please take time to read for more information. .Sh NAMING THINGS Some general rules exist: -.Bl -enum +.Bl -enum .It If a function is meant as a debugging aid in DDB, it should be enclosed in @@ -80,7 +80,7 @@ in .Ed .Pp And the name of the procedure should start with the prefix -.Li DDB_ +.Li DDB_ to clearly identify the procedure as a debugger routine. .El .Sh SCOPE OF SYMBOLS diff --git a/share/man/man9/ithread.9 b/share/man/man9/ithread.9 index 1c5e45b..310f737 100644 --- a/share/man/man9/ithread.9 +++ b/share/man/man9/ithread.9 @@ -223,7 +223,7 @@ and .Fn ithread_add_handler . .Bd -literal -offset indent int -swi_add(struct ithd **ithdp, const char *name, driver_intr_t handler, +swi_add(struct ithd **ithdp, const char *name, driver_intr_t handler, void *arg, int pri, enum intr_type flags, void **cookiep) { struct proc *p; diff --git a/share/man/man9/kernacc.9 b/share/man/man9/kernacc.9 index 6af21ef..ee617ec 100644 --- a/share/man/man9/kernacc.9 +++ b/share/man/man9/kernacc.9 @@ -66,9 +66,9 @@ The possible values of .Fa rw are any bitwise combination of .Dv VM_PROT_READ , -.Dv VM_PROT_WRITE +.Dv VM_PROT_WRITE and -.Dv VM_PROT_EXECUTE . +.Dv VM_PROT_EXECUTE . .Fn kernacc checks addresses in the kernel address space, while .Fn useracc @@ -79,11 +79,11 @@ The process context to use for this operation is taken from the global variable .Va curproc . .Sh RETURN VALUES -Both functions return boolean true if the type of access specified +Both functions return boolean true if the type of access specified by .Fa rw is permitted. Otherwise boolean false is returned. .Sh BUGS -The process pointer should be passed in as an argument to +The process pointer should be passed in as an argument to .Fn useracc . diff --git a/share/man/man9/kobj.9 b/share/man/man9/kobj.9 index 70817f6..6d89cfe 100644 --- a/share/man/man9/kobj.9 +++ b/share/man/man9/kobj.9 @@ -68,7 +68,7 @@ and is only slightly more expensive than a direct function call, making kernel objects suitable for performance-critical algorithms. .Pp Suitable uses for kernel objects are any algorithms which need some -kind of polymorphism (i.e. many different objects which can be treated +kind of polymorphism (i.e. many different objects which can be treated in a uniform way). The common behaviour of the objects is described by a suitable interface and each different type of object is implemented by a diff --git a/share/man/man9/make_dev.9 b/share/man/man9/make_dev.9 index a4d5bfd..1c6602e 100644 --- a/share/man/man9/make_dev.9 +++ b/share/man/man9/make_dev.9 @@ -1,6 +1,6 @@ .\" Copyright (c) 1999 Chris Costello .\" All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -9,7 +9,7 @@ .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE @@ -21,9 +21,9 @@ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. -.\" +.\" .\" $FreeBSD$ -.\" +.\" .Dd May 27, 2001 .Os .Dt MAKE_DEV 9 diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9 index 7ecccf4..62ac212 100644 --- a/share/man/man9/malloc.9 +++ b/share/man/man9/malloc.9 @@ -101,7 +101,7 @@ Otherwise, may call sleep to wait for resources to be released by other processes. If this flag is set, .Fn malloc -will return +will return .Dv NULL rather then block. Note that .Dv M_WAITOK @@ -109,7 +109,7 @@ is defined to be 0, meaning that blocking operation is the default. .It Dv M_ASLEEP Causes .Fn malloc -to call +to call .Fn asleep if the request cannot be immediately fulfilled due to a resource shortage. M_ASLEEP is not useful alone and should always be or'd with M_NOWAIT to allow @@ -129,16 +129,16 @@ queued. Indicates that it is Ok to wait for resources. It is unconveniently defined as 0 so care should be taken never to compare against this value directly or try to AND it as a flag. The default operation is to block -until the memory allocation succeeds. +until the memory allocation succeeds. .Fn malloc can only return .Dv NULL -if -.Dv M_NOWAIT +if +.Dv M_NOWAIT is specified. .It Dv M_USE_RESERVE Indicates that the system can dig into its reserve in order to obtain the -requested memory. This option used to be called M_KERNEL but has been +requested memory. This option used to be called M_KERNEL but has been renamed to something more obvious. This option has been depreciated and is slowly being removed from the kernel, and so should not be used with any new programming. @@ -180,9 +180,9 @@ MALLOC(buf, struct foo_buf *, sizeof *buf, M_FOOBUF, M_NOWAIT); returns a kernel virtual address that is suitably aligned for storage of any type of object, or .Dv NULL -if the request could not be satisfied and -.Dv M_NOWAIT -was set. If +if the request could not be satisfied and +.Dv M_NOWAIT +was set. If .Dv M_ASLEEP was set and .Fn malloc diff --git a/share/man/man9/mbuf.9 b/share/man/man9/mbuf.9 index a19dcef..5ff0c5e 100644 --- a/share/man/man9/mbuf.9 +++ b/share/man/man9/mbuf.9 @@ -38,7 +38,7 @@ .\" .Ss Mbuf allocation macros .Fn MGET "struct mbuf *mbuf" "int how" "short type" -.Fn MGETHDR "struct mbuf *mbuf" "int how" "short type" +.Fn MGETHDR "struct mbuf *mbuf" "int how" "short type" .Fn MCLGET "struct mbuf *mbuf" "int how" .Fo MEXTADD .Fa "struct mbuf *mbuf" @@ -56,7 +56,7 @@ .\" .Ss Mbuf utility macros .Fn mtod "struct mbuf *mbuf" "any type" -.Fn MEXT_IS_REF "struct mbuf *mbuf" +.Fn MEXT_IS_REF "struct mbuf *mbuf" .Fn M_COPY_PKTHDR "struct mbuf *to" "struct mbuf *from" .Fn M_ALIGN "struct mbuf *mbuf" "u_int len" .Fn MH_ALIGN "struct mbuf *mbuf" "u_int len" @@ -200,7 +200,7 @@ flag set, bytes can otherwise. .Pp If external storage is being associated with an mbuf, the -.Dv m_ext +.Dv m_ext header is added at the cost of losing the internal data buffer. It includes a pointer to external storage, the size of the storage, a pointer to a function used for freeing the storage, @@ -247,7 +247,7 @@ permits, as opposed to allocating a separate mbuf cluster to hold the same data. .\" .Ss Macros and Functions -There are numerous predefined macros and functions that provide the +There are numerous predefined macros and functions that provide the developer with common utilities. .\" .Bl -ohang -offset indent @@ -272,7 +272,7 @@ argument is to be set to or .Dv M_DONTWAIT . It specifies whether the caller is willing to block if necessary. -If +If .Fa how is set to .Dv M_TRYWAIT , @@ -306,7 +306,7 @@ that can make use of possible empty space before data .Pq "e.g. left after trimming of a link-layer header" . The new chain pointer or .Dv NULL -is in +is in .Fa mbuf after the call. .It Fn M_WRITABLE mbuf @@ -314,7 +314,7 @@ This macro will evaluate true if the mbuf is not marked .Dv M_RDONLY and if either the mbuf does not contain external storage or, if it does, -then if the reference count of the storage is not greater than 1. +then if the reference count of the storage is not greater than 1. The .Dv M_RDONLY flag can be set in the mbuf's @@ -330,7 +330,7 @@ macro, or can be directly set in individual mbufs. .El .Pp The functions are: -.Bl -ohang -offset indent +.Bl -ohang -offset indent .It Fn m_get how type A function version of .Fn MGET @@ -412,9 +412,9 @@ must be less than .Dv MHLEN . .\" .It Fn m_copym mbuf offset len how -Make a copy of an mbuf chain starting +Make a copy of an mbuf chain starting .Fa offset -bytes from the beginning, continuing for +bytes from the beginning, continuing for .Fa len bytes. If @@ -446,7 +446,7 @@ Copy data from an mbuf chain starting .Fa off bytes from the beginning, continuing for .Fa len -bytes, into the indicated buffer +bytes, into the indicated buffer .Fa buf . .\" .It Fn m_copyback mbuf offset len buf diff --git a/share/man/man9/microseq.9 b/share/man/man9/microseq.9 index 792de50..a530100 100644 --- a/share/man/man9/microseq.9 +++ b/share/man/man9/microseq.9 @@ -296,7 +296,7 @@ This pointer is passed to any C call (see above). .Pp Parameter: .Bl -enum -offset indent -.It +.It pointer to the buffer that shall be accessed by xxx_P() microsequence calls. Note that this pointer is automatically incremented during xxx_P() calls .El @@ -311,7 +311,7 @@ Parameter: .Bl -enum -offset indent .It delay in ms -.El +.El .Pp Predefined macro: MS_ADELAY(delay) .Ss MS_OP_BRSTAT - BRanch on STATe @@ -358,14 +358,14 @@ Predefined macro: MS_CALL(microseq) .Ss MS_OP_RASSERT_P - Register ASSERT from internal PTR is used to assert a register with data currently pointed by the internal PTR pointer. -Parameter: +Parameter: .Bl -enum -offset indent .It amount of data to write to the register .It register .El -.Pp +.Pp Predefined macro: MS_RASSERT_P(iter,reg) .Ss MS_OP_RFETCH_P - Register FETCH to internal PTR is used to fetch data from a register. @@ -392,7 +392,7 @@ This allows to write magic sequences to the port. Parameter: .Bl -enum -offset indent -.It +.It amount of data to read from the register .It register diff --git a/share/man/man9/mutex.9 b/share/man/man9/mutex.9 index 173f8d7..a0dd224 100644 --- a/share/man/man9/mutex.9 +++ b/share/man/man9/mutex.9 @@ -1,6 +1,6 @@ -.\" +.\" .\" Copyright (c) 1998 Berkeley Software Design, Inc. All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -12,7 +12,7 @@ .\" 3. Berkeley Software Design Inc's name may not be used to endorse or .\" promote products derived from this software without specific prior .\" written permission. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE @@ -151,7 +151,7 @@ is saved rather than the data it points to. The data pointed to must remain stable until the mutex is destroyed. The -.Fa opts +.Fa opts argument is used to set the type of mutex. It may contain either .Dv MTX_DEF @@ -242,7 +242,7 @@ Presently, the only valid value in the .Fn mtx_trylock case is .Dv MTX_QUIET , -and its effects are identical to those described for +and its effects are identical to those described for .Fn mtx_lock and .Fn mtx_lock_spin @@ -374,7 +374,7 @@ in an interrupt thread without fear of deadlock against an interrupted thread on the same CPU. .Ss The Spin Mutex Type -A +A .Dv MTX_SPIN mutex will not relinquish the CPU when it cannot immediately get the requested lock, @@ -428,7 +428,7 @@ The flags passed to the .Fn mtx_lock_spin_flags , .Fn mtx_unlock_flags , and -.Fn mtx_unlock_spin_flags +.Fn mtx_unlock_spin_flags functions provide some basic options to the caller, and are often used only under special circumstances to modify lock or unlock behavior. @@ -467,4 +467,4 @@ These functions appeared in .Tn BSD/OS 4.1 and -.Fx 5.0 . +.Fx 5.0 . diff --git a/share/man/man9/namei.9 b/share/man/man9/namei.9 index 332f1c7..3443360 100644 --- a/share/man/man9/namei.9 +++ b/share/man/man9/namei.9 @@ -27,7 +27,7 @@ .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" -.\" If you integrate this manpage in another OS, I'd appreciate a note +.\" If you integrate this manpage in another OS, I'd appreciate a note .\" - eivind@FreeBSD.org .\" .\" $FreeBSD$ @@ -108,7 +108,7 @@ to release the lock and do a .Xr vrele 9 , all in one). .It Dv LOCKPARENT -Make +Make .Fn namei also return the parent (directory) vnode (in nd.ni_dvp), in locked state, unless the dvp is identical to the vp, in which case the dvp diff --git a/share/man/man9/panic.9 b/share/man/man9/panic.9 index 724f1fd..a34c61a 100644 --- a/share/man/man9/panic.9 +++ b/share/man/man9/panic.9 @@ -49,7 +49,7 @@ function terminates the running system. The message is a .Xr printf 3 style format string. The message is printed to the console and the location -.Fa panicstr +.Fa panicstr is set to the address of the message text for retrieval from the OS core dump. .Pp diff --git a/share/man/man9/pfil.9 b/share/man/man9/pfil.9 index de1bc74..b663fcd 100644 --- a/share/man/man9/pfil.9 +++ b/share/man/man9/pfil.9 @@ -36,7 +36,7 @@ .Nd packet filter interface .Sh SYNOPSIS .Fd #include <sys/param.h> -.Fd #include <sys/mbuf.h> +.Fd #include <sys/mbuf.h> .Fd #include <net/if.h> .Fd #include <net/pfil.h> .Ft struct packet_filter_hook * diff --git a/share/man/man9/posix4.9 b/share/man/man9/posix4.9 index 412ab7f..0cdec81 100644 --- a/share/man/man9/posix4.9 +++ b/share/man/man9/posix4.9 @@ -54,7 +54,7 @@ the base features of the operating system. .Bd -literal -offset 0i _POSIX_SOURCE .Ed -is a macro from POSIX.1 that can +is a macro from POSIX.1 that can be defined to specify that only POSIX and ANSI functionality should occur in the name space. .Bd -literal -offset 0i diff --git a/share/man/man9/rtalloc.9 b/share/man/man9/rtalloc.9 index eaca160..1c34932 100644 --- a/share/man/man9/rtalloc.9 +++ b/share/man/man9/rtalloc.9 @@ -12,7 +12,7 @@ .\" no representations about the suitability of this software for any .\" purpose. It is provided "as is" without express or implied .\" warranty. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS .\" ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF @@ -99,8 +99,8 @@ Thus, this function can only be used for address families which are smaller than the default .Dq Li "struct sockaddr" . Before calling -.Fn rtalloc -for the first time, callers should ensure that unused bits of the +.Fn rtalloc +for the first time, callers should ensure that unused bits of the structure are set to zero. On subsequent calls, .Fn rtalloc returns without performing a lookup if @@ -121,7 +121,7 @@ and .Dv RTF_PRCLONING flags are undesired. The .Ar ro -argument is the same as +argument is the same as .Fn rtalloc , but there is additionally a .Ar flags @@ -199,5 +199,5 @@ and the .Fn rtalloc_ign function and the .Ar flags -argument to +argument to .Fn rtalloc1 . diff --git a/share/man/man9/rtentry.9 b/share/man/man9/rtentry.9 index 6b0eb9b..b6c732c 100644 --- a/share/man/man9/rtentry.9 +++ b/share/man/man9/rtentry.9 @@ -12,7 +12,7 @@ .\" no representations about the suitability of this software for any .\" purpose. It is provided "as is" without express or implied .\" warranty. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS .\" ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE, .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF @@ -251,7 +251,7 @@ Number of intermediate systems on the path to this destination. .It Xo .Vt "u_long rmx_expire" ; .Xc -The time +The time (a la .Xr time 3 ) at which this route should expire, or zero if it should never expire. @@ -260,7 +260,7 @@ are actually deleted once they expire. .It Xo .Vt "u_long rmx_recvpipe" ; .Xc -Nominally, the bandwidth-delay product for the path +Nominally, the bandwidth-delay product for the path .Em from the destination .Em to diff --git a/share/man/man9/sleep.9 b/share/man/man9/sleep.9 index 8a82350..366101d 100644 --- a/share/man/man9/sleep.9 +++ b/share/man/man9/sleep.9 @@ -82,7 +82,7 @@ The function is used to make the first process in the queue that is sleeping on the parameter .Fa ident -runnable. This can prevent the system from becoming saturated +runnable. This can prevent the system from becoming saturated when a large number of processes are sleeping on the same address, but only one of them can actually do any useful work when made runnable. @@ -144,10 +144,10 @@ is called several times, only the most recent call is effective. may be called with an .Ar ident value of NULL -to remove any previously queued condition. +to remove any previously queued condition. .Pp .Nm Await -implements the new asynchronous wait function. When +implements the new asynchronous wait function. When .Fn asleep is called on an identifier it associates the process with that identifier but does not block. @@ -155,21 +155,21 @@ identifier but does not block. will actually block the process until .Fn wakeup is called on that identifier any time after the -.Fn asleep . -If +.Fn asleep . +If .Fn wakeup is called after you .Fn asleep -but before you +but before you .Fn await -then the +then the .Fn await call is effectively a NOP. If .Fn await is called multiple times without an intervening .Fn asleep , -the +the .Fn await is effectively a NOP but will also call .Fn mi_switch @@ -183,7 +183,7 @@ call. If -1 is passed for the priority you must be prepared to catch signal conditions if the prior call to .Fn asleep specified it in its priority. If -1 is passed for the timeout you must be -prepared to catch a timeout condition if the prior call to +prepared to catch a timeout condition if the prior call to .Fn asleep specified a timeout. When you use -1, it is usually a good idea to not make assumptions as to the arguments used by the prior @@ -197,12 +197,12 @@ and functions are mainly used by the kernel to shift the burden of blocking away from extremely low level routines and to push it onto their callers. This in turn allows more complex interlocking code to -.Em backout +.Em backout of a temporary resource failure (such as lack of memory) in order to release major locks prior to actually blocking, and to then retry the operation on wakeup. This key feature is expected to be heavily used in SMP situations in order to allow code to make -better use of spinlocks. A spinlock, by its very nature, cannot be used +better use of spinlocks. A spinlock, by its very nature, cannot be used around code that might block. It is hoped that these capabilities will make it easier to migrate the SMP master locks deeper into the kernel. .Pp @@ -236,7 +236,7 @@ appeared in a very early version of Unix. appeared in .Bx 4.4 . .Pp -.Nm Asleep Ns / Ns Nm await +.Nm Asleep Ns / Ns Nm await first appeared in .Fx 3.0 and is designed to shift the burden of blocking diff --git a/share/man/man9/style.9 b/share/man/man9/style.9 index 7fd4b58..3bce059 100644 --- a/share/man/man9/style.9 +++ b/share/man/man9/style.9 @@ -1,4 +1,4 @@ -.\" Copyright (c) 1995 FreeBSD Inc. +.\" Copyright (c) 1995 FreeBSD Inc. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without @@ -120,9 +120,9 @@ macros (ones that have side effects), and the names of macros for manifest constants, are all in uppercase. The expansions of expression-like macros are either a single token or have outer parentheses. -Put a single tab character between the +Put a single tab character between the .Ql #define -and the macro name. +and the macro name. If a macro is an inline expansion of a function, the function name is all in lowercase and the macro has the same name all in uppercase. .\" XXX the above conflicts with ANSI style where the names are the @@ -141,7 +141,7 @@ backslashes; it makes it easier to read. If the macro encapsulates a compound statement, enclose it in a .Dq Li do loop, -so that it can safely be used in +so that it can safely be used in .Dq Li if statements. Any final statement-terminating semicolon should be @@ -432,7 +432,7 @@ Casts and sizeof's are not followed by a space. Note that .Xr indent 1 does not understand this rule. .Pp -NULL is the preferred null pointer constant. Use NULL instead of +NULL is the preferred null pointer constant. Use NULL instead of (type *)0 or (type *)NULL in contexts where the compiler knows the type, e.g., in assignments. Use (type *)NULL in other contexts, in particular for all function args. (Casting is essential for @@ -583,8 +583,8 @@ or .Xr warn 3 .Sh HISTORY This man page is largely based on the src/admin/style/style file from -the -.Tn BSD +the +.Tn BSD 4.4-Lite2 release, with updates to reflect the current practice and desire of the .Fx diff --git a/share/man/man9/suser.9 b/share/man/man9/suser.9 index 167ae75..229ca41 100644 --- a/share/man/man9/suser.9 +++ b/share/man/man9/suser.9 @@ -68,12 +68,12 @@ powers should be extended to imprisoned roots. By default a process does not command superuser powers if it has been imprisoned by the .Xr jail 2 -system call. +system call. There are cases however where this is appropriate, and this can be done by setting the .Dv PRISON_ROOT bit in the flags argument to the -.Nm suser_xxx +.Nm suser_xxx function. It is important to review carefully in each case that this does not weaken the prison. Generally only where the action is protected by the @@ -87,10 +87,10 @@ The and .Nm suser_xxx functions note the fact that superuser powers have been used in the -process structure of the process specified. +process structure of the process specified. Because part of their function is to notice -whether superuser powers have been used, -the functions should only be called after other permission +whether superuser powers have been used, +the functions should only be called after other permission possibilities have been exhausted. .Sh RETURN VALUES The diff --git a/share/man/man9/sx.9 b/share/man/man9/sx.9 index c41d3cf..5fa5dd3 100644 --- a/share/man/man9/sx.9 +++ b/share/man/man9/sx.9 @@ -1,12 +1,12 @@ -.\" +.\" .\" Copyright (C) 2001 Jason Evans <jasone@freebsd.org>. All rights reserved. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice(s), this list of conditions and the following disclaimer as -.\" the first lines of this file unmodified other than the possible +.\" the first lines of this file unmodified other than the possible .\" addition of one or more copyright notices. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice(s), this list of conditions and the following disclaimer in the diff --git a/share/man/man9/sysctl_add_oid.9 b/share/man/man9/sysctl_add_oid.9 index 9f62a88..2616d45 100644 --- a/share/man/man9/sysctl_add_oid.9 +++ b/share/man/man9/sysctl_add_oid.9 @@ -308,7 +308,7 @@ This format is used as a hint by to apply proper data formatting for display purposes. Currently used format names are: .Dq N -for node, +for node, .Dq A for .Li "char *" , @@ -463,12 +463,12 @@ int a_int; char *string = "dynamic sysctl"; ... -root1 = SYSCTL_ADD_NODE( NULL, SYSCTL_STATIC_CHILDREN(/* tree top */), +root1 = SYSCTL_ADD_NODE( NULL, SYSCTL_STATIC_CHILDREN(/* tree top */), OID_AUTO, "newtree", CTLFLAG_RW, 0, "new top level tree"); oidp = SYSCTL_ADD_INT( NULL, SYSCTL_CHILDREN(root1), OID_AUTO, "newint", CTLFLAG_RW, &a_int, 0, "new int leaf"); ... -root2 = SYSCTL_ADD_NODE( NULL, SYSCTL_STATIC_CHILDREN(_debug), +root2 = SYSCTL_ADD_NODE( NULL, SYSCTL_STATIC_CHILDREN(_debug), OID_AUTO, "newtree", CTLFLAG_RW, 0, "new tree under debug"); oidp = SYSCTL_ADD_STRING( NULL, SYSCTL_CHILDREN(root2), OID_AUTO, "newstring", CTLFLAG_RD, string, 0, "new string leaf"); diff --git a/share/man/man9/sysctl_ctx_init.9 b/share/man/man9/sysctl_ctx_init.9 index 65b55d9..6056e98 100644 --- a/share/man/man9/sysctl_ctx_init.9 +++ b/share/man/man9/sysctl_ctx_init.9 @@ -191,12 +191,12 @@ char *string = "dynamic sysctl"; ... sysctl_ctx_init(&clist); -oidp = SYSCTL_ADD_NODE( &clist, SYSCTL_STATIC_CHILDREN(/* tree top */), +oidp = SYSCTL_ADD_NODE( &clist, SYSCTL_STATIC_CHILDREN(/* tree top */), OID_AUTO, newtree, CTFLAG_RW, 0, "new top level tree"); oidp = SYSCTL_ADD_INT( &clist, SYSCTL_CHILDREN(oidp), OID_AUTO, newint, CTLFLAG_RW, &a_int, 0, "new int leaf"); ... -oidp = SYSCTL_ADD_NODE( &clist, SYSCTL_STATIC_CHILDREN(_debug), +oidp = SYSCTL_ADD_NODE( &clist, SYSCTL_STATIC_CHILDREN(_debug), OID_AUTO, newtree, CTFLAG_RW, 0, "new tree under debug"); oidp = SYSCTL_ADD_STRING( &clist, SYSCTL_CHILDREN(oidp), OID_AUTO, newstring, CTLFLAG_R, string, 0, "new string leaf"); diff --git a/share/man/man9/time.9 b/share/man/man9/time.9 index a07a244..6a60549 100644 --- a/share/man/man9/time.9 +++ b/share/man/man9/time.9 @@ -75,7 +75,7 @@ The .Va runtime variable holds the time that the system switched to the current process. -It is set after each context switch, +It is set after each context switch, and is updated when the system time is adjusted with .Xr settimeofday 2 . Because @@ -123,7 +123,7 @@ returned by .Xr gettime 9 and .Xr microtime 9 -are updated, comparing the results of the two routines +are updated, comparing the results of the two routines may result in a time value that appears to go backwards. This can be avoided by consistently using one function or the other for use in any given context. diff --git a/share/man/man9/timeout.9 b/share/man/man9/timeout.9 index b5e390a..41a5096 100644 --- a/share/man/man9/timeout.9 +++ b/share/man/man9/timeout.9 @@ -95,7 +95,7 @@ The return value from .Fn timeout is a .Ft struct callout_handle -which can be used in conjunction with the +which can be used in conjunction with the .Fn untimeout function to request that a scheduled timeout be canceled. .Pp @@ -156,10 +156,10 @@ Thus they are protected from re-entrancy. .Pp The functions .Fn callout_init , -.Fn callout_stop +.Fn callout_stop and .Fn callout_reset -are low-level routines for clients who wish to allocate their own +are low-level routines for clients who wish to allocate their own callout structures. .Pp The function @@ -187,7 +187,7 @@ The function first calls .Fn callout_stop to disestablish the callout, and then establishes a new callout in the -same manner as +same manner as .Fn timeout . .Sh HISTORY The current timeout and untimeout routines are based on the work of @@ -206,7 +206,7 @@ was published by and .An A. Lauck in the paper -.%T "Hashed and Hierarchical Timing Wheels: Data Structures for the Efficient Implementation of a Timer Facility" +.%T "Hashed and Hierarchical Timing Wheels: Data Structures for the Efficient Implementation of a Timer Facility" in the .%B "Proceedings of the 11th ACM Annual Symposium on Operating Systems Principles" . The current implementation replaces the long standing BSD linked list diff --git a/share/man/man9/uio.9 b/share/man/man9/uio.9 index 95edcc4..64c5786 100644 --- a/share/man/man9/uio.9 +++ b/share/man/man9/uio.9 @@ -146,7 +146,7 @@ error: /* do error cleanup here */ return rv; } - + .Ed .Sh RETURN VALUES .Fn uiomove diff --git a/share/man/man9/vnode.9 b/share/man/man9/vnode.9 index 9aec55a..27a0650 100644 --- a/share/man/man9/vnode.9 +++ b/share/man/man9/vnode.9 @@ -158,13 +158,13 @@ and The first is the number of clients within the kernel which are using this vnode. This count is maintained by .Xr vref 9 , -.Xr vrele 9 +.Xr vrele 9 and .Xr vput 9 . The second is the number of clients within the kernel who veto the recycling of this vnode. This count is maintained by -.Xr vhold 9 +.Xr vhold 9 and .Xr vdrop 9 . When both the @@ -175,7 +175,7 @@ of a vnode reaches zero then the vnode will be put on the freelist and may be reused for another file, possibly in another filesystem. The transition to and from the freelist is handled by .Xr getnewvnode 9 , -.Xr vfree 9 +.Xr vfree 9 and .Xr vbusy 9 . The third is a count of the number of clients which are writing into @@ -240,7 +240,7 @@ A FIFO (named pipe). Advisory locking won't work on this. An old style bad sector map .El .Sh NOTES -VFIFO uses the "struct fileops" from +VFIFO uses the "struct fileops" from .Pa /sys/kern/sys_pipe.c . VSOCK uses the "struct fileops" from .Pa /sys/kern/sys_socket.c . |