xref: /freebsd/lib/libc/string/bstring.3 (revision edf8578117e8844e02c0121147f45e4609b30680)
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. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"     @(#)bstring.3	8.1 (Berkeley) 6/4/93
31.\"
32.Dd June 4, 1993
33.Dt BSTRING 3
34.Os
35.Sh NAME
36.Nm bcmp ,
37.Nm bcopy ,
38.Nm bzero ,
39.Nm memccpy ,
40.Nm memchr ,
41.Nm memcmp ,
42.Nm memcpy ,
43.Nm memmove ,
44.Nm memset
45.Nd byte string operations
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.In string.h
50.Ft int
51.Fn bcmp "const void *b1" "const void *b2" "size_t len"
52.Ft void
53.Fn bcopy "const void *src" "void *dst" "size_t len"
54.Ft void
55.Fn bzero "void *b" "size_t len"
56.Ft void *
57.Fn memchr "const void *b" "int c" "size_t len"
58.Ft int
59.Fn memcmp "const void *b1" "const void *b2" "size_t len"
60.Ft void *
61.Fn memccpy "void *dst" "const void *src" "int c" "size_t len"
62.Ft void *
63.Fn memcpy "void *dst" "const void *src" "size_t len"
64.Ft void *
65.Fn memmove "void *dst" "const void *src" "size_t len"
66.Ft void *
67.Fn memset "void *b" "int c" "size_t len"
68.Sh DESCRIPTION
69These functions operate on variable length strings of bytes.
70They do not check for terminating null bytes as the routines
71listed in
72.Xr string 3
73do.
74.Pp
75See the specific manual pages for more information.
76.Sh SEE ALSO
77.Xr bcmp 3 ,
78.Xr bcopy 3 ,
79.Xr bzero 3 ,
80.Xr memccpy 3 ,
81.Xr memchr 3 ,
82.Xr memcmp 3 ,
83.Xr memcpy 3 ,
84.Xr memmove 3 ,
85.Xr memset 3
86.Sh STANDARDS
87The functions
88.Fn memchr ,
89.Fn memcmp ,
90.Fn memcpy ,
91.Fn memmove ,
92and
93.Fn memset
94conform to
95.St -isoC .
96.Sh HISTORY
97The functions
98.Fn bzero
99and
100.Fn memccpy
101appeared in
102.Bx 4.3 ;
103the functions
104.Fn bcmp ,
105.Fn bcopy ,
106appeared in
107.Bx 4.2 .
108