74ccdc452cc2f064b333a0a95894b1f57539e716
[dragonfly.git] / lib / libc / string / bstring.3
1 .\" Copyright (c) 1990, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Chris Torek.
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 .\"
34 .\"     @(#)bstring.3   8.1 (Berkeley) 6/4/93
35 .\" $FreeBSD: src/lib/libc/string/bstring.3,v 1.3.2.3 2001/12/14 18:33:59 ru Exp $
36 .\" $DragonFly: src/lib/libc/string/bstring.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
37 .\"
38 .Dd June 4, 1993
39 .Dt BSTRING 3
40 .Os
41 .Sh NAME
42 .Nm bcmp ,
43 .Nm bcopy ,
44 .Nm bzero ,
45 .Nm memccpy ,
46 .Nm memchr ,
47 .Nm memcmp ,
48 .Nm memcpy ,
49 .Nm memmove ,
50 .Nm memset
51 .Nd byte string operations
52 .Sh LIBRARY
53 .Lb libc
54 .Sh SYNOPSIS
55 .In string.h
56 .Ft int
57 .Fn bcmp "const void *b1" "const void *b2" "size_t len"
58 .Ft void
59 .Fn bcopy "const void *src" "void *dst" "size_t len"
60 .Ft void
61 .Fn bzero "void *b" "size_t len"
62 .Ft void *
63 .Fn memchr "const void *b" "int c" "size_t len"
64 .Ft int
65 .Fn memcmp "const void *b1" "const void *b2" "size_t len"
66 .Ft void *
67 .Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
68 .Ft void *
69 .Fn memcpy "void *dst" "const void *src" "size_t len"
70 .Ft void *
71 .Fn memmove "void *dst" "const void *src" "size_t len"
72 .Ft void *
73 .Fn memset "void *b" "int c" "size_t len"
74 .Sh DESCRIPTION
75 These functions operate on variable length strings of bytes.
76 They do not check for terminating null bytes as the routines
77 listed in
78 .Xr string 3
79 do.
80 .Pp
81 See the specific manual pages for more information.
82 .Sh SEE ALSO
83 .Xr bcmp 3 ,
84 .Xr bcopy 3 ,
85 .Xr bzero 3 ,
86 .Xr memccpy 3 ,
87 .Xr memchr 3 ,
88 .Xr memcmp 3 ,
89 .Xr memcpy 3 ,
90 .Xr memmove 3 ,
91 .Xr memset 3
92 .Sh STANDARDS
93 The functions
94 .Fn memchr ,
95 .Fn memcmp ,
96 .Fn memcpy ,
97 .Fn memmove ,
98 and
99 .Fn memset
100 conform to
101 .St -isoC .
102 .Sh HISTORY
103 The functions
104 .Fn bzero
105 and
106 .Fn memccpy
107 appeared in
108 .Bx 4.3 ;
109 the functions
110 .Fn bcmp ,
111 .Fn bcopy ,
112 appeared in
113 .Bx 4.2 .