diff options
150 files changed, 1167 insertions, 1167 deletions
diff --git a/share/examples/scsi_target/scsi_target.8 b/share/examples/scsi_target/scsi_target.8 index 34a85cd..677e2b4 100644 --- a/share/examples/scsi_target/scsi_target.8 +++ b/share/examples/scsi_target/scsi_target.8 @@ -119,6 +119,13 @@ All options default to the minimal functionality of SCSI-1. To be safe, .Nm checks the SIM for the requested capability before enabling target mode. +.Sh FILES +.Bl -tag -width ".Pa /usr/share/examples/scsi_target" -compact +.It Pa /dev/targ* +Control devices. +.It Pa /usr/share/examples/scsi_target +Source directory. +.El .Sh EXAMPLES Create a 5 megabyte backing store file. .Pp @@ -134,13 +141,6 @@ Debugging information will be output. 16-bit wide transfers will be used if the SIM supports them. .Pp .Dl "scsi_target -d -s 1000 -W 16 0:1:0 vol" -.Sh FILES -.Bl -tag -width ".Pa /usr/share/examples/scsi_target" -compact -.It Pa /dev/targ* -Control devices. -.It Pa /usr/share/examples/scsi_target -Source directory. -.El .Sh SEE ALSO .Xr scsi 4 , .Xr targ 4 diff --git a/share/man/man3/pthread_attr_get_np.3 b/share/man/man3/pthread_attr_get_np.3 index 6a31d33..479fa42 100644 --- a/share/man/man3/pthread_attr_get_np.3 +++ b/share/man/man3/pthread_attr_get_np.3 @@ -68,6 +68,11 @@ The .Fn pthread_attr_get_np function will always return a pointer to the thread's real stack address, regardless of its value in the original attributes structure. +.Sh RETURN VALUES +If successful, +.Fn pthread_attr_get_np +function returns 0. +Otherwise, an error number is returned to indicate the error. .Sh EXAMPLES .Bd -literal size_t @@ -83,11 +88,6 @@ my_thread_stack_size(pthread_t pid) return(size); } .Ed -.Sh RETURN VALUES -If successful, -.Fn pthread_attr_get_np -function returns 0. -Otherwise, an error number is returned to indicate the error. .Sh ERRORS The .Fn pthread_attr_get_np diff --git a/share/man/man3/pthread_barrier_destroy.3 b/share/man/man3/pthread_barrier_destroy.3 index c579e7d..6786ba3 100644 --- a/share/man/man3/pthread_barrier_destroy.3 +++ b/share/man/man3/pthread_barrier_destroy.3 @@ -75,6 +75,15 @@ any of them will be released is determined by the argument to .Fn pthread_barrier_init . Once the threads have been released the barrier will be reset. +.Sh IMPLEMENTATION NOTES +In both +.Lb libpthread +and +.Lb libthr +the +.Dv PTHREAD_BARRIER_SERIAL_THREAD +return value will +always be returned by the last thread to reach the barrier. .Sh RETURN VALUES If successful, both @@ -92,15 +101,6 @@ Otherwise, an error number will be returned to indicate the error. .Pp None of these functions will return .Er EINTR . -.Sh IMPLEMENTATION NOTES -In both -.Lb libpthread -and -.Lb libthr -the -.Dv PTHREAD_BARRIER_SERIAL_THREAD -return value will -always be returned by the last thread to reach the barrier. .Sh ERRORS The .Fn pthread_barrier_destroy diff --git a/share/man/man3/pthread_rwlock_destroy.3 b/share/man/man3/pthread_rwlock_destroy.3 index f44aea6..5d7eafa 100644 --- a/share/man/man3/pthread_rwlock_destroy.3 +++ b/share/man/man3/pthread_rwlock_destroy.3 @@ -49,13 +49,6 @@ If successful, the function will return zero. Otherwise an error number will be returned to indicate the error. -.Sh SEE ALSO -.Xr pthread_rwlock_init 3 -.Sh STANDARDS -The -.Fn pthread_rwlock_destroy -function is expected to conform to -.St -susv2 . .Sh ERRORS The .Fn pthread_rwlock_destroy @@ -78,6 +71,13 @@ The value specified by .Fa lock is invalid. .El +.Sh SEE ALSO +.Xr pthread_rwlock_init 3 +.Sh STANDARDS +The +.Fn pthread_rwlock_destroy +function is expected to conform to +.St -susv2 . .Sh HISTORY The .Fn pthread_rwlock_destroy diff --git a/share/man/man3/pthread_rwlock_init.3 b/share/man/man3/pthread_rwlock_init.3 index baee444..b4f8f7f 100644 --- a/share/man/man3/pthread_rwlock_init.3 +++ b/share/man/man3/pthread_rwlock_init.3 @@ -57,15 +57,6 @@ If successful, the function will return zero. Otherwise an error number will be returned to indicate the error. -.Sh SEE ALSO -.Xr pthread_rwlockattr_init 3 , -.Xr pthread_rwlockattr_setpshared 3 , -.Xr pthread_rwlock_destroy 3 -.Sh STANDARDS -The -.Fn pthread_rwlock_init -function is expected to conform to -.St -susv2 . .Sh ERRORS The .Fn pthread_rwlock_init @@ -95,6 +86,15 @@ The value specified by .Fa attr is invalid. .El +.Sh SEE ALSO +.Xr pthread_rwlockattr_init 3 , +.Xr pthread_rwlockattr_setpshared 3 , +.Xr pthread_rwlock_destroy 3 +.Sh STANDARDS +The +.Fn pthread_rwlock_init +function is expected to conform to +.St -susv2 . .Sh HISTORY The .Fn pthread_rwlock_init diff --git a/share/man/man3/pthread_rwlock_rdlock.3 b/share/man/man3/pthread_rwlock_rdlock.3 index 6b8affd..e4c0b73 100644 --- a/share/man/man3/pthread_rwlock_rdlock.3 +++ b/share/man/man3/pthread_rwlock_rdlock.3 @@ -77,18 +77,6 @@ and functions will return zero. Otherwise an error number will be returned to indicate the error. -.Sh SEE ALSO -.Xr pthread_rwlock_init 3 , -.Xr pthread_rwlock_trywrlock 3 , -.Xr pthread_rwlock_unlock 3 , -.Xr pthread_rwlock_wrlock 3 -.Sh STANDARDS -The -.Fn pthread_rwlock_rdlock -and -.Fn pthread_rwlock_tryrdlock -functions are expected to conform to -.St -susv2 . .Sh ERRORS The .Fn pthread_rwlock_tryrdlock @@ -122,6 +110,18 @@ is invalid. Insufficient memory exists to initialize the lock (applies to statically initialized locks only). .El +.Sh SEE ALSO +.Xr pthread_rwlock_init 3 , +.Xr pthread_rwlock_trywrlock 3 , +.Xr pthread_rwlock_unlock 3 , +.Xr pthread_rwlock_wrlock 3 +.Sh STANDARDS +The +.Fn pthread_rwlock_rdlock +and +.Fn pthread_rwlock_tryrdlock +functions are expected to conform to +.St -susv2 . .Sh HISTORY The .Fn pthread_rwlock_rdlock diff --git a/share/man/man3/pthread_rwlock_unlock.3 b/share/man/man3/pthread_rwlock_unlock.3 index 91ba9f0..652ad22 100644 --- a/share/man/man3/pthread_rwlock_unlock.3 +++ b/share/man/man3/pthread_rwlock_unlock.3 @@ -57,14 +57,6 @@ to indicate the error. The results are undefined if .Fa lock is not held by the calling thread. -.Sh SEE ALSO -.Xr pthread_rwlock_rdlock 3 , -.Xr pthread_rwlock_wrlock 3 -.Sh STANDARDS -The -.Fn pthread_rwlock_unlock -function is expected to conform to -.St -susv2 . .Sh ERRORS The .Fn pthread_rwlock_unlock @@ -77,6 +69,14 @@ is invalid. .It Bq Er EPERM The current thread does not own the read/write lock. .El +.Sh SEE ALSO +.Xr pthread_rwlock_rdlock 3 , +.Xr pthread_rwlock_wrlock 3 +.Sh STANDARDS +The +.Fn pthread_rwlock_unlock +function is expected to conform to +.St -susv2 . .Sh HISTORY The .Fn pthread_rwlock_unlock diff --git a/share/man/man3/pthread_rwlock_wrlock.3 b/share/man/man3/pthread_rwlock_wrlock.3 index 5349504..c4fa422 100644 --- a/share/man/man3/pthread_rwlock_wrlock.3 +++ b/share/man/man3/pthread_rwlock_wrlock.3 @@ -63,18 +63,6 @@ and functions will return zero. Otherwise an error number will be returned to indicate the error. -.Sh SEE ALSO -.Xr pthread_rwlock_init 3 , -.Xr pthread_rwlock_rdlock 3 , -.Xr pthread_rwlock_tryrdlock 3 , -.Xr pthread_rwlock_unlock 3 -.Sh STANDARDS -The -.Fn pthread_rwlock_wrlock -and -.Fn pthread_rwlock_trywrlock -functions are expected to conform to -.St -susv2 . .Sh ERRORS The .Fn pthread_rwlock_trywrlock @@ -101,6 +89,18 @@ is invalid. Insufficient memory exists to initialize the lock (applies to statically initialized locks only). .El +.Sh SEE ALSO +.Xr pthread_rwlock_init 3 , +.Xr pthread_rwlock_rdlock 3 , +.Xr pthread_rwlock_tryrdlock 3 , +.Xr pthread_rwlock_unlock 3 +.Sh STANDARDS +The +.Fn pthread_rwlock_wrlock +and +.Fn pthread_rwlock_trywrlock +functions are expected to conform to +.St -susv2 . .Sh HISTORY The .Fn pthread_rwlock_wrlock diff --git a/share/man/man3/pthread_rwlockattr_destroy.3 b/share/man/man3/pthread_rwlockattr_destroy.3 index 8ccc219..f798939 100644 --- a/share/man/man3/pthread_rwlockattr_destroy.3 +++ b/share/man/man3/pthread_rwlockattr_destroy.3 @@ -50,13 +50,6 @@ If successful, the function will return zero. Otherwise an error number will be returned to indicate the error. -.Sh SEE ALSO -.Xr pthread_rwlockattr_init 3 -.Sh STANDARDS -The -.Fn pthread_rwlockattr_destroy -function is expected to conform to -.St -susv2 . .Sh ERRORS The .Fn pthread_rwlockattr_destroy @@ -67,6 +60,13 @@ The value specified by .Fa attr is invalid. .El +.Sh SEE ALSO +.Xr pthread_rwlockattr_init 3 +.Sh STANDARDS +The +.Fn pthread_rwlockattr_destroy +function is expected to conform to +.St -susv2 . .Sh HISTORY The .Fn pthread_rwlockattr_destroy diff --git a/share/man/man3/pthread_rwlockattr_getpshared.3 b/share/man/man3/pthread_rwlockattr_getpshared.3 index acda6e9..f23406c 100644 --- a/share/man/man3/pthread_rwlockattr_getpshared.3 +++ b/share/man/man3/pthread_rwlockattr_getpshared.3 @@ -62,15 +62,6 @@ If successful, the function will return zero. Otherwise an error number will be returned to indicate the error. -.Sh SEE ALSO -.Xr pthread_rwlockattr_init 3 , -.Xr pthread_rwlockattr_setpshared 3 , -.Xr pthread_rwlock_init 3 -.Sh STANDARDS -The -.Fn pthread_rwlockattr_getpshared -function is expected to conform to -.St -susv2 . .Sh ERRORS The .Fn pthread_rwlockattr_getpshared @@ -81,6 +72,15 @@ The value specified by .Fa attr is invalid. .El +.Sh SEE ALSO +.Xr pthread_rwlockattr_init 3 , +.Xr pthread_rwlockattr_setpshared 3 , +.Xr pthread_rwlock_init 3 +.Sh STANDARDS +The +.Fn pthread_rwlockattr_getpshared +function is expected to conform to +.St -susv2 . .Sh HISTORY The .Fn pthread_rwlockattr_getpshared diff --git a/share/man/man3/pthread_rwlockattr_init.3 b/share/man/man3/pthread_rwlockattr_init.3 index 0020386..8869993 100644 --- a/share/man/man3/pthread_rwlockattr_init.3 +++ b/share/man/man3/pthread_rwlockattr_init.3 @@ -48,6 +48,14 @@ If successful, the function will return zero. Otherwise an error number will be returned to indicate the error. +.Sh ERRORS +The +.Fn pthread_rwlockattr_init +function will fail if: +.Bl -tag -width Er +.It Bq Er ENOMEM +Insufficient memory exists to initialize the attribute object. +.El .Sh SEE ALSO .Xr pthread_rwlockattr_destroy 3 , .Xr pthread_rwlockattr_getpshared 3 , @@ -58,14 +66,6 @@ The .Fn pthread_rwlockattr_init function is expected to conform to .St -susv2 . -.Sh ERRORS -The -.Fn pthread_rwlockattr_init -function will fail if: -.Bl -tag -width Er -.It Bq Er ENOMEM -Insufficient memory exists to initialize the attribute object. -.El .Sh HISTORY The .Fn pthread_rwlockattr_init diff --git a/share/man/man3/pthread_rwlockattr_setpshared.3 b/share/man/man3/pthread_rwlockattr_setpshared.3 index b4d2ecb..a8e99b3 100644 --- a/share/man/man3/pthread_rwlockattr_setpshared.3 +++ b/share/man/man3/pthread_rwlockattr_setpshared.3 @@ -64,15 +64,6 @@ If successful, the function will return zero. Otherwise an error number will be returned to indicate the error. -.Sh SEE ALSO -.Xr pthread_rwlockattr_getpshared 3 , -.Xr pthread_rwlockattr_init 3 , -.Xr pthread_rwlock_init 3 -.Sh STANDARDS -The -.Fn pthread_rwlockattr_setpshared -function is expected to conform to -.St -susv2 . .Sh ERRORS The .Fn pthread_rwlockattr_setpshared @@ -85,6 +76,15 @@ or .Fa pshared is invalid. .El +.Sh SEE ALSO +.Xr pthread_rwlockattr_getpshared 3 , +.Xr pthread_rwlockattr_init 3 , +.Xr pthread_rwlock_init 3 +.Sh STANDARDS +The +.Fn pthread_rwlockattr_setpshared +function is expected to conform to +.St -susv2 . .Sh HISTORY The .Fn pthread_rwlockattr_setpshared diff --git a/share/man/man3/stdarg.3 b/share/man/man3/stdarg.3 index 7f29f2a..92a26f7 100644 --- a/share/man/man3/stdarg.3 +++ b/share/man/man3/stdarg.3 @@ -196,6 +196,13 @@ void foo(char *fmt, ...) va_end(ap); } .Ed +.Sh COMPATIBILITY +These macros are +.Em not +compatible with the historic macros they replace. +A backward compatible version can be found in the include +file +.In varargs.h . .Sh STANDARDS The .Fn va_start , @@ -205,13 +212,6 @@ and .Fn va_end macros conform to .St -isoC-99 . -.Sh COMPATIBILITY -These macros are -.Em not -compatible with the historic macros they replace. -A backward compatible version can be found in the include -file -.In varargs.h . .Sh BUGS Unlike the .Em varargs diff --git a/share/man/man4/adv.4 b/share/man/man4/adv.4 index 5c2a543..cb043a0 100644 --- a/share/man/man4/adv.4 +++ b/share/man/man4/adv.4 @@ -224,6 +224,11 @@ RATOC REX-PCI30 (PC-98) .Xr da 4 , .Xr sa 4 , .Xr scsi 4 +.Sh HISTORY +The +.Nm +driver appeared in +.Fx 3.0 . .Sh AUTHORS .An -nosplit The @@ -237,8 +242,3 @@ of Advanced System Products, Inc. Many thanks to AdvanSys for providing the original driver under a suitable license for use in .Fx . -.Sh HISTORY -The -.Nm -driver appeared in -.Fx 3.0 . diff --git a/share/man/man4/adw.4 b/share/man/man4/adw.4 index 79d305c..ca13661 100644 --- a/share/man/man4/adw.4 +++ b/share/man/man4/adw.4 @@ -82,6 +82,11 @@ AdvanSys ABP3950U2W .Xr da 4 , .Xr sa 4 , .Xr scsi 4 +.Sh HISTORY +The +.Nm +driver appeared in +.Fx 3.0 . .Sh AUTHORS .An -nosplit The @@ -94,8 +99,3 @@ of Advanced System Products, Inc. Many thanks to AdvanSys for providing the original driver under a suitable license for use in .Fx . -.Sh HISTORY -The -.Nm -driver appeared in -.Fx 3.0 . diff --git a/share/man/man4/aha.4 b/share/man/man4/aha.4 index 5ea060b..e260707 100644 --- a/share/man/man4/aha.4 +++ b/share/man/man4/aha.4 @@ -89,18 +89,6 @@ DTC 3290 SCSI controller in 1542 emulation mode .It Tekram SCSI controllers in 154x emulation mode .El -.Sh BUGS -The AHA-154xA card does not support residuals on data transfers. -As a result, this card is no longer supported. -.Pp -There have been some reports that the AHA-154xB does not work well -under heavy load. -.Pp -The AHA-154xCP is a plug and play controller. -However, its resources are set using the on-board BIOS and cannot be -moved. -Failures to attached for this card are often caused when the resources -set in the BIOS conflict. .Sh SEE ALSO .Xr ahb 4 , .Xr ahc 4 , @@ -122,3 +110,15 @@ from the .Nm bt driver written by .An Justin T. Gibbs . +.Sh BUGS +The AHA-154xA card does not support residuals on data transfers. +As a result, this card is no longer supported. +.Pp +There have been some reports that the AHA-154xB does not work well +under heavy load. +.Pp +The AHA-154xCP is a plug and play controller. +However, its resources are set using the on-board BIOS and cannot be +moved. +Failures to attached for this card are often caused when the resources +set in the BIOS conflict. diff --git a/share/man/man4/ahc.4 b/share/man/man4/ahc.4 index 9213dc0..6453c80 100644 --- a/share/man/man4/ahc.4 +++ b/share/man/man4/ahc.4 @@ -388,6 +388,26 @@ Since the local SCB space serves as a cache for disconnected transactions, the more SCB space available, the less host bus traffic consumed saving and restoring SCB data. +.Sh SEE ALSO +.Xr aha 4 , +.Xr ahb 4 , +.Xr cd 4 , +.Xr da 4 , +.Xr sa 4 , +.Xr scsi 4 +.Sh HISTORY +The +.Nm +driver appeared in +.Fx 2.0 . +.Sh AUTHORS +The +.Nm +driver, the +.Tn AIC7xxx +sequencer-code assembler, +and the firmware running on the aic7xxx chips was written by +.An Justin T. Gibbs . .Sh BUGS Some Quantum drives (at least the Empire 2100 and 1080s) will not run on an .Tn AIC7870 @@ -412,23 +432,3 @@ voltage differential boards as shipped by Adaptec. Information on how to modify HVD board to work correctly in target mode is available from Adaptec. -.Sh SEE ALSO -.Xr aha 4 , -.Xr ahb 4 , -.Xr cd 4 , -.Xr da 4 , -.Xr sa 4 , -.Xr scsi 4 -.Sh AUTHORS -The -.Nm -driver, the -.Tn AIC7xxx -sequencer-code assembler, -and the firmware running on the aic7xxx chips was written by -.An Justin T. Gibbs . -.Sh HISTORY -The -.Nm -driver appeared in -.Fx 2.0 . diff --git a/share/man/man4/ahd.4 b/share/man/man4/ahd.4 index 03c9452..260036b 100644 --- a/share/man/man4/ahd.4 +++ b/share/man/man4/ahd.4 @@ -153,16 +153,17 @@ Many motherboards with on-board .Tn SCSI support .El -.Sh BUGS -The current generation of 79xx chips do not support target mode in Ultra320 -mode. -Target mode in general has not been well tested in this driver. .Sh SEE ALSO .Xr ahc 4 , .Xr cd 4 , .Xr da 4 , .Xr sa 4 , .Xr scsi 4 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 4.7 . .Sh AUTHORS The .Nm @@ -174,8 +175,7 @@ and the firmware running on the aic79xx chips was written by This manual page is based on the .Xr ahc 4 manual page. -.Sh HISTORY -The -.Nm -driver first appeared in -.Fx 4.7 . +.Sh BUGS +The current generation of 79xx chips do not support target mode in Ultra320 +mode. +Target mode in general has not been well tested in this driver. diff --git a/share/man/man4/bktr.4 b/share/man/man4/bktr.4 index 6f30948..ddb2fd3 100644 --- a/share/man/man4/bktr.4 +++ b/share/man/man4/bktr.4 @@ -189,16 +189,6 @@ Video Highway XTreme .It VideoLogic Captivator PCI .El -.Sh AUTHORS -.An -nosplit -This driver is based on the work of -.An Jim Lowe Aq james@miller.cs.uwm.edu , -.An Mark Tinguely Aq tinguely@plains.nodak.edu , -.An Amancio Hasty Aq hasty@star-gate.com , -.An Roger Hardiman Aq roger@FreeBSD.org -and a bunch of other people. -Support for Pinnacle PCTV Rave cards was added by -.An Branko Lankester Aq branko@euro.net . .Sh FILES .Bl -tag -width /usr/share/examples/meteor -compact .It Pa /usr/share/examples/meteor @@ -234,3 +224,13 @@ The .Nm driver first appeared in .Fx 2.2 . +.Sh AUTHORS +.An -nosplit +This driver is based on the work of +.An Jim Lowe Aq james@miller.cs.uwm.edu , +.An Mark Tinguely Aq tinguely@plains.nodak.edu , +.An Amancio Hasty Aq hasty@star-gate.com , +.An Roger Hardiman Aq roger@FreeBSD.org +and a bunch of other people. +Support for Pinnacle PCTV Rave cards was added by +.An Branko Lankester Aq branko@euro.net . diff --git a/share/man/man4/blackhole.4 b/share/man/man4/blackhole.4 index 1f0e3db..7b86682 100644 --- a/share/man/man4/blackhole.4 +++ b/share/man/man4/blackhole.4 @@ -73,11 +73,11 @@ It should be used together with other security mechanisms. .Xr udp 4 , .Xr ipfw 8 , .Xr sysctl 8 -.Sh AUTHORS -.An Geoffrey M. Rehmet .Sh HISTORY The TCP and UDP .Nm MIBs first appeared in .Fx 4.0 . +.Sh AUTHORS +.An Geoffrey M. Rehmet diff --git a/share/man/man4/bpf.4 b/share/man/man4/bpf.4 index f1b1311..58eb6be 100644 --- a/share/man/man4/bpf.4 +++ b/share/man/man4/bpf.4 @@ -605,6 +605,11 @@ array initializers: .Fn BPF_STMT opcode operand and .Fn BPF_JUMP opcode operand true_offset false_offset . +.Sh FILES +.Bl -tag -compact -width /dev/bpfXXX +.It Pa /dev/bpf Ns Sy n +the packet filter device +.El .Sh EXAMPLES The following filter is taken from the Reverse ARP Daemon. It accepts only Reverse ARP requests. @@ -673,33 +678,6 @@ struct bpf_insn insns[] = { .%A Jacobson V. .%T "An efficient, extensible, and portable network monitor" .Re -.Sh FILES -.Bl -tag -compact -width /dev/bpfXXX -.It Pa /dev/bpf Ns Sy n -the packet filter device -.El -.Sh BUGS -The read buffer must be of a fixed size (returned by the -.Dv BIOCGBLEN -ioctl). -.Pp -A file that does not request promiscuous mode may receive promiscuously -received packets as a side effect of another file requesting this -mode on the same hardware interface. -This could be fixed in the kernel with additional processing overhead. -However, we favor the model where -all files must assume that the interface is promiscuous, and if -so desired, must utilize a filter to reject foreign packets. -.Pp -Data link protocols with variable length headers are not currently supported. -.Pp -The -.Dv SEESENT -flag has been observed to work incorrectly on some interface -types, including those with hardware loopback rather than software loopback, -and point-to-point interfaces. -It appears to function correctly on a -broad range of Ethernet-style interfaces. .Sh HISTORY The Enet packet filter was created in 1980 by Mike Accetta and Rick Rashid at Carnegie-Mellon University. @@ -724,3 +702,25 @@ of Lawrence Berkeley Laboratory, implemented BPF in Summer 1990. Much of the design is due to .An Van Jacobson . +.Sh BUGS +The read buffer must be of a fixed size (returned by the +.Dv BIOCGBLEN +ioctl). +.Pp +A file that does not request promiscuous mode may receive promiscuously +received packets as a side effect of another file requesting this +mode on the same hardware interface. +This could be fixed in the kernel with additional processing overhead. +However, we favor the model where +all files must assume that the interface is promiscuous, and if +so desired, must utilize a filter to reject foreign packets. +.Pp +Data link protocols with variable length headers are not currently supported. +.Pp +The +.Dv SEESENT +flag has been observed to work incorrectly on some interface +types, including those with hardware loopback rather than software loopback, +and point-to-point interfaces. +It appears to function correctly on a +broad range of Ethernet-style interfaces. diff --git a/share/man/man4/bridge.4 b/share/man/man4/bridge.4 index 1098f2e..98b882d 100644 --- a/share/man/man4/bridge.4 +++ b/share/man/man4/bridge.4 @@ -140,6 +140,12 @@ do not support this functionality. Also, bridging is not compatible with interfaces which use hardware loopback, because there is no way to tell locally generated packets from externally generated ones. +.Sh FILES +.Bl -tag -width ".Pa /boot/kernel/bridge.ko" -compact +.It Pa /boot/kernel/bridge.ko +.Nm +loadable module. +.El .Sh EXAMPLES A simple .Nm @@ -200,6 +206,18 @@ is performed by the devices. When using VLAN devices, care must be taken by not creating loops between these devices and their parent interfaces. +.Sh SEE ALSO +.Xr ip 4 , +.Xr ng_bridge 4 , +.Xr vlan 4 , +.Xr ipf 8 , +.Xr ipfw 8 , +.Xr sysctl 8 +.Sh HISTORY +Bridging was introduced in +.Fx 2.2.8 +by +.An Luigi Rizzo Aq luigi@iet.unipi.it . .Sh BUGS Care must be taken not to construct loops in the .Nm @@ -232,21 +250,3 @@ It might be useful to have a rule of the form .Pp near the beginning of your ruleset to implement specific rulesets for bridged packets. -.Sh FILES -.Bl -tag -width ".Pa /boot/kernel/bridge.ko" -compact -.It Pa /boot/kernel/bridge.ko -.Nm -loadable module. -.El -.Sh SEE ALSO -.Xr ip 4 , -.Xr ng_bridge 4 , -.Xr vlan 4 , -.Xr ipf 8 , -.Xr ipfw 8 , -.Xr sysctl 8 -.Sh HISTORY -Bridging was introduced in -.Fx 2.2.8 -by -.An Luigi Rizzo Aq luigi@iet.unipi.it . diff --git a/share/man/man4/bt.4 b/share/man/man4/bt.4 index 6a2c33f..295837b0 100644 --- a/share/man/man4/bt.4 +++ b/share/man/man4/bt.4 @@ -168,11 +168,30 @@ AMI FastDisk Host Adapters that are true BusLogic MultiMaster clones are also supported by the .Nm driver. +.Sh FILES +.Bl -tag -width /usr/share/man0/template.doc -compact +.It Pa sys/dev/buslogic/bt.c +Core Driver Implementation +.It Pa sys/dev/buslogic/btreg.h +MultiMaster Register Set and Core Driver Data Structures +.It Pa sys/pci/bt_pci.c +PCI Bus Driver Attachment +.It Pa sys/i386/eisa/bt_eisa.c +EISA Bus Driver Attachment +.It Pa sys/i386/isa/bt_isa.c +ISA/VL Bus Driver Attachment +.El .Sh SEE ALSO .Xr cd 4 , .Xr da 4 , .Xr sa 4 , .Xr scsi 4 +.Sh HISTORY +The +.Nm +driver first appeared in the +.Bx 386 +patch kit. .Sh AUTHORS .An -nosplit .An Julian Elischer @@ -191,22 +210,3 @@ 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. -.Sh FILES -.Bl -tag -width /usr/share/man0/template.doc -compact -.It Pa sys/dev/buslogic/bt.c -Core Driver Implementation -.It Pa sys/dev/buslogic/btreg.h -MultiMaster Register Set and Core Driver Data Structures -.It Pa sys/pci/bt_pci.c -PCI Bus Driver Attachment -.It Pa sys/i386/eisa/bt_eisa.c -EISA Bus Driver Attachment -.It Pa sys/i386/isa/bt_isa.c -ISA/VL Bus Driver Attachment -.El -.Sh HISTORY -The -.Nm -driver first appeared in the -.Bx 386 -patch kit. diff --git a/share/man/man4/ccd.4 b/share/man/man4/ccd.4 index 0f65ea6..4ff4002 100644 --- a/share/man/man4/ccd.4 +++ b/share/man/man4/ccd.4 @@ -198,9 +198,6 @@ disk usually destroys whatever data previously existed on that disk. .Nm device special files .El -.Sh HISTORY -The concatenated disk driver was originally written at the University of -Utah. .Sh SEE ALSO .Xr dd 1 , .Xr ccdconfig 8 , @@ -210,3 +207,6 @@ Utah. .Xr mount 8 , .Xr newfs 8 , .Xr vinum 8 +.Sh HISTORY +The concatenated disk driver was originally written at the University of +Utah. diff --git a/share/man/man4/cd.4 b/share/man/man4/cd.4 index 7898e71..19113b7 100644 --- a/share/man/man4/cd.4 +++ b/share/man/man4/cd.4 @@ -481,6 +481,18 @@ None. .Xr disklabel 5 , .Xr disklabel 8 , .Xr cd 9 +.Sh HISTORY +This +.Nm +driver is based upon the +.Nm +driver written by Julian Elischer, which appeared in +.Bx 386 0.1 . +The +CAM version of the +.Nm +driver was written by Kenneth Merry and first appeared in +.Fx 3.0 . .Sh BUGS The names of the structures used for the third argument to .Fn ioctl @@ -506,15 +518,3 @@ require modification of to support the two timeouts when hardwiring .Nm devices. -.Sh HISTORY -This -.Nm -driver is based upon the -.Nm -driver written by Julian Elischer, which appeared in -.Bx 386 0.1 . -The -CAM version of the -.Nm -driver was written by Kenneth Merry and first appeared in -.Fx 3.0 . diff --git a/share/man/man4/ch.4 b/share/man/man4/ch.4 index 48db43c..5891fd1 100644 --- a/share/man/man4/ch.4 +++ b/share/man/man4/ch.4 @@ -316,21 +316,6 @@ driver supports are not thoroughly tested due to the fact that the devices available for testing do not support the necessary commands. This is true for alternate volume tags, media flipping, import/export element handling, multiple picker operation and other things. -.Sh AUTHORS -.An -nosplit -The -.Nm -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 -.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 -.An Hans Huebner Aq hans@artcom.de . .Sh FILES .Bl -tag -width /dev/ch[0-9] -compact .It Pa /dev/ch[0-9] @@ -351,3 +336,18 @@ The .Nm driver appeared in .Bx 386 0.1 . +.Sh AUTHORS +.An -nosplit +The +.Nm +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 +.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 +.An Hans Huebner Aq hans@artcom.de . diff --git a/share/man/man4/dcons.4 b/share/man/man4/dcons.4 index 3353cfc..c97840c 100644 --- a/share/man/man4/dcons.4 +++ b/share/man/man4/dcons.4 @@ -52,6 +52,11 @@ for interaction. The buffer consists of 4 channels. There are 2 ports, one for the console TTY and another is GDB port, then each port has an input channel and an output channel. +.Sh FILES +.Bl -tag -width indent -compact +.It Pa /dev/dcons +.It Pa /etc/ttys +.El .Sh EXAMPLES If you want to run .Xr getty 8 @@ -80,11 +85,6 @@ application. See .Xr dconschat 8 for more details. -.Sh FILES -.Bl -tag -width indent -compact -.It Pa /dev/dcons -.It Pa /etc/ttys -.El .Sh SEE ALSO .Xr dcons_crom 4 , .Xr ddb 4 , diff --git a/share/man/man4/divert.4 b/share/man/man4/divert.4 index 7cd8102..0180ef3 100644 --- a/share/man/man4/divert.4 +++ b/share/man/man4/divert.4 @@ -164,6 +164,9 @@ that was not associated with any interface. .Xr sendto 2 , .Xr socket 2 , .Xr ipfw 8 +.Sh AUTHORS +.An Archie Cobbs Aq archie@FreeBSD.org , +Whistle Communications Corp. .Sh BUGS This is an attempt to provide a clean way for user mode processes to implement various IP tricks like address translation, but it @@ -177,6 +180,3 @@ packet destined for another machine don't get routed through the local machine, the packet is lost. This should probably be a settable socket option in any case. -.Sh AUTHORS -.An Archie Cobbs Aq archie@FreeBSD.org , -Whistle Communications Corp. diff --git a/share/man/man4/dpt.4 b/share/man/man4/dpt.4 index 01b3f22..c5f1d18 100644 --- a/share/man/man4/dpt.4 +++ b/share/man/man4/dpt.4 @@ -94,6 +94,11 @@ EISA Bus Driver Attachment .Xr da 4 , .Xr sa 4 , .Xr scsi 4 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 2.2.6 . .Sh AUTHORS .An -nosplit The @@ -102,8 +107,3 @@ driver was written by .An Simon Shapiro and ported to the CAM SCSI system by .An Justin T. Gibbs . -.Sh HISTORY -The -.Nm -driver first appeared in -.Fx 2.2.6 . diff --git a/share/man/man4/ed.4 b/share/man/man4/ed.4 index 90289b2..4c89d9d 100644 --- a/share/man/man4/ed.4 +++ b/share/man/man4/ed.4 @@ -323,13 +323,6 @@ work in 8bit mode, much higher performance can be achieved by specifying In addition, you should also specify .Cd "iosiz 16384" to take advantage of the extra 8K of shared memory that 16bit mode provides. -.Sh BUGS -The -.Nm -driver is a bit too aggressive about resetting the card whenever any bad -packets are received. -As a result, it may throw out some good packets which -have been received but not yet transferred from the card to main memory. .Sh SEE ALSO .Xr arp 4 , .Xr miibus 4 , @@ -346,3 +339,10 @@ The .Nm device driver and this manual page were written by .An David Greenman . +.Sh BUGS +The +.Nm +driver is a bit too aggressive about resetting the card whenever any bad +packets are received. +As a result, it may throw out some good packets which +have been received but not yet transferred from the card to main memory. diff --git a/share/man/man4/fast_ipsec.4 b/share/man/man4/fast_ipsec.4 index 38c75e9..503ef60 100644 --- a/share/man/man4/fast_ipsec.4 +++ b/share/man/man4/fast_ipsec.4 @@ -80,19 +80,6 @@ To selectively enable/disable protocols, use .Xr sysctl 8 . .Sh DIAGNOSTICS To be added. -.Sh BUGS -There is presently no support for IPv6. -.Pp -The -.Tn IPcomp -protocol support does not work. -.Pp -Certain legacy authentication algorithms are not supported because of -issues with the -.Xr crypto 4 -subsystem. -.Pp -This documentation is incomplete. .Sh SEE ALSO .Xr crypto 4 , .Xr ipsec 4 , @@ -114,3 +101,16 @@ The .Nm protocols first appeared in .Fx 5.0 . +.Sh BUGS +There is presently no support for IPv6. +.Pp +The +.Tn IPcomp +protocol support does not work. +.Pp +Certain legacy authentication algorithms are not supported because of +issues with the +.Xr crypto 4 +subsystem. +.Pp +This documentation is incomplete. diff --git a/share/man/man4/fatm.4 b/share/man/man4/fatm.4 index 6e7448f..51dc6fc 100644 --- a/share/man/man4/fatm.4 +++ b/share/man/man4/fatm.4 @@ -102,6 +102,8 @@ fatm0: <FORE PCA200E> mem 0xd5800000-0xd59fffff irq 9 at device 9.0 on pci0 .Xr natm 4 , .Xr natmip 4 , .Xr utopia 4 +.Sh AUTHORS +.An Harti Brandt Aq harti@FreeBSD.org .Sh BUGS These cards can CBR shape a single VCC only. It is currently possible to @@ -111,5 +113,3 @@ wrong. See .Xr hatm 4 for a better card. -.Sh AUTHORS -.An Harti Brandt Aq harti@FreeBSD.org diff --git a/share/man/man4/fwe.4 b/share/man/man4/fwe.4 index 24c5ce6..9c01dcf 100644 --- a/share/man/man4/fwe.4 +++ b/share/man/man4/fwe.4 @@ -61,16 +61,6 @@ This driver supports as well if it is compiled with the .Dv DEVICE_POLLING option. -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 5.0 . -.Sh BUGS -This driver emulates Ethernet in a very adhoc way and it does not reserve a -stream channel using an isochronous manager. -Note that this driver uses a protocol which is very different from RFC 2734 -(IPv4 over IEEE 1394). .Sh SEE ALSO .Xr arp 4 , .Xr firewire 4 , @@ -82,8 +72,18 @@ Note that this driver uses a protocol which is very different from RFC 2734 .Xr ifconfig 8 , .Xr kldload 8 , .Xr sysctl 8 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 5.0 . .Sh AUTHORS The .Nm driver and this manual page were written by .An Hidetoshi Shimokawa . +.Sh BUGS +This driver emulates Ethernet in a very adhoc way and it does not reserve a +stream channel using an isochronous manager. +Note that this driver uses a protocol which is very different from RFC 2734 +(IPv4 over IEEE 1394). diff --git a/share/man/man4/fwip.4 b/share/man/man4/fwip.4 index 64fdc7d..8bf2dec 100644 --- a/share/man/man4/fwip.4 +++ b/share/man/man4/fwip.4 @@ -57,16 +57,6 @@ This driver supports as well if it is compiled with the .Dv DEVICE_POLLING option. -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 5.3 . -.Sh BUGS -This driver currently does not support the MCAP protocol for multicast -IP over FireWire. -Multicast packets are treated as broadcast packets which is sufficient -for most trivial uses of multicast. .Sh SEE ALSO .Xr arp 4 , .Xr firewire 4 , @@ -77,6 +67,11 @@ for most trivial uses of multicast. .Xr ifconfig 8 , .Xr kldload 8 , .Xr sysctl 8 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 5.3 . .Sh AUTHORS .An -nosplit The @@ -85,3 +80,8 @@ driver and this manual page were written by .An Doug Rabson , based on earlier work by .An Hidetoshi Shimokawa . +.Sh BUGS +This driver currently does not support the MCAP protocol for multicast +IP over FireWire. +Multicast packets are treated as broadcast packets which is sufficient +for most trivial uses of multicast. diff --git a/share/man/man4/gdb.4 b/share/man/man4/gdb.4 index 8f7b45b..6fdc03c 100644 --- a/share/man/man4/gdb.4 +++ b/share/man/man4/gdb.4 @@ -576,9 +576,6 @@ This command is that answer. It does nothing else except to print a warning message to remind you to remove it again. .El -.Sh AUTHORS -This man page was written by -.An "Greg Lehey" Aq grog@FreeBSD.org . .Sh SEE ALSO .Xr gdb 1 , .Xr ps 1 , @@ -588,6 +585,9 @@ This man page was written by .Xr dmesg 8 , .Xr fwcontrol 8 , .Xr kldload 8 +.Sh AUTHORS +This man page was written by +.An "Greg Lehey" Aq grog@FreeBSD.org . .Sh BUGS The .Xr gdb 1 diff --git a/share/man/man4/hatm.4 b/share/man/man4/hatm.4 index df85456..f9b7e70 100644 --- a/share/man/man4/hatm.4 +++ b/share/man/man4/hatm.4 @@ -129,11 +129,6 @@ and .Cm unassigned (see .Xr utopia 4 ) . -.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 ENVIRONMENT When attaching to a device the driver checks the kernel environment (see @@ -272,6 +267,11 @@ 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 , diff --git a/share/man/man4/hifn.4 b/share/man/man4/hifn.4 index 7a0b407..0f7ee95 100644 --- a/share/man/man4/hifn.4 +++ b/share/man/man4/hifn.4 @@ -94,13 +94,6 @@ See .Pa http://www.soekris.com/ . Contains a 7955 and supports symmetric and random number operations. .El -.Sh BUGS -The 7751 chip starts out at initialization by only supporting compression. -A proprietary algorithm, which has been reverse engineered, is required to -unlock the cryptographic functionality of the chip. -It is possible for vendors to make boards which have a lock ID not known -to the driver, but all vendors currently just use the obvious ID which is -13 bytes of 0. .Sh SEE ALSO .Xr crypt 3 , .Xr crypto 4 , @@ -126,3 +119,10 @@ The .Nm device driver was imported to .Fx 5.0 . +.Sh BUGS +The 7751 chip starts out at initialization by only supporting compression. +A proprietary algorithm, which has been reverse engineered, is required to +unlock the cryptographic functionality of the chip. +It is possible for vendors to make boards which have a lock ID not known +to the driver, but all vendors currently just use the obvious ID which is +13 bytes of 0. diff --git a/share/man/man4/hptmv.4 b/share/man/man4/hptmv.4 index b222950..956e3be 100644 --- a/share/man/man4/hptmv.4 +++ b/share/man/man4/hptmv.4 @@ -54,11 +54,6 @@ The .Nm driver only works on the i386 platform as it requires a binary blob object from the manufacturer which they only supply for the i386 platform. -.Sh BUGS -The -.Nm -driver does not support manipulating the RAID from the OS, RAIDs need -to be set up from the on-board BIOS. .Sh SEE ALSO .Xr kld 4 , .Xr kldload 8 , @@ -80,3 +75,8 @@ by .An Scott Long . This manual page was written by .An David E. O'Brien . +.Sh BUGS +The +.Nm +driver does not support manipulating the RAID from the OS, RAIDs need +to be set up from the on-board BIOS. diff --git a/share/man/man4/ifmib.4 b/share/man/man4/ifmib.4 index e1c69b6..3cffbea 100644 --- a/share/man/man4/ifmib.4 +++ b/share/man/man4/ifmib.4 @@ -182,6 +182,11 @@ the structure is a .%D August 1994 .%O RFC 1650 .Re +.Sh HISTORY +The +.Nm +interface first appeared in +.Fx 2.2 . .Sh BUGS Many Ethernet-like interfaces do not yet support the Ethernet MIB; the interfaces known to support it include @@ -189,8 +194,3 @@ the interfaces known to support it include and .Xr de 4 . Regardless, all interfaces automatically support the generic MIB. -.Sh HISTORY -The -.Nm -interface first appeared in -.Fx 2.2 . diff --git a/share/man/man4/isp.4 b/share/man/man4/isp.4 index 3b88253..1f7a4d4 100644 --- a/share/man/man4/isp.4 +++ b/share/man/man4/isp.4 @@ -172,6 +172,16 @@ This is a driver debug level- meaningful from 0 through 7. This is a driver target mode debug level- meaningful from 0 through 5. .El +.Sh SEE ALSO +.Xr da 4 , +.Xr intro 4 , +.Xr ispfw 4 , +.Xr sa 4 , +.Xr scsi 4 +.Sh AUTHORS +The +.Nm +driver was written by Matthew Jacob for NASA/Ames Research Center. .Sh BUGS The driver currently ignores some NVRAM settings. .Pp @@ -192,13 +202,3 @@ To unwedge the system, unplug and replug the fibre channel connection, or otherwise cause a LIP (Loop Initialization Primitive sequence)- this will kick the f/w into getting unstuck. -.Sh SEE ALSO -.Xr da 4 , -.Xr intro 4 , -.Xr ispfw 4 , -.Xr sa 4 , -.Xr scsi 4 -.Sh AUTHORS -The -.Nm -driver was written by Matthew Jacob for NASA/Ames Research Center. diff --git a/share/man/man4/joy.4 b/share/man/man4/joy.4 index d645593..cee2dae 100644 --- a/share/man/man4/joy.4 +++ b/share/man/man4/joy.4 @@ -101,8 +101,8 @@ Time = 24.2e-6s + 0.011e-6s * R/Ohms .It Pa /dev/joy? joystick device files .El -.Sh AUTHORS -.An Jean-Marc Zucconi Aq jmz@cabri.obs-besancon.fr .Sh HISTORY The joystick driver appeared in .Fx 2.0.5 . +.Sh AUTHORS +.An Jean-Marc Zucconi Aq jmz@cabri.obs-besancon.fr diff --git a/share/man/man4/kld.4 b/share/man/man4/kld.4 index 3601ca2..58b08d5 100644 --- a/share/man/man4/kld.4 +++ b/share/man/man4/kld.4 @@ -131,6 +131,22 @@ example source code implementing a sample kld module .Xr kldstat 8 , .Xr kldunload 8 , .Xr sysctl 8 +.Sh HISTORY +The +.Nm +facility appeared in +.Fx 3.0 +and was designed as a replacement for the +.Xr lkm 4 +facility, which was similar in functionality to the loadable kernel modules +facility provided by +.Tn SunOS +4.1.3. +.Sh AUTHORS +The +.Nm +facility was originally implemented by +.An Doug Rabson Aq dfr@FreeBSD.org . .Sh BUGS If a module B, is dependent on another module A, but is not compiled with module A as a dependency, then @@ -157,19 +173,3 @@ for any error encountered while loading a module. When system internal interfaces change, old modules often cannot detect this, and such modules when loaded will often cause crashes or mysterious failures. -.Sh HISTORY -The -.Nm -facility appeared in -.Fx 3.0 -and was designed as a replacement for the -.Xr lkm 4 -facility, which was similar in functionality to the loadable kernel modules -facility provided by -.Tn SunOS -4.1.3. -.Sh AUTHORS -The -.Nm -facility was originally implemented by -.An Doug Rabson Aq dfr@FreeBSD.org . diff --git a/share/man/man4/led.4 b/share/man/man4/led.4 index c60230d..a2b2b58 100644 --- a/share/man/man4/led.4 +++ b/share/man/man4/led.4 @@ -145,6 +145,10 @@ becomes .El .Pp The sequence is repeated after a one second pause. +.Sh FILES +.Bl -tag -width ".Pa /dev/led/*" +.It Pa /dev/led/* +.El .Sh EXAMPLES A .Sq Li d12 @@ -161,10 +165,6 @@ flashes .Bd -literal /usr/games/morse -l "Soekris rocks" > /dev/led/error .Ed -.Sh FILES -.Bl -tag -width ".Pa /dev/led/*" -.It Pa /dev/led/* -.El .Sh SEE ALSO .Xr morse 6 .Sh HISTORY diff --git a/share/man/man4/lpt.4 b/share/man/man4/lpt.4 index 121fda2..3856652 100644 --- a/share/man/man4/lpt.4 +++ b/share/man/man4/lpt.4 @@ -75,6 +75,11 @@ In order to retrieve printer info from /dev/lpt0, just apply the command to the device. If the printer supports IEEE1284 nibble mode and has data to send to the host, you'll get it. +.Sh FILES +.Bl -tag -width Pa -compact +.It Pa /dev/lpt0 +first parallel port driver +.El .Sh SEE ALSO .Xr ppbus 4 , .Xr ppc 4 , @@ -82,11 +87,6 @@ data to send to the host, you'll get it. .Sh HISTORY This driver replaces the functionality of the lpa driver, which is now defunct. -.Sh FILES -.Bl -tag -width Pa -compact -.It Pa /dev/lpt0 -first parallel port driver -.El .Sh BUGS There are lots of them, especially in cheap parallel port implementations. .Pp diff --git a/share/man/man4/man4.alpha/osf1.4 b/share/man/man4/man4.alpha/osf1.4 index f41937f..38a75cf 100644 --- a/share/man/man4/man4.alpha/osf1.4 +++ b/share/man/man4/man4.alpha/osf1.4 @@ -83,6 +83,9 @@ see .It Pa /compat/osf1 minimal OSF1 run-time environment .El +.Sh HISTORY +OSF/1 ABI support first appeared in +.Fx 4.0 . .Sh BUGS We cannot run OSF/1 applications which rely on the .Xr pthread 3 @@ -90,6 +93,3 @@ API, such as the JDK. OSF/1's pthreads library uses Mach system calls. Mach system calls would be very difficult to support in .Fx . -.Sh HISTORY -OSF/1 ABI support first appeared in -.Fx 4.0 . diff --git a/share/man/man4/man4.i386/aic.4 b/share/man/man4/man4.i386/aic.4 index c537bc9..991a0c5 100644 --- a/share/man/man4/man4.i386/aic.4 +++ b/share/man/man4/man4.i386/aic.4 @@ -67,12 +67,6 @@ Adaptec AHA-1030B, AHA-1030P (PC98) .It NEC PC-9801-100 (PC98) .El -.Sh BUGS -The driver does not work well with multiple devices on the SCSI bus. -The driver works well with devices like CDROMs and Tape drives. -The driver works not so well with disk drives. -The PC Card version appears to work better than the ISA version, but -that may be due to differing levels of testing of the devices. .Sh SEE ALSO .Xr aha 4 , .Xr ahb 4 , @@ -82,3 +76,9 @@ that may be due to differing levels of testing of the devices. .Xr da 4 , .Xr intro 4 , .Xr sa 4 +.Sh BUGS +The driver does not work well with multiple devices on the SCSI bus. +The driver works well with devices like CDROMs and Tape drives. +The driver works not so well with disk drives. +The PC Card version appears to work better than the ISA version, but +that may be due to differing levels of testing of the devices. diff --git a/share/man/man4/man4.i386/apm.4 b/share/man/man4/man4.i386/apm.4 index bd1adf1..e2c33e4 100644 --- a/share/man/man4/man4.i386/apm.4 +++ b/share/man/man4/man4.i386/apm.4 @@ -117,6 +117,11 @@ polls APM events and handles the following events. .It Dv "PMEV_UPDATETIME " No "adjust clock " "update time" .El .El +.Sh SEE ALSO +.Xr apm 8 , +.Xr zzz 8 +.Sh AUTHORS +Tatsumi Hosokawa <hosokawa@jp.FreeBSD.org> .Sh BUGS WARNING! Many, if not most, of the implementations of APM-bios in laptops @@ -151,8 +156,3 @@ or .Pp Disk spin-down, LCD backlight control, and power on demand have not been supported on the current version. -.Sh SEE ALSO -.Xr apm 8 , -.Xr zzz 8 -.Sh AUTHORS -Tatsumi Hosokawa <hosokawa@jp.FreeBSD.org> diff --git a/share/man/man4/man4.i386/ar.4 b/share/man/man4/man4.i386/ar.4 index 114bbc7..5a925df 100644 --- a/share/man/man4/man4.i386/ar.4 +++ b/share/man/man4/man4.i386/ar.4 @@ -83,12 +83,6 @@ Connecting to this hook enables the transmission of raw HDLC frames. The node will have the same name as the device with ``sync_'' prepended, e.g., .Dv sync_ar0 . -.Sh DIAGNOSTICS -.Bl -diag -.It "ar%d: Warning illegal interrupt %d." -The card cannot use the specified interrupt. -Choose a different one. -.El .Sh FILES .Bl -tag -width /sys/i386/isa/ic/hd64570.h -compact .It Pa /sys/i386/isa/ic/hd64570.h @@ -97,15 +91,12 @@ Choose a different one. .It Pa /sys/i386/isa/if_ar.h .It Pa /sys/pci/if_ar_p.c .El -.Sh BUGS -At the moment only the V.35 and X.21 interfaces are tested. -The others -may need tweaks to the clock selection code. -.Pp -The code can probably stand some optimizing. -.Pp -Please report bugs to -.Aq jhay@FreeBSD.org . +.Sh DIAGNOSTICS +.Bl -diag +.It "ar%d: Warning illegal interrupt %d." +The card cannot use the specified interrupt. +Choose a different one. +.El .Sh SEE ALSO .Xr cx 4 , .Xr netgraph 4 , @@ -125,3 +116,12 @@ device driver was written by .An John Hay Aq jhay@FreeBSD.org . Netgraph support was added by .An Julian Elischer Aq julian@FreeBSD.org . +.Sh BUGS +At the moment only the V.35 and X.21 interfaces are tested. +The others +may need tweaks to the clock selection code. +.Pp +The code can probably stand some optimizing. +.Pp +Please report bugs to +.Aq jhay@FreeBSD.org . diff --git a/share/man/man4/man4.i386/el.4 b/share/man/man4/man4.i386/el.4 index 88d1673..b0cdc10 100644 --- a/share/man/man4/man4.i386/el.4 +++ b/share/man/man4/man4.i386/el.4 @@ -50,13 +50,6 @@ The valid I/O ports are in the range 0x280-0x3f0. The .Nm driver supports the 3Com 3c501 8bit ISA Ethernet card. -.Sh BUGS -The driver assumes the card is configured for the same IRQ as the kernel. -No probing or checking is done to determine if this is the case. -.Pp -Does not currently support DMA. -.Pp -Does not currently support multicasts. .Sh SEE ALSO .Xr ed 4 , .Xr ep 4 , @@ -65,3 +58,10 @@ Does not currently support multicasts. .Xr le 4 , .Xr ng_ether 4 , .Xr ifconfig 8 +.Sh BUGS +The driver assumes the card is configured for the same IRQ as the kernel. +No probing or checking is done to determine if this is the case. +.Pp +Does not currently support DMA. +.Pp +Does not currently support multicasts. diff --git a/share/man/man4/man4.i386/ep.4 b/share/man/man4/man4.i386/ep.4 index 9446688..d9f82f6 100644 --- a/share/man/man4/man4.i386/ep.4 +++ b/share/man/man4/man4.i386/ep.4 @@ -149,9 +149,9 @@ Erase the pencil mark and reboot. .Xr ng_ether 4 , .Xr vx 4 , .Xr ifconfig 8 -.Sh BUGS -Support for the 3Com 3C1 is not working. -Support for the 3CCFEM556 Fast Ethernet cards has not been tested. .Sh STANDARDS are great. There's so many to choose from. +.Sh BUGS +Support for the 3Com 3C1 is not working. +Support for the 3CCFEM556 Fast Ethernet cards has not been tested. diff --git a/share/man/man4/man4.i386/ex.4 b/share/man/man4/man4.i386/ex.4 index f76725f..6a07f8b 100644 --- a/share/man/man4/man4.i386/ex.4 +++ b/share/man/man4/man4.i386/ex.4 @@ -69,8 +69,6 @@ interrupt than the one specified in the kernel configuration file. .It "ex%d: invalid IRQ." The device probe detected an invalid IRQ setting. .El -.Sh BUGS -Currently the driver does not support multicast. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -89,3 +87,5 @@ device driver was written by .An Javier Mart\('in Rueda . This manual page was written by .An David E. O'Brien . +.Sh BUGS +Currently the driver does not support multicast. diff --git a/share/man/man4/man4.i386/fe.4 b/share/man/man4/man4.i386/fe.4 index fa568e1..f92ecce 100644 --- a/share/man/man4/man4.i386/fe.4 +++ b/share/man/man4/man4.i386/fe.4 @@ -293,26 +293,11 @@ It requires the PC card (PCMCIA) support package. .Xr ng_ether 4 , .Xr ifconfig 8 , .Xr pccardd 8 -.Sh BUGS -Following are major known bugs: -.Pp -Statistics on the number of collisions maintained by the +.Sh HISTORY +The .Nm -driver is not accurate; -the -.Fl i -option of -.Xr netstat 1 -shows slightly less value than true number of collisions. -.Pp -More mbuf clusters are used than expected. -The packet receive routine has an intended violation -against the mbuf cluster allocation policy. -The unnecessarily allocated clusters are freed within short lifetime, -and it will not affect long term kernel memory usage. -.Pp -Although XNS and IPX support is included in the driver, -it has never been tested and it is expected to have a lot of bugs. +driver appeared in +.Fx 2.0.5 . .Sh AUTHORS, COPYRIGHT AND DISCLAIMER The .Nm @@ -354,8 +339,23 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENT AND THE ASSOCIATED SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.Sh HISTORY -The +.Sh BUGS +Following are major known bugs: +.Pp +Statistics on the number of collisions maintained by the .Nm -driver appeared in -.Fx 2.0.5 . +driver is not accurate; +the +.Fl i +option of +.Xr netstat 1 +shows slightly less value than true number of collisions. +.Pp +More mbuf clusters are used than expected. +The packet receive routine has an intended violation +against the mbuf cluster allocation policy. +The unnecessarily allocated clusters are freed within short lifetime, +and it will not affect long term kernel memory usage. +.Pp +Although XNS and IPX support is included in the driver, +it has never been tested and it is expected to have a lot of bugs. diff --git a/share/man/man4/man4.i386/lnc.4 b/share/man/man4/man4.i386/lnc.4 index f547cc9..37eed70 100644 --- a/share/man/man4/man4.i386/lnc.4 +++ b/share/man/man4/man4.i386/lnc.4 @@ -131,9 +131,6 @@ is the same one the card is configured for. .It "lnc%d: Transmit buffer error -- Resetting" .It "lnc%d: Transmit underflow error -- Resetting" .El -.Sh BUGS -This driver has the potential of being the most verbose of any of the -Ethernet device drivers. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -154,3 +151,6 @@ Support for the AMD PCHome phone-line based network added by .An Robert Watson . This manual page was written by .An David E. O'Brien . +.Sh BUGS +This driver has the potential of being the most verbose of any of the +Ethernet device drivers. diff --git a/share/man/man4/man4.i386/longrun.4 b/share/man/man4/man4.i386/longrun.4 index 9ca29b1..b9bfc66 100644 --- a/share/man/man4/man4.i386/longrun.4 +++ b/share/man/man4/man4.i386/longrun.4 @@ -56,12 +56,12 @@ To set LongRun mode to performance oriented variable frequency mode (less power savings): .Pp .Dl "# sysctl hw.crusoe.longrun=2" +.Sh HISTORY +The Transmeta(TM) Crusoe(TM) LongRun(TM) support first appeared in +.Fx 4.4 . .Sh AUTHORS .An -nosplit LongRun support and this manual page were written by .An Tamotsu HATTORI Aq athlete@kta.att.ne.jp and .An Mitsuru IWASAKI Aq iwasaki@FreeBSD.org . -.Sh HISTORY -The Transmeta(TM) Crusoe(TM) LongRun(TM) support first appeared in -.Fx 4.4 . diff --git a/share/man/man4/man4.i386/mcd.4 b/share/man/man4/man4.i386/mcd.4 index 33b9d04..532e3a4 100644 --- a/share/man/man4/man4.i386/mcd.4 +++ b/share/man/man4/man4.i386/mcd.4 @@ -150,6 +150,11 @@ supported, the only interrupts that the board generates are those that aren't supported by the driver anyway. .Sh SEE ALSO .In sys/cdio.h +.Sh HISTORY +An +.Nm +driver appeared in +.Fx 1.0 . .Sh AUTHORS .An -nosplit The driver was written by @@ -162,8 +167,3 @@ Changes were provided by .An Andrew A. Chernov , and .An Jordan K. Hubbard . -.Sh HISTORY -An -.Nm -driver appeared in -.Fx 1.0 . diff --git a/share/man/man4/man4.i386/pnp.4 b/share/man/man4/man4.i386/pnp.4 index f87789d..744d061 100644 --- a/share/man/man4/man4.i386/pnp.4 +++ b/share/man/man4/man4.i386/pnp.4 @@ -76,6 +76,12 @@ no provision for manual override. .%T ``Clarifications to the Plug and Play ISA Specification, Version 1.0a'' .%D December 10, 1994 .Re +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 2.2.5 . +It has been substantially updated in subsequent versions. .Sh AUTHORS PnP support was originally written for @@ -84,9 +90,3 @@ by .An Luigi Rizzo , based on initial work done by .An Sujal Patel . -.Sh HISTORY -The -.Nm -driver first appeared in -.Fx 2.2.5 . -It has been substantially updated in subsequent versions. diff --git a/share/man/man4/man4.i386/scd.4 b/share/man/man4/man4.i386/scd.4 index bca2be9..5f18895 100644 --- a/share/man/man4/man4.i386/scd.4 +++ b/share/man/man4/man4.i386/scd.4 @@ -59,6 +59,11 @@ accesses the raw device. .El .Sh SEE ALSO .Pa /sys/i386/isa/scd.c +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 2.0.5 . .Sh AUTHORS .An -nosplit The driver was written by @@ -67,8 +72,3 @@ with code contributed by .An Holger Veit and .An Brian Moore . -.Sh HISTORY -The -.Nm -driver first appeared in -.Fx 2.0.5 . diff --git a/share/man/man4/man4.i386/spkr.4 b/share/man/man4/man4.i386/spkr.4 index e29ad6c..fc0ed99 100644 --- a/share/man/man4/man4.i386/spkr.4 +++ b/share/man/man4/man4.i386/spkr.4 @@ -209,6 +209,23 @@ BASIC.) .Pp Whitespace in play strings is simply skipped and may be used to separate melody sections. +.Sh FILES +.Bl -tag -width /dev/speakerxx +.It Pa /dev/speaker +speaker device file +.El +.Sh SEE ALSO +.Xr spkrtest 8 +.Sh HISTORY +The +.Nm +device appeared in +.Fx 1.0 . +.Sh AUTHORS +.An Eric S. Raymond Aq esr@snark.thyrsus.com +June 1990 +.Sh "PORTED BY" +.An Andrew A. Chernov Aq ache@astral.msk.su .Sh BUGS Due to roundoff in the pitch tables and slop in the tone-generation and timer hardware (neither of which was designed for precision), neither pitch accuracy @@ -230,20 +247,3 @@ compatibility. In play strings which are very long (longer than your system's physical I/O blocks) note suffixes or numbers may occasionally be parsed incorrectly due to crossing a block boundary. -.Sh FILES -.Bl -tag -width /dev/speakerxx -.It Pa /dev/speaker -speaker device file -.El -.Sh SEE ALSO -.Xr spkrtest 8 -.Sh AUTHORS -.An Eric S. Raymond Aq esr@snark.thyrsus.com -June 1990 -.Sh "PORTED BY" -.An Andrew A. Chernov Aq ache@astral.msk.su -.Sh HISTORY -The -.Nm -device appeared in -.Fx 1.0 . diff --git a/share/man/man4/man4.i386/sr.4 b/share/man/man4/man4.i386/sr.4 index ffb104a..3761ece 100644 --- a/share/man/man4/man4.i386/sr.4 +++ b/share/man/man4/man4.i386/sr.4 @@ -122,12 +122,6 @@ Connecting to this hook enables the transmission of raw HDLC frames. The node will have the same name as the device with ``sync_'' prepended, e.g., .Dv sync_sr0 . -.Sh DIAGNOSTICS -.Bl -diag -.It "sr%d: Warning illegal interrupt %d." -The card cannot use the specified interrupt. -Choose a different one. -.El .Sh FILES .Bl -tag -width /sys/i386/isa/ic/hd64570.h -compact .It Pa /sys/i386/isa/ic/hd64570.h @@ -136,12 +130,12 @@ Choose a different one. .It Pa /sys/i386/isa/if_sr.h .It Pa /sys/pci/if_sr_p.c .El -.Sh BUGS -At the moment only the X.21 interface is tested. -The others -may need tweaks to the clock selection code. -.Pp -The code can probably stand some optimizing. +.Sh DIAGNOSTICS +.Bl -diag +.It "sr%d: Warning illegal interrupt %d." +The card cannot use the specified interrupt. +Choose a different one. +.El .Sh SEE ALSO .Xr ar 4 , .Xr cx 4 , @@ -157,3 +151,9 @@ device driver was written by .Pp Netgraph support was added by .An Julian Elischer Aq julian@FreeBSD.org . +.Sh BUGS +At the moment only the X.21 interface is tested. +The others +may need tweaks to the clock selection code. +.Pp +The code can probably stand some optimizing. diff --git a/share/man/man4/man4.i386/streams.4 b/share/man/man4/man4.i386/streams.4 index 84a572c..90d6800 100644 --- a/share/man/man4/man4.i386/streams.4 +++ b/share/man/man4/man4.i386/streams.4 @@ -60,14 +60,6 @@ emulation is only provided as a service to support ABI requirements in the SVR4 environment which .Xr svr4 4 needs to present to client binaries. -.Sh BUGS -This whole interface is a crude hack to produce STREAMS semantics -through emulation over sockets. -.Pp -Programmers who hope to be able to use this interface to provide -SVR4 STREAMS services to -.Bx -applications will be sorely disappointed. .Sh SEE ALSO .Xr svr4 4 .Sh HISTORY @@ -76,3 +68,11 @@ System V Release 4 ABI support first appeared in The ABI was ported from an equivalent facility present in .Nx 1.3 written by Christos Zoulas. +.Sh BUGS +This whole interface is a crude hack to produce STREAMS semantics +through emulation over sockets. +.Pp +Programmers who hope to be able to use this interface to provide +SVR4 STREAMS services to +.Bx +applications will be sorely disappointed. diff --git a/share/man/man4/man4.i386/svr4.4 b/share/man/man4/man4.i386/svr4.4 index 4d31568..6546a99 100644 --- a/share/man/man4/man4.i386/svr4.4 +++ b/share/man/man4/man4.i386/svr4.4 @@ -155,6 +155,25 @@ calls are executed. The subset of STREAMS functionality which is provided is small, probably little more than what is required to enable programs on the Solaris CD sets to run. +.Sh FILES +.Bl -tag -width /sys/compat/svr4/syscalls.master -compact +.It Pa /compat/svr4 +minimal SVR4 run-time environment +.It Pa /sys/compat/svr4/syscalls.master +mappings between SVR4 syscalls and +.Nm +module entrypoints. +.El +.Sh SEE ALSO +.Xr brandelf 1 , +.Xr streams 4 , +.Xr elf 5 +.Sh HISTORY +System V Release 4 ABI support first appeared in +.Fx 4.0 . +The ABI was ported from an equivalent facility present in +.Nx 1.3 +written by Christos Zoulas. .Sh BUGS Emulation of signal handlers is buggy. .Pp @@ -195,22 +214,3 @@ variables could set the .Dq personality the environment should present to client applications. -.Sh FILES -.Bl -tag -width /sys/compat/svr4/syscalls.master -compact -.It Pa /compat/svr4 -minimal SVR4 run-time environment -.It Pa /sys/compat/svr4/syscalls.master -mappings between SVR4 syscalls and -.Nm -module entrypoints. -.El -.Sh SEE ALSO -.Xr brandelf 1 , -.Xr streams 4 , -.Xr elf 5 -.Sh HISTORY -System V Release 4 ABI support first appeared in -.Fx 4.0 . -The ABI was ported from an equivalent facility present in -.Nx 1.3 -written by Christos Zoulas. diff --git a/share/man/man4/man4.i386/vx.4 b/share/man/man4/man4.i386/vx.4 index 8681c44..fed95fa 100644 --- a/share/man/man4/man4.i386/vx.4 +++ b/share/man/man4/man4.i386/vx.4 @@ -94,16 +94,6 @@ mostly in spurious warnings. 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 -driver is known not to reset the adapter correctly following a warm boot -on some systems. -.Pp -The -.Nm -driver has not been exhaustively tested with all the models of cards that it -claims to support. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -126,3 +116,13 @@ 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 BUGS +The +.Nm +driver is known not to reset the adapter correctly following a warm boot +on some systems. +.Pp +The +.Nm +driver has not been exhaustively tested with all the models of cards that it +claims to support. diff --git a/share/man/man4/mem.4 b/share/man/man4/mem.4 index 0d8bae4..5dd2cb9 100644 --- a/share/man/man4/mem.4 +++ b/share/man/man4/mem.4 @@ -186,12 +186,6 @@ base/length supplied. An attempt to remove a range failed because the range is permanently enabled. .El -.Sh BUGS -Busy range attributes are not yet managed correctly. -.Pp -This device is required for all users of -.Xr kvm 3 -to operate. .Sh FILES .Bl -tag -width /dev/kmem -compact .It Pa /dev/mem @@ -209,3 +203,9 @@ files appeared in .At v6 . The ioctl interface for memory range attributes was added in .Fx 3.2 . +.Sh BUGS +Busy range attributes are not yet managed correctly. +.Pp +This device is required for all users of +.Xr kvm 3 +to operate. diff --git a/share/man/man4/meteor.4 b/share/man/man4/meteor.4 index a71507c..62ff6e9 100644 --- a/share/man/man4/meteor.4 +++ b/share/man/man4/meteor.4 @@ -865,10 +865,10 @@ will be set to: invalid meteor_counts structure pointer. .El .El +.Sh AUTHORS +.An Jim Lowe Aq james@miller.cs.uwm.edu , +.An Mark Tinguely Aq tinguely@plains.nodak.edu .Sh BUGS The .Nm driver no longer works at all. -.Sh AUTHORS -.An Jim Lowe Aq james@miller.cs.uwm.edu , -.An Mark Tinguely Aq tinguely@plains.nodak.edu diff --git a/share/man/man4/mlx.4 b/share/man/man4/mlx.4 index ade0b70..2c26ade 100644 --- a/share/man/man4/mlx.4 +++ b/share/man/man4/mlx.4 @@ -221,13 +221,6 @@ or in the driver. .El .Sh SEE ALSO .Xr mlxcontrol 8 -.Sh BUGS -The driver does not yet support EISA adapters. -The DEC KZPSC has insufficient flash ROM to hold any reasonably recent firmware. -This has caused problems for this driver. -.Pp -The driver does not yet support the version 6.x firmware as found in the -AcceleRAID 352 and eXtremeRAID 2000 and 3000 products. .Sh AUTHORS .An -nosplit The @@ -242,3 +235,10 @@ This manual page was written by and .An Michael Smith .Aq msmith@FreeBSD.org . +.Sh BUGS +The driver does not yet support EISA adapters. +The DEC KZPSC has insufficient flash ROM to hold any reasonably recent firmware. +This has caused problems for this driver. +.Pp +The driver does not yet support the version 6.x firmware as found in the +AcceleRAID 352 and eXtremeRAID 2000 and 3000 products. diff --git a/share/man/man4/mly.4 b/share/man/man4/mly.4 index 7cfd8ee..a57c603 100644 --- a/share/man/man4/mly.4 +++ b/share/man/man4/mly.4 @@ -243,10 +243,6 @@ The driver does not attempt to name the enclosures. .Pp These events report controller status changes. .El -.Sh BUGS -The driver does not yet provide an external management interface. -.Pp -Enclosures are not named or otherwise identified in event messages. .Sh AUTHORS .An -nosplit The @@ -258,3 +254,7 @@ driver was written by This manual page was written by .An Michael Smith .Aq msmith@FreeBSD.org . +.Sh BUGS +The driver does not yet provide an external management interface. +.Pp +Enclosures are not named or otherwise identified in event messages. diff --git a/share/man/man4/ng_bpf.4 b/share/man/man4/ng_bpf.4 index c63c89c..faf0fe1 100644 --- a/share/man/man4/ng_bpf.4 +++ b/share/man/man4/ng_bpf.4 @@ -175,6 +175,17 @@ ngctl msg ${NODEPATH} setprogram { thisHook=\\"${INHOOK}\\" \\ ifNotMatch=\\"${NOTMATCHHOOK}\\" \\ ${BPFPROG} } } .Ed +.Sh SEE ALSO +.Xr bpf 4 , +.Xr netgraph 4 , +.Xr ngctl 8 +.Sh HISTORY +The +.Nm +node type was implemented in +.Fx 4.0 . +.Sh AUTHORS +.An Archie Cobbs Aq archie@FreeBSD.org .Sh BUGS When built as a loadable kernel module, this module includes the file .Pa net/bpf_filter.c . @@ -183,14 +194,3 @@ Although loading the module should fail if already exists in the kernel, currently it does not, and the duplicate copies of the file do not interfere. However, this may change in the future. -.Sh HISTORY -The -.Nm -node type was implemented in -.Fx 4.0 . -.Sh SEE ALSO -.Xr bpf 4 , -.Xr netgraph 4 , -.Xr ngctl 8 -.Sh AUTHORS -.An Archie Cobbs Aq archie@FreeBSD.org diff --git a/share/man/man4/ng_bt3c.4 b/share/man/man4/ng_bt3c.4 index 2f0431f..9e46736 100644 --- a/share/man/man4/ng_bt3c.4 +++ b/share/man/man4/ng_bt3c.4 @@ -124,10 +124,6 @@ Download card firmware. .El .Sh SHUTDOWN This node shuts down when the corresponding card is un-plugged. -.Sh BUGS -The driver is based on information obtained from -.An Jose Orlando Pereira Aq jop@di.uminho.pt -and disassembled the W2K driver. .Sh SEE ALSO .Xr cardbus 4 , .Xr netgraph 4 , @@ -145,3 +141,7 @@ node type was implemented in .Fx 5.0 . .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh BUGS +The driver is based on information obtained from +.An Jose Orlando Pereira Aq jop@di.uminho.pt +and disassembled the W2K driver. diff --git a/share/man/man4/ng_btsocket.4 b/share/man/man4/ng_btsocket.4 index c84d712..5146d15 100644 --- a/share/man/man4/ng_btsocket.4 +++ b/share/man/man4/ng_btsocket.4 @@ -333,9 +333,6 @@ unique) and always accept hook connection requests. These node types support the generic control messages. .Sh SHUTDOWN These nodes are persistent and cannot be shut down. -.Sh BUGS -Most likely. -Please report if found. .Sh SEE ALSO .Xr btsockstat 1 , .Xr socket 2 , @@ -352,3 +349,6 @@ module was implemented in .Fx 5.0 . .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh BUGS +Most likely. +Please report if found. diff --git a/share/man/man4/ng_cisco.4 b/share/man/man4/ng_cisco.4 index 491437e..b959e95 100644 --- a/share/man/man4/ng_cisco.4 +++ b/share/man/man4/ng_cisco.4 @@ -157,11 +157,6 @@ struct ngciscostat { This node shuts down upon receipt of a .Dv NGM_SHUTDOWN control message, or when all hooks have been disconnected. -.Sh BUGS -Not all of the functionality has been implemented. -For example, -the node does not support querying the remote end for its IP address -and netmask. .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_iface 4 , @@ -182,3 +177,8 @@ node type was implemented in .Sh AUTHORS .An Julian Elischer Aq julian@FreeBSD.org , .An Archie Cobbs Aq archie@FreeBSD.org +.Sh BUGS +Not all of the functionality has been implemented. +For example, +the node does not support querying the remote end for its IP address +and netmask. diff --git a/share/man/man4/ng_ether.4 b/share/man/man4/ng_ether.4 index 1593410..d44b249 100644 --- a/share/man/man4/ng_ether.4 +++ b/share/man/man4/ng_ether.4 @@ -204,6 +204,16 @@ tracing packet flow, statistics, etc.: ngctl mkpeer fxp0: tee lower right ngctl connect fxp0: lower upper left .Ed +.Sh SEE ALSO +.Xr arp 4 , +.Xr netgraph 4 , +.Xr netintro 4 , +.Xr ifconfig 8 , +.Xr ngctl 8 , +.Xr nghook 8 +.Sh AUTHORS +.An Julian Elischer Aq julian@FreeBSD.org +.An Archie Cobbs Aq archie@FreeBSD.org .Sh BUGS The automatic KLD module loading mechanism that works for most other Netgraph node types does not work for the @@ -217,13 +227,3 @@ Therefore, if the KLD is not statically compiled into the kernel, it is necessary to load the KLD manually in order to bring the .Nm ether nodes into existence. -.Sh SEE ALSO -.Xr arp 4 , -.Xr netgraph 4 , -.Xr netintro 4 , -.Xr ifconfig 8 , -.Xr ngctl 8 , -.Xr nghook 8 -.Sh AUTHORS -.An Julian Elischer Aq julian@FreeBSD.org -.An Archie Cobbs Aq archie@FreeBSD.org diff --git a/share/man/man4/ng_frame_relay.4 b/share/man/man4/ng_frame_relay.4 index 83a6489..79e18e6 100644 --- a/share/man/man4/ng_frame_relay.4 +++ b/share/man/man4/ng_frame_relay.4 @@ -78,15 +78,6 @@ This node type supports only the generic control messages. This node shuts down upon receipt of a .Dv NGM_SHUTDOWN control message, or when all hooks have been disconnected. -.Sh BUGS -Technically, frames on DLCI X should not be transmitted to the switch -until the LMI protocol entity on both ends has configured DLCI X as active. -The -.Nm -node type ignores this restriction, and will always pass data received -on a DLCI hook to -.Dv downstream . -Instead, it should query the LMI node first. .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_lmi 4 , @@ -98,3 +89,12 @@ node type was implemented in .Fx 4.0 . .Sh AUTHORS .An Julian Elischer Aq julian@FreeBSD.org +.Sh BUGS +Technically, frames on DLCI X should not be transmitted to the switch +until the LMI protocol entity on both ends has configured DLCI X as active. +The +.Nm +node type ignores this restriction, and will always pass data received +on a DLCI hook to +.Dv downstream . +Instead, it should query the LMI node first. diff --git a/share/man/man4/ng_h4.4 b/share/man/man4/ng_h4.4 index d3a944b..cda15e4 100644 --- a/share/man/man4/ng_h4.4 +++ b/share/man/man4/ng_h4.4 @@ -104,11 +104,6 @@ Reset all statistic counters to zero. .Sh SHUTDOWN This node shuts down when the corresponding device is closed (or the line discipline is uninstalled on the device). -.Sh BUGS -This node still uses -.Xr spltty 9 -to lock tty layer. -This is wrong. .Sh SEE ALSO .Xr ioctl 2 , .Xr netgraph 4 , @@ -121,3 +116,8 @@ node type was implemented in .Fx 5.0 . .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh BUGS +This node still uses +.Xr spltty 9 +to lock tty layer. +This is wrong. diff --git a/share/man/man4/ng_hci.4 b/share/man/man4/ng_hci.4 index 797d44e..28de180 100644 --- a/share/man/man4/ng_hci.4 +++ b/share/man/man4/ng_hci.4 @@ -371,9 +371,6 @@ This node shuts down upon receipt of a .Dv NGM_SHUTDOWN control message, or when all hooks have been disconnected. -.Sh BUGS -Most likely. -Please report if found. .Sh SEE ALSO .Xr netgraph 4 , .Xr hccontrol 8 , @@ -385,3 +382,6 @@ node type was implemented in .Fx 5.0 . .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh BUGS +Most likely. +Please report if found. diff --git a/share/man/man4/ng_l2cap.4 b/share/man/man4/ng_l2cap.4 index b2abe51..bd050fc 100644 --- a/share/man/man4/ng_l2cap.4 +++ b/share/man/man4/ng_l2cap.4 @@ -406,9 +406,6 @@ This node shuts down upon receipt of an .Dv NGM_SHUTDOWN control message, or when all hooks have been disconnected. -.Sh BUGS -Most likely. -Please report if found. .Sh SEE ALSO .Xr netgraph 4 , .Xr l2control 8 , @@ -421,3 +418,6 @@ node type was implemented in .Fx 5.0 . .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh BUGS +Most likely. +Please report if found. diff --git a/share/man/man4/ng_mppc.4 b/share/man/man4/ng_mppc.4 index 242a1b7..a146228 100644 --- a/share/man/man4/ng_mppc.4 +++ b/share/man/man4/ng_mppc.4 @@ -160,11 +160,6 @@ These files must be obtained elsewhere and added to the kernel sources before this node type will compile with the .Dv NETGRAPH_MPPC_COMPRESSION option. -.Sh BUGS -In PPP, encryption should be handled by the Encryption Control Protocol (ECP) -rather than CCP. -However, Microsoft combined both compression and encryption into their -``compression'' algorithm, which is confusing. .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_ppp 4 , @@ -192,3 +187,8 @@ However, Microsoft combined both compression and encryption into their .Re .Sh AUTHORS .An Archie Cobbs Aq archie@FreeBSD.org +.Sh BUGS +In PPP, encryption should be handled by the Encryption Control Protocol (ECP) +rather than CCP. +However, Microsoft combined both compression and encryption into their +``compression'' algorithm, which is confusing. diff --git a/share/man/man4/ng_netflow.4 b/share/man/man4/ng_netflow.4 index 6e347ca..689e9a6 100644 --- a/share/man/man4/ng_netflow.4 +++ b/share/man/man4/ng_netflow.4 @@ -222,14 +222,6 @@ node in this example is connected to msg netflow:export connect inet/10.0.0.1:4444 SEQ .Ed -.Sh BUGS -The -.Nm -node type does not fill in AS numbers. -This is due to the lack of necessary information in the kernel routing table. -However, this information can be injected into the kernel from a routing daemon -such as GNU Zebra. -This functionality may become available in future releases. .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_ksocket 4 , @@ -247,3 +239,11 @@ based on .Nm ng_ipacct written by .An Roman V. Palagin Aq romanp@unshadow.net . +.Sh BUGS +The +.Nm +node type does not fill in AS numbers. +This is due to the lack of necessary information in the kernel routing table. +However, this information can be injected into the kernel from a routing daemon +such as GNU Zebra. +This functionality may become available in future releases. diff --git a/share/man/man4/ng_one2many.4 b/share/man/man4/ng_one2many.4 index 788566f..1753649f 100644 --- a/share/man/man4/ng_one2many.4 +++ b/share/man/man4/ng_one2many.4 @@ -245,9 +245,6 @@ With a similar setup on a peer machine (using the address 192.168.1.2), a point-to-point Ethernet connection with four times normal bandwidth is achieved. -.Sh BUGS -More transmit and link failure algorithms should be supported. -A good candidate is Cisco's Etherchannel. .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_bridge 4 , @@ -270,3 +267,6 @@ netgraph node (with round-robin algorithm) was written by The all algorithm was added by .An Rogier R. Mulhuijzen .Aq drwilco@drwilco.net . +.Sh BUGS +More transmit and link failure algorithms should be supported. +A good candidate is Cisco's Etherchannel. diff --git a/share/man/man4/ng_pptpgre.4 b/share/man/man4/ng_pptpgre.4 index fb7146e..a1d6180 100644 --- a/share/man/man4/ng_pptpgre.4 +++ b/share/man/man4/ng_pptpgre.4 @@ -160,11 +160,6 @@ control message, or when both hooks have been disconnected. .%T "Generic Routing Encapsulation over IPv4 networks" .%O RFC 1702 .Re -.Sh BUGS -The node should not expect incoming GRE packets to have an IP header. -This behavior is inherited from the (converse) behavior of raw IP sockets. -An intermediate node that strips IP headers in one direction -should be used instead. .Sh HISTORY The .Nm @@ -172,3 +167,8 @@ node type was implemented in .Fx 4.0 . .Sh AUTHORS .An Archie Cobbs Aq archie@FreeBSD.org +.Sh BUGS +The node should not expect incoming GRE packets to have an IP header. +This behavior is inherited from the (converse) behavior of raw IP sockets. +An intermediate node that strips IP headers in one direction +should be used instead. diff --git a/share/man/man4/ng_rfc1490.4 b/share/man/man4/ng_rfc1490.4 index bcba26d..54b327e 100644 --- a/share/man/man4/ng_rfc1490.4 +++ b/share/man/man4/ng_rfc1490.4 @@ -113,8 +113,6 @@ This command returns current encapsulation method on the node. This node shuts down upon receipt of a .Dv NGM_SHUTDOWN control message, or when all hooks have been disconnected. -.Sh BUGS -Not all of RFC 1490 is implemented. .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_frame_relay 4 , @@ -140,3 +138,5 @@ node type was implemented in .Fx 4.0 . .Sh AUTHORS .An Julian Elischer Aq julian@FreeBSD.org +.Sh BUGS +Not all of RFC 1490 is implemented. diff --git a/share/man/man4/ng_socket.4 b/share/man/man4/ng_socket.4 index 1b237d6..c46ed3a 100644 --- a/share/man/man4/ng_socket.4 +++ b/share/man/man4/ng_socket.4 @@ -166,14 +166,6 @@ If the .Dv NGM_SOCK_CMD_NOLINGER message has been received, closure of the last hook will also initiate a shutdown of the node. -.Sh BUGS -It is not possible to reject the connection of a hook, though any -data received on that hook can certainly be ignored. -.Pp -The controlling process is not notified of all events that an in-kernel node -would be notified of, e.g.\& a new hook, or hook removal. -Some node-initiated messages should be defined for this purpose (to be -sent up the control socket). .Sh SEE ALSO .Xr socket 2 , .Xr netgraph 3 , @@ -187,3 +179,11 @@ node type was implemented in .Fx 4.0 . .Sh AUTHORS .An Julian Elischer Aq julian@FreeBSD.org +.Sh BUGS +It is not possible to reject the connection of a hook, though any +data received on that hook can certainly be ignored. +.Pp +The controlling process is not notified of all events that an in-kernel node +would be notified of, e.g.\& a new hook, or hook removal. +Some node-initiated messages should be defined for this purpose (to be +sent up the control socket). diff --git a/share/man/man4/ng_source.4 b/share/man/man4/ng_source.4 index d659dfa..7e7440e 100644 --- a/share/man/man4/ng_source.4 +++ b/share/man/man4/ng_source.4 @@ -179,6 +179,70 @@ This node shuts down upon receipt of a control message, or when the .Dv output hook has been disconnected. +.Sh IMPLEMENTATION NOTES +.No ( Fx 4.4 +version) +.Pp +The use of +.Xr splimp 9 +around the +.Dv NG_SEND_DATA +loop is important. +Without it, +the time taken by a single invocation of +.Fn ng_source_intr +becomes too +large and the packet rate drops. +Probably due to the NIC starting to +send the packets right away. +.Pp +Copying all the packets in one loop and sending them in another inside +of +.Fn ng_source_send +is done to limit how long we are at +.Xr splimp 9 +and gave +minor packet rate increases (~5% at 256 byte packets). +However note +that if there are errors in the send loop, the remaining copied packets +are simply freed and discarded; thus we skip those packets, and ordering +of the input queue to the output is not maintained. +.Pp +Calling +.Xr timeout 9 +at the end of +.Fn ng_source_intr +instead of near the +beginning is done to help avoid CPU starvation if +.Fn ng_source_intr +takes a long time to run. +.Pp +The use of +.Xr splnet 9 +may be sub-optimal. +It is used for synchronization +within the node (e.g., data received on the +.Dv input +hook while +.Fn ng_source_send +is active) but we do not want to hold it too long and risk +starving the NIC. +.Pp +For clarity and simplicity, debugging messages and instrumentation code +has been removed. +On i386 one can include +.In machine/cpufunc.h +to have access to the +.Fn rdtsc +function to read the instruction counter at the +start and end of +.Fn ng_source_intr . +Also useful is the packet count returned by +.Fn ng_source_send . +Do not try to report such things from within +.Fn ng_source_intr , +instead include the values in +.Va sc->stats . .Sh EXAMPLES Attach the node to an .Xr ng_ether 4 @@ -270,70 +334,6 @@ command: date -r 1035305880 Tue Oct 22 12:58:00 EDT 2002 .Ed -.Sh IMPLEMENTATION NOTES -.No ( Fx 4.4 -version) -.Pp -The use of -.Xr splimp 9 -around the -.Dv NG_SEND_DATA -loop is important. -Without it, -the time taken by a single invocation of -.Fn ng_source_intr -becomes too -large and the packet rate drops. -Probably due to the NIC starting to -send the packets right away. -.Pp -Copying all the packets in one loop and sending them in another inside -of -.Fn ng_source_send -is done to limit how long we are at -.Xr splimp 9 -and gave -minor packet rate increases (~5% at 256 byte packets). -However note -that if there are errors in the send loop, the remaining copied packets -are simply freed and discarded; thus we skip those packets, and ordering -of the input queue to the output is not maintained. -.Pp -Calling -.Xr timeout 9 -at the end of -.Fn ng_source_intr -instead of near the -beginning is done to help avoid CPU starvation if -.Fn ng_source_intr -takes a long time to run. -.Pp -The use of -.Xr splnet 9 -may be sub-optimal. -It is used for synchronization -within the node (e.g., data received on the -.Dv input -hook while -.Fn ng_source_send -is active) but we do not want to hold it too long and risk -starving the NIC. -.Pp -For clarity and simplicity, debugging messages and instrumentation code -has been removed. -On i386 one can include -.In machine/cpufunc.h -to have access to the -.Fn rdtsc -function to read the instruction counter at the -start and end of -.Fn ng_source_intr . -Also useful is the packet count returned by -.Fn ng_source_send . -Do not try to report such things from within -.Fn ng_source_intr , -instead include the values in -.Va sc->stats . .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_echo 4 , diff --git a/share/man/man4/ng_tty.4 b/share/man/man4/ng_tty.4 index e5485d5..158bcff 100644 --- a/share/man/man4/ng_tty.4 +++ b/share/man/man4/ng_tty.4 @@ -118,15 +118,6 @@ The .Dv NGM_SHUTDOWN control message is not valid, and always returns the error .Er EOPNOTSUPP . -.Sh BUGS -The serial driver code also has a notion of a -.Dq hot character . -Unfortunately, this value is statically defined in terms of the -line discipline and cannot be changed. -Therefore, if a hot character other than 0x7e (the default) is set for the -.Nm -node, the node has no way to convey this information to the -serial driver, and sub-optimal performance may result. .Sh SEE ALSO .Xr ioctl 2 , .Xr netgraph 4 , @@ -140,3 +131,12 @@ node type was implemented in .Fx 4.0 . .Sh AUTHORS .An Archie Cobbs Aq archie@FreeBSD.org +.Sh BUGS +The serial driver code also has a notion of a +.Dq hot character . +Unfortunately, this value is statically defined in terms of the +line discipline and cannot be changed. +Therefore, if a hot character other than 0x7e (the default) is set for the +.Nm +node, the node has no way to convey this information to the +serial driver, and sub-optimal performance may result. diff --git a/share/man/man4/ng_ubt.4 b/share/man/man4/ng_ubt.4 index 4083a45..ebb454d 100644 --- a/share/man/man4/ng_ubt.4 +++ b/share/man/man4/ng_ubt.4 @@ -105,10 +105,6 @@ Reset all statistic counters to zero. .El .Sh SHUTDOWN This node shuts down when the corresponding USB device is un-plugged. -.Sh BUGS -Isochronous USB transfers are broken. -This means that the USB device will not be able to transfer SCO data (voice). -USB interrupt transfers are implemented as bulk-in transfers (not really a bug). .Sh SEE ALSO .Xr netgraph 4 , .Xr ugen 4 , @@ -121,3 +117,7 @@ node type was implemented in .Fx 5.0 . .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh BUGS +Isochronous USB transfers are broken. +This means that the USB device will not be able to transfer SCO data (voice). +USB interrupt transfers are implemented as bulk-in transfers (not really a bug). diff --git a/share/man/man4/ng_uni.4 b/share/man/man4/ng_uni.4 index b1d3118..451110a 100644 --- a/share/man/man4/ng_uni.4 +++ b/share/man/man4/ng_uni.4 @@ -398,6 +398,12 @@ Note, that connections are not released. .Xr ng_sscfu 4 , .Xr ng_sscop 4 , .Xr ngctl 8 +.Sh AUTHORS +The +.Nm uni +netgraph node +and this manual page were written by +.An Harti Brandt Aq harti@FreeBSD.org .Sh BUGS .Bl -bullet -compact .It @@ -411,9 +417,3 @@ PNNI not yet implemented. .It Need to implement connection modification and the Q.2931 amendments. .El -.Sh AUTHORS -The -.Nm uni -netgraph node -and this manual page were written by -.An Harti Brandt Aq harti@FreeBSD.org diff --git a/share/man/man4/ng_vjc.4 b/share/man/man4/ng_vjc.4 index 8db5b4c..8a22d49 100644 --- a/share/man/man4/ng_vjc.4 +++ b/share/man/man4/ng_vjc.4 @@ -193,24 +193,6 @@ Failing to do this can result in corrupted TCP stream data. This node shuts down upon receipt of a .Dv NGM_SHUTDOWN control message, or when all hooks have been disconnected. -.Sh BUGS -As the initialization routine in the kernel implementation of -Van Jacobson compression initializes both compression and decompression -at once, this node does not allow compression and decompression to -be enabled in separate operations. -In order to enable one when -the other is already enabled, first both must be disabled, then -both enabled. -This of course resets the node state. -This restriction may be lifted in a later version. -.Pp -When built as a loadable kernel module, this module includes the file -.Pa net/slcompress.c . -Although loading the module should fail if -.Pa net/slcompress.c -already exists in the kernel, currently it does not, and the duplicate -copies of the file do not interfere. -However, this may change in the future. .Sh SEE ALSO .Xr netgraph 4 , .Xr ng_iface 4 , @@ -233,3 +215,21 @@ node type was implemented in .Fx 4.0 . .Sh AUTHORS .An Archie Cobbs Aq archie@FreeBSD.org +.Sh BUGS +As the initialization routine in the kernel implementation of +Van Jacobson compression initializes both compression and decompression +at once, this node does not allow compression and decompression to +be enabled in separate operations. +In order to enable one when +the other is already enabled, first both must be disabled, then +both enabled. +This of course resets the node state. +This restriction may be lifted in a later version. +.Pp +When built as a loadable kernel module, this module includes the file +.Pa net/slcompress.c . +Although loading the module should fail if +.Pa net/slcompress.c +already exists in the kernel, currently it does not, and the duplicate +copies of the file do not interfere. +However, this may change in the future. diff --git a/share/man/man4/nsp.4 b/share/man/man4/nsp.4 index 7a74270..2df5803 100644 --- a/share/man/man4/nsp.4 +++ b/share/man/man4/nsp.4 @@ -60,8 +60,6 @@ I-O DATA CBSC16 .Xr pccard 4 , .Xr sa 4 , .Xr scsi 4 -.Sh BUGS -SMIT mode is only supported under OLDCARD now. .Sh HISTORY The .Nm @@ -84,3 +82,5 @@ This manual page was written by .An Noriaki MITSUNAGA Aq non@FreeBSD.org and .An Hideyuki KURASHINA Aq rushani@FreeBSD.org . +.Sh BUGS +SMIT mode is only supported under OLDCARD now. diff --git a/share/man/man4/pcm.4 b/share/man/man4/pcm.4 index fbc5427..4f0de59 100644 --- a/share/man/man4/pcm.4 +++ b/share/man/man4/pcm.4 @@ -341,9 +341,19 @@ AC97 codec is not likely to be accompanied with the sound card. .It unsupported subdevice XX A device node is not created properly. .El -.Sh BUGS -Some features of your cards (e.g., global volume control) might not -be supported on all devices. +.Sh SEE ALSO +.Xr snd_csa 4 , +.Xr snd_gusc 4 , +.Xr snd_sbc 4 , +.Xr devfs 5 , +.Xr loader.conf 5 , +.Xr dmesg 8 , +.Xr kldload 8 , +.Xr sysctl 8 +.Rs +.%T "The OSS API" +.%O "http://www.opensound.com/pguide/oss.pdf" +.Re .Sh HISTORY The .Nm @@ -360,19 +370,6 @@ by .An Cameron Grant . The API evolved from the VOXWARE standard which later became OSS standard. -.Sh SEE ALSO -.Xr snd_csa 4 , -.Xr snd_gusc 4 , -.Xr snd_sbc 4 , -.Xr devfs 5 , -.Xr loader.conf 5 , -.Xr dmesg 8 , -.Xr kldload 8 , -.Xr sysctl 8 -.Rs -.%T "The OSS API" -.%O "http://www.opensound.com/pguide/oss.pdf" -.Re .Sh AUTHORS .An -nosplit .An Luigi Rizzo Aq luigi@iet.unipi.it @@ -386,3 +383,6 @@ later revised the device driver for revised this manual page. It was then rewritten for .Fx 5.2 . +.Sh BUGS +Some features of your cards (e.g., global volume control) might not +be supported on all devices. diff --git a/share/man/man4/pcvt.4 b/share/man/man4/pcvt.4 index 9d8ae66..5c9650d 100644 --- a/share/man/man4/pcvt.4 +++ b/share/man/man4/pcvt.4 @@ -696,6 +696,16 @@ driver Documents the various compile-time options to tailor .Nm . .El +.Sh SEE ALSO +.Xr cursor 1 , +.Xr loadfont 1 , +.Xr scon 1 , +.Xr intro 2 , +.Xr ioctl 2 , +.Xr atkbd 4 , +.Xr keyboard 4 , +.Xr config 8 , +.Xr ispcvt 8 .Sh HISTORY The .Nm @@ -737,15 +747,5 @@ and .An Don Ahn , and the keyboard mapping code from .An Holger Veit Aq veit@first.gmd.de . -.Sh SEE ALSO -.Xr cursor 1 , -.Xr loadfont 1 , -.Xr scon 1 , -.Xr intro 2 , -.Xr ioctl 2 , -.Xr atkbd 4 , -.Xr keyboard 4 , -.Xr config 8 , -.Xr ispcvt 8 .Sh BUGS At least one left. diff --git a/share/man/man4/ppc.4 b/share/man/man4/ppc.4 index 6fea973..9b96625 100644 --- a/share/man/man4/ppc.4 +++ b/share/man/man4/ppc.4 @@ -122,10 +122,6 @@ ppb->ppb_avm field contains the available modes of the chipset. .Xr ppbus 4 , .Xr ppi 4 , .Xr device.hints 5 -.Sh BUGS -The chipset detection process may corrupt your chipset configuration. -You may -disable chipset specific detection by using the above flags. .Sh HISTORY The .Nm @@ -134,3 +130,7 @@ manual page first appeared in .Sh AUTHORS This manual page was written by .An Nicolas Souchu . +.Sh BUGS +The chipset detection process may corrupt your chipset configuration. +You may +disable chipset specific detection by using the above flags. diff --git a/share/man/man4/psm.4 b/share/man/man4/psm.4 index 9f862dc..bfeb594 100644 --- a/share/man/man4/psm.4 +++ b/share/man/man4/psm.4 @@ -833,15 +833,6 @@ 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 -has been removed. -It was never functional anyway. -.Pp -Enabling the extended support for Synaptics touchpads has been reported to -cause problems with responsivity on some (newer) models of Synaptics -hardware, particularly those with guest devices. .Sh SEE ALSO .Xr ioctl 2 , .Xr syslog 3 , @@ -873,3 +864,12 @@ to name the few. .Pp This manual page was written by .An Kazutaka Yokota Aq yokota@FreeBSD.org . +.Sh BUGS +The ioctl command +.Dv MOUSEIOCREAD +has been removed. +It was never functional anyway. +.Pp +Enabling the extended support for Synaptics touchpads has been reported to +cause problems with responsivity on some (newer) models of Synaptics +hardware, particularly those with guest devices. diff --git a/share/man/man4/sa.4 b/share/man/man4/sa.4 index 9ffcca9..e1fc4dc 100644 --- a/share/man/man4/sa.4 +++ b/share/man/man4/sa.4 @@ -197,26 +197,6 @@ Eject on close (if capable) Control mode device (to examine state while another program is accessing the device, e.g.). .El -.Sh BUGS -This driver lacks many of the hacks required to deal with older devices. -Many older -.Tn SCSI-1 -devices may not work properly with this driver yet. -.Pp -Additionally, certain -tapes (QIC tapes mostly) that were written under -.Fx -2.X -aren't automatically read correctly with this driver: you may need to -explicitly set variable block mode or set to the blocksize that works best -for your device in order to read tapes written under -.Fx -2.X. -.Pp -Fine grained density and compression mode support that is bound to specific -device names needs to be added. -.Pp -Support for fast indexing by use of partitions is missing. .Sh DIAGNOSTICS None. .Sh SEE ALSO @@ -245,3 +225,23 @@ The current owner of record is .An Matthew Jacob who has suffered too many years of breaking tape drivers. +.Sh BUGS +This driver lacks many of the hacks required to deal with older devices. +Many older +.Tn SCSI-1 +devices may not work properly with this driver yet. +.Pp +Additionally, certain +tapes (QIC tapes mostly) that were written under +.Fx +2.X +aren't automatically read correctly with this driver: you may need to +explicitly set variable block mode or set to the blocksize that works best +for your device in order to read tapes written under +.Fx +2.X. +.Pp +Fine grained density and compression mode support that is bound to specific +device names needs to be added. +.Pp +Support for fast indexing by use of partitions is missing. diff --git a/share/man/man4/sbsh.4 b/share/man/man4/sbsh.4 index fbd1dd4..c318a8d 100644 --- a/share/man/man4/sbsh.4 +++ b/share/man/man4/sbsh.4 @@ -43,6 +43,13 @@ Modem-specific parameters (master/slave mode, line rate, etc.) must be set with the .Nm sb16config utility before interface activation. +.Sh FILES +The sources for the driver reside in: +.Pp +.Bl -tag -compact +.It Pa /sys/dev/sbsh/if_sbsh.c +.It Pa /sys/dev/sbsh/if_sbshreg.h +.El .Sh DIAGNOSTICS .Bl -diag .It "sbsh%d: couldn't map memory" @@ -64,13 +71,6 @@ Probably, a hardware error or incompatibility. .It "sbsh%d: unable to get mbuf cluster" The driver failed to allocate a memory buffer. .El -.Sh FILES -The sources for the driver reside in: -.Pp -.Bl -tag -compact -.It Pa /sys/dev/sbsh/if_sbsh.c -.It Pa /sys/dev/sbsh/if_sbshreg.h -.El .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , diff --git a/share/man/man4/snd_csa.4 b/share/man/man4/snd_csa.4 index a3d9a72..1c85424 100644 --- a/share/man/man4/snd_csa.4 +++ b/share/man/man4/snd_csa.4 @@ -58,12 +58,12 @@ Such configurations are not supported by the .Nm driver yet. +.Sh SEE ALSO +.Xr sound 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 4.0 . -.Sh SEE ALSO -.Xr sound 4 .Sh AUTHORS .An Seigo Tanimura Aq tanimura@r.dl.itc.u-tokyo.ac.jp diff --git a/share/man/man4/snd_gusc.4 b/share/man/man4/snd_gusc.4 index 1c97866..cb577b1 100644 --- a/share/man/man4/snd_gusc.4 +++ b/share/man/man4/snd_gusc.4 @@ -70,13 +70,13 @@ Gravis UltraSound PnP .It xxx: gus pcm not attached, out of memory There are not enough memory to drive the device. .El +.Sh SEE ALSO +.Xr sound 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 4.0 . -.Sh SEE ALSO -.Xr sound 4 .Sh AUTHORS .An Ville-Pertti Keinonen Aq will@iki.fi .An Seigo Tanimura Aq tanimura@r.dl.itc.u-tokyo.ac.jp diff --git a/share/man/man4/snd_ich.4 b/share/man/man4/snd_ich.4 index 443a5ab..ba7b910 100644 --- a/share/man/man4/snd_ich.4 +++ b/share/man/man4/snd_ich.4 @@ -79,13 +79,13 @@ NVIDIA nForce3 250 .It SiS 7012 .El +.Sh SEE ALSO +.Xr sound 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 4.2 . -.Sh SEE ALSO -.Xr sound 4 .Sh AUTHORS This manual page was written by .An Jorge Mario G. Mazo Aq jgutie11@eafit.edu.co . diff --git a/share/man/man4/snd_maestro.4 b/share/man/man4/snd_maestro.4 index d555680..cf01689 100644 --- a/share/man/man4/snd_maestro.4 +++ b/share/man/man4/snd_maestro.4 @@ -54,14 +54,14 @@ ESS Technology Maestro-2 .It ESS Technology Maestro-2E .El +.Sh SEE ALSO +.Xr snd_maestro3 4 , +.Xr sound 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 4.2 . -.Sh SEE ALSO -.Xr snd_maestro3 4 , -.Xr sound 4 .Sh AUTHORS This manual page was written by .An Jorge Mario G. Mazo Aq jgutie11@eafit.edu.co . diff --git a/share/man/man4/snd_sbc.4 b/share/man/man4/snd_sbc.4 index ea847a1..d3b5860 100644 --- a/share/man/man4/snd_sbc.4 +++ b/share/man/man4/snd_sbc.4 @@ -70,12 +70,12 @@ Check the I/O port configuration. .It bad irq XX (5/7/9/10 valid) The IRQ given to the driver is not valid. .El +.Sh SEE ALSO +.Xr sound 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 4.0 . -.Sh SEE ALSO -.Xr sound 4 .Sh AUTHORS .An Seigo Tanimura Aq tanimura@r.dl.itc.u-tokyo.ac.jp diff --git a/share/man/man4/snp.4 b/share/man/man4/snp.4 index 96a0663..809d30b 100644 --- a/share/man/man4/snp.4 +++ b/share/man/man4/snp.4 @@ -69,16 +69,16 @@ and detached. .Xr sio 4 , .Xr kldload 8 , .Xr watch 8 +.Sh HISTORY +The +.Nm +device first appeared in +.Fx 2.1 . +.Sh AUTHORS +.An Ugen J.S. Antsilevich Aq ugen@NetVision.net.il .Sh BUGS Caveat emptor! This manual page is horribly stale and wildly inaccurate in some places. .Pp While in line mode, user input cannot be seen. No signals may be sent to the observed tty. -.Sh AUTHORS -.An Ugen J.S. Antsilevich Aq ugen@NetVision.net.il -.Sh HISTORY -The -.Nm -device first appeared in -.Fx 2.1 . diff --git a/share/man/man4/spic.4 b/share/man/man4/spic.4 index 3c43bb3..a398007 100644 --- a/share/man/man4/spic.4 +++ b/share/man/man4/spic.4 @@ -49,13 +49,13 @@ respectively. From that a program reading the Jogdial can decide what to do. Some actions might include scrolling, mimicking mouse buttons, launching applications, or other useful things. +.Sh SEE ALSO +.Xr moused 8 .Sh HISTORY The .Nm device driver first appeared in .Fx 4.6 . -.Sh SEE ALSO -.Xr moused 8 .Sh AUTHORS .An Nick Sayer Aq nsayer@FreeBSD.org .An Will Andrews Aq will@FreeBSD.org diff --git a/share/man/man4/spkr.4 b/share/man/man4/spkr.4 index e29ad6c..fc0ed99 100644 --- a/share/man/man4/spkr.4 +++ b/share/man/man4/spkr.4 @@ -209,6 +209,23 @@ BASIC.) .Pp Whitespace in play strings is simply skipped and may be used to separate melody sections. +.Sh FILES +.Bl -tag -width /dev/speakerxx +.It Pa /dev/speaker +speaker device file +.El +.Sh SEE ALSO +.Xr spkrtest 8 +.Sh HISTORY +The +.Nm +device appeared in +.Fx 1.0 . +.Sh AUTHORS +.An Eric S. Raymond Aq esr@snark.thyrsus.com +June 1990 +.Sh "PORTED BY" +.An Andrew A. Chernov Aq ache@astral.msk.su .Sh BUGS Due to roundoff in the pitch tables and slop in the tone-generation and timer hardware (neither of which was designed for precision), neither pitch accuracy @@ -230,20 +247,3 @@ compatibility. In play strings which are very long (longer than your system's physical I/O blocks) note suffixes or numbers may occasionally be parsed incorrectly due to crossing a block boundary. -.Sh FILES -.Bl -tag -width /dev/speakerxx -.It Pa /dev/speaker -speaker device file -.El -.Sh SEE ALSO -.Xr spkrtest 8 -.Sh AUTHORS -.An Eric S. Raymond Aq esr@snark.thyrsus.com -June 1990 -.Sh "PORTED BY" -.An Andrew A. Chernov Aq ache@astral.msk.su -.Sh HISTORY -The -.Nm -device appeared in -.Fx 1.0 . diff --git a/share/man/man4/splash.4 b/share/man/man4/splash.4 index f66bdbe..cc7efc7 100644 --- a/share/man/man4/splash.4 +++ b/share/man/man4/splash.4 @@ -219,10 +219,6 @@ Both the splash screen and the screen saver work with only. They are not available for the alternative console driver .Xr pcvt 4 . -.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 -and will remain in memory, wasting kernel memory space. .Sh SEE ALSO .Xr vidcontrol 1 , .Xr syscons 4 , @@ -255,3 +251,7 @@ module was written by based on the .Pa splash_bmp code. +.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 +and will remain in memory, wasting kernel memory space. diff --git a/share/man/man4/sym.4 b/share/man/man4/sym.4 index 2f07deb..6ce4e13 100644 --- a/share/man/man4/sym.4 +++ b/share/man/man4/sym.4 @@ -332,8 +332,6 @@ Tyan S1365 .El .Sh MISC The DEC KZPCA-AA is a rebadged SYM8952U. -.Sh BUGS -No known bugs. .Sh SEE ALSO .Xr cd 4 , .Xr da 4 , @@ -341,6 +339,11 @@ No known bugs. .Xr sa 4 , .Xr scsi 4 , .Xr camcontrol 8 +.Sh HISTORY +The +.Nm +driver appeared in +.Fx 4.0 . .Sh AUTHORS .An -nosplit The @@ -364,8 +367,5 @@ by .An Wolfgang Stanglmeier and .An Stefan Esser . -.Sh HISTORY -The -.Nm -driver appeared in -.Fx 4.0 . +.Sh BUGS +No known bugs. diff --git a/share/man/man4/syscons.4 b/share/man/man4/syscons.4 index cd2000b..5eddb5e 100644 --- a/share/man/man4/syscons.4 +++ b/share/man/man4/syscons.4 @@ -518,8 +518,6 @@ 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. .Sh SEE ALSO .Xr kbdcontrol 1 , .Xr login 1 , @@ -551,3 +549,5 @@ 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 BUGS +This manual page is incomplete and urgently needs revision. diff --git a/share/man/man4/targ.4 b/share/man/man4/targ.4 index f3618c0..a1fa449 100644 --- a/share/man/man4/targ.4 +++ b/share/man/man4/targ.4 @@ -130,16 +130,6 @@ are the control devices. .%T "FreeBSD Target Information" .%O http://www.root.org/~nate/freebsd/ .Re -.Sh BUGS -Currently, only the -.Xr ahc 4 -and -.Xr isp 4 -drivers fully support target mode. -.Pp -The -.Xr ahc 4 -driver does not support tagged queuing in target mode. .Sh AUTHORS .An -nosplit The @@ -153,3 +143,13 @@ for .Fx 5.0 by .An Nate Lawson Aq nate@root.org . +.Sh BUGS +Currently, only the +.Xr ahc 4 +and +.Xr isp 4 +drivers fully support target mode. +.Pp +The +.Xr ahc 4 +driver does not support tagged queuing in target mode. diff --git a/share/man/man4/tdfx.4 b/share/man/man4/tdfx.4 index 33e3aac..7430d93 100644 --- a/share/man/man4/tdfx.4 +++ b/share/man/man4/tdfx.4 @@ -73,6 +73,13 @@ Mirrors of above interfaces (Some apps use .Pa /dev/voodoo ) .El +.Sh HISTORY +The +.Nm +driver appeared in +.Fx 5.0 , +and was originally developed for Linux kernel 2.0.x, later written for +2.2.x and 2.4.x. .Sh AUTHORS .An -nosplit The driver was developed by @@ -87,10 +94,3 @@ and to be directly compatible with it and support the many GLIDE based games available for Linux and .Ux . -.Sh HISTORY -The -.Nm -driver appeared in -.Fx 5.0 , -and was originally developed for Linux kernel 2.0.x, later written for -2.2.x and 2.4.x. diff --git a/share/man/man4/twe.4 b/share/man/man4/twe.4 index 6eb8ebe..2e09bb2 100644 --- a/share/man/man4/twe.4 +++ b/share/man/man4/twe.4 @@ -241,6 +241,12 @@ No further I/O will be handled. The controller was successfully reset, and outstanding commands were restarted. .El +.Sh AUTHORS +The +.Nm +driver and manpage were written by +.An Michael Smith +.Aq msmith@FreeBSD.org . .Sh BUGS The controller cannot handle I/O transfers that are not aligned to a 512-byte boundary. @@ -250,9 +256,3 @@ This process is inefficient, and thus in order to obtain best performance user-space applications accessing the device should do so with aligned buffers. -.Sh AUTHORS -The -.Nm -driver and manpage were written by -.An Michael Smith -.Aq msmith@FreeBSD.org . diff --git a/share/man/man4/tx.4 b/share/man/man4/tx.4 index bfbd425..6384fb4 100644 --- a/share/man/man4/tx.4 +++ b/share/man/man4/tx.4 @@ -99,11 +99,11 @@ Packet thrown away. .It "tx%d: can't stop %s DMA" While resetting, the driver failed to stop the device correctly. .El -.Sh BUGS -The auto-negotiation does not work very well. .Sh SEE ALSO .Xr arp 4 , .Xr miibus 4 , .Xr netintro 4 , .Xr ng_ether 4 , .Xr ifconfig 8 +.Sh BUGS +The auto-negotiation does not work very well. diff --git a/share/man/man4/ubtbcmfw.4 b/share/man/man4/ubtbcmfw.4 index 76de904..afe5a1f 100644 --- a/share/man/man4/ubtbcmfw.4 +++ b/share/man/man4/ubtbcmfw.4 @@ -71,9 +71,6 @@ calls: .It Dv USB_GET_DEVICE_DESC Pq Vt usb_device_descriptor_t Return the device descriptor. .El -.Sh BUGS -Most likely. -Please report if found. .Sh FILES .Bl -tag -width ".Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE" -compact .It Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE @@ -94,3 +91,6 @@ driver was implemented in .Fx 5.0 . .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh BUGS +Most likely. +Please report if found. diff --git a/share/man/man4/ucycom.4 b/share/man/man4/ucycom.4 index d086c80..480df2b 100644 --- a/share/man/man4/ucycom.4 +++ b/share/man/man4/ucycom.4 @@ -60,14 +60,14 @@ driver behaves like a .Sh SEE ALSO .Xr tty 4 , .Xr usb 4 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 5.3 . .Sh AUTHORS .An -nosplit The .Nm driver and this manual page were written by .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org . -.Sh HISTORY -The -.Nm -driver first appeared in -.Fx 5.3 . diff --git a/share/man/man4/uvisor.4 b/share/man/man4/uvisor.4 index 206bc7d..e6bac3f 100644 --- a/share/man/man4/uvisor.4 +++ b/share/man/man4/uvisor.4 @@ -108,13 +108,6 @@ Sony Clie NX60 .It Sony Clie S360 .El -.Sh BUGS -The code to provide multiple -.Xr ucom 4 -instances has not yet been ported from -.Nx . -It is unclear whether this driver works in its -current state. .Sh SEE ALSO .Xr tty 4 , .Xr ucom 4 , @@ -130,3 +123,10 @@ This manual page was adopted from by .An Tom Rhodes Aq trhodes@FreeBSD.org at that time. +.Sh BUGS +The code to provide multiple +.Xr ucom 4 +instances has not yet been ported from +.Nx . +It is unclear whether this driver works in its +current state. diff --git a/share/man/man4/vinum.4 b/share/man/man4/vinum.4 index 0318d89..fc99de2 100644 --- a/share/man/man4/vinum.4 +++ b/share/man/man4/vinum.4 @@ -841,6 +841,24 @@ The drive is not accessible. .It Em up The drive is up and running. .El +.Sh SEE ALSO +.Xr disklabel 5 , +.Xr loader.conf 5 , +.Xr disklabel 8 , +.Xr loader 8 , +.Xr newfs 8 , +.Xr vinum 8 +.Sh HISTORY +.Nm +first appeared in +.Fx 3.0 . +The RAID-5 component of +.Nm +was developed by Cybernet Inc.\& +.Pq Pa http://www.cybernet.com/ , +for its NetMAX product. +.Sh AUTHORS +.An Greg Lehey Aq grog@lemis.com . .Sh BUGS .Nm is a new product. @@ -1155,21 +1173,3 @@ at the beginning. .It If you have a panic, a stack trace as described above. .El -.Sh AUTHORS -.An Greg Lehey Aq grog@lemis.com . -.Sh HISTORY -.Nm -first appeared in -.Fx 3.0 . -The RAID-5 component of -.Nm -was developed by Cybernet Inc.\& -.Pq Pa http://www.cybernet.com/ , -for its NetMAX product. -.Sh SEE ALSO -.Xr disklabel 5 , -.Xr loader.conf 5 , -.Xr disklabel 8 , -.Xr loader 8 , -.Xr newfs 8 , -.Xr vinum 8 diff --git a/share/man/man4/vpo.4 b/share/man/man4/vpo.4 index 4d3ea1c..bab7fc1 100644 --- a/share/man/man4/vpo.4 +++ b/share/man/man4/vpo.4 @@ -90,10 +90,6 @@ bootflags to force other modes. .Xr ppbus 4 , .Xr ppc 4 , .Xr scsi 4 -.Sh BUGS -During boot, the driver first tries to detect a classic ZIP, then a ZIP+. -The ZIP+ detection is intrusive and may send erroneous characters to your -printer if the drive is not connected to your parallel port. .Sh HISTORY The .Nm @@ -103,3 +99,7 @@ manual page first appeared in This manual page was written by .An Nicolas Souchu . +.Sh BUGS +During boot, the driver first tries to detect a classic ZIP, then a ZIP+. +The ZIP+ detection is intrusive and may send erroneous characters to your +printer if the drive is not connected to your parallel port. diff --git a/share/man/man4/worm.4 b/share/man/man4/worm.4 index 727fb62..72e74b8 100644 --- a/share/man/man4/worm.4 +++ b/share/man/man4/worm.4 @@ -88,16 +88,6 @@ driver instead. .Xr cd 4 , .Xr pass 4 , .Xr xpt 4 -.Sh AUTHORS -.An -nosplit -The first skeleton for a -.Nm -driver has been written by -.An Peter Dufault -in May, 1995. -The driver has then been improved and made actually usable at all by -.An J\(:org Wunsch -in January, 1996. .Sh HISTORY The .Nm @@ -108,3 +98,13 @@ and disappeared in with the advent of the CAM .Tn SCSI layer. +.Sh AUTHORS +.An -nosplit +The first skeleton for a +.Nm +driver has been written by +.An Peter Dufault +in May, 1995. +The driver has then been improved and made actually usable at all by +.An J\(:org Wunsch +in January, 1996. diff --git a/share/man/man5/dir.5 b/share/man/man5/dir.5 index 6c5a387..c471043 100644 --- a/share/man/man5/dir.5 +++ b/share/man/man5/dir.5 @@ -149,12 +149,12 @@ struct dirent { .Sh SEE ALSO .Xr fs 5 , .Xr inode 5 -.Sh BUGS -The usage of the member d_type of struct dirent is unportable as it is -.Fx Ns -specific . -It also may fail on certain file systems, for example the cd9660 file system. .Sh HISTORY A .Nm file format appeared in .At v7 . +.Sh BUGS +The usage of the member d_type of struct dirent is unportable as it is +.Fx Ns -specific . +It also may fail on certain file systems, for example the cd9660 file system. diff --git a/share/man/man5/group.5 b/share/man/man5/group.5 index 7dc1fc64..ede3a5a 100644 --- a/share/man/man5/group.5 +++ b/share/man/man5/group.5 @@ -148,12 +148,6 @@ may still have this limit. .Xr passwd 5 , .Xr pw 8 , .Xr yp 8 -.Sh BUGS -The -.Xr passwd 1 -command does not change the -.Nm -passwords. .Sh HISTORY A .Nm @@ -161,3 +155,9 @@ file format appeared in .At v6 . Support for comments first appeared in .Fx 3.0 . +.Sh BUGS +The +.Xr passwd 1 +command does not change the +.Nm +passwords. diff --git a/share/man/man5/hosts.equiv.5 b/share/man/man5/hosts.equiv.5 index c180d2a..aede76c 100644 --- a/share/man/man5/hosts.equiv.5 +++ b/share/man/man5/hosts.equiv.5 @@ -96,6 +96,18 @@ For security reasons, a user's 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 FILES +.Bl -tag -width /etc/hosts.equivxxx -compact +.It Pa /etc/hosts.equiv +The +.Nm +file resides in +.Pa /etc . +.It Pa $HOME/.rhosts +.Nm .rhosts +file resides in +.Pa $HOME . +.El .Sh EXAMPLES .Dl bar.com foo .Pp @@ -116,18 +128,6 @@ Trust all hosts from netgroup and their users except users from netgroup .Dq dau . -.Sh FILES -.Bl -tag -width /etc/hosts.equivxxx -compact -.It Pa /etc/hosts.equiv -The -.Nm -file resides in -.Pa /etc . -.It Pa $HOME/.rhosts -.Nm .rhosts -file resides in -.Pa $HOME . -.El .Sh SEE ALSO .Xr rcp 1 , .Xr rlogin 1 , diff --git a/share/man/man5/intro.5 b/share/man/man5/intro.5 index bf9af6d..764ba4d 100644 --- a/share/man/man5/intro.5 +++ b/share/man/man5/intro.5 @@ -39,15 +39,15 @@ .Nd "introduction to file formats" .Sh DESCRIPTION This section contains information about file formats. -.Sh SEE ALSO -.Xr apropos 1 , -.Xr intro 1 , -.Xr intro 8 .Sh FILES .Bl -tag -width /etc/shells -compact .It Pa /etc location of most system configuration files .El +.Sh SEE ALSO +.Xr apropos 1 , +.Xr intro 1 , +.Xr intro 8 .Sh HISTORY The .Nm diff --git a/share/man/man5/libmap.conf.5 b/share/man/man5/libmap.conf.5 index 4299e58..f6da1ea 100644 --- a/share/man/man5/libmap.conf.5 +++ b/share/man/man5/libmap.conf.5 @@ -95,6 +95,11 @@ The most common use at the date of writing is for allowing multiple .Tn POSIX threading libraries to be used on a system without relinking or changing symlinks. +.Sh FILES +.Bl -tag -width ".Pa /etc/libmap.conf" -compact +.It Pa /etc/libmap.conf +The libmap configuration file. +.El .Sh EXAMPLES .Bd -literal # /etc/libmap.conf @@ -121,11 +126,6 @@ libpthread.so libpthread.so libpthread.so.1 libthr.so.1 libpthread.so libthr.so .Ed -.Sh FILES -.Bl -tag -width ".Pa /etc/libmap.conf" -compact -.It Pa /etc/libmap.conf -The libmap configuration file. -.El .Sh SEE ALSO .Xr ldd 1 , .Xr rtld 1 diff --git a/share/man/man5/linprocfs.5 b/share/man/man5/linprocfs.5 index dbd8cab..2be3da3 100644 --- a/share/man/man5/linprocfs.5 +++ b/share/man/man5/linprocfs.5 @@ -71,6 +71,11 @@ The complete virtual address space of the current process. .Xr procfs 5 , .Xr mount_linprocfs 8 , .Xr pseudofs 9 +.Sh HISTORY +The +.Nm +first appeared in +.Fx 4.0 . .Sh AUTHORS .An -nosplit The @@ -85,8 +90,3 @@ based on the .Xr procfs 5 manual page by .An Garrett Wollman . -.Sh HISTORY -The -.Nm -first appeared in -.Fx 4.0 . diff --git a/share/man/man5/mailer.conf.5 b/share/man/man5/mailer.conf.5 index 87c1249..56582ec 100644 --- a/share/man/man5/mailer.conf.5 +++ b/share/man/man5/mailer.conf.5 @@ -56,6 +56,8 @@ The second member of each pair is the name of the program to actually execute when the first name is invoked. The file may also contain comments, denoted by a # mark in the first column of any line. +.Sh FILES +/etc/mail/mailer.conf .Sh EXAMPLES The following is an example of how to set up an .Nm @@ -77,8 +79,6 @@ send-mail /usr/local/sbin/sendmail mailq /usr/local/sbin/sendmail newaliases /usr/local/sbin/sendmail .Ed -.Sh FILES -/etc/mail/mailer.conf .Sh SEE ALSO .Xr mail 1 , .Xr mailq 1 , diff --git a/share/man/man5/networks.5 b/share/man/man5/networks.5 index ff62267..386ee7d 100644 --- a/share/man/man5/networks.5 +++ b/share/man/man5/networks.5 @@ -80,10 +80,10 @@ file resides in .El .Sh SEE ALSO .Xr getnetent 3 -.Sh BUGS -A name server should be used instead of a static file. .Sh HISTORY The .Nm file format appeared in .Bx 4.2 . +.Sh BUGS +A name server should be used instead of a static file. diff --git a/share/man/man5/passwd.5 b/share/man/man5/passwd.5 index 9476ec0..0bbb5b1 100644 --- a/share/man/man5/passwd.5 +++ b/share/man/man5/passwd.5 @@ -313,27 +313,6 @@ password file, with passwords intact .Xr db 3 Ns -format password database, with passwords intact .El -.Sh SEE ALSO -.Xr chpass 1 , -.Xr login 1 , -.Xr passwd 1 , -.Xr getpwent 3 , -.Xr login.conf 5 , -.Xr netgroup 5 , -.Xr adduser 8 , -.Xr pwd_mkdb 8 , -.Xr vipw 8 , -.Xr yp 8 -.Pp -.%T "Managing NFS and NIS" -(O'Reilly & Associates) -.Sh BUGS -User information should (and eventually will) be stored elsewhere. -.Pp -Placing -.Sq compat -exclusions in the file after any inclusions will have -unexpected results. .Sh COMPATIBILITY The password file format has changed since .Bx 4.3 . @@ -352,6 +331,20 @@ of offset you want. BEGIN { FS = ":"} { print $1 ":" $2 ":" $3 ":" $4 "::0:0:" $5 ":" $6 ":" $7 } .Ed +.Sh SEE ALSO +.Xr chpass 1 , +.Xr login 1 , +.Xr passwd 1 , +.Xr getpwent 3 , +.Xr login.conf 5 , +.Xr netgroup 5 , +.Xr adduser 8 , +.Xr pwd_mkdb 8 , +.Xr vipw 8 , +.Xr yp 8 +.Pp +.%T "Managing NFS and NIS" +(O'Reilly & Associates) .Sh HISTORY A .Nm @@ -369,3 +362,10 @@ It was imported from the .Nx Project, where it first appeared in .Nx 1.4 . +.Sh BUGS +User information should (and eventually will) be stored elsewhere. +.Pp +Placing +.Sq compat +exclusions in the file after any inclusions will have +unexpected results. diff --git a/share/man/man5/protocols.5 b/share/man/man5/protocols.5 index fb9577e..37d3541 100644 --- a/share/man/man5/protocols.5 +++ b/share/man/man5/protocols.5 @@ -71,10 +71,10 @@ file resides in .El .Sh SEE ALSO .Xr getprotoent 3 -.Sh BUGS -A name server should be used instead of a static file. .Sh HISTORY The .Nm file format appeared in .Bx 4.2 . +.Sh BUGS +A name server should be used instead of a static file. diff --git a/share/man/man5/remote.5 b/share/man/man5/remote.5 index 0935b77..666608d 100644 --- a/share/man/man5/remote.5 +++ b/share/man/man5/remote.5 @@ -175,6 +175,14 @@ Indicates that the list of capabilities is continued in the named description. This is used primarily to share common capability information. .El +.Sh FILES +.Bl -tag -width /etc/remote -compact +.It Pa /etc/remote +The +.Nm +host description file resides in +.Pa /etc . +.El .Sh EXAMPLES Here is a short example showing the use of the capability continuation feature. @@ -190,14 +198,6 @@ UNIX-57600:\e arpavax|ax:\e :pn=\e@:tc=UNIX-57600 .Ed -.Sh FILES -.Bl -tag -width /etc/remote -compact -.It Pa /etc/remote -The -.Nm -host description file resides in -.Pa /etc . -.El .Sh SEE ALSO .Xr cu 1 , .Xr tip 1 , diff --git a/share/man/man5/services.5 b/share/man/man5/services.5 index 738573dd5..40320f9 100644 --- a/share/man/man5/services.5 +++ b/share/man/man5/services.5 @@ -84,10 +84,10 @@ file resides in .El .Sh SEE ALSO .Xr getservent 3 -.Sh BUGS -A name server should be used instead of a static file. .Sh HISTORY The .Nm file format appeared in .Bx 4.2 . +.Sh BUGS +A name server should be used instead of a static file. diff --git a/share/man/man5/stab.5 b/share/man/man5/stab.5 index 397a58b..bbbd292 100644 --- a/share/man/man5/stab.5 +++ b/share/man/man5/stab.5 @@ -212,10 +212,10 @@ compiled files: .Xr as 1 , .Xr ld 1 , .Xr a.out 5 -.Sh BUGS -More basic types are needed. .Sh HISTORY The .Nm file appeared in .Bx 4.0 . +.Sh BUGS +More basic types are needed. diff --git a/share/man/man6/intro.6 b/share/man/man6/intro.6 index f6eac24..7403754 100644 --- a/share/man/man6/intro.6 +++ b/share/man/man6/intro.6 @@ -48,12 +48,6 @@ command: .Bd -literal -offset indent $ apropos '\\(6\\)' .Ed -.Sh SEE ALSO -.Xr intro 1 , -.Xr dm 8 -.Pp -Tutorials in the -.%T "UNIX User's Manual Supplementary Documents" . .Sh FILES .Bl -tag -width /usr/share/doc/usd/31.trek -compact .It Pa /usr/games @@ -61,6 +55,12 @@ location of games .It Pa /usr/share/doc/usd games tutorials .El +.Sh SEE ALSO +.Xr intro 1 , +.Xr dm 8 +.Pp +Tutorials in the +.%T "UNIX User's Manual Supplementary Documents" . .Sh HISTORY The .Nm diff --git a/share/man/man7/ports.7 b/share/man/man7/ports.7 index 345a4b1..4a80029 100644 --- a/share/man/man7/ports.7 +++ b/share/man/man7/ports.7 @@ -466,10 +466,6 @@ The following are part of the ports collection: .Pp .Pa http://www.FreeBSD.org/ports (searchable index of all ports) -.Sh AUTHORS -.An -nosplit -This manual page was originated by -.An David O'Brien . .Sh HISTORY The Ports Collection appeared in @@ -478,6 +474,10 @@ It has since spread to .Nx and .Ox . +.Sh AUTHORS +.An -nosplit +This manual page was originated by +.An David O'Brien . .Sh BUGS Ports documentation is split over four places \(em .Pa /usr/ports/Mk/bsd.port.mk , diff --git a/share/man/man8/adding_user.8 b/share/man/man8/adding_user.8 index 007c3bf..2f4dab1 100644 --- a/share/man/man8/adding_user.8 +++ b/share/man/man8/adding_user.8 @@ -108,10 +108,10 @@ skeletal login directory .Xr adduser 8 , .Xr pwd_mkdb 8 , .Xr vipw 8 -.Sh BUGS -User information should (and eventually will) be stored elsewhere. .Sh HISTORY The .Nm utility appeared in .Bx 3.0 . +.Sh BUGS +User information should (and eventually will) be stored elsewhere. diff --git a/share/man/man8/diskless.8 b/share/man/man8/diskless.8 index ecf88a0..5c8345a 100644 --- a/share/man/man8/diskless.8 +++ b/share/man/man8/diskless.8 @@ -449,6 +449,17 @@ Be warned that using unencrypted to mount root and user partitions may expose information such as encryption keys. +.Sh SEE ALSO +.Xr ethers 5 , +.Xr exports 5 , +.Xr bootpd 8 , +.Xr mountd 8 , +.Xr nfsd 8 , +.Xr pxeboot 8 , +.Xr reboot 8 , +.Xr tftpd 8 +.Pp +.Pa ports/net/etherboot .Sh BUGS This manpage is probably incomplete. .Pp @@ -462,14 +473,3 @@ and while trying to preserve the original content. The process might not handle all cases. -.Sh SEE ALSO -.Xr ethers 5 , -.Xr exports 5 , -.Xr bootpd 8 , -.Xr mountd 8 , -.Xr nfsd 8 , -.Xr pxeboot 8 , -.Xr reboot 8 , -.Xr tftpd 8 -.Pp -.Pa ports/net/etherboot diff --git a/share/man/man8/rc.8 b/share/man/man8/rc.8 index fed004a..23ddbfa 100644 --- a/share/man/man8/rc.8 +++ b/share/man/man8/rc.8 @@ -466,6 +466,23 @@ before starting the daemon. .Pp Following tradition, all startup files reside in .Pa /etc . +.Sh FILES +.Bl -tag -compact +.It Pa /etc/rc +.It Pa /etc/rc.conf +.It Pa /etc/rc.conf.local +.It Pa /etc/rc.d/ +.It Pa /etc/rc.firewall +.It Pa /etc/rc.local +.It Pa /etc/rc.shutdown +.It Pa /etc/rc.subr +.It Pa /var/run/dmesg.boot +.Xr dmesg 1 +results soon after the +.Nm +process begins. +Useful when dmesg buffer in the kernel no longer has this information. +.El .Sh EXAMPLES The following is a minimal .Nm rc.d/ @@ -546,23 +563,6 @@ As all processes are killed by at shutdown, the explicit .Xr kill 1 is unnecessary, but is often included. -.Sh FILES -.Bl -tag -compact -.It Pa /etc/rc -.It Pa /etc/rc.conf -.It Pa /etc/rc.conf.local -.It Pa /etc/rc.d/ -.It Pa /etc/rc.firewall -.It Pa /etc/rc.local -.It Pa /etc/rc.shutdown -.It Pa /etc/rc.subr -.It Pa /var/run/dmesg.boot -.Xr dmesg 1 -results soon after the -.Nm -process begins. -Useful when dmesg buffer in the kernel no longer has this information. -.El .Sh SEE ALSO .Xr kill 1 , .Xr rc.conf 5 , diff --git a/share/man/man8/sticky.8 b/share/man/man8/sticky.8 index fdff63e..aa94a11 100644 --- a/share/man/man8/sticky.8 +++ b/share/man/man8/sticky.8 @@ -69,14 +69,14 @@ Any user may create a sticky directory. See .Xr chmod 1 for details about modifying file modes. +.Sh HISTORY +A +.Nm +command appeared in +.At 32v . .Sh BUGS Neither .Xr open 2 nor .Xr mkdir 2 will create a file with the sticky bit set. -.Sh HISTORY -A -.Nm -command appeared in -.At 32v . diff --git a/share/man/man8/yp.8 b/share/man/man8/yp.8 index 2903c89..75e3cc1 100644 --- a/share/man/man8/yp.8 +++ b/share/man/man8/yp.8 @@ -511,6 +511,24 @@ a v1 and v2 server. .Xr ypserv 8 manual page for a detailed description of these special features and flags.) +.Sh HISTORY +The +.Nm YP +subsystem was written from the ground up by +.An Theo de Raadt +to be compatible to Sun's implementation. +Bug fixes, improvements +and +.Tn NIS +server support were later added by +.An Bill Paul . +The server-side code was originally written by +.An Peter Eriksson +and +.An Tobias Reber +and is subject to the GNU Public License. +No Sun code was +referenced. .Sh BUGS While .Fx @@ -546,21 +564,3 @@ manuals for there. Neither Sun nor this author have found a clean way to handle the problems that occur when ypbind cannot find its server upon bootup. -.Sh HISTORY -The -.Nm YP -subsystem was written from the ground up by -.An Theo de Raadt -to be compatible to Sun's implementation. -Bug fixes, improvements -and -.Tn NIS -server support were later added by -.An Bill Paul . -The server-side code was originally written by -.An Peter Eriksson -and -.An Tobias Reber -and is subject to the GNU Public License. -No Sun code was -referenced. diff --git a/share/man/man9/BUS_ADD_CHILD.9 b/share/man/man9/BUS_ADD_CHILD.9 index 8a76d33..8b69d5a 100644 --- a/share/man/man9/BUS_ADD_CHILD.9 +++ b/share/man/man9/BUS_ADD_CHILD.9 @@ -58,10 +58,6 @@ Busses implementing should insert the device into the tree using .Xr device_add_child 9 before adding things such as their own ivars and resource lists to the device. -.Sh SEE ALSO -.Xr device 9 , -.Xr device_add_child 9 , -.Xr driver 9 .Sh RETURN VALUES The .Fn BUS_ADD_CHILD @@ -69,6 +65,10 @@ method returns .Vt device_t added to the tree, or .Dv NULL . +.Sh SEE ALSO +.Xr device 9 , +.Xr device_add_child 9 , +.Xr driver 9 .Sh AUTHORS This manual page was written by .An M. Warner Losh . diff --git a/share/man/man9/BUS_PRINT_CHILD.9 b/share/man/man9/BUS_PRINT_CHILD.9 index 9601466..a3709d9 100644 --- a/share/man/man9/BUS_PRINT_CHILD.9 +++ b/share/man/man9/BUS_PRINT_CHILD.9 @@ -54,11 +54,11 @@ Please see for more information regarding the proper formatting of the messages printed by .Fn BUS_PRINT_CHILD . +.Sh RETURN VALUES +The number of characters output. .Sh SEE ALSO .Xr device 9 , .Xr driver 9 -.Sh RETURN VALUES -The number of characters output. .Sh AUTHORS This manual page was written by .An Doug Rabson . diff --git a/share/man/man9/bus_generic_print_child.9 b/share/man/man9/bus_generic_print_child.9 index ae7780d..b4f1b87 100644 --- a/share/man/man9/bus_generic_print_child.9 +++ b/share/man/man9/bus_generic_print_child.9 @@ -56,10 +56,10 @@ The former prints "foo0: <FooCard 1234>" and the latter "on bar0". 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 -.Xr device 9 .Sh RETURN VALUES The number of characters output. +.Sh SEE ALSO +.Xr device 9 .Sh AUTHORS This man page was written by .An Doug Rabson . diff --git a/share/man/man9/contigmalloc.9 b/share/man/man9/contigmalloc.9 index 885357b..69c9ee5 100644 --- a/share/man/man9/contigmalloc.9 +++ b/share/man/man9/contigmalloc.9 @@ -109,8 +109,6 @@ p = contigmalloc(8192, M_DEVBUF, M_ZERO, 0, (1L << 22), Ask for 8192 bytes of zero-filled memory residing between physical address 0 and 4194303 inclusive, aligned to a 32K boundary and not crossing a 1M address boundary. -.Sh SEE ALSO -.Xr malloc 9 .Sh DIAGNOSTICS The .Fn contigmalloc @@ -121,3 +119,5 @@ is zero, or if or .Fa boundary is not a power of two. +.Sh SEE ALSO +.Xr malloc 9 diff --git a/share/man/man9/g_access.9 b/share/man/man9/g_access.9 index 5bb8d52..95ad1da 100644 --- a/share/man/man9/g_access.9 +++ b/share/man/man9/g_access.9 @@ -86,18 +86,6 @@ cannot fail when the arguments and .Fa dce are less than or equal to 0. -.Sh ERRORS -Possible errors: -.Bl -tag -width Er -.It Bq Er EPERM -The function is trying to open a provider with an exclusive access count, but -it is already open for writing. -.It Bq Er EPERM -The function is trying to open a provider for writing, but it is already -exclusively open. -.El -.Pp -Any other error that can be returned by the provider's access method. .Sh EXAMPLES Create a consumer, attach it to a given provider, gain read access and read first sector. @@ -147,6 +135,18 @@ some_function(struct g_geom *mygeom, struct g_provider *pp) g_destroy_consumer(cp); } .Ed +.Sh ERRORS +Possible errors: +.Bl -tag -width Er +.It Bq Er EPERM +The function is trying to open a provider with an exclusive access count, but +it is already open for writing. +.It Bq Er EPERM +The function is trying to open a provider for writing, but it is already +exclusively open. +.El +.Pp +Any other error that can be returned by the provider's access method. .Sh SEE ALSO .Xr geom 4 , .Xr DECLARE_GEOM_CLASS 9 , diff --git a/share/man/man9/g_attach.9 b/share/man/man9/g_attach.9 index 96ba0eb..4bf7d9c 100644 --- a/share/man/man9/g_attach.9 +++ b/share/man/man9/g_attach.9 @@ -79,12 +79,6 @@ The topology lock has to be held. The .Fn g_attach function returns 0 if successful; otherwise an error code is returned. -.Sh ERRORS -Possible errors: -.Bl -tag -width Er -.It Bq Er ELOOP -The operation creates a topology loop. -.El .Sh EXAMPLES Create a consumer, attach it to a given provider, gain read access and clean up. .Bd -literal -offset indent @@ -123,6 +117,12 @@ some_function(struct g_geom *mygeom, struct g_provider *pp) g_destroy_consumer(cp); } .Ed +.Sh ERRORS +Possible errors: +.Bl -tag -width Er +.It Bq Er ELOOP +The operation creates a topology loop. +.El .Sh SEE ALSO .Xr geom 4 , .Xr DECLARE_GEOM_CLASS 9 , diff --git a/share/man/man9/g_event.9 b/share/man/man9/g_event.9 index 0cb574d..380caa8 100644 --- a/share/man/man9/g_event.9 +++ b/share/man/man9/g_event.9 @@ -130,6 +130,21 @@ and .Fn g_waitfor_event functions return 0 if successful; otherwise an error code is returned. +.Sh EXAMPLES +Example of a function called from the event queue. +.Bd -literal -offset indent +void +example_event(void *arg, int flag) +{ + + if (flag == EV_CANCEL) { + printf("Event with argument %p canceled.\\n", arg); + return; + } + + printf("Event with argument %p called.\\n", arg); +} +.Ed .Sh ERRORS Possible errors for the .Fn g_post_event @@ -156,21 +171,6 @@ argument was set to .Dv M_NOWAIT and there was insufficient memory. .El -.Sh EXAMPLES -Example of a function called from the event queue. -.Bd -literal -offset indent -void -example_event(void *arg, int flag) -{ - - if (flag == EV_CANCEL) { - printf("Event with argument %p canceled.\\n", arg); - return; - } - - printf("Event with argument %p called.\\n", arg); -} -.Ed .Sh SEE ALSO .Xr geom 4 , .Xr DECLARE_GEOM_CLASS 9 , diff --git a/share/man/man9/hashinit.9 b/share/man/man9/hashinit.9 index 3d2c996..15fdb3b 100644 --- a/share/man/man9/hashinit.9 +++ b/share/man/man9/hashinit.9 @@ -80,6 +80,10 @@ The argument should be the bit mask returned by the call to .Fn hashinit that allocated the hash table. +.Sh IMPLEMENTATION NOTES +The largest prime hash value chosen by +.Fn phashinit +is 32749. .Sh RETURN VALUES The .Fn hashinit @@ -95,10 +99,6 @@ function returns a pointer to an allocated hash table and sets the location pointed to by .Fa nentries to the number of rows in the hash table. -.Sh IMPLEMENTATION NOTES -The largest prime hash value chosen by -.Fn phashinit -is 32749. .Sh EXAMPLES A typical example is shown below: .Bd -literal -offset indent @@ -122,9 +122,6 @@ uses the value in \&... hashdestroy(footable, M_FOO, foomask); .Ed -.Sh SEE ALSO -.Xr LIST_HEAD 3 , -.Xr malloc 9 .Sh DIAGNOSTICS The .Fn hashinit @@ -140,6 +137,9 @@ function will panic if the hash table pointed to by .Fa hashtbl is not empty. +.Sh SEE ALSO +.Xr LIST_HEAD 3 , +.Xr malloc 9 .Sh BUGS There is no .Fn phashdestroy diff --git a/share/man/man9/mac.9 b/share/man/man9/mac.9 index 5218fa9..7511bd8 100644 --- a/share/man/man9/mac.9 +++ b/share/man/man9/mac.9 @@ -176,6 +176,11 @@ for information on the MAC Framework APIs. .%T "The FreeBSD Developers' Handbook" .%O "http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/" .Re +.Sh HISTORY +The +.Tn TrustedBSD +MAC Framework first appeared in +.Fx 5.0 . .Sh AUTHORS This man page was written by .An Robert Watson . @@ -227,11 +232,6 @@ Additional contributors include: .An Andrew Reiter , and .An Tim Robbins . -.Sh HISTORY -The -.Tn TrustedBSD -MAC Framework first appeared in -.Fx 5.0 . .Sh BUGS See the earlier section in this document concerning appropriateness for production use. diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9 index 442e41e..ea4dd06 100644 --- a/share/man/man9/malloc.9 +++ b/share/man/man9/malloc.9 @@ -231,18 +231,6 @@ one must include .In sys/types.h ) and .In sys/kernel.h . -.Sh RETURN VALUES -The -.Fn malloc , -.Fn realloc , -and -.Fn reallocf -functions return 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 (implying that -.Dv M_NOWAIT -was set). .Sh IMPLEMENTATION NOTES The memory allocator allocates memory in chunks that have size a power of two for requests up to the size of a page of memory. @@ -290,10 +278,18 @@ when holding a .Xr vnode 9 interlock, will cause a LOR (Lock Order Reversal) due to the intertwining of VM Objects and Vnodes. -.Sh SEE ALSO -.Xr vmstat 8 , -.Xr contigmalloc 9 , -.Xr vnode 9 +.Sh RETURN VALUES +The +.Fn malloc , +.Fn realloc , +and +.Fn reallocf +functions return 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 (implying that +.Dv M_NOWAIT +was set). .Sh DIAGNOSTICS A kernel compiled with the .Dv INVARIANTS @@ -305,3 +301,7 @@ and functions. Failing consistency checks will cause a panic or a system console message. +.Sh SEE ALSO +.Xr vmstat 8 , +.Xr contigmalloc 9 , +.Xr vnode 9 diff --git a/share/man/man9/microseq.9 b/share/man/man9/microseq.9 index c4197d9..041e2be 100644 --- a/share/man/man9/microseq.9 +++ b/share/man/man9/microseq.9 @@ -474,10 +474,6 @@ at ppc level to avoid ppbus to adapter function call overhead. But some actions like deciding whereas the transfer is IEEE1284-1994 compliant are executed at ppbus layer. -.Sh BUGS -Only one level of submicrosequences is allowed. -.Pp -When triggering the port, maximum delay allowed is 255 us. .Sh SEE ALSO .Xr ppbus 4 , .Xr ppc 4 , @@ -491,3 +487,7 @@ manual page first appeared in This manual page was written by .An Nicolas Souchu . +.Sh BUGS +Only one level of submicrosequences is allowed. +.Pp +When triggering the port, maximum delay allowed is 255 us. diff --git a/share/man/man9/pfil.9 b/share/man/man9/pfil.9 index cf10e25..b54449e 100644 --- a/share/man/man9/pfil.9 +++ b/share/man/man9/pfil.9 @@ -143,6 +143,9 @@ The .Fn pfil_head_unregister function might sleep! +.Sh SEE ALSO +.Xr bpf 4 , +.Xr bridge 4 .Sh HISTORY The .Nm @@ -209,6 +212,3 @@ of time. will return .Er ENOBUFS to indicate this. -.Sh SEE ALSO -.Xr bpf 4 , -.Xr bridge 4 diff --git a/share/man/man9/pmap_page_exists_quick.9 b/share/man/man9/pmap_page_exists_quick.9 index f0db837..8db2580 100644 --- a/share/man/man9/pmap_page_exists_quick.9 +++ b/share/man/man9/pmap_page_exists_quick.9 @@ -45,6 +45,11 @@ function is used to quickly determine if the page exists in the physical map .Fa pmap . It is typically called from the VM paging code. +.Sh IMPLEMENTATION NOTES +The PV count used above may be changed upwards or downwards in future; +it is only necessary that +.Dv TRUE +be returned for a small subset of pmaps for proper page aging. .Sh RETURN VALUES The .Fn pmap_page_exists_quick @@ -54,11 +59,6 @@ only if the PV entry for the physical map .Fa pmap is one of the first 16 PVs linked from the page .Fa m . -.Sh IMPLEMENTATION NOTES -The PV count used above may be changed upwards or downwards in future; -it is only necessary that -.Dv TRUE -be returned for a small subset of pmaps for proper page aging. .Sh SEE ALSO .Xr pmap 9 .Sh AUTHORS diff --git a/share/man/man9/rtentry.9 b/share/man/man9/rtentry.9 index 94b3810..6b70994 100644 --- a/share/man/man9/rtentry.9 +++ b/share/man/man9/rtentry.9 @@ -286,6 +286,9 @@ The radix-tree representation of the routing table and the .Vt rt_metrics structure first appeared in .Bx 4.3 reno . +.Sh AUTHORS +This manual page was written by +.An Garrett Wollman . .Sh BUGS There are a number of historical relics remaining in this interface. The @@ -298,6 +301,3 @@ There is some disagreement over whether it is legitimate for .Dv RTF_LLINFO to be set by any process other than .Va rt_ifa->ifa_rtrequest . -.Sh AUTHORS -This manual page was written by -.An Garrett Wollman . diff --git a/share/man/man9/uio.9 b/share/man/man9/uio.9 index 0126754..b567067 100644 --- a/share/man/man9/uio.9 +++ b/share/man/man9/uio.9 @@ -111,6 +111,15 @@ for the associated thread; used if indicates that the transfer is to be made from/to a process's address space. .El +.Sh RETURN VALUES +.Fn uiomove +can return +.Er EFAULT +from the invoked +.Xr copyin 9 +or +.Xr copyout 9 +in case the transfer was to/from a process's address space. .Sh EXAMPLES The idea is that the driver maintains a private buffer for its data, and processes the request in chunks of maximal the size of this @@ -151,15 +160,6 @@ fooread(dev_t dev, struct uio *uio, int flag) return (rv); } .Ed -.Sh RETURN VALUES -.Fn uiomove -can return -.Er EFAULT -from the invoked -.Xr copyin 9 -or -.Xr copyout 9 -in case the transfer was to/from a process's address space. .Sh SEE ALSO .Xr read 2 , .Xr readv 2 , diff --git a/share/man/man9/vm_map_clean.9 b/share/man/man9/vm_map_clean.9 index 85af33c..a739044 100644 --- a/share/man/man9/vm_map_clean.9 +++ b/share/man/man9/vm_map_clean.9 @@ -61,6 +61,10 @@ is TRUE, any cached pages are also freed. .Pp The range provided must be contiguous, it MUST NOT contain holes. The range provided MUST NOT contain any sub-map entries. +.Sh IMPLEMENTATION NOTES +This routine holds the +.Va Giant +lock to prevent multiple entry. .Sh RETURN VALUES The .Fn vm_map_clean @@ -74,10 +78,6 @@ will be returned if the function encountered a sub-map entry; .Dv KERN_INVALID_ARGUMENT will be returned if the function encountered a hole in the region provided, or if an entry could not be found for the given start address. -.Sh IMPLEMENTATION NOTES -This routine holds the -.Va Giant -lock to prevent multiple entry. .Sh SEE ALSO .Xr vm_map 9 .Sh AUTHORS |
