Libc-825.24.tar.gz

[apple/libc.git] / string / FreeBSD / bstring.3

diff --git a/string/FreeBSD/bstring.3 b/string/FreeBSD/bstring.3
index 3629a3eb3daa24258815e827cdc0b8dc14289e8c..4b3438762466a878bfde2cec8cd8560413656fea 100644 (file)
--- a/string/FreeBSD/bstring.3
+++ b/string/FreeBSD/bstring.3
@@ -11,10 +11,6 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"    This product includes software developed by the University of
-.\"    California, Berkeley and its contributors.
 .\" 4. Neither the name of the University nor the names of its contributors
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
@@ -32,7 +28,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)bstring.3  8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/string/bstring.3,v 1.7 2001/10/01 16:09:00 ru Exp $
+.\" $FreeBSD: src/lib/libc/string/bstring.3,v 1.8 2007/01/09 00:28:11 imp Exp $
 .\"
 .Dd June 4, 1993
 .Dt BSTRING 3
@@ -51,33 +47,76 @@
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
-.In string.h
+.In strings.h
 .Ft int
-.Fn bcmp "const void *b1" "const void *b2" "size_t len"
+.Fo bcmp
+.Fa "const void *s1"
+.Fa "const void *s2"
+.Fa "size_t n"
+.Fc
 .Ft void
-.Fn bcopy "const void *src" "void *dst" "size_t len"
+.Fo bcopy
+.Fa "const void *s1"
+.Fa "void *s2"
+.Fa "size_t n"
+.Fc
 .Ft void
-.Fn bzero "void *b" "size_t len"
+.Fo bzero
+.Fa "void *s"
+.Fa "size_t n"
+.Fc
+.In string.h
 .Ft void *
-.Fn memchr "const void *b" "int c" "size_t len"
-.Ft int
-.Fn memcmp "const void *b1" "const void *b2" "size_t len"
+.Fo memccpy
+.Fa "void *restrict s1"
+.Fa "const void *restrict s2"
+.Fa "int c"
+.Fa "size_t n"
+.Fc
 .Ft void *
-.Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
+.Fo memchr
+.Fa "const void *s"
+.Fa "int c"
+.Fa "size_t n"
+.Fc
+.Ft int
+.Fo memcmp
+.Fa "const void *s1"
+.Fa "const void *s2"
+.Fa "size_t n"
+.Fc
 .Ft void *
-.Fn memcpy "void *dst" "const void *src" "size_t len"
+.Fo memcpy
+.Fa "void *restrict s1"
+.Fa "const void *restrict s2"
+.Fa "size_t n"
+.Fc
 .Ft void *
-.Fn memmove "void *dst" "const void *src" "size_t len"
+.Fo memmove
+.Fa "void *s1"
+.Fa "const void *s2"
+.Fa "size_t n"
+.Fc
 .Ft void *
-.Fn memset "void *b" "int c" "size_t len"
+.Fo memset
+.Fa "void *s"
+.Fa "int c"
+.Fa "size_t n"
+.Fc
 .Sh DESCRIPTION
 These functions operate on variable length strings of bytes.
-They do not check for terminating null bytes as the routines
+They do not check for terminating null bytes, as the routines
 listed in
 .Xr string 3
 do.
 .Pp
 See the specific manual pages for more information.
+.Sh LEGACY SYNOPSIS
+.Fd #include <string.h>
+.Pp
+The include file
+.In string.h
+is necessary and sufficient for all functions.
 .Sh SEE ALSO
 .Xr bcmp 3 ,
 .Xr bcopy 3 ,
@@ -87,7 +126,8 @@ See the specific manual pages for more information.
 .Xr memcmp 3 ,
 .Xr memcpy 3 ,
 .Xr memmove 3 ,
-.Xr memset 3
+.Xr memset 3 ,
+.Xr compat 5
 .Sh STANDARDS
 The functions
 .Fn memchr ,