xref: /netbsd/share/man/man9/bcopy.9 (revision bf9ec67e)
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. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"     from: @(#)bcopy.3	8.1 (Berkeley) 6/4/93
36.\"	$NetBSD: bcopy.9,v 1.6 2002/02/13 08:18:36 ross Exp $
37.\"
38.Dd July 7, 2001
39.Dt BCOPY 9
40.Os
41.Sh NAME
42.Nm bcopy
43.Nd copy byte string
44.Sh SYNOPSIS
45.Fd #include \*[Lt]sys/systm.h\*[Gt]
46.Ft void
47.Fn bcopy "const void *src" "void *dst" "size_t len"
48.Sh DESCRIPTION
49.Bf -symbolic
50The
51.Fn bcopy
52interface is obsolete.
53Do not add new code using it.
54It will soon be purged.
55Use
56.Xr memcpy 9
57instead.
58(The
59.Fn bcopy
60function is now a macro for
61.Xr memcpy 9 . )
62.Ef
63.Pp
64The
65.Fn bcopy
66function
67copies
68.Fa len
69bytes from string
70.Fa src
71to string
72.Fa dst .
73.Pp
74.Bf -symbolic
75Unlike
76.Xr bcopy 3
77the two strings must not overlap!
78.Ef
79In the traditional
80.Bx
81kernel, overlapping copies were handled by the now-purged
82.Fn ovbcopy
83function. If you need to copy overlapping data, see
84.Xr memmove 9 .
85.Pp
86If
87.Fa len
88is zero, no bytes are copied.
89.Sh SEE ALSO
90.Xr bcopy 3 ,
91.Xr memcpy 9 ,
92.Xr memmove 9
93