From 0afc94c17a8772df34294778904e816258542498 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ulrich=20Sp=C3=B6rlein?= Date: Thu, 13 May 2010 12:07:55 +0000 Subject: [PATCH] mdoc: move CAVEATS, BUGS and SECURITY CONSIDERATIONS sections to the bottom of the manpages and order them consistently. GNU groff doesn't care about the ordering, and doesn't even mention CAVEATS and SECURITY CONSIDERATIONS as common sections and where to put them. Found by: mdocml lint run Reviewed by: ru --- lib/libarchive/cpio.5 | 50 +++---- lib/libc/gen/fmtcheck.3 | 12 +- lib/libc/stdio/fgets.3 | 26 ++-- lib/libc/stdio/printf.3 | 142 +++++++++---------- lib/libc/stdio/tmpnam.3 | 22 +-- lib/libc/stdio/wprintf.3 | 6 +- lib/libc/stdlib/realpath.3 | 24 ++-- lib/libc/string/strcat.3 | 34 ++--- lib/libc/string/strcpy.3 | 20 +-- lib/libc/sys/access.2 | 42 +++--- lib/libc/sys/execve.2 | 48 +++---- lib/libc/sys/setuid.2 | 66 ++++----- lib/libpmc/pmc.mips.3 | 4 +- lib/libpmc/pmc.xscale.3 | 4 +- lib/msun/man/fenv.3 | 24 ++-- sbin/fsirand/fsirand.8 | 12 +- sbin/mksnap_ffs/mksnap_ffs.8 | 6 +- sbin/mount/mount.8 | 10 +- sbin/mount_msdosfs/mount_msdosfs.8 | 12 +- sbin/mount_ntfs/mount_ntfs.8 | 16 +-- sbin/mount_reiserfs/mount_reiserfs.8 | 6 +- sbin/mount_std/mount_std.8 | 4 +- sbin/rcorder/rcorder.8 | 26 ++-- share/man/man4/ae.4 | 16 +-- share/man/man4/ahb.4 | 14 +- share/man/man4/amdtemp.4 | 6 +- share/man/man4/ataraid.4 | 6 +- share/man/man4/cpuctl.4 | 4 +- share/man/man4/ed.4 | 36 ++--- share/man/man4/ef.4 | 8 +- share/man/man4/en.4 | 8 +- share/man/man4/fpa.4 | 10 +- share/man/man4/geom_fox.4 | 16 +-- share/man/man4/harp.4 | 4 +- share/man/man4/hatm.4 | 26 ++-- share/man/man4/hifn.4 | 18 +-- share/man/man4/hwpmc.4 | 72 +++++----- share/man/man4/inet.4 | 12 +- share/man/man4/kbdmux.4 | 14 +- share/man/man4/ksyms.4 | 12 +- share/man/man4/man4.i386/cs.4 | 12 +- share/man/man4/man4.i386/ie.4 | 12 +- share/man/man4/man4.i386/mse.4 | 8 +- share/man/man4/man4.i386/pnp.4 | 22 +-- share/man/man4/man4.i386/pnpbios.4 | 22 +-- share/man/man4/man4.i386/vx.4 | 20 +-- share/man/man4/man4.i386/wl.4 | 22 +-- share/man/man4/man4.powerpc/snd_ai2s.4 | 4 +- share/man/man4/man4.powerpc/snd_davbus.4 | 4 +- share/man/man4/man4.sparc64/clkbrd.4 | 4 +- share/man/man4/man4.sparc64/creator.4 | 4 +- share/man/man4/man4.sparc64/machfb.4 | 4 +- share/man/man4/man4.sparc64/ofw_console.4 | 26 ++-- share/man/man4/man4.sparc64/openfirm.4 | 38 ++--- share/man/man4/man4.sparc64/openprom.4 | 30 ++-- share/man/man4/natm.4 | 10 +- share/man/man4/nve.4 | 8 +- share/man/man4/patm.4 | 12 +- share/man/man4/psm.4 | 60 ++++---- share/man/man4/splash.4 | 8 +- share/man/man4/syscons.4 | 16 +-- share/man/man4/twa.4 | 0 share/man/man4/ucom.4 | 16 +-- share/man/man4/vkbd.4 | 14 +- share/man/man4/wpi.4 | 8 +- share/man/man5/make.conf.5 | 14 +- share/man/man5/reiserfs.5 | 6 +- share/man/man5/xfs.5 | 32 ++--- share/man/man9/fail.9 | 8 +- share/man/man9/mbpool.9 | 4 +- sys/boot/forth/loader.conf.5 | 16 +-- tools/tools/vimage/vimage.8 | 10 +- usr.bin/bsdiff/bsdiff/bsdiff.1 | 4 +- usr.bin/bsdiff/bspatch/bspatch.1 | 4 +- usr.sbin/adduser/adduser.conf.5 | 6 +- usr.sbin/bluetooth/bthidd/bthidd.8 | 34 ++--- usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 | 16 +-- usr.sbin/cpucontrol/cpucontrol.8 | 4 +- usr.sbin/crunch/crunchgen/crunchgen.1 | 32 ++--- usr.sbin/mount_portalfs/mount_portalfs.8 | 4 +- usr.sbin/moused/moused.8 | 56 ++++---- usr.sbin/mtree/mtree.5 | 22 +-- usr.sbin/rtprio/rtprio.1 | 6 +- 83 files changed, 780 insertions(+), 780 deletions(-) mode change 100755 => 100644 share/man/man4/twa.4 diff --git a/lib/libarchive/cpio.5 b/lib/libarchive/cpio.5 index 02077d65120d..5bc60feaddf6 100644 --- a/lib/libarchive/cpio.5 +++ b/lib/libarchive/cpio.5 @@ -268,31 +268,6 @@ data, including ACLs and extended attributes, as special entries in cpio archives. .Pp XXX Others? XXX -.Sh BUGS -The -.Dq CRC -format is mis-named, as it uses a simple checksum and -not a cyclic redundancy check. -.Pp -The old binary format is limited to 16 bits for user id, -group id, device, and inode numbers. -It is limited to 4 gigabyte file sizes. -.Pp -The old ASCII format is limited to 18 bits for -the user id, group id, device, and inode numbers. -It is limited to 8 gigabyte file sizes. -.Pp -The new ASCII format is limited to 4 gigabyte file sizes. -.Pp -None of the cpio formats store user or group names, -which are essential when moving files between systems with -dissimilar user or group numbering. -.Pp -Especially when writing older cpio variants, it may be necessary -to map actual device/inode values to synthesized values that -fit the available fields. -With very large filesystems, this may be necessary even for -the newer formats. .Sh SEE ALSO .Xr cpio 1 , .Xr tar 5 @@ -323,3 +298,28 @@ license. The character format was adopted as part of .St -p1003.1-88 . XXX when did "newc" appear? Who invented it? When did HP come out with their variant? When did Sun introduce ACLs and extended attributes? XXX +.Sh BUGS +The +.Dq CRC +format is mis-named, as it uses a simple checksum and +not a cyclic redundancy check. +.Pp +The old binary format is limited to 16 bits for user id, +group id, device, and inode numbers. +It is limited to 4 gigabyte file sizes. +.Pp +The old ASCII format is limited to 18 bits for +the user id, group id, device, and inode numbers. +It is limited to 8 gigabyte file sizes. +.Pp +The new ASCII format is limited to 4 gigabyte file sizes. +.Pp +None of the cpio formats store user or group names, +which are essential when moving files between systems with +dissimilar user or group numbering. +.Pp +Especially when writing older cpio variants, it may be necessary +to map actual device/inode values to synthesized values that +fit the available fields. +With very large filesystems, this may be necessary even for +the newer formats. diff --git a/lib/libc/gen/fmtcheck.3 b/lib/libc/gen/fmtcheck.3 index 2fa587b6bd9f..0bd429982ead 100644 --- a/lib/libc/gen/fmtcheck.3 +++ b/lib/libc/gen/fmtcheck.3 @@ -87,6 +87,12 @@ will return .Fa fmt_suspect . Otherwise, it will return .Fa fmt_default . +.Sh SEE ALSO +.Xr printf 3 +.Sh BUGS +The +.Fn fmtcheck +function does not recognize positional parameters. .Sh SECURITY CONSIDERATIONS Note that the formats may be quite different as long as they accept the same arguments. @@ -100,9 +106,3 @@ is not equivalent to .Qq Li %lx because the first requires an integer and the second requires a long. -.Sh SEE ALSO -.Xr printf 3 -.Sh BUGS -The -.Fn fmtcheck -function does not recognize positional parameters. diff --git a/lib/libc/stdio/fgets.3 b/lib/libc/stdio/fgets.3 index aa8e2acc4986..fba7353ac6a6 100644 --- a/lib/libc/stdio/fgets.3 +++ b/lib/libc/stdio/fgets.3 @@ -128,6 +128,19 @@ may also fail and set .Va errno for any of the errors specified for the routine .Xr getchar 3 . +.Sh SEE ALSO +.Xr feof 3 , +.Xr ferror 3 , +.Xr fgetln 3 , +.Xr fgetws 3 , +.Xr getline 3 +.Sh STANDARDS +The functions +.Fn fgets +and +.Fn gets +conform to +.St -isoC-99 . .Sh SECURITY CONSIDERATIONS The .Fn gets @@ -143,16 +156,3 @@ It is strongly suggested that the function be used in all cases. (See the FSA.) -.Sh SEE ALSO -.Xr feof 3 , -.Xr ferror 3 , -.Xr fgetln 3 , -.Xr fgetws 3 , -.Xr getline 3 -.Sh STANDARDS -The functions -.Fn fgets -and -.Fn gets -conform to -.St -isoC-99 . diff --git a/lib/libc/stdio/printf.3 b/lib/libc/stdio/printf.3 index 2c031f70ccca..90a8ed8b02ed 100644 --- a/lib/libc/stdio/printf.3 +++ b/lib/libc/stdio/printf.3 @@ -709,77 +709,6 @@ char *newfmt(const char *fmt, ...) return (p); } .Ed -.Sh SECURITY CONSIDERATIONS -The -.Fn sprintf -and -.Fn vsprintf -functions are easily misused in a manner which enables malicious users -to arbitrarily change a running program's functionality through -a buffer overflow attack. -Because -.Fn sprintf -and -.Fn vsprintf -assume an infinitely long string, -callers must be careful not to overflow the actual space; -this is often hard to assure. -For safety, programmers should use the -.Fn snprintf -interface instead. -For example: -.Bd -literal -void -foo(const char *arbitrary_string, const char *and_another) -{ - char onstack[8]; - -#ifdef BAD - /* - * This first sprintf is bad behavior. Do not use sprintf! - */ - sprintf(onstack, "%s, %s", arbitrary_string, and_another); -#else - /* - * The following two lines demonstrate better use of - * snprintf(). - */ - snprintf(onstack, sizeof(onstack), "%s, %s", arbitrary_string, - and_another); -#endif -} -.Ed -.Pp -The -.Fn printf -and -.Fn sprintf -family of functions are also easily misused in a manner -allowing malicious users to arbitrarily change a running program's -functionality by either causing the program -to print potentially sensitive data -.Dq "left on the stack" , -or causing it to generate a memory fault or bus error -by dereferencing an invalid pointer. -.Pp -.Cm %n -can be used to write arbitrary data to potentially carefully-selected -addresses. -Programmers are therefore strongly advised to never pass untrusted strings -as the -.Fa format -argument, as an attacker can put format specifiers in the string -to mangle your stack, -leading to a possible security hole. -This holds true even if the string was built using a function like -.Fn snprintf , -as the resulting string may still contain user-supplied conversion specifiers -for later interpolation by -.Fn printf . -.Pp -Always use the proper secure idiom: -.Pp -.Dl "snprintf(buffer, sizeof(buffer), \*q%s\*q, string);" .Sh COMPATIBILITY Many application writers used the name .Va dprintf @@ -906,3 +835,74 @@ The family of functions do not correctly handle multibyte characters in the .Fa format argument. +.Sh SECURITY CONSIDERATIONS +The +.Fn sprintf +and +.Fn vsprintf +functions are easily misused in a manner which enables malicious users +to arbitrarily change a running program's functionality through +a buffer overflow attack. +Because +.Fn sprintf +and +.Fn vsprintf +assume an infinitely long string, +callers must be careful not to overflow the actual space; +this is often hard to assure. +For safety, programmers should use the +.Fn snprintf +interface instead. +For example: +.Bd -literal +void +foo(const char *arbitrary_string, const char *and_another) +{ + char onstack[8]; + +#ifdef BAD + /* + * This first sprintf is bad behavior. Do not use sprintf! + */ + sprintf(onstack, "%s, %s", arbitrary_string, and_another); +#else + /* + * The following two lines demonstrate better use of + * snprintf(). + */ + snprintf(onstack, sizeof(onstack), "%s, %s", arbitrary_string, + and_another); +#endif +} +.Ed +.Pp +The +.Fn printf +and +.Fn sprintf +family of functions are also easily misused in a manner +allowing malicious users to arbitrarily change a running program's +functionality by either causing the program +to print potentially sensitive data +.Dq "left on the stack" , +or causing it to generate a memory fault or bus error +by dereferencing an invalid pointer. +.Pp +.Cm %n +can be used to write arbitrary data to potentially carefully-selected +addresses. +Programmers are therefore strongly advised to never pass untrusted strings +as the +.Fa format +argument, as an attacker can put format specifiers in the string +to mangle your stack, +leading to a possible security hole. +This holds true even if the string was built using a function like +.Fn snprintf , +as the resulting string may still contain user-supplied conversion specifiers +for later interpolation by +.Fn printf . +.Pp +Always use the proper secure idiom: +.Pp +.Dl "snprintf(buffer, sizeof(buffer), \*q%s\*q, string);" diff --git a/lib/libc/stdio/tmpnam.3 b/lib/libc/stdio/tmpnam.3 index 66652b741716..937068f68d93 100644 --- a/lib/libc/stdio/tmpnam.3 +++ b/lib/libc/stdio/tmpnam.3 @@ -217,6 +217,17 @@ for any of the errors specified for the library functions .Xr malloc 3 or .Xr mktemp 3 . +.Sh SEE ALSO +.Xr mkstemp 3 , +.Xr mktemp 3 +.Sh STANDARDS +The +.Fn tmpfile +and +.Fn tmpnam +functions +conform to +.St -isoC . .Sh SECURITY CONSIDERATIONS The .Fn tmpnam @@ -235,14 +246,3 @@ It is strongly suggested that be used in place of these functions. (See the FSA.) -.Sh SEE ALSO -.Xr mkstemp 3 , -.Xr mktemp 3 -.Sh STANDARDS -The -.Fn tmpfile -and -.Fn tmpnam -functions -conform to -.St -isoC . diff --git a/lib/libc/stdio/wprintf.3 b/lib/libc/stdio/wprintf.3 index 3e9184662eae..fecb5867b164 100644 --- a/lib/libc/stdio/wprintf.3 +++ b/lib/libc/stdio/wprintf.3 @@ -588,9 +588,6 @@ In no case does a non-existent or small field width cause truncation of a numeric field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result. -.Sh SECURITY CONSIDERATIONS -Refer to -.Xr printf 3 . .Sh SEE ALSO .Xr btowc 3 , .Xr fputws 3 , @@ -616,3 +613,6 @@ and functions conform to .St -isoC-99 . +.Sh SECURITY CONSIDERATIONS +Refer to +.Xr printf 3 . diff --git a/lib/libc/stdlib/realpath.3 b/lib/libc/stdlib/realpath.3 index 166bb129c24c..57ad4ba2efe7 100644 --- a/lib/libc/stdlib/realpath.3 +++ b/lib/libc/stdlib/realpath.3 @@ -109,6 +109,18 @@ for any of the errors specified for the library functions .Xr readlink 2 and .Xr getcwd 3 . +.Sh SEE ALSO +.Xr getcwd 3 +.Sh STANDARDS +The +.Fn realpath +function conforms to +.St -p1003.1-2001 . +.Sh HISTORY +The +.Fn realpath +function first appeared in +.Bx 4.4 . .Sh CAVEATS This implementation of .Fn realpath @@ -121,15 +133,3 @@ under certain circumstances, return a relative .Fa resolved_path when given a relative .Fa pathname . -.Sh "SEE ALSO" -.Xr getcwd 3 -.Sh STANDARDS -The -.Fn realpath -function conforms to -.St -p1003.1-2001 . -.Sh HISTORY -The -.Fn realpath -function first appeared in -.Bx 4.4 . diff --git a/lib/libc/string/strcat.3 b/lib/libc/string/strcat.3 index 4c9fec9acbed..dfa55a470a09 100644 --- a/lib/libc/string/strcat.3 +++ b/lib/libc/string/strcat.3 @@ -80,6 +80,23 @@ and functions return the pointer .Fa s . +.Sh SEE ALSO +.Xr bcopy 3 , +.Xr memccpy 3 , +.Xr memcpy 3 , +.Xr memmove 3 , +.Xr strcpy 3 , +.Xr strlcat 3 , +.Xr strlcpy 3 , +.Xr wcscat 3 +.Sh STANDARDS +The +.Fn strcat +and +.Fn strncat +functions +conform to +.St -isoC . .Sh SECURITY CONSIDERATIONS The .Fn strcat @@ -138,20 +155,3 @@ foo(const char *arbitrary_string) #endif } .Ed -.Sh SEE ALSO -.Xr bcopy 3 , -.Xr memccpy 3 , -.Xr memcpy 3 , -.Xr memmove 3 , -.Xr strcpy 3 , -.Xr strlcat 3 , -.Xr strlcpy 3 , -.Xr wcscat 3 -.Sh STANDARDS -The -.Fn strcat -and -.Fn strncat -functions -conform to -.St -isoC . diff --git a/lib/libc/string/strcpy.3 b/lib/libc/string/strcpy.3 index 157abccacbf4..395e2f9b7b57 100644 --- a/lib/libc/string/strcpy.3 +++ b/lib/libc/string/strcpy.3 @@ -174,16 +174,6 @@ Note that because .Xr strlcpy 3 is not defined in any standards, it should only be used when portability is not a concern. -.Sh SECURITY CONSIDERATIONS -The -.Fn strcpy -function is easily misused in a manner which enables malicious users -to arbitrarily change a running program's functionality through a -buffer overflow attack. -(See -the FSA -and -.Sx EXAMPLES . ) .Sh SEE ALSO .Xr bcopy 3 , .Xr memccpy 3 , @@ -214,3 +204,13 @@ and .Fn stpncpy was added in .Fx 8.0 . +.Sh SECURITY CONSIDERATIONS +The +.Fn strcpy +function is easily misused in a manner which enables malicious users +to arbitrarily change a running program's functionality through a +buffer overflow attack. +(See +the FSA +and +.Sx EXAMPLES . ) diff --git a/lib/libc/sys/access.2 b/lib/libc/sys/access.2 index 0cd3c6f72e7f..65b8fb6bfbb1 100644 --- a/lib/libc/sys/access.2 +++ b/lib/libc/sys/access.2 @@ -188,6 +188,27 @@ is neither .Dv AT_FDCWD nor a file descriptor associated with a directory. .El +.Sh SEE ALSO +.Xr chmod 2 , +.Xr intro 2 , +.Xr stat 2 +.Sh STANDARDS +The +.Fn access +system call is expected to conform to +.St -p1003.1-90 . +The +.Fn faccessat +system call follows The Open Group Extended API Set 2 specification. +.Sh HISTORY +The +.Fn access +function appeared in +.At v7 . +The +.Fn faccessat +system call appeared in +.Fx 8.0 . .Sh SECURITY CONSIDERATIONS The .Fn access @@ -212,24 +233,3 @@ of the st_mode bits that the application might not understand -- e.g. in the case of AFS). It also allows a cheaper file existence test than .Xr stat 2 . -.Sh SEE ALSO -.Xr chmod 2 , -.Xr intro 2 , -.Xr stat 2 -.Sh STANDARDS -The -.Fn access -system call is expected to conform to -.St -p1003.1-90 . -The -.Fn faccessat -system call follows The Open Group Extended API Set 2 specification. -.Sh HISTORY -The -.Fn access -function appeared in -.At v7 . -The -.Fn faccessat -system call appeared in -.Fx 8.0 . diff --git a/lib/libc/sys/execve.2 b/lib/libc/sys/execve.2 index acc647113bc0..0559a1a614d6 100644 --- a/lib/libc/sys/execve.2 +++ b/lib/libc/sys/execve.2 @@ -313,30 +313,6 @@ The .Fa fd argument is not a valid file descriptor open for executing. .El -.Sh CAVEATS -If a program is -.Em setuid -to a non-super-user, but is executed when -the real -.Em uid -is ``root'', then the program has some of the powers -of a super-user as well. -.Pp -When executing an interpreted program through -.Fn fexecve , -kernel supplies -.Pa /dev/fd/n -as a second argument to the interpreter, -where -.Ar n -is the file descriptor passed in the -.Fa fd -argument to -.Fn fexecve . -For this construction to work correctly, the -.Xr fdescfs 5 -filesystem shall be mounted on -.Pa /dev/fd . .Sh SEE ALSO .Xr ktrace 1 , .Xr _exit 2 , @@ -373,3 +349,27 @@ The .Fn fexecve system call appeared in .Fx 8.0 . +.Sh CAVEATS +If a program is +.Em setuid +to a non-super-user, but is executed when +the real +.Em uid +is ``root'', then the program has some of the powers +of a super-user as well. +.Pp +When executing an interpreted program through +.Fn fexecve , +kernel supplies +.Pa /dev/fd/n +as a second argument to the interpreter, +where +.Ar n +is the file descriptor passed in the +.Fa fd +argument to +.Fn fexecve . +For this construction to work correctly, the +.Xr fdescfs 5 +filesystem shall be mounted on +.Pa /dev/fd . diff --git a/lib/libc/sys/setuid.2 b/lib/libc/sys/setuid.2 index 78e4ab8f810b..4bb4a68ff8a5 100644 --- a/lib/libc/sys/setuid.2 +++ b/lib/libc/sys/setuid.2 @@ -124,39 +124,6 @@ The system calls will fail if: The user is not the super user and the ID specified is not the real, effective ID, or saved ID. .El -.Sh SECURITY CONSIDERATIONS -Read and write permissions to files are determined upon a call to -.Xr open 2 . -Once a file descriptor is open, dropping privilege does not affect -the process's read/write permissions, even if the user ID specified -has no read or write permissions to the file. -These files normally remain open in any new process executed, -resulting in a user being able to read or modify -potentially sensitive data. -.Pp -To prevent these files from remaining open after an -.Xr exec 3 -call, be sure to set the close-on-exec flag is set: -.Bd -literal -void -pseudocode(void) -{ - int fd; - /* ... */ - - fd = open("/path/to/sensitive/data", O_RDWR); - if (fd == -1) - err(1, "open"); - - /* - * Set close-on-exec flag; see fcntl(2) for more information. - */ - if (fcntl(fd, F_SETFD, FD_CLOEXEC) == -1) - err(1, "fcntl(F_SETFD)"); - /* ... */ - execve(path, argv, environ); -} -.Ed .Sh SEE ALSO .Xr getgid 2 , .Xr getuid 2 , @@ -191,3 +158,36 @@ and .Fn setgid functions appeared in .At v7 . +.Sh SECURITY CONSIDERATIONS +Read and write permissions to files are determined upon a call to +.Xr open 2 . +Once a file descriptor is open, dropping privilege does not affect +the process's read/write permissions, even if the user ID specified +has no read or write permissions to the file. +These files normally remain open in any new process executed, +resulting in a user being able to read or modify +potentially sensitive data. +.Pp +To prevent these files from remaining open after an +.Xr exec 3 +call, be sure to set the close-on-exec flag is set: +.Bd -literal +void +pseudocode(void) +{ + int fd; + /* ... */ + + fd = open("/path/to/sensitive/data", O_RDWR); + if (fd == -1) + err(1, "open"); + + /* + * Set close-on-exec flag; see fcntl(2) for more information. + */ + if (fcntl(fd, F_SETFD, FD_CLOEXEC) == -1) + err(1, "fcntl(F_SETFD)"); + /* ... */ + execve(path, argv, environ); +} +.Ed diff --git a/lib/libpmc/pmc.mips.3 b/lib/libpmc/pmc.mips.3 index f9ec1d001dc8..3fe6825067fd 100644 --- a/lib/libpmc/pmc.mips.3 +++ b/lib/libpmc/pmc.mips.3 @@ -392,8 +392,6 @@ and the underlying hardware events used. .Xr pmc_cpuinfo 3 , .Xr pmclog 3 , .Xr hwpmc 4 -.Sh CAVEATS -The MIPS code does not yet support sampling. .Sh HISTORY The .Nm pmc @@ -408,3 +406,5 @@ library was written by MIPS support was added by .An "George Neville-Neil" .Aq gnn@FreeBSD.org . +.Sh CAVEATS +The MIPS code does not yet support sampling. diff --git a/lib/libpmc/pmc.xscale.3 b/lib/libpmc/pmc.xscale.3 index 3cb64c36cfb3..955a84b024c6 100644 --- a/lib/libpmc/pmc.xscale.3 +++ b/lib/libpmc/pmc.xscale.3 @@ -135,8 +135,6 @@ and the underlying hardware events used. .Xr pmc_cpuinfo 3 , .Xr pmclog 3 , .Xr hwpmc 4 -.Sh CAVEATS -The Intel XScale code does not yet support sampling. .Sh HISTORY The .Nm pmc @@ -154,3 +152,5 @@ library was written by Intel XScale support was added by .An "Rui Paulo" .Aq rpaulo@FreeBSD.org . +.Sh CAVEATS +The Intel XScale code does not yet support sampling. diff --git a/lib/msun/man/fenv.3 b/lib/msun/man/fenv.3 index 728874e16fe9..aaea5f584086 100644 --- a/lib/msun/man/fenv.3 +++ b/lib/msun/man/fenv.3 @@ -196,18 +196,6 @@ environment. The macro .Dv FE_DFL_ENV expands to a pointer to the default environment. -.Sh CAVEATS -The FENV_ACCESS pragma can be enabled with -.Dl "#pragma STDC FENV_ACCESS ON" -and disabled with the -.Dl "#pragma STDC FENV_ACCESS OFF" -directive. -This lexically-scoped annotation tells the compiler that the program -may access the floating-point environment, so optimizations that would -violate strict IEEE-754 semantics are disabled. -If execution reaches a block of code for which -.Dv FENV_ACCESS -is off, the floating-point environment will become undefined. .Sh EXAMPLES The following routine computes the square root function. It explicitly raises an invalid exception on appropriate inputs using @@ -274,6 +262,18 @@ It supersedes the non-standard routines defined in .In ieeefp.h and documented in .Xr fpgetround 3 . +.Sh CAVEATS +The FENV_ACCESS pragma can be enabled with +.Dl "#pragma STDC FENV_ACCESS ON" +and disabled with the +.Dl "#pragma STDC FENV_ACCESS OFF" +directive. +This lexically-scoped annotation tells the compiler that the program +may access the floating-point environment, so optimizations that would +violate strict IEEE-754 semantics are disabled. +If execution reaches a block of code for which +.Dv FENV_ACCESS +is off, the floating-point environment will become undefined. .Sh BUGS The .Dv FENV_ACCESS diff --git a/sbin/fsirand/fsirand.8 b/sbin/fsirand/fsirand.8 index 00f0eeee4c99..66a1724303cb 100644 --- a/sbin/fsirand/fsirand.8 +++ b/sbin/fsirand/fsirand.8 @@ -88,12 +88,6 @@ is not marked as clean. Print the current generation numbers for all inodes instead of generating new ones. .El -.Sh CAVEATS -Since -.Nm -allocates enough memory to hold all the inodes in -a given cylinder group it may use a large amount -of memory for large disks with few cylinder groups. .Sh SEE ALSO .Xr fs 5 , .Xr fsck 8 , @@ -114,3 +108,9 @@ version first appeared in .Fx 2.2.5 . .Sh AUTHORS .An Todd C. Miller Aq Todd.Miller@courtesan.com +.Sh CAVEATS +Since +.Nm +allocates enough memory to hold all the inodes in +a given cylinder group it may use a large amount +of memory for large disks with few cylinder groups. diff --git a/sbin/mksnap_ffs/mksnap_ffs.8 b/sbin/mksnap_ffs/mksnap_ffs.8 index 92e59e55ee7d..f9558df0dd12 100644 --- a/sbin/mksnap_ffs/mksnap_ffs.8 +++ b/sbin/mksnap_ffs/mksnap_ffs.8 @@ -71,11 +71,11 @@ mount -o ro /dev/md0 /mnt/ .Xr chown 8 , .Xr mdconfig 8 , .Xr mount 8 -.Sh CAVEATS -The disk full situation is not handled gracefully and may -lead to a system panic when no free blocks are found. .Sh HISTORY The .Nm utility first appeared in .Fx 5.0 . +.Sh CAVEATS +The disk full situation is not handled gracefully and may +lead to a system panic when no free blocks are found. diff --git a/sbin/mount/mount.8 b/sbin/mount/mount.8 index d3f6717bf375..b6d562c48517 100644 --- a/sbin/mount/mount.8 +++ b/sbin/mount/mount.8 @@ -542,6 +542,11 @@ support for a particular file system might be provided either on a static .Xr umount 8 , .Xr zfs 8 , .Xr zpool 8 +.Sh HISTORY +A +.Nm +utility appeared in +.At v1 . .Sh CAVEATS After a successful .Nm , @@ -564,10 +569,5 @@ gets a signal (that causes an update of the export list) only when the file system is mounted via .Nm . -.Sh HISTORY -A -.Nm -utility appeared in -.At v1 . .Sh BUGS It is possible for a corrupted file system to cause a crash. diff --git a/sbin/mount_msdosfs/mount_msdosfs.8 b/sbin/mount_msdosfs/mount_msdosfs.8 index 9a3be1377ebe..3dac0135d5b3 100644 --- a/sbin/mount_msdosfs/mount_msdosfs.8 +++ b/sbin/mount_msdosfs/mount_msdosfs.8 @@ -199,12 +199,6 @@ To mount a Japanese MS-DOS file system located in .Pp List of Localized MS Operating Systems: .Pa http://www.microsoft.com/globaldev/reference/oslocversion.mspx . -.Sh CAVEATS -The use of the -.Fl 9 -flag could result in damaged file systems, -albeit the damage is in part taken care of by -procedures similar to the ones used in Win'95. .Sh HISTORY The .Nm @@ -221,3 +215,9 @@ of the more aptly-named The character code conversion routine was added by .An Ryuichiro Imura Aq imura@ryu16.org at 2003. +.Sh CAVEATS +The use of the +.Fl 9 +flag could result in damaged file systems, +albeit the damage is in part taken care of by +procedures similar to the ones used in Win'95. diff --git a/sbin/mount_ntfs/mount_ntfs.8 b/sbin/mount_ntfs/mount_ntfs.8 index 60c2e3bc90fa..eb8ba690cb5b 100644 --- a/sbin/mount_ntfs/mount_ntfs.8 +++ b/sbin/mount_ntfs/mount_ntfs.8 @@ -149,14 +149,6 @@ The file name must not contain multibyte characters. .Xr fstab 5 , .Xr mount 8 , .Xr mount_msdosfs 8 -.Sh CAVEATS -This utility is primarily used for read access to an NTFS volume. -See the -.Sx WRITING -section for details about writing to an NTFS volume. -.Pp -For a full read-write NTFS support consider sysutils/fusefs-ntfs -port/package. .Sh HISTORY The .Nm @@ -171,3 +163,11 @@ The NTFS kernel implementation, .Nm utility, and manual were written by .An Semen Ustimenko Aq semenu@FreeBSD.org . +.Sh CAVEATS +This utility is primarily used for read access to an NTFS volume. +See the +.Sx WRITING +section for details about writing to an NTFS volume. +.Pp +For a full read-write NTFS support consider sysutils/fusefs-ntfs +port/package. diff --git a/sbin/mount_reiserfs/mount_reiserfs.8 b/sbin/mount_reiserfs/mount_reiserfs.8 index 7306182667d2..a63dfdffa494 100644 --- a/sbin/mount_reiserfs/mount_reiserfs.8 +++ b/sbin/mount_reiserfs/mount_reiserfs.8 @@ -66,9 +66,6 @@ To mount a ReiserFS volume located in .Xr unmount 2 , .Xr fstab 5 , .Xr mount 8 -.Sh CAVEATS -This utility is primarily used for read access to a ReiserFS volume. -Writing to a volume is currently unsupported. .Sh HISTORY The .Nm @@ -88,3 +85,6 @@ The .Nm utility and manual were written by .An Jean-S\['e]bastien P\['e]dron Aq dumbbell@FreeBSD.org . +.Sh CAVEATS +This utility is primarily used for read access to a ReiserFS volume. +Writing to a volume is currently unsupported. diff --git a/sbin/mount_std/mount_std.8 b/sbin/mount_std/mount_std.8 index 7575cee0b186..0aeeba8e8194 100644 --- a/sbin/mount_std/mount_std.8 +++ b/sbin/mount_std/mount_std.8 @@ -142,8 +142,6 @@ loadable module for it was found. .Xr linprocfs 5 , .Xr procfs 5 , .Xr mount 8 -.Sh CAVEATS -None of the ``standard'' file systems may be NFS-exported. .Sh HISTORY The .Nm @@ -165,3 +163,5 @@ the .Dq linprocfs file system type first appeared in .Fx 4.0 . +.Sh CAVEATS +None of the ``standard'' file systems may be NFS-exported. diff --git a/sbin/rcorder/rcorder.8 b/sbin/rcorder/rcorder.8 index 82330c36a343..b17b0a337ca1 100644 --- a/sbin/rcorder/rcorder.8 +++ b/sbin/rcorder/rcorder.8 @@ -152,6 +152,19 @@ processing the stated condition. A set of files has a circular dependency which was detected while processing the stated file. .El +.Sh SEE ALSO +.Xr rc 8 +.Sh HISTORY +The +.Nm +utility first appeared in +.Nx 1.5 . +.Sh AUTHORS +.An -nosplit +Written by +.An Perry E. Metzger Aq perry@piermont.com +and +.An Matthew R. Green Aq mrg@eterna.com.au . .Sh BUGS The .Dq Li REQUIRE @@ -171,16 +184,3 @@ script in the dependency ordering, not necessarily that it requires .Xr named 8 to be started or enabled. -.Sh SEE ALSO -.Xr rc 8 -.Sh HISTORY -The -.Nm -utility first appeared in -.Nx 1.5 . -.Sh AUTHORS -.An -nosplit -Written by -.An Perry E. Metzger Aq perry@piermont.com -and -.An Matthew R. Green Aq mrg@eterna.com.au . diff --git a/share/man/man4/ae.4 b/share/man/man4/ae.4 index 0b5e8f8cd612..36951b2ef863 100644 --- a/share/man/man4/ae.4 +++ b/share/man/man4/ae.4 @@ -133,6 +133,14 @@ instead. .Xr ng_ether 4 , .Xr vlan 4 , .Xr ifconfig 8 +.Sh HISTORY +The +.Nm +driver and this manual page was written by +.An Stanislav Sedov +.Aq stas@FreeBSD.org . +It first appeared in +.Fx 7.1 . .Sh BUGS The Attansic L2 FastEthernet contoller supports DMA but does not use a descriptor based transfer mechanism via scatter-gather DMA. @@ -142,11 +150,3 @@ Furthermore, a lot of data alignment restrictions apply. This may introduce a high CPU load on systems with heavy network activity. Luckily enough this should not be a problem on modern hardware as L2 does not support speeds faster than 100Mbps. -.Sh HISTORY -The -.Nm -driver and this manual page was written by -.An Stanislav Sedov -.Aq stas@FreeBSD.org . -It first appeared in -.Fx 7.1 . diff --git a/share/man/man4/ahb.4 b/share/man/man4/ahb.4 index 6ef99931a2a5..fab6fecb258a 100644 --- a/share/man/man4/ahb.4 +++ b/share/man/man4/ahb.4 @@ -70,13 +70,6 @@ Adaptec AHA-1740A .It Adaptec AHA-1742A .El -.Sh CAVEATS -The Adaptec 174X is very sensitive to SCSI bus termination and cable -length. -It may also have difficulties operating with some modern devices -that, due to their speed, expose timing problems in the controller. -There are no known mechanisms for working around device incompatibilities of -this nature. .Sh SEE ALSO .Xr aha 4 , .Xr ahc 4 , @@ -90,3 +83,10 @@ The .Nm driver was written by .An Justin T. Gibbs . +.Sh CAVEATS +The Adaptec 174X is very sensitive to SCSI bus termination and cable +length. +It may also have difficulties operating with some modern devices +that, due to their speed, expose timing problems in the controller. +There are no known mechanisms for working around device incompatibilities of +this nature. diff --git a/share/man/man4/amdtemp.4 b/share/man/man4/amdtemp.4 index 6d1ca7c4b078..b955d70bc9ea 100644 --- a/share/man/man4/amdtemp.4 +++ b/share/man/man4/amdtemp.4 @@ -64,9 +64,6 @@ located in each CPU core. For the K10 and K11 families, the driver creates .Va dev.cpu.%d.temperature with the temperature of each core. -.Sh BUGS -AMD K9 is not supported because temperature reporting has been replaced -by Maltese. .Sh SEE ALSO .Xr sysctl 8 .Sh HISTORY @@ -77,3 +74,6 @@ driver first appeared in .Sh AUTHORS .An Rui Paulo Aq rpaulo@FreeBSD.org .An Norikatsu Shigemura Aq nork@FreeBSD.org +.Sh BUGS +AMD K9 is not supported because temperature reporting has been replaced +by Maltese. diff --git a/share/man/man4/ataraid.4 b/share/man/man4/ataraid.4 index ee7446dff1a5..98d30688a078 100644 --- a/share/man/man4/ataraid.4 +++ b/share/man/man4/ataraid.4 @@ -135,9 +135,6 @@ ATA RAID device nodes .Sh SEE ALSO .Xr ata 4 , .Xr atacontrol 8 -.Sh CAVEATS -RAID5 is not supported at this time. -Code exists, but it neither uses nor maintains parity information. .Sh AUTHORS .An -nosplit The @@ -146,3 +143,6 @@ driver was written by .An S\(/oren Schmidt Aq sos@FreeBSD.org . This manual page was written by .An Christian Brueffer Aq brueffer@FreeBSD.org . +.Sh CAVEATS +RAID5 is not supported at this time. +Code exists, but it neither uses nor maintains parity information. diff --git a/share/man/man4/cpuctl.4 b/share/man/man4/cpuctl.4 index 09b2d4ef72fc..bf1bddeb83e7 100644 --- a/share/man/man4/cpuctl.4 +++ b/share/man/man4/cpuctl.4 @@ -148,10 +148,10 @@ The .Nm driver first appeared in .Fx 7.2 . -.Sh BUGS -Yes, probably, report if any. .Sh AUTHORS The .Nm module and this manual page were written by .An Stanislav Sedov Aq stas@FreeBSD.org . +.Sh BUGS +Yes, probably, report if any. diff --git a/share/man/man4/ed.4 b/share/man/man4/ed.4 index 0a435275a769..62176695f121 100644 --- a/share/man/man4/ed.4 +++ b/share/man/man4/ed.4 @@ -370,6 +370,24 @@ Probing for an MII bus has failed. This indicates a coding error in the PC Card attachment, because a PHY is required for the chips that generate this error message. .El +.Sh SEE ALSO +.Xr altq 4 , +.Xr arp 4 , +.Xr miibus 4 , +.Xr netintro 4 , +.Xr ng_ether 4 , +.Xr device.hints 5 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 1.0 . +.Sh AUTHORS +The +.Nm +device driver and this manual page were written by +.An David Greenman . .Sh CAVEATS Early revision DS8390 chips have problems. They lock up whenever the receive @@ -393,24 +411,6 @@ The Mitsubishi B8895 PC Card uses a DP83902, but its ASIC part is undocumented. Neither the NE2000 nor the WD83x0 drivers work with this card. .Pp -.Sh SEE ALSO -.Xr altq 4 , -.Xr arp 4 , -.Xr miibus 4 , -.Xr netintro 4 , -.Xr ng_ether 4 , -.Xr device.hints 5 , -.Xr ifconfig 8 -.Sh HISTORY -The -.Nm -device driver first appeared in -.Fx 1.0 . -.Sh AUTHORS -The -.Nm -device driver and this manual page were written by -.An David Greenman . .Sh BUGS The .Nm diff --git a/share/man/man4/ef.4 b/share/man/man4/ef.4 index c93d5f12022b..ce074879ba43 100644 --- a/share/man/man4/ef.4 +++ b/share/man/man4/ef.4 @@ -100,12 +100,12 @@ file: .Dl ifconfig_ed2f1_ipx="ipx 0x102" .Sh DIAGNOSTICS None. -.Sh CAVEATS -Avoid to configure the parent Ethernet device for the IPX protocol, after the -.Nm -driver is loaded. .Sh SEE ALSO .Xr ipx 3 , .Xr ifconfig 8 .Sh AUTHORS .An Boris Popov Aq bp@FreeBSD.org . +.Sh CAVEATS +Avoid to configure the parent Ethernet device for the IPX protocol, after the +.Nm +driver is loaded. diff --git a/share/man/man4/en.4 b/share/man/man4/en.4 index a256b9e6ff25..f9281fa968f7 100644 --- a/share/man/man4/en.4 +++ b/share/man/man4/en.4 @@ -60,10 +60,6 @@ en0: ATM midway v0, board IDs 6.0, Utopia (pipelined), 512KB on-board RAM en0: maximum DMA burst length = 64 bytes en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated .Ed -.Sh CAVEATS -The driver extensively uses DMA on PCI. -The first -generation PCI chipsets do not work or exhibit poor performance. .Sh SEE ALSO .Xr natm 4 , .Xr natmip 4 , @@ -76,3 +72,7 @@ of Washington University implemented .Nm driver in 1996 for .Nx . +.Sh CAVEATS +The driver extensively uses DMA on PCI. +The first +generation PCI chipsets do not work or exhibit poor performance. diff --git a/share/man/man4/fpa.4 b/share/man/man4/fpa.4 index b751e296d0da..097442998e8c 100644 --- a/share/man/man4/fpa.4 +++ b/share/man/man4/fpa.4 @@ -40,11 +40,6 @@ requires a minimum of 1K device memory to be set up. The ECU (EISA Configuration Utility) will need to be run to change the settings. .El -.Sh CAVEATS -Normally, the device driver will not enable the reception of SMT frames. -However if the IFF_LINK1 flag is set, the device driver will enable the -reception of SMT frames and pass them up to the Berkeley Packet Filter for -processing. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -56,3 +51,8 @@ and .Nm fea device drivers and this manual page were written by .An Matt Thomas . +.Sh CAVEATS +Normally, the device driver will not enable the reception of SMT frames. +However if the IFF_LINK1 flag is set, the device driver will enable the +reception of SMT frames and pass them up to the Berkeley Packet Filter for +processing. diff --git a/share/man/man4/geom_fox.4 b/share/man/man4/geom_fox.4 index 8e262b94ae52..76fd0b90212f 100644 --- a/share/man/man4/geom_fox.4 +++ b/share/man/man4/geom_fox.4 @@ -177,6 +177,14 @@ da2.fox N/A da2 .Xr GEOM 4 , .Xr geom 8 , .Xr gmultipath 8 +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An "Poul-Henning Kamp" Aq phk@FreeBSD.org . +This manual page was written by +.An "Wilko Bulte" Aq wilko@FreeBSD.org . .Sh CAVEATS The .Nm @@ -193,14 +201,6 @@ Safety belts are not provided. For FibreChannel devices it is suggested to use the Port WWN of the device. The World Wide Name is guaranteed to be worldwide unique per the FibreChannel standard. -.Sh AUTHORS -.An -nosplit -The -.Nm -driver was written by -.An "Poul-Henning Kamp" Aq phk@FreeBSD.org . -This manual page was written by -.An "Wilko Bulte" Aq wilko@FreeBSD.org . .Sh BUGS The .Nm diff --git a/share/man/man4/harp.4 b/share/man/man4/harp.4 index 6f4d9410233f..9495f62d5646 100644 --- a/share/man/man4/harp.4 +++ b/share/man/man4/harp.4 @@ -56,11 +56,11 @@ Netgraph interface (they are in different namespaces). .Xr ng_atm 4 , .Xr patm 4 , .Xr atm 8 +.Sh AUTHORS +.An Harti Brandt Aq harti@FreeBSD.org .Sh CAVEATS When .Xr fatm 4 is used, it must be started before .Nm is loaded, to get the correct configuration for the HARP physical interface. -.Sh AUTHORS -.An Harti Brandt Aq harti@FreeBSD.org diff --git a/share/man/man4/hatm.4 b/share/man/man4/hatm.4 index f9b7e705bde0..59de800438e7 100644 --- a/share/man/man4/hatm.4 +++ b/share/man/man4/hatm.4 @@ -252,6 +252,19 @@ a connection can eat up all available TPDs. Maximum number of memory pages allocated to small external mbufs. This must not be zero and not larger than 65536. .El +.Sh DIAGNOSTICS +.Bd -literal +hatm0: mem 0xd2600000-0xd26fffff irq 9 at device 15.0 on pci2 +hatm0: ForeRunnerHE 622, Rev. D, S/N 2949834, MAC=00:20:48:2d:02:ca +.Ed +.Sh SEE ALSO +.Xr natm 4 , +.Xr natmip 4 , +.Xr utopia 4 , +.Xr ifconfig 8 , +.Xr route 8 +.Sh AUTHORS +.An Harti Brandt Aq harti@FreeBSD.org .Sh CAVEATS When putting a HE155 into a 64-bit 66MHz PCI slot the machine may hang. This occurs very early in the POST so that even the display does not turn on. @@ -267,16 +280,3 @@ and arguments the .Nx function has. -.Sh DIAGNOSTICS -.Bd -literal -hatm0: mem 0xd2600000-0xd26fffff irq 9 at device 15.0 on pci2 -hatm0: ForeRunnerHE 622, Rev. D, S/N 2949834, MAC=00:20:48:2d:02:ca -.Ed -.Sh SEE ALSO -.Xr natm 4 , -.Xr natmip 4 , -.Xr utopia 4 , -.Xr ifconfig 8 , -.Xr route 8 -.Sh AUTHORS -.An Harti Brandt Aq harti@FreeBSD.org diff --git a/share/man/man4/hifn.4 b/share/man/man4/hifn.4 index 02b8e32b4432..a53bac3231f7 100644 --- a/share/man/man4/hifn.4 +++ b/share/man/man4/hifn.4 @@ -107,15 +107,6 @@ Contains a 7955 and supports symmetric and random number operations. .Xr ipsec 4 , .Xr random 4 , .Xr crypto 9 -.Sh CAVEATS -The Hifn 9751 shares the same PCI ID. -This chip is basically a 7751, but with the cryptographic functions missing. -Instead, the 9751 is only capable of doing compression. -Since we do not currently attempt to use any of these chips to do -compression, the 9751-based cards are not useful. -.Pp -Support for the 7955 and 7956 is incomplete; the asymmetric crypto -facilities are to be added and the performance is suboptimal. .Sh HISTORY The .Nm @@ -125,6 +116,15 @@ The .Nm device driver was imported to .Fx 5.0 . +.Sh CAVEATS +The Hifn 9751 shares the same PCI ID. +This chip is basically a 7751, but with the cryptographic functions missing. +Instead, the 9751 is only capable of doing compression. +Since we do not currently attempt to use any of these chips to do +compression, the 9751-based cards are not useful. +.Pp +Support for the 7955 and 7956 is incomplete; the asymmetric crypto +facilities are to be added and the performance is suboptimal. .Sh BUGS The 7751 chip starts out at initialization by only supporting compression. A proprietary algorithm, which has been reverse engineered, is required to diff --git a/share/man/man4/hwpmc.4 b/share/man/man4/hwpmc.4 index 7034cd423002..6264bd01ef12 100644 --- a/share/man/man4/hwpmc.4 +++ b/share/man/man4/hwpmc.4 @@ -450,42 +450,6 @@ These variables may be set in the kernel environment using before .Nm is loaded. -.Sh SECURITY CONSIDERATIONS -PMCs may be used to monitor the actual behavior of the system on hardware. -In situations where this constitutes an undesirable information leak, -the following options are available: -.Bl -enum -.It -Set the -.Xr sysctl 8 -tunable -.Va security.bsd.unprivileged_syspmcs -to 0. -This ensures that unprivileged processes cannot allocate system-wide -PMCs and thus cannot observe the hardware behavior of the system -as a whole. -This tunable may also be set at boot time using -.Xr loader 8 , -or with -.Xr kenv 1 -prior to loading the -.Nm -driver into the kernel. -.It -Set the -.Xr sysctl 8 -tunable -.Va security.bsd.unprivileged_proc_debug -to 0. -This will ensure that an unprivileged process cannot attach a PMC -to any process other than itself and thus cannot observe the hardware -behavior of other processes with the same credentials. -.El -.Pp -System administrators should note that on IA-32 platforms -.Fx -makes the content of the IA-32 TSC counter available to all processes -via the RDTSC instruction. .Sh IMPLEMENTATION NOTES .Ss SMP Symmetry The kernel driver requires all physical CPUs in an SMP system to have @@ -831,3 +795,39 @@ Many single-processor motherboards keep the APIC disabled in BIOS; on such systems .Nm will not support sampling PMCs. +.Sh SECURITY CONSIDERATIONS +PMCs may be used to monitor the actual behavior of the system on hardware. +In situations where this constitutes an undesirable information leak, +the following options are available: +.Bl -enum +.It +Set the +.Xr sysctl 8 +tunable +.Va security.bsd.unprivileged_syspmcs +to 0. +This ensures that unprivileged processes cannot allocate system-wide +PMCs and thus cannot observe the hardware behavior of the system +as a whole. +This tunable may also be set at boot time using +.Xr loader 8 , +or with +.Xr kenv 1 +prior to loading the +.Nm +driver into the kernel. +.It +Set the +.Xr sysctl 8 +tunable +.Va security.bsd.unprivileged_proc_debug +to 0. +This will ensure that an unprivileged process cannot attach a PMC +to any process other than itself and thus cannot observe the hardware +behavior of other processes with the same credentials. +.El +.Pp +System administrators should note that on IA-32 platforms +.Fx +makes the content of the IA-32 TSC counter available to all processes +via the RDTSC instruction. diff --git a/share/man/man4/inet.4 b/share/man/man4/inet.4 index b1878d58ddef..ef189d32c023 100644 --- a/share/man/man4/inet.4 +++ b/share/man/man4/inet.4 @@ -280,12 +280,6 @@ in the reassembling queue for a packet. .%B PS1 .%N 8 .Re -.Sh CAVEATS -The Internet protocol support is subject to change as -the Internet protocols develop. -Users should not depend -on details of the current implementation, but rather -the services exported. .Sh HISTORY The .Nm @@ -295,3 +289,9 @@ The .Dq protocol cloning code appeared in .Fx 2.1 . +.Sh CAVEATS +The Internet protocol support is subject to change as +the Internet protocols develop. +Users should not depend +on details of the current implementation, but rather +the services exported. diff --git a/share/man/man4/kbdmux.4 b/share/man/man4/kbdmux.4 index f92fa4584e9b..72b588906a14 100644 --- a/share/man/man4/kbdmux.4 +++ b/share/man/man4/kbdmux.4 @@ -35,6 +35,13 @@ utility. .Xr atkbd 4 , .Xr syscons 4 , .Xr ukbd 4 +.Sh HISTORY +The +.Nm +module was implemented in +.Fx 6.0 . +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com .Sh CAVEATS The .Nm @@ -47,10 +54,3 @@ keyboard share the same state. The .Nm keyboard is logically equivalent to one keyboard with lots of duplicated keys. -.Sh HISTORY -The -.Nm -module was implemented in -.Fx 6.0 . -.Sh AUTHORS -.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/share/man/man4/ksyms.4 b/share/man/man4/ksyms.4 index 56572e90cb73..d12f46001b86 100644 --- a/share/man/man4/ksyms.4 +++ b/share/man/man4/ksyms.4 @@ -130,6 +130,12 @@ driver first appeared in .Fx 8.0 to support .Xr lockstat 1 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Stacey Son +.Aq sson@freebsd.org . .Sh BUGS Because files can be dynamically linked into the kernel at any time the symbol information can vary. When you open the @@ -150,9 +156,3 @@ can be used to get the memory address where the symbol table is stored to save kernel memory. .Xr mmap 2 may also be used but it will map it to another address. -.Sh AUTHORS -The -.Nm -driver was written by -.An Stacey Son -.Aq sson@freebsd.org . diff --git a/share/man/man4/man4.i386/cs.4 b/share/man/man4/man4.i386/cs.4 index c1ee7ae88a51..b7e038934f6a 100644 --- a/share/man/man4/man4.i386/cs.4 +++ b/share/man/man4/man4.i386/cs.4 @@ -129,12 +129,6 @@ The parameters obtained via PnP were not accepted by the driver. The adapter may not function. .El -.Sh CAVEATS -The CS89x0 family of adapters have a very small RAM buffer (4K). -This may -cause problems with extremely high network loads or bursty network traffic. -In particular, NFS operations should be limited to 1k read/write transactions -in order to avoid overruns. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -150,3 +144,9 @@ and .An Oleg Sharoiko . This manpage was written by .An Michael Smith . +.Sh CAVEATS +The CS89x0 family of adapters have a very small RAM buffer (4K). +This may +cause problems with extremely high network loads or bursty network traffic. +In particular, NFS operations should be limited to 1k read/write transactions +in order to avoid overruns. diff --git a/share/man/man4/man4.i386/ie.4 b/share/man/man4/man4.i386/ie.4 index 17d24d23ce61..2ef9d05669ff 100644 --- a/share/man/man4/man4.i386/ie.4 +++ b/share/man/man4/man4.i386/ie.4 @@ -116,12 +116,6 @@ The card refused to respond correctly during configuration. .It "ie%d: individual address setup command failed" The programming of the Ethernet (MAC) address failed. .El -.Sh CAVEATS -The Racal Interlan NI5210 comes in variants with 8 and 16 kbytes of -shared memory. -It is strongly advisable to use the 16 kbyte variant. -You can upgrade your 8 kbyte card to 16 kbyte by adding an additional -RAM chip. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -141,3 +135,9 @@ support was written by .An Charles M. Hannum . This manual page was written by .An Wilko C. Bulte . +.Sh CAVEATS +The Racal Interlan NI5210 comes in variants with 8 and 16 kbytes of +shared memory. +It is strongly advisable to use the 16 kbyte variant. +You can upgrade your 8 kbyte card to 16 kbyte by adding an additional +RAM chip. diff --git a/share/man/man4/man4.i386/mse.4 b/share/man/man4/man4.i386/mse.4 index 7f83dcc87a97..a5cb3f7b17e7 100644 --- a/share/man/man4/man4.i386/mse.4 +++ b/share/man/man4/man4.i386/mse.4 @@ -373,10 +373,6 @@ Define the .Nm driver at the secondary port address with the IRQ 4 and the acceleration factor of 3. -.Sh CAVEATS -Some bus mouse interface cards generate interrupts at the fixed report rate -when enabled, whether or not the mouse state is changing. -The others generate interrupts only when the state is changing. .Sh SEE ALSO .Xr ioctl 2 , .Xr mouse 4 , @@ -384,3 +380,7 @@ The others generate interrupts only when the state is changing. .Xr sysmouse 4 , .Xr moused 8 .\".Sh HISTORY +.Sh CAVEATS +Some bus mouse interface cards generate interrupts at the fixed report rate +when enabled, whether or not the mouse state is changing. +The others generate interrupts only when the state is changing. diff --git a/share/man/man4/man4.i386/pnp.4 b/share/man/man4/man4.i386/pnp.4 index 1c9a2cd42fb6..7c17b0e04dc0 100644 --- a/share/man/man4/man4.i386/pnp.4 +++ b/share/man/man4/man4.i386/pnp.4 @@ -48,17 +48,6 @@ If it cannot assign necessary resources to a PnP ISA device without causing conflict with other devices in the system, the device will not be activated and will be unavailable to programs. -.Sh CAVEATS -It is not possible to disable individual PnP ISA devices. -The -.Nm -driver will find all devices conforming the PnP ISA specification -and try to activate them all. -.Pp -There is no way to explicitly assign particular resource to -the PnP ISA device. -The resource assignment is fully automatic and there is -no provision for manual override. .Sh SEE ALSO .Xr pnpbios 4 .Sh STANDARDS @@ -88,3 +77,14 @@ by .An Luigi Rizzo , based on initial work done by .An Sujal Patel . +.Sh CAVEATS +It is not possible to disable individual PnP ISA devices. +The +.Nm +driver will find all devices conforming the PnP ISA specification +and try to activate them all. +.Pp +There is no way to explicitly assign particular resource to +the PnP ISA device. +The resource assignment is fully automatic and there is +no provision for manual override. diff --git a/share/man/man4/man4.i386/pnpbios.4 b/share/man/man4/man4.i386/pnpbios.4 index d8e7609f878f..b386be21f629 100644 --- a/share/man/man4/man4.i386/pnpbios.4 +++ b/share/man/man4/man4.i386/pnpbios.4 @@ -44,17 +44,6 @@ If it cannot assign necessary resources to a device without causing conflict with other devices in the system, the device will not be activated and will be unavailable to programs. -.Sh CAVEATS -There is no explicit way to disable individual embedded devices. -The -.Nm -driver will find all devices reported by the -.Dq "Plug and Play (PnP)" -BIOS and try to activate them all. -.Pp -There is no way to explicitly assign particular resource to a device. -The resource assignment is fully automatic and there is -no provision for manual override. .Sh SEE ALSO .Xr pnp 4 .Sh STANDARDS @@ -83,3 +72,14 @@ The .Nm driver was written by .An Mike Smith . +.Sh CAVEATS +There is no explicit way to disable individual embedded devices. +The +.Nm +driver will find all devices reported by the +.Dq "Plug and Play (PnP)" +BIOS and try to activate them all. +.Pp +There is no way to explicitly assign particular resource to a device. +The resource assignment is fully automatic and there is +no provision for manual override. diff --git a/share/man/man4/man4.i386/vx.4 b/share/man/man4/man4.i386/vx.4 index 99d89e92dfed..ab0472b6868a 100644 --- a/share/man/man4/man4.i386/vx.4 +++ b/share/man/man4/man4.i386/vx.4 @@ -96,16 +96,6 @@ rebuild the kernel, and reboot. .Pp All other diagnostics indicate either a hardware problem or a bug in the driver. -.Sh CAVEATS -Some early-revision 3c590 cards are defective and suffer from many receive -overruns, which cause lost packets. -The author has attempted to implement -a test for it based on the information supplied by 3Com, but the test resulted -mostly in spurious warnings. -.Pp -The performance of this driver is somewhat limited by the fact that it uses -only polled-mode I/O and does not make use of the bus-mastering capability -of the cards. .Sh SEE ALSO .Xr arp 4 , .Xr netintro 4 , @@ -128,6 +118,16 @@ device driver and this manual page were written by based on the work of .An Herb Peyerl and with the assistance of numerous others. +.Sh CAVEATS +Some early-revision 3c590 cards are defective and suffer from many receive +overruns, which cause lost packets. +The author has attempted to implement +a test for it based on the information supplied by 3Com, but the test resulted +mostly in spurious warnings. +.Pp +The performance of this driver is somewhat limited by the fact that it uses +only polled-mode I/O and does not make use of the bus-mastering capability +of the cards. .Sh BUGS The .Nm diff --git a/share/man/man4/man4.i386/wl.4 b/share/man/man4/man4.i386/wl.4 index 2f8fdc520693..a1eacdabcd56 100644 --- a/share/man/man4/man4.i386/wl.4 +++ b/share/man/man4/man4.i386/wl.4 @@ -141,17 +141,6 @@ packets and also stores the IP src address. ARP packets are ignored, as are any other network protocol barring IPv4 packets. .El -.Sh CAVEATS -The 82586 has numerous defects. -It may experience transmit-side -errors when modern faster cpus send packets at it faster than it can handle. -The driver (and probably the chip) does not support an all multicast mode. -As a result, it can be used with applications like -.Xr mrouted 8 Pq Pa ports/net/mrouted , -but it must go into promiscuous mode for that to work. -The driver -is slow to change modes from "normal" to promiscuous mode, presumably -due to delays in the configuration code. .Sh SEE ALSO .Xr sysctl 8 , .Xr wlconfig 8 @@ -189,3 +178,14 @@ for contributions. .Sh AUTHORS Too numerous to mention. See above. +.Sh CAVEATS +The 82586 has numerous defects. +It may experience transmit-side +errors when modern faster cpus send packets at it faster than it can handle. +The driver (and probably the chip) does not support an all multicast mode. +As a result, it can be used with applications like +.Xr mrouted 8 Pq Pa ports/net/mrouted , +but it must go into promiscuous mode for that to work. +The driver +is slow to change modes from "normal" to promiscuous mode, presumably +due to delays in the configuration code. diff --git a/share/man/man4/man4.powerpc/snd_ai2s.4 b/share/man/man4/man4.powerpc/snd_ai2s.4 index eabea346a9ba..dee04243e34a 100644 --- a/share/man/man4/man4.powerpc/snd_ai2s.4 +++ b/share/man/man4/man4.powerpc/snd_ai2s.4 @@ -66,8 +66,6 @@ Apple Tumbler Audio Apple Snapper Audio .El .Pp -.Sh BUGS -Recording and operation with non-44.1 Khz audio are not currently supported. .Sh SEE ALSO .Xr sound 4 , .Xr snd_davbus 4 @@ -88,3 +86,5 @@ driver was written by and ported to FreeBSD by .An Marco Trillo .Aq marcotrillo@gmail.com . +.Sh BUGS +Recording and operation with non-44.1 Khz audio are not currently supported. diff --git a/share/man/man4/man4.powerpc/snd_davbus.4 b/share/man/man4/man4.powerpc/snd_davbus.4 index 934886e14fe4..afdf9065c6f6 100644 --- a/share/man/man4/man4.powerpc/snd_davbus.4 +++ b/share/man/man4/man4.powerpc/snd_davbus.4 @@ -64,8 +64,6 @@ Apple Burgundy Audio Apple Screamer Audio .El .Pp -.Sh BUGS -Recording is not currently supported. .Sh SEE ALSO .Xr sound 4 , .Xr snd_ai2s 4 @@ -81,3 +79,5 @@ The driver was written by .An Marco Trillo .Aq marcotrillo@gmail.com . +.Sh BUGS +Recording is not currently supported. diff --git a/share/man/man4/man4.sparc64/clkbrd.4 b/share/man/man4/man4.sparc64/clkbrd.4 index b6c0bb381d02..ad74ee288ef9 100644 --- a/share/man/man4/man4.sparc64/clkbrd.4 +++ b/share/man/man4/man4.sparc64/clkbrd.4 @@ -62,8 +62,6 @@ driver also prints out the number of board slots the chassis provides. .It Pa /dev/led/clockboard clock board LED device node .El -.Sh CAVEATS -Hardware management functionality is not implemented. .Sh SEE ALSO .Xr fhc 4 , .Xr led 4 @@ -86,3 +84,5 @@ and ported to .Fx by .An "Marius Strobl" Aq marius@FreeBSD.org . +.Sh CAVEATS +Hardware management functionality is not implemented. diff --git a/share/man/man4/man4.sparc64/creator.4 b/share/man/man4/man4.sparc64/creator.4 index 5f6ab2334b00..5d7205be72ee 100644 --- a/share/man/man4/man4.sparc64/creator.4 +++ b/share/man/man4/man4.sparc64/creator.4 @@ -62,8 +62,6 @@ these frame buffers .Nm device nodes .El -.Sh CAVEATS -Font loading and mode switching are not implemented. .Sh SEE ALSO .Xr machfb 4 , .Xr syscons 4 @@ -86,3 +84,5 @@ roughly based on the .Ox driver written by .An "Jason L. Wright" . +.Sh CAVEATS +Font loading and mode switching are not implemented. diff --git a/share/man/man4/man4.sparc64/machfb.4 b/share/man/man4/man4.sparc64/machfb.4 index 7d0af1103657..c42eb9b08b98 100644 --- a/share/man/man4/man4.sparc64/machfb.4 +++ b/share/man/man4/man4.sparc64/machfb.4 @@ -154,8 +154,6 @@ driver at this time: .Tn Sun PGX64 8/24-Bit Color Frame Buffer (part no.\& 370-4362) .El -.Sh CAVEATS -Font loading and mode switching are not implemented. .Sh SEE ALSO .Xr creator 4 , .Xr syscons 4 @@ -178,3 +176,5 @@ based on the .Nx driver written by .An "Bang Jun-Young" . +.Sh CAVEATS +Font loading and mode switching are not implemented. diff --git a/share/man/man4/man4.sparc64/ofw_console.4 b/share/man/man4/man4.sparc64/ofw_console.4 index 8ae1c0c04a16..9a4513b10506 100644 --- a/share/man/man4/man4.sparc64/ofw_console.4 +++ b/share/man/man4/man4.sparc64/ofw_console.4 @@ -78,19 +78,6 @@ terminal output device in case the console output device is the screen .It Pa /dev/tty[a-z] terminal device in case both the console input and output device is tty[a-z] .El -.Sh CAVEATS -Since the Open Firmware will handle BREAK -(or Stop-A) -sequences before -.Nm , -the preferred way to enter -.Xr ddb 4 -when using -.Nm -is to include -.Cd "options ALT_BREAK_TO_DEBUGGER" -in a ddb-enabled kernel, and enter the alternate BREAK sequence -(RETURN TILDE CTRL-b). .Sh SEE ALSO .Xr creator 4 , .Xr machfb 4 , @@ -107,6 +94,19 @@ The .Nm driver was written by .An "Benno Rice" Aq benno@FreeBSD.org . +.Sh CAVEATS +Since the Open Firmware will handle BREAK +(or Stop-A) +sequences before +.Nm , +the preferred way to enter +.Xr ddb 4 +when using +.Nm +is to include +.Cd "options ALT_BREAK_TO_DEBUGGER" +in a ddb-enabled kernel, and enter the alternate BREAK sequence +(RETURN TILDE CTRL-b). .Sh BUGS The .Nm diff --git a/share/man/man4/man4.sparc64/openfirm.4 b/share/man/man4/man4.sparc64/openfirm.4 index 686fe868c954..63abd855ed00 100644 --- a/share/man/man4/man4.sparc64/openfirm.4 +++ b/share/man/man4/man4.sparc64/openfirm.4 @@ -251,25 +251,6 @@ The kernel could not allocate memory to copy in data from user-space or to retrieve data from the .Tn Open Firmware . .El -.Sh CAVEATS -Due to limitations within -.Tn Open Firmware -itself, -these functions run at elevated priority and may adversely affect system -performance. -.Pp -For at least the -.Pa /options -node the property value passed in to the -.Dv OFIOCSET -call has to be null-terminated and the value length passed in has to include -the terminating -.Ql \e0 . -However, as with the -.Dv OFIOCGET -call, -the returned value length does not include the terminating -.Ql \e0 . .Sh SEE ALSO .Xr ioctl 2 , .Xr openprom 4 , @@ -298,3 +279,22 @@ interface was ported to .Fx by .An "Thomas Moestl" Aq tmm@FreeBSD.org . +.Sh CAVEATS +Due to limitations within +.Tn Open Firmware +itself, +these functions run at elevated priority and may adversely affect system +performance. +.Pp +For at least the +.Pa /options +node the property value passed in to the +.Dv OFIOCSET +call has to be null-terminated and the value length passed in has to include +the terminating +.Ql \e0 . +However, as with the +.Dv OFIOCGET +call, +the returned value length does not include the terminating +.Ql \e0 . diff --git a/share/man/man4/man4.sparc64/openprom.4 b/share/man/man4/man4.sparc64/openprom.4 index e66a8d8581d5..e8336280a22e 100644 --- a/share/man/man4/man4.sparc64/openprom.4 +++ b/share/man/man4/man4.sparc64/openprom.4 @@ -206,21 +206,6 @@ The kernel could not allocate memory to copy in data from user-space or to retrieve data from the .Tn Open Firmware . .El -.Sh CAVEATS -Due to limitations within -.Tn Open Firmware -itself, -these functions run at elevated priority and may adversely affect system -performance. -.Pp -The -.Nm -interface exists entirely for compatibility with software like X11, -and only the features that are actually needed for that are implemented. -The interface sucks too much to actually use, -new code should use the -.Xr openfirm 4 -interface instead. .Sh SEE ALSO .Xr ioctl 2 , .Xr openfirm 4 , @@ -238,3 +223,18 @@ The .Nm interface was written by .An "Jake Burkholder" Aq jake@FreeBSD.org . +.Sh CAVEATS +Due to limitations within +.Tn Open Firmware +itself, +these functions run at elevated priority and may adversely affect system +performance. +.Pp +The +.Nm +interface exists entirely for compatibility with software like X11, +and only the features that are actually needed for that are implemented. +The interface sucks too much to actually use, +new code should use the +.Xr openfirm 4 +interface instead. diff --git a/share/man/man4/natm.4 b/share/man/man4/natm.4 index 33bd2b19e8e2..59e5559d3fd2 100644 --- a/share/man/man4/natm.4 +++ b/share/man/man4/natm.4 @@ -83,11 +83,6 @@ overhead of a protocol control block lookup. This allows us to take advantage of the fact that ATM has already demultiplexed the data for us. -.Sh CAVEATS -The NATM protocol support is subject to change as -the ATM protocols develop. -Users should not depend on details of the current implementation, but rather -the services exported. .Sh SEE ALSO .Xr en 4 , .Xr fatm 4 , @@ -99,3 +94,8 @@ the services exported. of Washington University implemented the NATM protocol layer along with the EN ATM driver in 1996 for .Nx . +.Sh CAVEATS +The NATM protocol support is subject to change as +the ATM protocols develop. +Users should not depend on details of the current implementation, but rather +the services exported. diff --git a/share/man/man4/nve.4 b/share/man/man4/nve.4 index 5fe5229a215e..a1db97aa725d 100644 --- a/share/man/man4/nve.4 +++ b/share/man/man4/nve.4 @@ -114,10 +114,6 @@ There are not enough mbufs available for allocation. The device has stopped responding to the network, or there is a problem with the network connection (cable). .El -.Sh BUGS -There are reports that when the card is in auto select mode, -ifconfig output reports a 10baseT/UTP output while the LEDs and -bandwidth show that the card is actually in 100baseTX mode. .Sh SEE ALSO .Xr altq 4 , .Xr arp 4 , @@ -138,3 +134,7 @@ driver was written by .An Quinton Dolan Aq q@onthenet.com.au and .An "David E. O'Brien" Aq obrien@FreeBSD.org . +.Sh BUGS +There are reports that when the card is in auto select mode, +ifconfig output reports a 10baseT/UTP output while the LEDs and +bandwidth show that the card is actually in 100baseTX mode. diff --git a/share/man/man4/patm.4 b/share/man/man4/patm.4 index 3ab2f7aec553..443b9f7a8d43 100644 --- a/share/man/man4/patm.4 +++ b/share/man/man4/patm.4 @@ -154,6 +154,12 @@ patm1: 128K x 32 SRAM; 4096 connections .Xr natm 4 , .Xr natmip 4 , .Xr utopia 4 +.Sh ACKNOWLEDGEMENTS +Thanks to Christian Bucari from ProSum for lending two of these cards to enable +the development of this driver. +Thanks also for answering my questions. +.Sh AUTHORS +.An Harti Brandt Aq harti@FreeBSD.org .Sh CAVEATS The card fails to generate an interrupt if a cell is received in AAL0 mode that has the MSB of the PTI field cleared. @@ -184,9 +190,3 @@ uses idle cells for spacing and the PHY counts these cells. While there is a configuration option for the chip to switch of these cells and, according to the documentation, this should not influence cell spacing, it does, so the driver lets the chip generate idle cells. -.Sh ACKNOWLEDGEMENTS -Thanks to Christian Bucari from ProSum for lending two of these cards to enable -the development of this driver. -Thanks also for answering my questions. -.Sh AUTHORS -.An Harti Brandt Aq harti@FreeBSD.org diff --git a/share/man/man4/psm.4 b/share/man/man4/psm.4 index b61a4d30ae01..ed911bdd9141 100644 --- a/share/man/man4/psm.4 +++ b/share/man/man4/psm.4 @@ -817,36 +817,6 @@ The rest of the lines show the device ID code, the number of detected buttons and internal variables. .Pp At debug level 2, much more detailed information is logged. -.Sh CAVEATS -Many pad devices behave as if the first (left) button were pressed if -the user `taps' the surface of the pad. -In contrast, some pad products, e.g.\& some versions of ALPS GlidePoint -and Interlink VersaPad, treat the tapping action -as fourth button events. -.Pp -It is reported that Interlink VersaPad requires both -.Em HOOKRESUME -and -.Em INITAFTERSUSPEND -flags in order to recover from suspended state. -These flags are automatically set when VersaPad is detected by the -.Nm -driver. -.Pp -Some PS/2 mouse models from MouseSystems require to be put in the -high resolution mode to work properly. -Use the driver flag to -set resolution. -.Pp -There is not a guaranteed way to re-synchronize with the first byte -of the packet once we are out of synchronization with the data -stream. -However, if you are using the \fIXFree86\fP server and experiencing -the problem, you may be able to make the X server synchronize with the mouse -by switching away to a virtual terminal and getting back to the X server, -unless the X server is accessing the mouse via -.Xr moused 8 . -Clicking any button without moving the mouse may also work. .Sh SEE ALSO .Xr ioctl 2 , .Xr syslog 3 , @@ -878,6 +848,36 @@ to name the few. .Pp This manual page was written by .An Kazutaka Yokota Aq yokota@FreeBSD.org . +.Sh CAVEATS +Many pad devices behave as if the first (left) button were pressed if +the user `taps' the surface of the pad. +In contrast, some pad products, e.g.\& some versions of ALPS GlidePoint +and Interlink VersaPad, treat the tapping action +as fourth button events. +.Pp +It is reported that Interlink VersaPad requires both +.Em HOOKRESUME +and +.Em INITAFTERSUSPEND +flags in order to recover from suspended state. +These flags are automatically set when VersaPad is detected by the +.Nm +driver. +.Pp +Some PS/2 mouse models from MouseSystems require to be put in the +high resolution mode to work properly. +Use the driver flag to +set resolution. +.Pp +There is not a guaranteed way to re-synchronize with the first byte +of the packet once we are out of synchronization with the data +stream. +However, if you are using the \fIXFree86\fP server and experiencing +the problem, you may be able to make the X server synchronize with the mouse +by switching away to a virtual terminal and getting back to the X server, +unless the X server is accessing the mouse via +.Xr moused 8 . +Clicking any button without moving the mouse may also work. .Sh BUGS The ioctl command .Dv MOUSEIOCREAD diff --git a/share/man/man4/splash.4 b/share/man/man4/splash.4 index 165366a8cc4d..5a32e864bd15 100644 --- a/share/man/man4/splash.4 +++ b/share/man/man4/splash.4 @@ -221,10 +221,6 @@ necessary to load the VESA module. Just load the bitmap file and the splash decoder module as in the first example above. .\".Sh DIAGNOSTICS -.Sh CAVEATS -Both the splash screen and the screen saver work with -.Xr syscons 4 -only. .Sh SEE ALSO .Xr vidcontrol 1 , .Xr syscons 4 , @@ -257,6 +253,10 @@ module was written by based on the .Pa splash_bmp code. +.Sh CAVEATS +Both the splash screen and the screen saver work with +.Xr syscons 4 +only. .Sh BUGS If you load a screen saver while another screen saver has already been loaded, the first screen saver will not be automatically unloaded diff --git a/share/man/man4/syscons.4 b/share/man/man4/syscons.4 index b0f98a1e31b0..acc6c665ff05 100644 --- a/share/man/man4/syscons.4 +++ b/share/man/man4/syscons.4 @@ -523,14 +523,6 @@ to the kernel. .Dl "makeoptions SC_DFLT_FONT=cp850 .Dl "device sc" .\".Sh DIAGNOSTICS -.Sh CAVEATS -The amount of data that is possible to insert from the cut buffer is limited -by the -.Brq Dv MAX_INPUT , -a system limit on the number of bytes that may be stored in the terminal -input queue - usually 1024 bytes -(see -.Xr termios 4 ) . .Sh SEE ALSO .Xr kbdcontrol 1 , .Xr login 1 , @@ -562,5 +554,13 @@ driver was written by .An S\(/oren Schmidt Aq sos@FreeBSD.org . This manual page was written by .An Kazutaka Yokota Aq yokota@FreeBSD.org . +.Sh CAVEATS +The amount of data that is possible to insert from the cut buffer is limited +by the +.Brq Dv MAX_INPUT , +a system limit on the number of bytes that may be stored in the terminal +input queue - usually 1024 bytes +(see +.Xr termios 4 ) . .Sh BUGS This manual page is incomplete and urgently needs revision. diff --git a/share/man/man4/twa.4 b/share/man/man4/twa.4 old mode 100755 new mode 100644 diff --git a/share/man/man4/ucom.4 b/share/man/man4/ucom.4 index 1f398474858d..ff891cb706ad 100644 --- a/share/man/man4/ucom.4 +++ b/share/man/man4/ucom.4 @@ -68,14 +68,6 @@ The .Va portno locater can be used to decide which port to use for devices that have multiple external ports. -.Sh BUGS -Prior to -.Fx 6.0 -.Nm -created -.Pa /dev/ucom? -rather than the uniform device names created today. -Old scripts must be adjusted accordingly. .Sh FILES .Bl -tag -width ".Pa /dev/cuaU?" .It Pa /dev/cuaU? @@ -103,3 +95,11 @@ This manual page was adopted from by .An Tom Rhodes Aq trhodes@FreeBSD.org in April 2002. +.Sh BUGS +Prior to +.Fx 6.0 +.Nm +created +.Pa /dev/ucom? +rather than the uniform device names created today. +Old scripts must be adjusted accordingly. diff --git a/share/man/man4/vkbd.4 b/share/man/man4/vkbd.4 index 079688f6bb0b..debdd3eea528 100644 --- a/share/man/man4/vkbd.4 +++ b/share/man/man4/vkbd.4 @@ -130,6 +130,13 @@ All queued scan codes are thrown away. .Xr atkbdc 4 , .Xr psm 4 , .Xr syscons 4 +.Sh HISTORY +The +.Nm +module was implemented in +.Fx 6.0 . +.Sh AUTHORS +.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com .Sh CAVEATS The .Nm @@ -144,10 +151,3 @@ at the same time. It is, however, in principal possible to obtain AT scan codes from the different sources and write them into the same virtual keyboard. The virtual keyboard state synchronization is the user's responsibility. -.Sh HISTORY -The -.Nm -module was implemented in -.Fx 6.0 . -.Sh AUTHORS -.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/share/man/man4/wpi.4 b/share/man/man4/wpi.4 index 07e881698276..9932ff4072d3 100644 --- a/share/man/man4/wpi.4 +++ b/share/man/man4/wpi.4 @@ -117,10 +117,6 @@ unload/reload the driver to continue. The hardware switch controlling the radio is currently turned off. Data transmission is not possible in this state. .El -.Sh BUGS -Not all the error messages are documented here. -.Pp -Background scanning is not currently supported. .Sh SEE ALSO .Xr wpifw 4 , .Xr pci 4 , @@ -143,3 +139,7 @@ ported .Nm to .Fx . +.Sh BUGS +Not all the error messages are documented here. +.Pp +Background scanning is not currently supported. diff --git a/share/man/man5/make.conf.5 b/share/man/man5/make.conf.5 index a6a32593e36d..9cc3c1d33013 100644 --- a/share/man/man5/make.conf.5 +++ b/share/man/man5/make.conf.5 @@ -753,13 +753,6 @@ file appeared sometime before This manual page was written by .An Mike W. Meyer Aq mwm@mired.org . -.Sh BUGS -This manual page may occasionally be out of date with respect to -the options currently available for use in -.Nm . -Please check the -.Pa /usr/share/examples/etc/make.conf -file for the latest options which are available. .Sh CAVEATS Note, that .Ev MAKEOBJDIRPREFIX @@ -768,3 +761,10 @@ and are environment variables and should not be set in .Nm but in make's environment. +.Sh BUGS +This manual page may occasionally be out of date with respect to +the options currently available for use in +.Nm . +Please check the +.Pa /usr/share/examples/etc/make.conf +file for the latest options which are available. diff --git a/share/man/man5/reiserfs.5 b/share/man/man5/reiserfs.5 index b7445a6a3a47..eda70288915e 100644 --- a/share/man/man5/reiserfs.5 +++ b/share/man/man5/reiserfs.5 @@ -61,9 +61,6 @@ volume located on .Xr unmount 2 , .Xr fstab 5 , .Xr mount 8 -.Sh CAVEATS -Currently, only read-only access is supported for ReiserFS volumes, -writing to a volume is not supported. .Sh HISTORY The .Nm @@ -82,3 +79,6 @@ by .Pp This manual page was written by .An Craig Rodrigues Aq rodrigc@FreeBSD.org . +.Sh CAVEATS +Currently, only read-only access is supported for ReiserFS volumes, +writing to a volume is not supported. diff --git a/share/man/man5/xfs.5 b/share/man/man5/xfs.5 index 44654843fda7..c3504241600e 100644 --- a/share/man/man5/xfs.5 +++ b/share/man/man5/xfs.5 @@ -67,22 +67,6 @@ port contains the utility for creating XFS file systems, and also other utilities for analyzing, and repairing XFS file systems. -.Sh CAVEATS -The port of XFS to -.Fx -is currently incomplete. -Only read-only access is supported for XFS volumes. -Writing to a volume is not supported. -.Pp -The -.Fl p -flag to -.Cm mkfs.xfs -can be used to create an XFS file system which is populated with files -and other metadata. -This can be used to quickly create a read-only file system which -can be tested on -.Fx . .Sh HISTORY XFS was originally written by SGI for the IRIX operating system. SGI ported XFS to Linux, and released the source code under the GNU @@ -106,3 +90,19 @@ first appeared in .Sh AUTHORS This manual page was written by .An Craig Rodrigues Aq rodrigc@FreeBSD.org . +.Sh CAVEATS +The port of XFS to +.Fx +is currently incomplete. +Only read-only access is supported for XFS volumes. +Writing to a volume is not supported. +.Pp +The +.Fl p +flag to +.Cm mkfs.xfs +can be used to create an XFS file system which is populated with files +and other metadata. +This can be used to quickly create a read-only file system which +can be tested on +.Fx . diff --git a/share/man/man9/fail.9 b/share/man/man9/fail.9 index 81292f58db79..8d1e59346586 100644 --- a/share/man/man9/fail.9 +++ b/share/man/man9/fail.9 @@ -183,6 +183,10 @@ Return 5 for 1 in 1000 executions, but only 5 times total. .It Sy sysctl debug.fail_point.foobar="1%*sleep(50)" 1/100th of the time, sleep 50ms. .El +.Sh AUTHORS +.An -nosplit +This manual page was written by +.An Zach Loafman Aq zml@FreeBSD.org . .Sh CAVEATS It is easy to shoot yourself in the foot by setting fail points too aggressively or setting too many in combination. @@ -197,7 +201,3 @@ Currently, .Fn fail_point_eval does not verify whether the context is appropriate for calling .Fn msleep . -.Sh AUTHORS -.An -nosplit -This manual page was written by -.An Zach Loafman Aq zml@FreeBSD.org . diff --git a/share/man/man9/mbpool.9 b/share/man/man9/mbpool.9 index b042973ac84d..600c37179fb4 100644 --- a/share/man/man9/mbpool.9 +++ b/share/man/man9/mbpool.9 @@ -254,11 +254,11 @@ states and the number of buffers on the free list. .Sh SEE ALSO .Xr mbuf 9 +.Sh AUTHORS +.An Harti Brandt Aq harti@FreeBSD.org .Sh CAVEATS The function .Fn mbp_sync is currently a no-op because .Xr bus_dmamap_sync 9 is missing the offset and length parameters. -.Sh AUTHORS -.An Harti Brandt Aq harti@FreeBSD.org diff --git a/sys/boot/forth/loader.conf.5 b/sys/boot/forth/loader.conf.5 index df2183f1c41c..6abb7ea2aa5d 100644 --- a/sys/boot/forth/loader.conf.5 +++ b/sys/boot/forth/loader.conf.5 @@ -243,6 +243,14 @@ contains the instructions to automatically process .Xr boot 8 , .Xr loader 8 , .Xr loader.4th 8 +.Sh HISTORY +The file +.Nm +first appeared in +.Fx 3.2 . +.Sh AUTHORS +This manual page was written by +.An Daniel C. Sobral Aq dcs@FreeBSD.org . .Sh BUGS The .Xr loader 8 @@ -253,11 +261,3 @@ booting a particular system (i.e.\& .Dq Va hw.ata.ata_dma Ns "=0" ) should precede any experimental additions to .Nm . -.Sh HISTORY -The file -.Nm -first appeared in -.Fx 3.2 . -.Sh AUTHORS -This manual page was written by -.An Daniel C. Sobral Aq dcs@FreeBSD.org . diff --git a/tools/tools/vimage/vimage.8 b/tools/tools/vimage/vimage.8 index 517a788cda3d..d55bcba476eb 100644 --- a/tools/tools/vimage/vimage.8 +++ b/tools/tools/vimage/vimage.8 @@ -181,11 +181,6 @@ command exits 0 on success, and >0 if an error occurs. .Xr jail 8 .Xr jexec 8 .Xr jls 8 -.Sh BUGS -Deletion of vimages / vnets is known to leak kernel memory and fail at -stopping various timers, hence may lead to system crashes. -.Sh AUTHOR -.An "Marko Zec" Aq zec@fer.hr .Sh HISTORY Network stack virtualization framework first appeared as a patchset against the FreeBSD 4.7 kernel in 2002, and was maintained outside @@ -193,3 +188,8 @@ of the main FreeBSD tree. As a result of a project sponsored by the FreeBSD Foundation and Stiching NLNet, integrated virtualized network stack first appeared in FreeBSD 8.0. +.Sh BUGS +Deletion of vimages / vnets is known to leak kernel memory and fail at +stopping various timers, hence may lead to system crashes. +.Sh AUTHOR +.An "Marko Zec" Aq zec@fer.hr diff --git a/usr.bin/bsdiff/bsdiff/bsdiff.1 b/usr.bin/bsdiff/bsdiff/bsdiff.1 index 4ceb9ed5bb0c..6c598628a62f 100644 --- a/usr.bin/bsdiff/bsdiff/bsdiff.1 +++ b/usr.bin/bsdiff/bsdiff/bsdiff.1 @@ -65,6 +65,8 @@ an absolute minimum working set size of 8 times the size of .Ar oldfile . .Sh SEE ALSO .Xr bspatch 1 +.Sh AUTHORS +.An Colin Percival Aq cperciva@FreeBSD.org .Sh BUGS The .Nm @@ -84,5 +86,3 @@ and .Ar newfile and compare against them before and after applying .Ar patchfile . -.Sh AUTHORS -.An Colin Percival Aq cperciva@FreeBSD.org diff --git a/usr.bin/bsdiff/bspatch/bspatch.1 b/usr.bin/bsdiff/bspatch/bspatch.1 index 29b8db3c81ec..352d0cfa1be6 100644 --- a/usr.bin/bsdiff/bspatch/bspatch.1 +++ b/usr.bin/bsdiff/bspatch/bspatch.1 @@ -61,6 +61,8 @@ but can tolerate a very small working set without a dramatic loss of performance. .Sh SEE ALSO .Xr bsdiff 1 +.Sh AUTHORS +.An Colin Percival Aq cperciva@FreeBSD.org .Sh BUGS The .Nm @@ -82,5 +84,3 @@ that .Ar newfile matches the target file from which .Ar was built. -.Sh AUTHORS -.An Colin Percival Aq cperciva@FreeBSD.org diff --git a/usr.sbin/adduser/adduser.conf.5 b/usr.sbin/adduser/adduser.conf.5 index a78aeea59dcc..d5fcf772f0f6 100644 --- a/usr.sbin/adduser/adduser.conf.5 +++ b/usr.sbin/adduser/adduser.conf.5 @@ -208,6 +208,9 @@ The .Nm manual page first appeared in .Fx 5.3 . +.Sh AUTHORS +This manual page was written by +.An Tom Rhodes Aq trhodes@FreeBSD.org . .Sh BUGS The internal variables documented here may change without notice. Do not rely on them. @@ -216,6 +219,3 @@ To modify this file invoke with the .Fl C option instead. -.Sh AUTHORS -This manual page was written by -.An Tom Rhodes Aq trhodes@FreeBSD.org . diff --git a/usr.sbin/bluetooth/bthidd/bthidd.8 b/usr.sbin/bluetooth/bthidd/bthidd.8 index 37aaa3d4761f..8dd052edf094 100644 --- a/usr.sbin/bluetooth/bthidd/bthidd.8 +++ b/usr.sbin/bluetooth/bthidd/bthidd.8 @@ -83,23 +83,6 @@ disconnected Bluetooth HID devices and will attempt to establish an outgoing connection. The default rescan interval is 10 seconds. .El -.Sh CAVEATS -Any Bluetooth HID device that has -.Dv HUP_KEYBOARD -or -.Dv HUP_CONSUMER -entries in its descriptor is considered as -.Dq keyboard . -For each -.Dq keyboard -Bluetooth HID device, -the -.Nm -daemon will use a separate instance of the virtual keyboard interface -.Xr vkbd 4 . -Therefore the -.Xr kbdmux 4 -driver must be used to properly multiplex input from multiple keyboards. .Sh KNOWN LIMITATIONS The .Nm @@ -125,3 +108,20 @@ configuration file is needed as well. .Xr bthidcontrol 8 .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh CAVEATS +Any Bluetooth HID device that has +.Dv HUP_KEYBOARD +or +.Dv HUP_CONSUMER +entries in its descriptor is considered as +.Dq keyboard . +For each +.Dq keyboard +Bluetooth HID device, +the +.Nm +daemon will use a separate instance of the virtual keyboard interface +.Xr vkbd 4 . +Therefore the +.Xr kbdmux 4 +driver must be used to properly multiplex input from multiple keyboards. diff --git a/usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 b/usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 index e74e113af136..0588d0c3f5db 100644 --- a/usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 +++ b/usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 @@ -335,14 +335,6 @@ in mode with the .Dq Li rfcomm-client label. -.Sh CAVEATS -The -.Nm -utility in server mode will try to register the Bluetooth LAN Access Over PPP -service with the local SPD daemon. -If the local SDP daemon is not running, -.Nm -will exit with an error. .Sh SEE ALSO .Xr rfcomm_sppd 1 , .Xr bluetooth 3 , @@ -352,3 +344,11 @@ will exit with an error. .Xr sdpd 8 .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com +.Sh CAVEATS +The +.Nm +utility in server mode will try to register the Bluetooth LAN Access Over PPP +service with the local SPD daemon. +If the local SDP daemon is not running, +.Nm +will exit with an error. diff --git a/usr.sbin/cpucontrol/cpucontrol.8 b/usr.sbin/cpucontrol/cpucontrol.8 index 165e67b2a87c..62221c357b53 100644 --- a/usr.sbin/cpucontrol/cpucontrol.8 +++ b/usr.sbin/cpucontrol/cpucontrol.8 @@ -164,10 +164,10 @@ The .Nm utility first appeared in .Fx 7.2 . -.Sh BUGS -Yes, probably, report if any. .Sh AUTHORS The .Nm utility and this manual page was written by .An Stanislav Sedov Aq stas@FreeBSD.org . +.Sh BUGS +Yes, probably, report if any. diff --git a/usr.sbin/crunch/crunchgen/crunchgen.1 b/usr.sbin/crunch/crunchgen/crunchgen.1 index b7313b9fab17..5dfd0a9fbfba 100644 --- a/usr.sbin/crunch/crunchgen/crunchgen.1 +++ b/usr.sbin/crunch/crunchgen/crunchgen.1 @@ -441,6 +441,22 @@ would also need to be copied to the install floppy. .Xr crunchide 1 , .Xr make 1 , .Xr rtld 1 +.Sh AUTHORS +.An -nosplit +The +.Nm +utility was written by +.An James da Silva Aq jds@cs.umd.edu . +.Pp +Copyright (c) 1994 University of Maryland. +All Rights Reserved. +.Pp +The +.Ic libs_so +keyword was added in 2005 by +.An Adrian Steinmann Aq ast@marabu.ch +and +.An Ceri Davies Aq ceri@FreeBSD.org . .Sh CAVEATS While .Nm @@ -459,19 +475,3 @@ The .Dq Li make objs must then be used to get those object files built, or some other arrangements made. -.Sh AUTHORS -.An -nosplit -The -.Nm -utility was written by -.An James da Silva Aq jds@cs.umd.edu . -.Pp -Copyright (c) 1994 University of Maryland. -All Rights Reserved. -.Pp -The -.Ic libs_so -keyword was added in 2005 by -.An Adrian Steinmann Aq ast@marabu.ch -and -.An Ceri Davies Aq ceri@FreeBSD.org . diff --git a/usr.sbin/mount_portalfs/mount_portalfs.8 b/usr.sbin/mount_portalfs/mount_portalfs.8 index ffbcb0860796..b6ca9cc70656 100644 --- a/usr.sbin/mount_portalfs/mount_portalfs.8 +++ b/usr.sbin/mount_portalfs/mount_portalfs.8 @@ -207,10 +207,10 @@ ln -s '/p/pipe/usr/local/bin/passwd2xml /etc/passwd' \\ .%O "Berkeley, CA" .%I "Peter Honeyman" .Re -.Sh CAVEATS -This file system may not be NFS-exported. .Sh HISTORY The .Nm utility first appeared in .Bx 4.4 . +.Sh CAVEATS +This file system may not be NFS-exported. diff --git a/usr.sbin/moused/moused.8 b/usr.sbin/moused/moused.8 index 333b2470fb4d..8a214552a595 100644 --- a/usr.sbin/moused/moused.8 +++ b/usr.sbin/moused/moused.8 @@ -787,34 +787,6 @@ file, and bind .Pp to a key in your window manager, you can suspend mouse events on your laptop if you keep brushing over the mouse pad while typing. -.Sh CAVEATS -Many pad devices behave as if the first (left) button were pressed if -the user -.Dq taps -the surface of the pad. -In contrast, some ALPS GlidePoint and Interlink VersaPad models -treat the tapping action -as fourth button events. -Use the option -.Dq Fl m Li 1=4 -for these models -to obtain the same effect as the other pad devices. -.Pp -Cut and paste functions in the virtual console assume that there -are three buttons on the mouse. -The logical button 1 (logical left) selects a region of text in the -console and copies it to the cut buffer. -The logical button 3 (logical right) extends the selected region. -The logical button 2 (logical middle) pastes the selected text -at the text cursor position. -If the mouse has only two buttons, the middle, `paste' button -is not available. -To obtain the paste function, use the -.Fl 3 -option to emulate the middle button, or use the -.Fl m -option to assign the physical right button to the logical middle button: -.Dq Fl m Li 2=3 . .Sh SEE ALSO .Xr kill 1 , .Xr vidcontrol 1 , @@ -852,3 +824,31 @@ This manual page was written by .An Mike Pritchard Aq mpp@FreeBSD.org . The command and manual page have since been updated by .An Kazutaka Yokota Aq yokota@FreeBSD.org . +.Sh CAVEATS +Many pad devices behave as if the first (left) button were pressed if +the user +.Dq taps +the surface of the pad. +In contrast, some ALPS GlidePoint and Interlink VersaPad models +treat the tapping action +as fourth button events. +Use the option +.Dq Fl m Li 1=4 +for these models +to obtain the same effect as the other pad devices. +.Pp +Cut and paste functions in the virtual console assume that there +are three buttons on the mouse. +The logical button 1 (logical left) selects a region of text in the +console and copies it to the cut buffer. +The logical button 3 (logical right) extends the selected region. +The logical button 2 (logical middle) pastes the selected text +at the text cursor position. +If the mouse has only two buttons, the middle, `paste' button +is not available. +To obtain the paste function, use the +.Fl 3 +option to emulate the middle button, or use the +.Fl m +option to assign the physical right button to the logical middle button: +.Dq Fl m Li 2=3 . diff --git a/usr.sbin/mtree/mtree.5 b/usr.sbin/mtree/mtree.5 index 8f17d90344f5..8962e5f0add6 100644 --- a/usr.sbin/mtree/mtree.5 +++ b/usr.sbin/mtree/mtree.5 @@ -228,17 +228,6 @@ socket .Xr cksum 1 , .Xr find 1 , .Xr mtree 8 -.Sh BUGS -The -.Fx -implementation of mtree does not currently support -the -.Nm -2.0 -format. -The requirement for a -.Dq #mtree -signature line is new and not yet widely implemented. .Sh HISTORY The .Nm @@ -270,3 +259,14 @@ The .Dq full entry format was added by .Nx . +.Sh BUGS +The +.Fx +implementation of mtree does not currently support +the +.Nm +2.0 +format. +The requirement for a +.Dq #mtree +signature line is new and not yet widely implemented. diff --git a/usr.sbin/rtprio/rtprio.1 b/usr.sbin/rtprio/rtprio.1 index 3141fba384e3..567a1c437ee7 100644 --- a/usr.sbin/rtprio/rtprio.1 +++ b/usr.sbin/rtprio/rtprio.1 @@ -161,9 +161,6 @@ The utility appeared in .Fx 2.0 , but is similar to the HP-UX version. -.Sh CAVEATS -You can lock yourself out of the system by placing a cpu-heavy -process in a realtime priority. .Sh AUTHORS .An -nosplit .An Henrik Vestergaard Draboel Aq hvd@terry.ping.dk @@ -173,6 +170,9 @@ implementation in .Fx was substantially rewritten by .An David Greenman . +.Sh CAVEATS +You can lock yourself out of the system by placing a cpu-heavy +process in a realtime priority. .Sh BUGS There is no way to set/view the realtime priority of process 0 (swapper) (see