xref: /freebsd/lib/libc/string/strcpy.3 (revision 5521ff5a4d1929056e7ffc982fac3341ca54df7c)
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 LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.Fd #include <string.h>
49.Ft char *
50.Fn strcpy "char *dst" "const char *src"
51.Ft char *
52.Fn strncpy "char *dst" "const char *src" "size_t len"
53.Sh DESCRIPTION
54The
55.Fn strcpy
56and
57.Fn strncpy
58functions
59copy the string
60.Fa src
61to
62.Fa dst
63(including the terminating
64.Ql \e0
65character).
66.Pp
67The
68.Fn strncpy
69copies not more than
70.Fa len
71characters into
72.Fa dst ,
73appending
74.Ql \e0
75characters if
76.Fa src
77is less than
78.Fa len
79characters long, and
80.Em not
81terminating
82.Fa dst
83if
84.Fa src
85is more than
86.Fa len
87characters long.
88.Sh RETURN VALUES
89The
90.Fn strcpy
91and
92.Fn strncpy
93functions
94return
95.Fa dst .
96.Sh EXAMPLES
97The following sets
98.Dq Li chararray
99to
100.Dq Li abc\e0\e0\e0 :
101.Bd -literal -offset indent
102(void)strncpy(chararray, "abc", 6).
103.Ed
104.Pp
105The following sets
106.Dq Li chararray
107to
108.Dq Li abcdef :
109.Bd -literal -offset indent
110(void)strncpy(chararray, "abcdefgh", 6);
111.Ed
112.Sh SEE ALSO
113.Xr bcopy 3 ,
114.Xr memccpy 3 ,
115.Xr memcpy 3 ,
116.Xr memmove 3 ,
117.Xr strlcpy 3
118.Sh STANDARDS
119The
120.Fn strcpy
121and
122.Fn strncpy
123functions
124conform to
125.St -isoC .
126