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

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek.
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" 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 $
.\"
.Dd June 4, 1993
.Dt BSTRING 3
.Os
.Sh NAME
.Nm bcmp ,
.Nm bcopy ,
.Nm bzero ,
.Nm memccpy ,
.Nm memchr ,
.Nm memcmp ,
.Nm memcpy ,
.Nm memmove ,
.Nm memset
.Nd byte string operations
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In string.h
.Ft int
.Fn bcmp "const void *b1" "const void *b2" "size_t len"
.Ft void
.Fn bcopy "const void *src" "void *dst" "size_t len"
.Ft void
.Fn bzero "void *b" "size_t len"
.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"
.Ft void *
.Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
.Ft void *
.Fn memcpy "void *dst" "const void *src" "size_t len"
.Ft void *
.Fn memmove "void *dst" "const void *src" "size_t len"
.Ft void *
.Fn memset "void *b" "int c" "size_t len"
.Sh DESCRIPTION
These functions operate on variable length strings of bytes.
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 SEE ALSO
.Xr bcmp 3 ,
.Xr bcopy 3 ,
.Xr bzero 3 ,
.Xr memccpy 3 ,
.Xr memchr 3 ,
.Xr memcmp 3 ,
.Xr memcpy 3 ,
.Xr memmove 3 ,
.Xr memset 3
.Sh STANDARDS
The functions
.Fn memchr ,
.Fn memcmp ,
.Fn memcpy ,
.Fn memmove ,
and
.Fn memset
conform to
.St -isoC .
.Sh HISTORY
The functions
.Fn bzero
and
.Fn memccpy
appeared in
.Bx 4.3 ;
the functions
.Fn bcmp ,
.Fn bcopy ,
appeared in
.Bx 4.2 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1990, 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	3	.\"
5b2abdfb A	4	.\" This code is derived from software contributed to Berkeley by
5b2abdfb A	5	.\" Chris Torek.
e9ce8d39 A	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	9	.\" 1. Redistributions of source code must retain the above copyright
	10	.\" notice, this list of conditions and the following disclaimer.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice, this list of conditions and the following disclaimer in the
	13	.\" documentation and/or other materials provided with the distribution.
	14	.\" 3. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
5b2abdfb A	34	.\" @(#)bstring.3 8.1 (Berkeley) 6/4/93
5b2abdfb A	35	.\" $FreeBSD: src/lib/libc/string/bstring.3,v 1.7 2001/10/01 16:09:00 ru Exp $
e9ce8d39	36	.\"
5b2abdfb A	37	.Dd June 4, 1993
5b2abdfb A	38	.Dt BSTRING 3
e9ce8d39 A	39	.Os
e9ce8d39 A	40	.Sh NAME
5b2abdfb A	41	.Nm bcmp ,
	42	.Nm bcopy ,
	43	.Nm bzero ,
	44	.Nm memccpy ,
	45	.Nm memchr ,
	46	.Nm memcmp ,
	47	.Nm memcpy ,
	48	.Nm memmove ,
	49	.Nm memset
	50	.Nd byte string operations
e9ce8d39 A	51	.Sh LIBRARY
	52	.Lb libc
	53	.Sh SYNOPSIS
5b2abdfb	54	.In string.h
e9ce8d39	55	.Ft int
5b2abdfb A	56	.Fn bcmp "const void b1" "const void b2" "size_t len"
	57	.Ft void
	58	.Fn bcopy "const void src" "void dst" "size_t len"
	59	.Ft void
	60	.Fn bzero "void *b" "size_t len"
	61	.Ft void *
	62	.Fn memchr "const void *b" "int c" "size_t len"
	63	.Ft int
	64	.Fn memcmp "const void b1" "const void b2" "size_t len"
	65	.Ft void *
	66	.Fn memccpy "void dst" "const void src" "int c" "size_t len"
	67	.Ft void *
	68	.Fn memcpy "void dst" "const void src" "size_t len"
	69	.Ft void *
	70	.Fn memmove "void dst" "const void src" "size_t len"
	71	.Ft void *
	72	.Fn memset "void *b" "int c" "size_t len"
e9ce8d39	73	.Sh DESCRIPTION
5b2abdfb A	74	These functions operate on variable length strings of bytes.
	75	They do not check for terminating null bytes as the routines
	76	listed in
	77	.Xr string 3
	78	do.
	79	.Pp
	80	See the specific manual pages for more information.
e9ce8d39	81	.Sh SEE ALSO
5b2abdfb A	82	.Xr bcmp 3 ,
	83	.Xr bcopy 3 ,
	84	.Xr bzero 3 ,
	85	.Xr memccpy 3 ,
	86	.Xr memchr 3 ,
	87	.Xr memcmp 3 ,
	88	.Xr memcpy 3 ,
	89	.Xr memmove 3 ,
	90	.Xr memset 3
	91	.Sh STANDARDS
	92	The functions
	93	.Fn memchr ,
	94	.Fn memcmp ,
	95	.Fn memcpy ,
	96	.Fn memmove ,
	97	and
	98	.Fn memset
	99	conform to
	100	.St -isoC .
e9ce8d39	101	.Sh HISTORY
5b2abdfb A	102	The functions
	103	.Fn bzero
	104	and
	105	.Fn memccpy
	106	appeared in
	107	.Bx 4.3 ;
	108	the functions
	109	.Fn bcmp ,
	110	.Fn bcopy ,
	111	appeared in
	112	.Bx 4.2 .