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