xref: /freebsd/lib/libc/string/bcopy.3 (revision b2d48be1bc7df45ddd13b143a160d0acb5a383c5)
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.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"     @(#)bcopy.3	8.1 (Berkeley) 6/4/93
32.\" $FreeBSD$
33.\"
34.Dd August 24, 2015
35.Dt BCOPY 3
36.Os
37.Sh NAME
38.Nm bcopy
39.Nd copy byte string
40.Sh LIBRARY
41.Lb libc
42.Sh SYNOPSIS
43.In strings.h
44.Ft void
45.Fn bcopy "const void *src" "void *dst" "size_t len"
46.Sh DESCRIPTION
47The
48.Fn bcopy
49function
50copies
51.Fa len
52bytes from string
53.Fa src
54to string
55.Fa dst .
56The two strings may overlap.
57If
58.Fa len
59is zero, no bytes are copied.
60.Sh SEE ALSO
61.Xr memccpy 3 ,
62.Xr memcpy 3 ,
63.Xr memmove 3 ,
64.Xr strcpy 3 ,
65.Xr strncpy 3
66.Sh HISTORY
67A
68.Fn bcopy
69function appeared in
70.Bx 4.2 .
71Its prototype existed previously in
72.In string.h
73before it was moved to
74.In strings.h
75for
76.St -p1003.1-2001
77compliance.
78.Pp
79.St -p1003.1-2008
80removes the specification of
81.Fn bcopy
82and it is marked as LEGACY in
83.St -p1003.1-2004 .
84New programs should use
85.Xr memmove 3 .
86If the input and output buffer do not overlap, then
87.Xr memcpy 3
88is more efficient.
89Note that
90.Fn bcopy
91takes
92.Ar src
93and
94.Ar dst
95in the opposite order from
96.Fn memmove
97and
98.Fn memcpy .
99