xref: /freebsd/lib/libc/string/bstring.3 (revision 0aa4a9fc859fd43343e2d7b5094a50d1ca0948eb)
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.Dd December 5, 2023
31.Dt BSTRING 3
32.Os
33.Sh NAME
34.Nm bcmp ,
35.Nm bcopy ,
36.Nm bzero ,
37.Nm memccpy ,
38.Nm memchr ,
39.Nm memcmp ,
40.Nm memcpy ,
41.Nm memmove ,
42.Nm memset
43.Nd byte string operations
44.Sh LIBRARY
45.Lb libc
46.Sh SYNOPSIS
47.In string.h
48.Ft int
49.Fn bcmp "const void *b1" "const void *b2" "size_t len"
50.Ft void
51.Fn bcopy "const void *src" "void *dst" "size_t len"
52.Ft void
53.Fn bzero "void *b" "size_t len"
54.Ft void *
55.Fn memchr "const void *b" "int c" "size_t len"
56.Ft int
57.Fn memcmp "const void *b1" "const void *b2" "size_t len"
58.Ft void *
59.Fo memccpy
60.Fa "void * restrict dst"
61.Fa "const void * restrict src"
62.Fa "int c"
63.Fa "size_t len"
64.Fc
65.Ft void *
66.Fn memcpy "void *dst" "const void *src" "size_t len"
67.Ft void *
68.Fn memmove "void *dst" "const void *src" "size_t len"
69.Ft void *
70.Fn memset "void *b" "int c" "size_t len"
71.Sh DESCRIPTION
72These functions operate on variable length strings of bytes.
73They do not check for terminating null bytes as the routines
74listed in
75.Xr string 3
76do.
77.Pp
78See the specific manual pages for more information.
79.Sh SEE ALSO
80.Xr bcmp 3 ,
81.Xr bcopy 3 ,
82.Xr bzero 3 ,
83.Xr memccpy 3 ,
84.Xr memchr 3 ,
85.Xr memcmp 3 ,
86.Xr memcpy 3 ,
87.Xr memmove 3 ,
88.Xr memset 3
89.Sh STANDARDS
90The functions
91.Fn memchr ,
92.Fn memcmp ,
93.Fn memcpy ,
94.Fn memmove ,
95and
96.Fn memset
97conform to
98.St -isoC .
99.Sh HISTORY
100The functions
101.Fn bzero
102and
103.Fn memccpy
104appeared in
105.Bx 4.3 ;
106the functions
107.Fn bcmp ,
108.Fn bcopy ,
109appeared in
110.Bx 4.2 .
111