diff options
author | uqs <uqs@FreeBSD.org> | 2010-05-13 12:07:55 +0000 |
---|---|---|
committer | uqs <uqs@FreeBSD.org> | 2010-05-13 12:07:55 +0000 |
commit | 1ab3783e1a2e5231321a0fc5399736ddc70407f0 (patch) | |
tree | c699822393a0ad4134098c013ca4b4ea4e2f3108 /share/man/man4 | |
parent | 43b7e87f4317ace45532f012cea993a4d9d418f0 (diff) | |
download | FreeBSD-src-1ab3783e1a2e5231321a0fc5399736ddc70407f0.zip FreeBSD-src-1ab3783e1a2e5231321a0fc5399736ddc70407f0.tar.gz |
mdoc: move CAVEATS, BUGS and SECURITY CONSIDERATIONS sections to the
bottom of the manpages and order them consistently.
GNU groff doesn't care about the ordering, and doesn't even mention
CAVEATS and SECURITY CONSIDERATIONS as common sections and where to put
them.
Found by: mdocml lint run
Reviewed by: ru
Diffstat (limited to 'share/man/man4')
42 files changed, 333 insertions, 333 deletions
diff --git a/share/man/man4/ae.4 b/share/man/man4/ae.4 index 0b5e8f8..36951b2 100644 --- a/share/man/man4/ae.4 +++ b/share/man/man4/ae.4 @@ -133,6 +133,14 @@ instead. .Xr ng_ether 4 , .Xr vlan 4 , .Xr ifconfig 8 +.Sh HISTORY +The +.Nm +driver and this manual page was written by +.An Stanislav Sedov +.Aq stas@FreeBSD.org . +It first appeared in +.Fx 7.1 . .Sh BUGS The Attansic L2 FastEthernet contoller supports DMA but does not use a descriptor based transfer mechanism via scatter-gather DMA. @@ -142,11 +150,3 @@ Furthermore, a lot of data alignment restrictions apply. This may introduce a high CPU load on systems with heavy network activity. Luckily enough this should not be a problem on modern hardware as L2 does not support speeds faster than 100Mbps. -.Sh HISTORY -The -.Nm -driver and this manual page was written by -.An Stanislav Sedov -.Aq stas@FreeBSD.org . -It first appeared in -.Fx 7.1 . diff --git a/share/man/man4/ahb.4 b/share/man/man4/ahb.4 index 6ef9993..fab6fec 100644 --- a/share/man/man4/ahb.4 +++ b/share/man/man4/ahb.4 @@ -70,13 +70,6 @@ Adaptec AHA-1740A .It Adaptec AHA-1742A .El -.Sh CAVEATS -The Adaptec 174X is very sensitive to SCSI bus termination and cable -length. -It may also have difficulties operating with some modern devices -that, due to their speed, expose timing problems in the controller. -There are no known mechanisms for working around device incompatibilities of -this nature. .Sh SEE ALSO .Xr aha 4 , .Xr ahc 4 , @@ -90,3 +83,10 @@ The .Nm driver was written by .An Justin T. Gibbs . +.Sh CAVEATS +The Adaptec 174X is very sensitive to SCSI bus termination and cable +length. +It may also have difficulties operating with some modern devices +that, due to their speed, expose timing problems in the controller. +There are no known mechanisms for working around device incompatibilities of +this nature. diff --git a/share/man/man4/amdtemp.4 b/share/man/man4/amdtemp.4 index 6d1ca7c..b955d70 100644 --- a/share/man/man4/amdtemp.4 +++ b/share/man/man4/amdtemp.4 @@ -64,9 +64,6 @@ located in each CPU core. For the K10 and K11 families, the driver creates .Va dev.cpu.%d.temperature with the temperature of each core. -.Sh BUGS -AMD K9 is not supported because temperature reporting has been replaced -by Maltese. .Sh SEE ALSO .Xr sysctl 8 .Sh HISTORY @@ -77,3 +74,6 @@ driver first appeared in .Sh AUTHORS .An Rui Paulo Aq rpaulo@FreeBSD.org .An Norikatsu Shigemura Aq nork@FreeBSD.org +.Sh BUGS +AMD K9 is not supported because temperature reporting has been replaced +by Maltese. diff --git a/share/man/man4/ataraid.4 b/share/man/man4/ataraid.4 index ee7446d..98d3068 100644 --- a/share/man/man4/ataraid.4 +++ b/share/man/man4/ataraid.4 @@ -135,9 +135,6 @@ ATA RAID device nodes .Sh SEE ALSO .Xr ata 4 , .Xr atacontrol 8 -.Sh CAVEATS -RAID5 is not supported at this time. -Code exists, but it neither uses nor maintains parity information. .Sh AUTHORS .An -nosplit The @@ -146,3 +143,6 @@ driver was written by .An S\(/oren Schmidt Aq sos@FreeBSD.org . This manual page was written by .An Christian Brueffer Aq brueffer@FreeBSD.org . +.Sh CAVEATS +RAID5 is not supported at this time. +Code exists, but it neither uses nor maintains parity information. diff --git a/share/man/man4/cpuctl.4 b/share/man/man4/cpuctl.4 index 09b2d4e..bf1bdde 100644 --- a/share/man/man4/cpuctl.4 +++ b/share/man/man4/cpuctl.4 @@ -148,10 +148,10 @@ The .Nm driver first appeared in .Fx 7.2 . -.Sh BUGS -Yes, probably, report if any. .Sh AUTHORS The .Nm module and this manual page were written by .An Stanislav Sedov Aq stas@FreeBSD.org . +.Sh BUGS +Yes, probably, report if any. diff --git a/share/man/man4/ed.4 b/share/man/man4/ed.4 index 0a43527..6217669 100644 --- a/share/man/man4/ed.4 +++ b/share/man/man4/ed.4 @@ -370,6 +370,24 @@ Probing for an MII bus has failed. This indicates a coding error in the PC Card attachment, because a PHY is required for the chips that generate this error message. .El +.Sh SEE ALSO +.Xr altq 4 , +.Xr arp 4 , +.Xr miibus 4 , +.Xr netintro 4 , +.Xr ng_ether 4 , +.Xr device.hints 5 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 1.0 . +.Sh AUTHORS +The +.Nm +device driver and this manual page were written by +.An David Greenman . .Sh CAVEATS Early revision DS8390 chips have problems. They lock up whenever the receive @@ -393,24 +411,6 @@ The Mitsubishi B8895 PC Card uses a DP83902, but its ASIC part is undocumented. Neither the NE2000 nor the WD83x0 drivers work with this card. .Pp -.Sh SEE ALSO -.Xr altq 4 , -.Xr arp 4 , -.Xr miibus 4 , -.Xr netintro 4 , -.Xr ng_ether 4 , -.Xr device.hints 5 , -.Xr ifconfig 8 -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 1.0 . -.Sh AUTHORS -The -.Nm -device driver and this manual page were written by -.An David Greenman . .Sh BUGS The .Nm diff --git a/share/man/man4/ef.4 b/share/man/man4/ef.4 index c93d5f1..ce07487 100644 --- a/share/man/man4/ef.4 +++ b/share/man/man4/ef.4 @@ -100,12 +100,12 @@ file: .Dl ifconfig_ed2f1_ipx="ipx 0x102" .Sh DIAGNOSTICS None. -.Sh CAVEATS -Avoid to configure the parent Ethernet device for the IPX protocol, after the -.Nm -driver is loaded. .Sh SEE ALSO .Xr ipx 3 , .Xr ifconfig 8 .Sh AUTHORS .An Boris Popov Aq bp@FreeBSD.org . +.Sh CAVEATS +Avoid to configure the parent Ethernet device for the IPX protocol, after the +.Nm +driver is loaded. diff --git a/share/man/man4/en.4 b/share/man/man4/en.4 index a256b9e..f9281fa 100644 --- a/share/man/man4/en.4 +++ b/share/man/man4/en.4 @@ -60,10 +60,6 @@ en0: ATM midway v0, board IDs 6.0, Utopia (pipelined), 512KB on-board RAM en0: maximum DMA burst length = 64 bytes en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated .Ed -.Sh CAVEATS -The driver extensively uses DMA on PCI. -The first -generation PCI chipsets do not work or exhibit poor performance. .Sh SEE ALSO .Xr natm 4 , .Xr natmip 4 , @@ -76,3 +72,7 @@ of Washington University implemented .Nm driver in 1996 for .Nx . +.Sh CAVEATS +The driver extensively uses DMA on PCI. +The first +generation PCI chipsets do not work or exhibit poor performance. diff --git a/share/man/man4/fpa.4 b/share/man/man4/fpa.4 index b751e29..0974429 100644 --- a/share/man/man4/fpa.4 +++ b/share/man/man4/fpa.4 @@ -40,11 +40,6 @@ requires a minimum of 1K device memory to be set up. The ECU (EISA Configuration Utility) will need to be run to change the settings. .El -.Sh CAVEATS -Normally, the device driver will not enable the reception of SMT frames. -However if the IFF_LINK1 flag is set, the device driver will enable the -reception of SMT frames and pass them up to the Berkeley Packet Filter for -processing. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -56,3 +51,8 @@ and .Nm fea device drivers and this manual page were written by .An Matt Thomas . +.Sh CAVEATS +Normally, the device driver will not enable the reception of SMT frames. +However if the IFF_LINK1 flag is set, the device driver will enable the +reception of SMT frames and pass them up to the Berkeley Packet Filter for +processing. diff --git a/share/man/man4/geom_fox.4 b/share/man/man4/geom_fox.4 index 8e262b9..76fd0b9 100644 --- a/share/man/man4/geom_fox.4 +++ b/share/man/man4/geom_fox.4 @@ -177,6 +177,14 @@ da2.fox N/A da2 .Xr GEOM 4 , .Xr geom 8 , .Xr gmultipath 8 +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An "Poul-Henning Kamp" Aq phk@FreeBSD.org . +This manual page was written by +.An "Wilko Bulte" Aq wilko@FreeBSD.org . .Sh CAVEATS The .Nm @@ -193,14 +201,6 @@ Safety belts are not provided. For FibreChannel devices it is suggested to use the Port WWN of the device. The World Wide Name is guaranteed to be worldwide unique per the FibreChannel standard. -.Sh AUTHORS -.An -nosplit -The -.Nm -driver was written by -.An "Poul-Henning Kamp" Aq phk@FreeBSD.org . -This manual page was written by -.An "Wilko Bulte" Aq wilko@FreeBSD.org . .Sh BUGS The .Nm diff --git a/share/man/man4/harp.4 b/share/man/man4/harp.4 index 6f4d941..9495f62 100644 --- a/share/man/man4/harp.4 +++ b/share/man/man4/harp.4 @@ -56,11 +56,11 @@ Netgraph interface (they are in different namespaces). .Xr ng_atm 4 , .Xr patm 4 , .Xr atm 8 +.Sh AUTHORS +.An Harti Brandt Aq harti@FreeBSD.org .Sh CAVEATS When .Xr fatm 4 is used, it must be started before .Nm is loaded, to get the correct configuration for the HARP physical interface. -.Sh AUTHORS -.An Harti Brandt Aq harti@FreeBSD.org diff --git a/share/man/man4/hatm.4 b/share/man/man4/hatm.4 index f9b7e70..59de800 100644 --- a/share/man/man4/hatm.4 +++ b/share/man/man4/hatm.4 @@ -252,6 +252,19 @@ a connection can eat up all available TPDs. Maximum number of memory pages allocated to small external mbufs. This must not be zero and not larger than 65536. .El +.Sh DIAGNOSTICS +.Bd -literal +hatm0: <FORE HE> mem 0xd2600000-0xd26fffff irq 9 at device 15.0 on pci2 +hatm0: ForeRunnerHE 622, Rev. D, S/N 2949834, MAC=00:20:48:2d:02:ca +.Ed +.Sh SEE ALSO +.Xr natm 4 , +.Xr natmip 4 , +.Xr utopia 4 , +.Xr ifconfig 8 , +.Xr route 8 +.Sh AUTHORS +.An Harti Brandt Aq harti@FreeBSD.org .Sh CAVEATS When putting a HE155 into a 64-bit 66MHz PCI slot the machine may hang. This occurs very early in the POST so that even the display does not turn on. @@ -267,16 +280,3 @@ and arguments the .Nx function has. -.Sh DIAGNOSTICS -.Bd -literal -hatm0: <FORE HE> mem 0xd2600000-0xd26fffff irq 9 at device 15.0 on pci2 -hatm0: ForeRunnerHE 622, Rev. D, S/N 2949834, MAC=00:20:48:2d:02:ca -.Ed -.Sh SEE ALSO -.Xr natm 4 , -.Xr natmip 4 , -.Xr utopia 4 , -.Xr ifconfig 8 , -.Xr route 8 -.Sh AUTHORS -.An Harti Brandt Aq harti@FreeBSD.org diff --git a/share/man/man4/hifn.4 b/share/man/man4/hifn.4 index 02b8e32..a53bac3 100644 --- a/share/man/man4/hifn.4 +++ b/share/man/man4/hifn.4 @@ -107,15 +107,6 @@ Contains a 7955 and supports symmetric and random number operations. .Xr ipsec 4 , .Xr random 4 , .Xr crypto 9 -.Sh CAVEATS -The Hifn 9751 shares the same PCI ID. -This chip is basically a 7751, but with the cryptographic functions missing. -Instead, the 9751 is only capable of doing compression. -Since we do not currently attempt to use any of these chips to do -compression, the 9751-based cards are not useful. -.Pp -Support for the 7955 and 7956 is incomplete; the asymmetric crypto -facilities are to be added and the performance is suboptimal. .Sh HISTORY The .Nm @@ -125,6 +116,15 @@ The .Nm device driver was imported to .Fx 5.0 . +.Sh CAVEATS +The Hifn 9751 shares the same PCI ID. +This chip is basically a 7751, but with the cryptographic functions missing. +Instead, the 9751 is only capable of doing compression. +Since we do not currently attempt to use any of these chips to do +compression, the 9751-based cards are not useful. +.Pp +Support for the 7955 and 7956 is incomplete; the asymmetric crypto +facilities are to be added and the performance is suboptimal. .Sh BUGS The 7751 chip starts out at initialization by only supporting compression. A proprietary algorithm, which has been reverse engineered, is required to diff --git a/share/man/man4/hwpmc.4 b/share/man/man4/hwpmc.4 index 7034cd4..6264bd0 100644 --- a/share/man/man4/hwpmc.4 +++ b/share/man/man4/hwpmc.4 @@ -450,42 +450,6 @@ These variables may be set in the kernel environment using before .Nm is loaded. -.Sh SECURITY CONSIDERATIONS -PMCs may be used to monitor the actual behavior of the system on hardware. -In situations where this constitutes an undesirable information leak, -the following options are available: -.Bl -enum -.It -Set the -.Xr sysctl 8 -tunable -.Va security.bsd.unprivileged_syspmcs -to 0. -This ensures that unprivileged processes cannot allocate system-wide -PMCs and thus cannot observe the hardware behavior of the system -as a whole. -This tunable may also be set at boot time using -.Xr loader 8 , -or with -.Xr kenv 1 -prior to loading the -.Nm -driver into the kernel. -.It -Set the -.Xr sysctl 8 -tunable -.Va security.bsd.unprivileged_proc_debug -to 0. -This will ensure that an unprivileged process cannot attach a PMC -to any process other than itself and thus cannot observe the hardware -behavior of other processes with the same credentials. -.El -.Pp -System administrators should note that on IA-32 platforms -.Fx -makes the content of the IA-32 TSC counter available to all processes -via the RDTSC instruction. .Sh IMPLEMENTATION NOTES .Ss SMP Symmetry The kernel driver requires all physical CPUs in an SMP system to have @@ -831,3 +795,39 @@ Many single-processor motherboards keep the APIC disabled in BIOS; on such systems .Nm will not support sampling PMCs. +.Sh SECURITY CONSIDERATIONS +PMCs may be used to monitor the actual behavior of the system on hardware. +In situations where this constitutes an undesirable information leak, +the following options are available: +.Bl -enum +.It +Set the +.Xr sysctl 8 +tunable +.Va security.bsd.unprivileged_syspmcs +to 0. +This ensures that unprivileged processes cannot allocate system-wide +PMCs and thus cannot observe the hardware behavior of the system +as a whole. +This tunable may also be set at boot time using +.Xr loader 8 , +or with +.Xr kenv 1 +prior to loading the +.Nm +driver into the kernel. +.It +Set the +.Xr sysctl 8 +tunable +.Va security.bsd.unprivileged_proc_debug +to 0. +This will ensure that an unprivileged process cannot attach a PMC +to any process other than itself and thus cannot observe the hardware +behavior of other processes with the same credentials. +.El +.Pp +System administrators should note that on IA-32 platforms +.Fx +makes the content of the IA-32 TSC counter available to all processes +via the RDTSC instruction. diff --git a/share/man/man4/inet.4 b/share/man/man4/inet.4 index b1878d5..ef189d3 100644 --- a/share/man/man4/inet.4 +++ b/share/man/man4/inet.4 @@ -280,12 +280,6 @@ in the reassembling queue for a packet. .%B PS1 .%N 8 .Re -.Sh CAVEATS -The Internet protocol support is subject to change as -the Internet protocols develop. -Users should not depend -on details of the current implementation, but rather -the services exported. .Sh HISTORY The .Nm @@ -295,3 +289,9 @@ The .Dq protocol cloning code appeared in .Fx 2.1 . +.Sh CAVEATS +The Internet protocol support is subject to change as +the Internet protocols develop. +Users should not depend +on details of the current implementation, but rather +the services exported. diff --git a/share/man/man4/kbdmux.4 b/share/man/man4/kbdmux.4 index f92fa45..72b5889 100644 --- a/share/man/man4/kbdmux.4 +++ b/share/man/man4/kbdmux.4 @@ -35,6 +35,13 @@ utility. .Xr atkbd 4 , .Xr syscons 4 , .Xr ukbd 4 +.Sh HISTORY +The +.Nm +module was implemented in +.Fx 6.0 . +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com .Sh CAVEATS The .Nm @@ -47,10 +54,3 @@ keyboard share the same state. The .Nm keyboard is logically equivalent to one keyboard with lots of duplicated keys. -.Sh HISTORY -The -.Nm -module was implemented in -.Fx 6.0 . -.Sh AUTHORS -.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/share/man/man4/ksyms.4 b/share/man/man4/ksyms.4 index 56572e9..d12f460 100644 --- a/share/man/man4/ksyms.4 +++ b/share/man/man4/ksyms.4 @@ -130,6 +130,12 @@ driver first appeared in .Fx 8.0 to support .Xr lockstat 1 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Stacey Son +.Aq sson@freebsd.org . .Sh BUGS Because files can be dynamically linked into the kernel at any time the symbol information can vary. When you open the @@ -150,9 +156,3 @@ can be used to get the memory address where the symbol table is stored to save kernel memory. .Xr mmap 2 may also be used but it will map it to another address. -.Sh AUTHORS -The -.Nm -driver was written by -.An Stacey Son -.Aq sson@freebsd.org . diff --git a/share/man/man4/man4.i386/cs.4 b/share/man/man4/man4.i386/cs.4 index c1ee7ae..b7e0389 100644 --- a/share/man/man4/man4.i386/cs.4 +++ b/share/man/man4/man4.i386/cs.4 @@ -129,12 +129,6 @@ The parameters obtained via PnP were not accepted by the driver. The adapter may not function. .El -.Sh CAVEATS -The CS89x0 family of adapters have a very small RAM buffer (4K). -This may -cause problems with extremely high network loads or bursty network traffic. -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 , @@ -150,3 +144,9 @@ and .An Oleg Sharoiko . This manpage was written by .An Michael Smith . +.Sh CAVEATS +The CS89x0 family of adapters have a very small RAM buffer (4K). +This may +cause problems with extremely high network loads or bursty network traffic. +In particular, NFS operations should be limited to 1k read/write transactions +in order to avoid overruns. diff --git a/share/man/man4/man4.i386/ie.4 b/share/man/man4/man4.i386/ie.4 index 17d24d2..2ef9d05 100644 --- a/share/man/man4/man4.i386/ie.4 +++ b/share/man/man4/man4.i386/ie.4 @@ -116,12 +116,6 @@ The card refused to respond correctly during configuration. .It "ie%d: individual address setup command failed" The programming of the Ethernet (MAC) address failed. .El -.Sh CAVEATS -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. -You can upgrade your 8 kbyte card to 16 kbyte by adding an additional -RAM chip. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -141,3 +135,9 @@ support was written by .An Charles M. Hannum . This manual page was written by .An Wilko C. Bulte . +.Sh CAVEATS +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. +You can upgrade your 8 kbyte card to 16 kbyte by adding an additional +RAM chip. diff --git a/share/man/man4/man4.i386/mse.4 b/share/man/man4/man4.i386/mse.4 index 7f83dcc..a5cb3f7 100644 --- a/share/man/man4/man4.i386/mse.4 +++ b/share/man/man4/man4.i386/mse.4 @@ -373,10 +373,6 @@ Define the .Nm driver at the secondary port address with the IRQ 4 and the acceleration factor of 3. -.Sh CAVEATS -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 .Xr ioctl 2 , .Xr mouse 4 , @@ -384,3 +380,7 @@ The others generate interrupts only when the state is changing. .Xr sysmouse 4 , .Xr moused 8 .\".Sh HISTORY +.Sh CAVEATS +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. diff --git a/share/man/man4/man4.i386/pnp.4 b/share/man/man4/man4.i386/pnp.4 index 1c9a2cd..7c17b0e 100644 --- a/share/man/man4/man4.i386/pnp.4 +++ b/share/man/man4/man4.i386/pnp.4 @@ -48,17 +48,6 @@ If it cannot assign necessary resources to a PnP ISA device without causing conflict with other devices in the system, the device will not be activated and will be unavailable to programs. -.Sh CAVEATS -It is not possible to disable individual PnP ISA devices. -The -.Nm -driver will find all devices conforming the PnP ISA specification -and try to activate them all. -.Pp -There is no way to explicitly assign particular resource to -the PnP ISA device. -The resource assignment is fully automatic and there is -no provision for manual override. .Sh SEE ALSO .Xr pnpbios 4 .Sh STANDARDS @@ -88,3 +77,14 @@ by .An Luigi Rizzo , based on initial work done by .An Sujal Patel . +.Sh CAVEATS +It is not possible to disable individual PnP ISA devices. +The +.Nm +driver will find all devices conforming the PnP ISA specification +and try to activate them all. +.Pp +There is no way to explicitly assign particular resource to +the PnP ISA device. +The resource assignment is fully automatic and there is +no provision for manual override. diff --git a/share/man/man4/man4.i386/pnpbios.4 b/share/man/man4/man4.i386/pnpbios.4 index d8e7609..b386be2 100644 --- a/share/man/man4/man4.i386/pnpbios.4 +++ b/share/man/man4/man4.i386/pnpbios.4 @@ -44,17 +44,6 @@ If it cannot assign necessary resources to a device without causing conflict with other devices in the system, the device will not be activated and will be unavailable to programs. -.Sh CAVEATS -There is no explicit way to disable individual embedded devices. -The -.Nm -driver will find all devices reported by the -.Dq "Plug and Play (PnP)" -BIOS and try to activate them all. -.Pp -There is no way to explicitly assign particular resource to a device. -The resource assignment is fully automatic and there is -no provision for manual override. .Sh SEE ALSO .Xr pnp 4 .Sh STANDARDS @@ -83,3 +72,14 @@ The .Nm driver was written by .An Mike Smith . +.Sh CAVEATS +There is no explicit way to disable individual embedded devices. +The +.Nm +driver will find all devices reported by the +.Dq "Plug and Play (PnP)" +BIOS and try to activate them all. +.Pp +There is no way to explicitly assign particular resource to a device. +The resource assignment is fully automatic and there is +no provision for manual override. diff --git a/share/man/man4/man4.i386/vx.4 b/share/man/man4/man4.i386/vx.4 index 99d89e9..ab0472b 100644 --- a/share/man/man4/man4.i386/vx.4 +++ b/share/man/man4/man4.i386/vx.4 @@ -96,16 +96,6 @@ rebuild the kernel, and reboot. .Pp All other diagnostics indicate either a hardware problem or a bug in the driver. -.Sh CAVEATS -Some early-revision 3c590 cards are defective and suffer from many receive -overruns, which cause lost packets. -The author has attempted to implement -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 -of the cards. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -128,6 +118,16 @@ device driver and this manual page were written by based on the work of .An Herb Peyerl and with the assistance of numerous others. +.Sh CAVEATS +Some early-revision 3c590 cards are defective and suffer from many receive +overruns, which cause lost packets. +The author has attempted to implement +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 +of the cards. .Sh BUGS The .Nm diff --git a/share/man/man4/man4.i386/wl.4 b/share/man/man4/man4.i386/wl.4 index 2f8fdc5..a1eacda 100644 --- a/share/man/man4/man4.i386/wl.4 +++ b/share/man/man4/man4.i386/wl.4 @@ -141,17 +141,6 @@ packets and also stores the IP src address. ARP packets are ignored, as are any other network protocol barring IPv4 packets. .El -.Sh CAVEATS -The 82586 has numerous defects. -It may experience transmit-side -errors when modern faster cpus send packets at it faster than it can handle. -The driver (and probably the chip) does not support an all multicast mode. -As a result, it can be used with applications like -.Xr mrouted 8 Pq Pa ports/net/mrouted , -but it must go into promiscuous mode for that to work. -The driver -is slow to change modes from "normal" to promiscuous mode, presumably -due to delays in the configuration code. .Sh SEE ALSO .Xr sysctl 8 , .Xr wlconfig 8 @@ -189,3 +178,14 @@ for contributions. .Sh AUTHORS Too numerous to mention. See above. +.Sh CAVEATS +The 82586 has numerous defects. +It may experience transmit-side +errors when modern faster cpus send packets at it faster than it can handle. +The driver (and probably the chip) does not support an all multicast mode. +As a result, it can be used with applications like +.Xr mrouted 8 Pq Pa ports/net/mrouted , +but it must go into promiscuous mode for that to work. +The driver +is slow to change modes from "normal" to promiscuous mode, presumably +due to delays in the configuration code. diff --git a/share/man/man4/man4.powerpc/snd_ai2s.4 b/share/man/man4/man4.powerpc/snd_ai2s.4 index eabea34..dee0424 100644 --- a/share/man/man4/man4.powerpc/snd_ai2s.4 +++ b/share/man/man4/man4.powerpc/snd_ai2s.4 @@ -66,8 +66,6 @@ Apple Tumbler Audio Apple Snapper Audio .El .Pp -.Sh BUGS -Recording and operation with non-44.1 Khz audio are not currently supported. .Sh SEE ALSO .Xr sound 4 , .Xr snd_davbus 4 @@ -88,3 +86,5 @@ driver was written by and ported to FreeBSD by .An Marco Trillo .Aq marcotrillo@gmail.com . +.Sh BUGS +Recording and operation with non-44.1 Khz audio are not currently supported. diff --git a/share/man/man4/man4.powerpc/snd_davbus.4 b/share/man/man4/man4.powerpc/snd_davbus.4 index 934886e..afdf906 100644 --- a/share/man/man4/man4.powerpc/snd_davbus.4 +++ b/share/man/man4/man4.powerpc/snd_davbus.4 @@ -64,8 +64,6 @@ Apple Burgundy Audio Apple Screamer Audio .El .Pp -.Sh BUGS -Recording is not currently supported. .Sh SEE ALSO .Xr sound 4 , .Xr snd_ai2s 4 @@ -81,3 +79,5 @@ The driver was written by .An Marco Trillo .Aq marcotrillo@gmail.com . +.Sh BUGS +Recording is not currently supported. diff --git a/share/man/man4/man4.sparc64/clkbrd.4 b/share/man/man4/man4.sparc64/clkbrd.4 index b6c0bb3..ad74ee2 100644 --- a/share/man/man4/man4.sparc64/clkbrd.4 +++ b/share/man/man4/man4.sparc64/clkbrd.4 @@ -62,8 +62,6 @@ driver also prints out the number of board slots the chassis provides. .It Pa /dev/led/clockboard clock board LED device node .El -.Sh CAVEATS -Hardware management functionality is not implemented. .Sh SEE ALSO .Xr fhc 4 , .Xr led 4 @@ -86,3 +84,5 @@ and ported to .Fx by .An "Marius Strobl" Aq marius@FreeBSD.org . +.Sh CAVEATS +Hardware management functionality is not implemented. diff --git a/share/man/man4/man4.sparc64/creator.4 b/share/man/man4/man4.sparc64/creator.4 index 5f6ab23..5d7205b 100644 --- a/share/man/man4/man4.sparc64/creator.4 +++ b/share/man/man4/man4.sparc64/creator.4 @@ -62,8 +62,6 @@ these frame buffers .Nm device nodes .El -.Sh CAVEATS -Font loading and mode switching are not implemented. .Sh SEE ALSO .Xr machfb 4 , .Xr syscons 4 @@ -86,3 +84,5 @@ roughly based on the .Ox driver written by .An "Jason L. Wright" . +.Sh CAVEATS +Font loading and mode switching are not implemented. diff --git a/share/man/man4/man4.sparc64/machfb.4 b/share/man/man4/man4.sparc64/machfb.4 index 7d0af11..c42eb9b 100644 --- a/share/man/man4/man4.sparc64/machfb.4 +++ b/share/man/man4/man4.sparc64/machfb.4 @@ -154,8 +154,6 @@ driver at this time: .Tn Sun PGX64 8/24-Bit Color Frame Buffer (part no.\& 370-4362) .El -.Sh CAVEATS -Font loading and mode switching are not implemented. .Sh SEE ALSO .Xr creator 4 , .Xr syscons 4 @@ -178,3 +176,5 @@ based on the .Nx driver written by .An "Bang Jun-Young" . +.Sh CAVEATS +Font loading and mode switching are not implemented. diff --git a/share/man/man4/man4.sparc64/ofw_console.4 b/share/man/man4/man4.sparc64/ofw_console.4 index 8ae1c0c..9a4513b 100644 --- a/share/man/man4/man4.sparc64/ofw_console.4 +++ b/share/man/man4/man4.sparc64/ofw_console.4 @@ -78,19 +78,6 @@ terminal output device in case the console output device is the screen .It Pa /dev/tty[a-z] terminal device in case both the console input and output device is tty[a-z] .El -.Sh CAVEATS -Since the Open Firmware will handle BREAK -(or Stop-A) -sequences before -.Nm , -the preferred way to enter -.Xr ddb 4 -when using -.Nm -is to include -.Cd "options ALT_BREAK_TO_DEBUGGER" -in a ddb-enabled kernel, and enter the alternate BREAK sequence -(RETURN TILDE CTRL-b). .Sh SEE ALSO .Xr creator 4 , .Xr machfb 4 , @@ -107,6 +94,19 @@ The .Nm driver was written by .An "Benno Rice" Aq benno@FreeBSD.org . +.Sh CAVEATS +Since the Open Firmware will handle BREAK +(or Stop-A) +sequences before +.Nm , +the preferred way to enter +.Xr ddb 4 +when using +.Nm +is to include +.Cd "options ALT_BREAK_TO_DEBUGGER" +in a ddb-enabled kernel, and enter the alternate BREAK sequence +(RETURN TILDE CTRL-b). .Sh BUGS The .Nm diff --git a/share/man/man4/man4.sparc64/openfirm.4 b/share/man/man4/man4.sparc64/openfirm.4 index 686fe86..63abd85 100644 --- a/share/man/man4/man4.sparc64/openfirm.4 +++ b/share/man/man4/man4.sparc64/openfirm.4 @@ -251,25 +251,6 @@ The kernel could not allocate memory to copy in data from user-space or to retrieve data from the .Tn Open Firmware . .El -.Sh CAVEATS -Due to limitations within -.Tn Open Firmware -itself, -these functions run at elevated priority and may adversely affect system -performance. -.Pp -For at least the -.Pa /options -node the property value passed in to the -.Dv OFIOCSET -call has to be null-terminated and the value length passed in has to include -the terminating -.Ql \e0 . -However, as with the -.Dv OFIOCGET -call, -the returned value length does not include the terminating -.Ql \e0 . .Sh SEE ALSO .Xr ioctl 2 , .Xr openprom 4 , @@ -298,3 +279,22 @@ interface was ported to .Fx by .An "Thomas Moestl" Aq tmm@FreeBSD.org . +.Sh CAVEATS +Due to limitations within +.Tn Open Firmware +itself, +these functions run at elevated priority and may adversely affect system +performance. +.Pp +For at least the +.Pa /options +node the property value passed in to the +.Dv OFIOCSET +call has to be null-terminated and the value length passed in has to include +the terminating +.Ql \e0 . +However, as with the +.Dv OFIOCGET +call, +the returned value length does not include the terminating +.Ql \e0 . diff --git a/share/man/man4/man4.sparc64/openprom.4 b/share/man/man4/man4.sparc64/openprom.4 index e66a8d8..e833628 100644 --- a/share/man/man4/man4.sparc64/openprom.4 +++ b/share/man/man4/man4.sparc64/openprom.4 @@ -206,21 +206,6 @@ The kernel could not allocate memory to copy in data from user-space or to retrieve data from the .Tn Open Firmware . .El -.Sh CAVEATS -Due to limitations within -.Tn Open Firmware -itself, -these functions run at elevated priority and may adversely affect system -performance. -.Pp -The -.Nm -interface exists entirely for compatibility with software like X11, -and only the features that are actually needed for that are implemented. -The interface sucks too much to actually use, -new code should use the -.Xr openfirm 4 -interface instead. .Sh SEE ALSO .Xr ioctl 2 , .Xr openfirm 4 , @@ -238,3 +223,18 @@ The .Nm interface was written by .An "Jake Burkholder" Aq jake@FreeBSD.org . +.Sh CAVEATS +Due to limitations within +.Tn Open Firmware +itself, +these functions run at elevated priority and may adversely affect system +performance. +.Pp +The +.Nm +interface exists entirely for compatibility with software like X11, +and only the features that are actually needed for that are implemented. +The interface sucks too much to actually use, +new code should use the +.Xr openfirm 4 +interface instead. diff --git a/share/man/man4/natm.4 b/share/man/man4/natm.4 index 33bd2b1..59e5559d3 100644 --- a/share/man/man4/natm.4 +++ b/share/man/man4/natm.4 @@ -83,11 +83,6 @@ overhead of a protocol control block lookup. This allows us to take advantage of the fact that ATM has already demultiplexed the data for us. -.Sh CAVEATS -The NATM protocol support is subject to change as -the ATM protocols develop. -Users should not depend on details of the current implementation, but rather -the services exported. .Sh SEE ALSO .Xr en 4 , .Xr fatm 4 , @@ -99,3 +94,8 @@ the services exported. of Washington University implemented the NATM protocol layer along with the EN ATM driver in 1996 for .Nx . +.Sh CAVEATS +The NATM protocol support is subject to change as +the ATM protocols develop. +Users should not depend on details of the current implementation, but rather +the services exported. diff --git a/share/man/man4/nve.4 b/share/man/man4/nve.4 index 5fe5229..a1db97a 100644 --- a/share/man/man4/nve.4 +++ b/share/man/man4/nve.4 @@ -114,10 +114,6 @@ There are not enough mbufs available for allocation. The device has stopped responding to the network, or there is a problem with the network connection (cable). .El -.Sh BUGS -There are reports that when the card is in auto select mode, -ifconfig output reports a 10baseT/UTP output while the LEDs and -bandwidth show that the card is actually in 100baseTX mode. .Sh SEE ALSO .Xr altq 4 , .Xr arp 4 , @@ -138,3 +134,7 @@ driver was written by .An Quinton Dolan Aq q@onthenet.com.au and .An "David E. O'Brien" Aq obrien@FreeBSD.org . +.Sh BUGS +There are reports that when the card is in auto select mode, +ifconfig output reports a 10baseT/UTP output while the LEDs and +bandwidth show that the card is actually in 100baseTX mode. diff --git a/share/man/man4/patm.4 b/share/man/man4/patm.4 index 3ab2f7a..443b9f7 100644 --- a/share/man/man4/patm.4 +++ b/share/man/man4/patm.4 @@ -154,6 +154,12 @@ patm1: 128K x 32 SRAM; 4096 connections .Xr natm 4 , .Xr natmip 4 , .Xr utopia 4 +.Sh ACKNOWLEDGEMENTS +Thanks to Christian Bucari from ProSum for lending two of these cards to enable +the development of this driver. +Thanks also for answering my questions. +.Sh AUTHORS +.An Harti Brandt Aq harti@FreeBSD.org .Sh CAVEATS The card fails to generate an interrupt if a cell is received in AAL0 mode that has the MSB of the PTI field cleared. @@ -184,9 +190,3 @@ uses idle cells for spacing and the PHY counts these cells. While there is a configuration option for the chip to switch of these cells and, according to the documentation, this should not influence cell spacing, it does, so the driver lets the chip generate idle cells. -.Sh ACKNOWLEDGEMENTS -Thanks to Christian Bucari from ProSum for lending two of these cards to enable -the development of this driver. -Thanks also for answering my questions. -.Sh AUTHORS -.An Harti Brandt Aq harti@FreeBSD.org diff --git a/share/man/man4/psm.4 b/share/man/man4/psm.4 index b61a4d3..ed911bd 100644 --- a/share/man/man4/psm.4 +++ b/share/man/man4/psm.4 @@ -817,36 +817,6 @@ The rest of the lines show the device ID code, the number of detected 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 versions of ALPS GlidePoint -and Interlink VersaPad, treat the tapping action -as fourth button events. -.Pp -It is reported that Interlink VersaPad requires both -.Em HOOKRESUME -and -.Em INITAFTERSUSPEND -flags in order to recover from suspended state. -These flags are automatically set when VersaPad is detected by the -.Nm -driver. -.Pp -Some PS/2 mouse models from MouseSystems require to be put in the -high resolution mode to work properly. -Use the driver flag to -set resolution. -.Pp -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 -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 . -Clicking any button without moving the mouse may also work. .Sh SEE ALSO .Xr ioctl 2 , .Xr syslog 3 , @@ -878,6 +848,36 @@ to name the few. .Pp This manual page was written by .An Kazutaka Yokota Aq yokota@FreeBSD.org . +.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 versions of ALPS GlidePoint +and Interlink VersaPad, treat the tapping action +as fourth button events. +.Pp +It is reported that Interlink VersaPad requires both +.Em HOOKRESUME +and +.Em INITAFTERSUSPEND +flags in order to recover from suspended state. +These flags are automatically set when VersaPad is detected by the +.Nm +driver. +.Pp +Some PS/2 mouse models from MouseSystems require to be put in the +high resolution mode to work properly. +Use the driver flag to +set resolution. +.Pp +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 +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 . +Clicking any button without moving the mouse may also work. .Sh BUGS The ioctl command .Dv MOUSEIOCREAD diff --git a/share/man/man4/splash.4 b/share/man/man4/splash.4 index 165366a..5a32e86 100644 --- a/share/man/man4/splash.4 +++ b/share/man/man4/splash.4 @@ -221,10 +221,6 @@ necessary to load the VESA module. Just load the bitmap file and the splash decoder module as in the first example above. .\".Sh DIAGNOSTICS -.Sh CAVEATS -Both the splash screen and the screen saver work with -.Xr syscons 4 -only. .Sh SEE ALSO .Xr vidcontrol 1 , .Xr syscons 4 , @@ -257,6 +253,10 @@ module was written by based on the .Pa splash_bmp code. +.Sh CAVEATS +Both the splash screen and the screen saver work with +.Xr syscons 4 +only. .Sh BUGS If you load a screen saver while another screen saver has already been loaded, the first screen saver will not be automatically unloaded diff --git a/share/man/man4/syscons.4 b/share/man/man4/syscons.4 index b0f98a1..acc6c66 100644 --- a/share/man/man4/syscons.4 +++ b/share/man/man4/syscons.4 @@ -523,14 +523,6 @@ to the kernel. .Dl "makeoptions SC_DFLT_FONT=cp850 .Dl "device sc" .\".Sh DIAGNOSTICS -.Sh CAVEATS -The amount of data that is possible to insert from the cut buffer is limited -by the -.Brq Dv MAX_INPUT , -a system limit on the number of bytes that may be stored in the terminal -input queue - usually 1024 bytes -(see -.Xr termios 4 ) . .Sh SEE ALSO .Xr kbdcontrol 1 , .Xr login 1 , @@ -562,5 +554,13 @@ driver was written by .An S\(/oren Schmidt Aq sos@FreeBSD.org . This manual page was written by .An Kazutaka Yokota Aq yokota@FreeBSD.org . +.Sh CAVEATS +The amount of data that is possible to insert from the cut buffer is limited +by the +.Brq Dv MAX_INPUT , +a system limit on the number of bytes that may be stored in the terminal +input queue - usually 1024 bytes +(see +.Xr termios 4 ) . .Sh BUGS This manual page is incomplete and urgently needs revision. diff --git a/share/man/man4/twa.4 b/share/man/man4/twa.4 index 32cccfc..32cccfc 100755..100644 --- a/share/man/man4/twa.4 +++ b/share/man/man4/twa.4 diff --git a/share/man/man4/ucom.4 b/share/man/man4/ucom.4 index 1f39847..ff891cb 100644 --- a/share/man/man4/ucom.4 +++ b/share/man/man4/ucom.4 @@ -68,14 +68,6 @@ The .Va portno locater can be used to decide which port to use for devices that have multiple external ports. -.Sh BUGS -Prior to -.Fx 6.0 -.Nm -created -.Pa /dev/ucom? -rather than the uniform device names created today. -Old scripts must be adjusted accordingly. .Sh FILES .Bl -tag -width ".Pa /dev/cuaU?" .It Pa /dev/cuaU? @@ -103,3 +95,11 @@ This manual page was adopted from by .An Tom Rhodes Aq trhodes@FreeBSD.org in April 2002. +.Sh BUGS +Prior to +.Fx 6.0 +.Nm +created +.Pa /dev/ucom? +rather than the uniform device names created today. +Old scripts must be adjusted accordingly. diff --git a/share/man/man4/vkbd.4 b/share/man/man4/vkbd.4 index 079688f..debdd3e 100644 --- a/share/man/man4/vkbd.4 +++ b/share/man/man4/vkbd.4 @@ -130,6 +130,13 @@ All queued scan codes are thrown away. .Xr atkbdc 4 , .Xr psm 4 , .Xr syscons 4 +.Sh HISTORY +The +.Nm +module was implemented in +.Fx 6.0 . +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com .Sh CAVEATS The .Nm @@ -144,10 +151,3 @@ at the same time. It is, however, in principal possible to obtain AT scan codes from the different sources and write them into the same virtual keyboard. The virtual keyboard state synchronization is the user's responsibility. -.Sh HISTORY -The -.Nm -module was implemented in -.Fx 6.0 . -.Sh AUTHORS -.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/share/man/man4/wpi.4 b/share/man/man4/wpi.4 index 07e8816..9932ff4 100644 --- a/share/man/man4/wpi.4 +++ b/share/man/man4/wpi.4 @@ -117,10 +117,6 @@ unload/reload the driver to continue. The hardware switch controlling the radio is currently turned off. Data transmission is not possible in this state. .El -.Sh BUGS -Not all the error messages are documented here. -.Pp -Background scanning is not currently supported. .Sh SEE ALSO .Xr wpifw 4 , .Xr pci 4 , @@ -143,3 +139,7 @@ ported .Nm to .Fx . +.Sh BUGS +Not all the error messages are documented here. +.Pp +Background scanning is not currently supported. |