xref: /freebsd/lib/libc/string/strcpy.3 (revision 4e2abf95a3693a7ab1b40b3e4a5eb4d2c1acd6b3)
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 and the American National Standards Committee X3,
6.\" on Information Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)strcpy.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD$
38.\"
39.Dd June 4, 1993
40.Dt STRCPY 3
41.Os BSD 4
42.Sh NAME
43.Nm strcpy
44.Nd copy strings
45.Sh SYNOPSIS
46.Fd #include <string.h>
47.Ft char *
48.Fn strcpy "char *dst" "const char *src"
49.Ft char *
50.Fn strncpy "char *dst" "const char *src" "size_t len"
51.Sh DESCRIPTION
52The
53.Fn strcpy
54and
55.Fn strncpy
56functions
57copy the string
58.Fa src
59to
60.Fa dst
61(including the terminating
62.Ql \e0
63character).
64.Pp
65The
66.Fn strncpy
67copies not more than
68.Fa len
69characters into
70.Fa dst ,
71appending
72.Ql \e0
73characters if
74.Fa src
75is less than
76.Fa len
77characters long, and
78.Em not
79terminating
80.Fa dst
81if
82.Fa src
83is more than
84.Fa len
85characters long.
86.Sh RETURN VALUES
87The
88.Fn strcpy
89and
90.Fn strncpy
91functions
92return
93.Fa dst .
94.Sh EXAMPLES
95The following sets
96.Dq Li chararray
97to
98.Dq Li abc\e0\e0\e0 :
99.Bd -literal -offset indent
100(void)strncpy(chararray, "abc", 6).
101.Ed
102.Pp
103The following sets
104.Dq Li chararray
105to
106.Dq Li abcdef :
107.Bd -literal -offset indent
108(void)strncpy(chararray, "abcdefgh", 6);
109.Ed
110.Sh SEE ALSO
111.Xr bcopy 3 ,
112.Xr memccpy 3 ,
113.Xr memcpy 3 ,
114.Xr memmove 3 ,
115.Xr strlcpy 3
116.Sh STANDARDS
117The
118.Fn strcpy
119and
120.Fn strncpy
121functions
122conform to
123.St -ansiC .
124